Receive live data and status updates
Live data, status updates and actions
Only online noise instruments are supported through this API. If an instrument is online you can connect the websocket, if the instrument goes offline the websocket will be closed.
Requires an API key with the instruments:read
scope to make the connection and begin receiving status updates. Other actions require additional scopes.
Receive live data and status updates.
Payload example
{
"type": "LiveData",
"time": "2020-01-01T00:00:00Z",
"values": [
{
"name": "LAeq",
"value": 50.0
},
{
"name": "LCPeak",
"value": 60.0
}
]
}
Message #2
Payload
-
Type of message
Value is
InstrumentStatus
. -
Time of the status
-
True if the instrument is online, otherwise false
-
True if the instrument is measuring, otherwise false
-
True if the instrument is performing a calibration, otherwise false
-
True if the instrument is performing a System Integrity Check (SIC), otherwise false
Payload example
{
"type": "InstrumentStatus",
"time": "2020-01-01T00:00:00Z",
"online": true,
"measuring": true,
"calibrationInProgress": false,
"sicInProgress": false
}
Payload example
{
"type": "ActionStatus",
"time": "2020-01-01T00:00:00Z",
"action": "Identify",
"status": "InProgress"
}
Payload example
{
"error": "InvalidAction",
"description": "Unknown action (X)"
}
Payload example
{
"action": "KeepAlive"
}