Advanced API Websockets

Subscribe to TPPA WebSocket events

/tppa

TPPA WebSocket channel. To use this channel, TPPA >= 2.2.4.1 must be installed. You can specify the TPPA settings in the json payload.

Accepts one of the following messages.

SUBSCRIBE /tppa

Alignment Error Response

Payload

  • Response object Required
    Hide Response attributes Show Response attributes object
    • AzimuthError number
    • AltitudeError number
    • TotalError number
  • Error string Required
  • StatusCode integer Required
  • Success boolean Required
  • Type string Required
Payload examples 
{
  "Response": {
    "AzimuthError": 42.0,
    "AltitudeError": 42.0,
    "TotalError": 42.0
  },
  "Error": "string",
  "StatusCode": 200,
  "Success": true,
  "Type": "Socket"
}

Process Confirmation Response

Payload

  • Response string Required

    Values are started procedure, stopped procedure, paused procedure, or resumed procedure.

  • Error string Required
  • StatusCode integer Required
  • Success boolean Required
  • Type string Required
Payload examples 
{
  "Response": "started procedure",
  "Error": "string",
  "StatusCode": 200,
  "Success": true,
  "Type": "Socket"
}

Progress Response

Payload

  • Response object Required
    Hide Response attributes Show Response attributes object
    • Status string
    • Progress number(double)
  • Error string Required
  • StatusCode integer Required
  • Success boolean Required
  • Type string Required
Payload examples 
{
  "Response": {
    "Status": "Moving to next point",
    "Progress": 0.75
  },
  "Error": "string",
  "StatusCode": 200,
  "Success": true,
  "Type": "Socket"
}