# Start actions and live data

Start an action or start/stop live data.Start actions and live data

Method: SEND
Version: 1.0.0
License: MIT

## Servers

### production
Production server
Host: api.mycirrus.cloud
Protocol: wss
Path: /v1

## Operation Details

Action: send
Start an action or start/stop live data.
Start actions and live data

### Messages

#### Message
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.

#### Message
Start or stop live data.

If you specify the `StartLiveData` action the server will start sending live data for the specified types.<br>
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_

&nbsp;

Some types may be unavailable depending on subscription plan.<br>
If you specify an invalid or unavailable type, the server will ignore it.<br>
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.

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

The server will respond with another KeepAlive message.