The websocket transports text messages containing single JSON data objects. These objects all are Message objects. Parsing and interpreting the Message objects can be done along the type field in the message. The value of this field determines the data type and further content of the message:
| Token | Message Type |
|---|---|
| VALUE | Parameter, contains an update for a parameter value |
| RANGE | Range, contains a data type an valid range definition for a parameter |
| PONG | This could be an echoed message used by the front end as a heartbeat (see Echo / Heartbeat Function below) |
Range messages contain an additional dataType field which specifies the data type of the parameter belonging to this range definition. Depending on dataType, there will me more fields in the range message, specifying the valid range of a numeric parameter, the available choices for an enumeration and more. The table below list all defined data types:
| Token | Data Type |
|---|---|
| INTEGER | IntegerRange |
| HEX | HexRange |
| FLOAT | DoubleRange |
| BOOLEAN | BooleanRange |
| ALARM | AlarmFlagRange |
| CHOICE | EnumRange |
| OBJECT | ObjectRange |