SimTX API/Packets/AntennaPointingUpdate
Appearance
| 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
|
| 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_FIXEDpoints the antenna atazimuth_deg/elevation_deg.POINTING_MODE_TRACKfollowstracking.target_station_id.elevation_degmust be −90 to 90 and both angles finite.- Steering needs a station-bound session whose antenna has an
AZorAZELmount. AnAZmount keeps its elevation. Otherwise the request is answered with ErrorINVALID_REQUEST(Antenna pointing needs a station-bound session with a steerable mount) and the session continues. - Success is confirmed by SessionStatus
UPDATEDwithupdate_reason = UPDATE_REASON_POINTING, the request'srequest_idand the newpointingandtracking. - 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.