SiteSync Docs

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Custom JavaScript Decoder Upload Requirements ======

To ensure compatibility, follow these guidelines when uploading a custom JavaScript decoder.

===== Example Custom Decoder Function =====

Here's a simple example of a custom JavaScript decoder function conforming to the required function signature:

<code javascript>
/**
* Custom decoder function for decoding data.
* @param bytes - The payload data to be decoded (an array of bytes).
* @param port - The port number used during decoding.
* @returns {string} - The decoded result as a string.
*/
function Decoder(bytes, port) {
  // Your decoding logic here
  let decodedResult = {}; //empty object that holds all UDT tag values
  decodedResult.Measurement = bytes[0]
  decodedResult.BatteryLevel = bytes[1]
  decodedResult.Temperature = bytes[2]
  return decodedResult;
}
</code>

===== Necessities for Uploading a Custom JavaScript Decoder =====

  *** Function Signature**: The decoder function must have the following signature: function Decoder(bytes, port) { //Your decoding logic here// }
      * Other functions can be used in the file can called from the Decoder function, but the Decoder function acts as the main function. 

      * **Return Value**: The decoder must return an **object** that represents the desired tag structure of the UDT.

      * **bytes**: This parameter represents the input data that needs to be decoded. It is an array of bytes that is gathered from an uplink's payload.

      * **port**: This parameter denotes the port number that might be used within the decoder function or during the decoding process.

- **Runtime Limitations**: Be aware of the runtime limitations and constraints of GraalVM. For example, certain features or APIs available in other JavaScript engines may not be present in GraalVM. Refer to the GraalVM documentation for any restrictions you should consider while uploading your custom decoder.

- **Testing**: Before uploading the custom JavaScript decoder, thoroughly test it in a separate environment. Ensure that it performs as expected and adheres to the function signature mentioned above.