General

A Parser takes raw input from the Sensor API and converts the data into a unified format used by the Dashboard. In addition the parser can access an API to set device level properties and additional meta information outside of the actual data record.


Parsers are organized in 3 levels:

  • Hardcoded default parser
  • DeviceType parser
  • Device parser

When no parser on device level is defined, the parser for the device type will be executed. When no parser for the device type is defined, a hardcoded default parser will be executed.

Parsers are written in JavaScript.

Example

function Parse(input) {
  var dataStr = atob(input.data);
  var data = bytes(dataStr);

  // Decode an incoming message to an object of fields.
  var decoded = {input: input};

  return decoded;
}


Helper functions


Functions to cast Types, convert between Hex/Base64/Bytes and so on


// Bytes can convert binary data to byte array
// atob converts Base64 string to byte string
var bytes = bytes(atob("aGFsbG8gYmFzZTY0"));

// Convert Base64 to byte array, shortcut for bytes(atob(...))
var bytes = parseBase64("aGFsbG8gYmFzZTY0");

// Convert bytes to string
var str = string(bytes);

// byte parsing helper
uint16BE(bytes, idx);
uint16LE(bytes, idx);
uint32BE(bytes, idx);
uint32LE(bytes, idx);
float32LE(bytes, idx);
float32BE(bytes, idx);



Lobaro Platform Parser functions

Functions to access functions of the platform like WMBUS Parsing an so on.

// Parse wMbus message
Parser.parseWmbus(bytes);

// Takes bytes of a partial message and a cacheKey
// In context of the receiving device all data with the same cacheKey 
// is concatinated and the restult returned
// To start a new message, pass a new cacheKey
var joined = Parser.joinPartial(bytes, cacheKey);

// Clears all data with the given cacheKey 
// returns the joined parts that were added by joinPartial before
var joined = Parser.clearPartial(cacheKey);

// Equivalent to clearPartial followed by joinPartial
var joined = Parser.newPartial(cacheKey);


Device Related Functions

Functions Related to the Device the Parser is executed for.  All functions are optional. Not calling them will not change any data.


Access Fields of the Device

// Read only properties:
Device.name // String
Device.address // String
Device.tags // Array of Strings
Device.serial // String


Update the physical location of the sensor

Device.setLocation(lon, lat)


Set an device config value, displayed on the "Config" tab of the device

Device.setConfig("key", "value");

Get Configuration Value by Name:  (Configuration set for the Device in the Platform at the moment. Returns always the old Value. New Value that will be updated after the parser finished by "setConfig" calls are not considered.)

// value is null if if the value is not set. 
// value type is string, number or bool. 
// Byte arrays are encoded as Base64 strings.
var value = Device.getConfig("key");


Set an arbitrary device property, displayed on the "Overview" tab of the device

Device.setProperty("key", "value");


Get an arbitrary device property, displayed on the "Overview" tab of the device

var value = Device.getProperty("key");


Set the Sensor time of the current data record. Used for display, filter, sorting

The Timestamp must be in JS style and thus in milli seconds

Record.setTime(new Date(timestamp_ms));

When the parser output has a field called "time" on top level, it will be used like Record.setTime() was called

We might remove this in future. So always call Record.setTime() explicitly.



Get the time when the data was received by the server in ms, compatible with new Date(...).

Record.getReceivedAt();


  • No labels