Hub Home Downloads Documentation Releases

System operation

System gain

System Mute

System Power

PreviousControllers NextSpaces

Last updated 7 months ago

Was this helpful?

Get current system gain in dB

Returns the current system gain in dB (from -120dB to 0dB).

get

/gain/db

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://AAA-1234.local/psapi/gain/db'

200

500

{
  "value": 1,
  "scale": "linear"
}

Set current system gain in dB

Changes the target gain level for the system, the values should be in dB (-120dB to 0dB)

put

/gain/db

Body

valuenumberrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://AAA-1234.local/psapi/gain/db' \
  --header 'Content-Type: application/json' \
  --data '{"value":1}'

200

400

500

{
  "value": 1,
  "scale": "linear"
}

Decrease System Gain

Decrease the target system gain by X dB

put

/gain/decrease

Body

valuenumberrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://AAA-1234.local/psapi/gain/decrease' \
  --header 'Content-Type: application/json' \
  --data '{"value":1}'

200

400

500

{
  "value": 1,
  "scale": "linear"
}

Increase System Gain

Increase the target system gain by X dB

put

/gain/increase

Body

valuenumberrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://AAA-1234.local/psapi/gain/increase' \
  --header 'Content-Type: application/json' \
  --data '{"value":1}'

200

400

500

{
  "value": 1,
  "scale": "linear"
}

Get current system gain in linear values

Returns the current system gain in linear values (from 0 to 1).

get

/gain/linear

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://AAA-1234.local/psapi/gain/linear'

200

500

{
  "value": 1,
  "scale": "linear"
}

Set current system gain in linear values

Changes the target gain level for the system, the values should be in linear scale (0 to 1)

put

/gain/linear

Body

valuenumberrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://AAA-1234.local/psapi/gain/linear' \
  --header 'Content-Type: application/json' \
  --data '{"value":1}'

200

400

500

{
  "value": 1,
  "scale": "linear"
}

Get System Mute

Returns the system mute state

get

/mute

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://AAA-1234.local/psapi/mute'

200

500

{
  "muted": true
}

Set System Mute

Changes the system mute state

put

/mute

Body

mutedbooleanrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://AAA-1234.local/psapi/mute' \
  --header 'Content-Type: application/json' \
  --data '{"muted":true}'

200

400

500

{
  "muted": true
}

Get Power State

Returns the target power state for the system

get

/power

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://AAA-1234.local/psapi/power'

200

500

{
  "system": "on"
}

Set Power State

Changes the target power state for the system, allowed values are "on" and "sleep"

put

/power

Body

systemundefined · enumrequired

Example: on

Options: unknown, on, sleep

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://AAA-1234.local/psapi/power' \
  --header 'Content-Type: application/json' \
  --data '{"system":"on"}'

200

400

500

{
  "system": "on"
}

Get Module Power States

Get power information for all modules

get

/status/power

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://AAA-1234.local/psapi/status/power'

200

500

{
  "modules": {
    "ANY_ADDITIONAL_PROPERTY": {
      "status": "awake"
    }
  }
}

Stream Power Updates

This endpoint can be used to stream updates about the system power state through WebSockets. The payload returned is the same as in GET /power.

Find a Javascript client to use use this endpoint below.

const WebSocket = require('ws');

const client = new WebSocket('ws://localhost:6789/ws/power');
client.on('message', msg => console.log("Power update:" + msg.toString()));

get

/ws/power

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://AAA-1234.local/psapi/ws/power'

200

No body

Stream power information for all modules

This endpoint can be used to stream system power status information through WebSockets. The payload returned is the same as in GET /status/power but only the fields that have changed will be populated.

Upon reception of a message through the Websocket, a full system status can be retrieved by issuing a GET request to /status/power.

Find a Javascript client to use use this endpoint below.

const WebSocket = require('ws');

const client = new WebSocket('ws://localhost:6789/ws/status/power');
client.on('message', msg => console.log("Power status update:" + msg.toString()));

get

/ws/status/power

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://AAA-1234.local/psapi/ws/status/power'

200

No body