System operation

System gain

Get current system gain in dB

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

GEThttp://AAA-1234.local/psapi/gain/db

Response

200500

OK

Body

application/json

scale*enum

value*number

Request

JavaScriptCurlPython

const response = await fetch('http://AAA-1234.local/psapi/gain/db', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200500

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

Set current system gain in dB

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

PUThttp://AAA-1234.local/psapi/gain/db

Body

application/json

Gain in dB

value*number

Response

200400500

OK

Body

application/json

scale*enum

value*number

Request

JavaScriptCurlPython

const response = await fetch('http://AAA-1234.local/psapi/gain/db', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "value": 0
    }),
});
const data = await response.json();

Response

200400500

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

Decrease System Gain

Decrease the target system gain by X dB

PUThttp://AAA-1234.local/psapi/gain/decrease

Body

application/json

Gain difference in dB, positive number

value*number

Response

200400500

OK

Body

application/json

scale*enum

value*number

Request

JavaScriptCurlPython

const response = await fetch('http://AAA-1234.local/psapi/gain/decrease', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "value": 0
    }),
});
const data = await response.json();

Response

200400500

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

Increase System Gain

Increase the target system gain by X dB

PUThttp://AAA-1234.local/psapi/gain/increase

Body

application/json

Gain difference in dB, positive number

value*number

Response

200400500

OK

Body

application/json

scale*enum

value*number

Request

JavaScriptCurlPython

const response = await fetch('http://AAA-1234.local/psapi/gain/increase', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "value": 0
    }),
});
const data = await response.json();

Response

200400500

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

Get current system gain in linear values

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

GEThttp://AAA-1234.local/psapi/gain/linear

Response

200500

OK

Body

application/json

scale*enum

value*number

Request

JavaScriptCurlPython

const response = await fetch('http://AAA-1234.local/psapi/gain/linear', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200500

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

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)

PUThttp://AAA-1234.local/psapi/gain/linear

Body

application/json

Gain linear

value*number

Response

200400500

OK

Body

application/json

scale*enum

value*number

Request

JavaScriptCurlPython

const response = await fetch('http://AAA-1234.local/psapi/gain/linear', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "value": 0
    }),
});
const data = await response.json();

Response

200400500

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

System Mute

Get System Mute

Returns the system mute state

GEThttp://AAA-1234.local/psapi/mute

Response

200500

OK

Body

application/json

muted*boolean

Request

JavaScriptCurlPython

const response = await fetch('http://AAA-1234.local/psapi/mute', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200500

{
  "muted": false
}

Set System Mute

Changes the system mute state

PUThttp://AAA-1234.local/psapi/mute

Body

application/json

Mute

muted*boolean

Response

200400500

OK

Body

application/json

muted*boolean

Request

JavaScriptCurlPython

const response = await fetch('http://AAA-1234.local/psapi/mute', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "muted": false
    }),
});
const data = await response.json();

Response

200400500

{
  "muted": false
}

System Power

Get Power State

Returns the target power state for the system

GEThttp://AAA-1234.local/psapi/power

Response

200500

OK

Body

application/json

system*enum

Example: "on"

Request

JavaScriptCurlPython

const response = await fetch('http://AAA-1234.local/psapi/power', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200500

{
  "system": "on"
}

Set Power State

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

PUThttp://AAA-1234.local/psapi/power

Body

application/json

Power

system*enum

Example: "on"

Response

200400500

OK

Body

application/json

system*enum

Example: "on"

Request

JavaScriptCurlPython

const response = await fetch('http://AAA-1234.local/psapi/power', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "system": "on"
    }),
});
const data = await response.json();

Response

200400500

{
  "system": "on"
}

Get Module Power States

Get power information for all modules

GEThttp://AAA-1234.local/psapi/status/power

Response

200500

OK

Body

application/json

modulesobject

Request

JavaScriptCurlPython

const response = await fetch('http://AAA-1234.local/psapi/status/power', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200500

{}

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()));

GEThttp://AAA-1234.local/psapi/ws/power

Response

200

OK

Request

JavaScriptCurlPython

const response = await fetch('http://AAA-1234.local/psapi/ws/power', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

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()));

GEThttp://AAA-1234.local/psapi/ws/status/power

Response

200

OK

Request

JavaScriptCurlPython

const response = await fetch('http://AAA-1234.local/psapi/ws/status/power', {
    method: 'GET',
    headers: {},
});
const data = await response.json();