System operation
System gain
Changes the target gain level for the system, the values should be in dB (-120dB to 0dB)
PUT /psapi/gain/db HTTP/1.1
Host: aaa-1234.local
Content-Type: application/json
Accept: */*
Content-Length: 11
{
"value": 1
}
{
"scale": "linear",
"value": 1
}
Decrease the target system gain by X dB
PUT /psapi/gain/decrease HTTP/1.1
Host: aaa-1234.local
Content-Type: application/json
Accept: */*
Content-Length: 11
{
"value": 1
}
{
"scale": "linear",
"value": 1
}
Increase the target system gain by X dB
PUT /psapi/gain/increase HTTP/1.1
Host: aaa-1234.local
Content-Type: application/json
Accept: */*
Content-Length: 11
{
"value": 1
}
{
"scale": "linear",
"value": 1
}
Changes the target gain level for the system, the values should be in linear scale (0 to 1)
PUT /psapi/gain/linear HTTP/1.1
Host: aaa-1234.local
Content-Type: application/json
Accept: */*
Content-Length: 11
{
"value": 1
}
{
"scale": "linear",
"value": 1
}
System Mute
Changes the system mute state
PUT /psapi/mute HTTP/1.1
Host: aaa-1234.local
Content-Type: application/json
Accept: */*
Content-Length: 14
{
"muted": true
}
{
"muted": true
}
System Power
Changes the target power state for the system, allowed values are "on" and "sleep"
on
Possible values: PUT /psapi/power HTTP/1.1
Host: aaa-1234.local
Content-Type: application/json
Accept: */*
Content-Length: 15
{
"system": "on"
}
{
"system": "on"
}
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 /psapi/ws/power HTTP/1.1
Host: aaa-1234.local
Accept: */*
OK
No content
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 /psapi/ws/status/power HTTP/1.1
Host: aaa-1234.local
Accept: */*
OK
No content
Last updated
Was this helpful?