Start actions and live data

SUB live/{instrument}

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.

Start an action or start/stop live data.

SUBSCRIBE live/{instrument}

Message #1

Perform an action on the instrument.

The possible actions are:

  • Identify
    • The instrument will flash its LED.
  • Calibration
    • The instrument will start the calibration process. You will need to attach an acoustic calibrator to the instrument.
  • SIC
    • The instrument will perform a System Integrity Check (SIC).

 

Requires an API key with the instruments:action scope.

Headers

Payload

  • action string

    Action to perform

    Values are Identify, Calibration, or SIC.

Payload example 
{
  "action": "Identify"
}

Message #2

Start or stop live data.

If you specify the StartLiveData action the server will start sending live data for the specified types.
If the server is already sending live data, the types will be updated.

If you specify the StopLiveData action the server will stop sending live data.

The possible live data types are:

  • Leq
    • LAeq, LCeq, LZeq, LAeqI
    • LAeqT
  • Peak
    • LAPeak, LCPeak, LZPeak
  • SPL
    • LAF, LAS, LAI
    • LCF, LCS, LCI
    • LZF, LZS, LZI
  • Statistical Levels
    • Ln1, Ln5, Ln10, Ln50, Ln90, Ln95, Ln99
  • Moving Average
    • Examples: LAeq,5m, LAeq,60m
    • Available values dependant on settings
  • Octaves
    • 31.5Hz, 63Hz, 125Hz, 250Hz, 500Hz, 1KHz, 2KHz, 4KHz, 8KHz, 16KHz
  • Third Octaves
    • 6.3Hz3 to 20KHz3
    • Names end with 3 to differentiate from octave bands

 

Some types may be unavailable depending on subscription plan.
If you specify an invalid or unavailable type, the server will ignore it.
If all specified types are invalid or no types are specified, the server will respond with an error.

Requires an API key with the data.live:read scope.

Headers

Payload

  • action string

    Action to perform

    Values are StartLiveData or StopLiveData.

  • types array[string]

    List of requested live data types

Payload example 
{
  "action": "StartLiveData",
  "types": [
    "LAeq",
    "LCPeak"
  ]
}

Message #3

The connection will timeout after 1 minute of inactivity.
To keep the connection alive, send a KeepAlive message every 30 seconds.

The server will respond with another KeepAlive message.

Headers

Payload

  • action string

    Action to perform

    Value is KeepAlive.

Payload example 
{
  "action": "KeepAlive"
}