WebSocket Interface

The WebSocket interface provides:

For normal browser use, connect through the proxied WebSocket path:

ws://{servername}.local/wsprrypi/socket

The backend service receives this connection internally as:

ws://127.0.0.1:31416/socket

Available Commands

Examples of supported commands include:

Example request:

{"command":"get_tx_state"}

Example response:

{"tx_state":true}

As long as the socket remains connected, the server broadcasts runtime events to all connected clients.

Broadcast when the active configuration changes:

{
    "state":"reload",
    "timestamp":"2025-05-06T16:43:02Z",
    "type":"configuration"
}

Broadcast when a transmission begins:

{
    "state":"starting",
    "timestamp":"2025-05-06T16:40:01Z",
    "type":"transmit"
}

Broadcast when a transmission finishes:

{
    "state":"finished",
    "timestamp":"2025-05-06T16:41:51Z",
    "type":"transmit"
}

Broadcast when a transmission is stopped before completion:

{
    "state":"cancelled",
    "timestamp":"2025-05-06T16:40:20Z",
    "type":"transmit"
}

Broadcast during transient RF test tone operations:

{
    "state":"starting",
    "type":"test_tone"
}

The browser UI relies heavily on these broadcasts for: