Advanced API Websockets

Start or Stop TPPA

PUB /tppa

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

Accepts one of the following messages.

PUBLISH /tppa

Message #1

This is deprecated. Use the json payload instead.

Payload

string string

Values are start-alignment, stop-alignment, pause-alignment, or resume-alignment.

Payload examples 
"start-alignment"

Message #2

Payload

  • Action string Required

    Values are start-alignment, stop-alignment, pause-alignment, or resume-alignment.

  • ManualMode boolean

    Relevant for start-alignment only. If true, the alignment will be started in manual mode.

  • TargetDistance integer

    Relevant for start-alignment only.

  • MoveRate integer

    Relevant for start-alignment only.

  • EastDirection boolean

    Relevant for start-alignment only.

  • StartFromCurrentPosition boolean

    Relevant for start-alignment only.

  • AltDegrees integer

    Relevant for start-alignment only.

  • AltMinutes integer(int32)

    Relevant for start-alignment only.

  • AltSeconds number(double)

    Relevant for start-alignment only.

  • AzDegrees integer

    Relevant for start-alignment only.

  • AzMinutes integer(int32)

    Relevant for start-alignment only.

  • AzSeconds number(double)

    Relevant for start-alignment only.

  • AlignmentTolerance number(double)

    Relevant for start-alignment only.

  • Filter string

    Relevant for start-alignment only. The name of the filter to use.

  • ExposureTime number(double)

    Relevant for start-alignment only.

  • Binning integer(int32)

    Relevant for start-alignment only.

  • Gain integer(int32)

    Relevant for start-alignment only.

  • Offset integer(int32)

    Relevant for start-alignment only.

  • SearchRadius number(double)

    Relevant for start-alignment only.

Payload examples 
{
  "Action": "start-alignment",
  "ManualMode": true,
  "TargetDistance": 42,
  "MoveRate": 42,
  "EastDirection": true,
  "StartFromCurrentPosition": true,
  "AltDegrees": 42,
  "AltMinutes": 42,
  "AltSeconds": 42.0,
  "AzDegrees": 42,
  "AzMinutes": 42,
  "AzSeconds": 42.0,
  "AlignmentTolerance": 42.0,
  "Filter": "string",
  "ExposureTime": 42.0,
  "Binning": 42,
  "Gain": 42,
  "Offset": 42,
  "SearchRadius": 42.0
}