Skip to content
/
Live data and status chan...

MyCirrus API - Live data and status 1.0.0

API documentation for the MyCirrus API

Download AsyncAPI description
mycirrus-live.json
mycirrus-live.yaml
Overview
URL
https://www.cirrusresearch.com/support/
Support
support@cirrusresearch.com
License
MIT
Terms of Service
Servers
production
api.mycirrus.cloud
More details
Channel

Live data and status channel

name: 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.

Parameters

instrument

The serial number of the instrument

Channel binding
{
  "headers": [
    {
      "type": "object",
      "properties": { … }
    }
  ]
}

Messages

Accepts one of the following messages:

Payload

typestring

Type of message

Value"LiveData"
Example: "LiveData"
timestring(date-time)

Time of the data

Example: "2020-01-01T00:00:00Z"
valuesArray of objects

List of live data values

Example: [{"name":"LAeq","value":52.3},{"name":"LCPeak","value":63.4}]
Payload
{
  "type": "LiveData",
  "time": "2020-01-01T00:00:00Z",
  "values": [
    {
      "name": "LAeq",
      "value": 52.3
    },
    {
      "name": "LCPeak",
      "value": 63.4
    }
  ]
}

Send

Send

Start actions and live data

Start actions and live data

Start an action or start/stop live data.

Messages

DoAction
StartStopLiveData
KeepAlive

Receive

Receive

Receive live data and status updates

Receive live data and status updates

Receive live data and status updates.

Messages

LiveData
InstrumentStatus
ActionStatus
Error
KeepAlive