Jump to content

SimTX API/Packets/AntennaPointingUpdate

From SimTX Wiki
Revision as of 16:27, 24 October 2026 by Clanker (talk | contribs) (Protocol v25 reference)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
AntennaPointingUpdate
Frame ClientFrame, field 16
Member pointing
Direction Client → server
Session Receiver, transmitter
Roles Station-bound ROLE_RECEIVER, ROLE_TX_AUDIO, ROLE_TX_GENERATED.
Permission None
Answered by SessionStatus UPDATED or Error
Answers
Defined in session.proto

AntennaPointingUpdate steers the antenna of a running station-bound session, or changes its tracking and Doppler correction, without reconnecting. It needs the server feature pointing.

Definition

message AntennaPointingUpdate {
  int64 request_id = 1;
  PointingMode mode = 2;
  float azimuth_deg = 3;
  float elevation_deg = 4;
  Tracking tracking = 5;
}

Fields

# Field Type Description
1 request_id int64 Chosen by the client; echoed by the SessionStatus UPDATED or the Error that answers it.
2 mode PointingMode POINTING_MODE_FIXED: point at azimuth_deg / elevation_deg. POINTING_MODE_TRACK: follow tracking.
3 azimuth_deg float FIXED mode: azimuth in degrees from true north through east.
4 elevation_deg float FIXED mode: elevation in degrees. Ignored by an AZ mount.
5 tracking Tracking TRACK mode: the target, rotator and Doppler settings. Also accepted in FIXED mode to switch Doppler correction on or off.

Behaviour

  • POINTING_MODE_FIXED points the antenna at azimuth_deg / elevation_deg. POINTING_MODE_TRACK follows tracking.target_station_id.
  • elevation_deg must be −90 to 90 and both angles finite.
  • Steering needs a station-bound session whose antenna has an AZ or AZEL mount. An AZ mount keeps its elevation. Otherwise the request is answered with Error INVALID_REQUEST (Antenna pointing needs a station-bound session with a steerable mount) and the session continues.
  • Success is confirmed by SessionStatus UPDATED with update_reason = UPDATE_REASON_POINTING, the request's request_id and the new pointing and tracking.
  • The rotator moves at its slew rate; the new pointing is reached gradually. See Rotators.
  • The change applies to this session only. The station's stored default pointing is unchanged.

See also

SimTX API reference (protocol v25)
Start OverviewQuick startFramingData typesPacket listSchemaLimits and errorsCompatibility and versioning
Account service OverviewDevice loginServer directoryStation endpointsGame ticketsPermissionsPublic endpoints
Game protocol Connection and handshakeSession statusReceiver sessionTransmitter sessionControl sessionCatalogModeration
Stations StationsSatellitesTracking and pointing
Connection ClientHelloPingServerHelloPongErrorBanner
Session AntennaPointingUpdateSessionStatus
Receiver ForwardedClientAddressReceiverStartReceiverRetuneIqStreamDescriptorIqBlock
Transmitter TransmitterStartSampleBlockTxUpdateTxModeInfoTxQueueTxAcceptTxTelemetryTxUpdateAck
Control ListStationsStartMonitorStopMonitorWeatherMapRequestServerHealthRequestCoverageMapRequestEphemerisRequestPassPredictionRequestStationListMonitorBlockMonitorEndWeatherMapResponseServerHealthReportCoverageMapResponseEphemerisResponsePassPredictionResponseMonitorAck
Catalog CatalogListRequestCatalogFetchCatalogUploadCatalogDeleteCatalogListCatalogEntryCatalogUploadResultCatalogDeleteResult
Moderation KickRequestIpModerationRequestBroadcastBannerKickResultIpModerationResultStationImpactList
Archive Protocol v24 reference