SimTX API v24/Packets/StationList: Difference between revisions
SimTX API documentation |
Archive the v24 protocol reference: use the v24 templates, links and categories |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{SimTX API navigation}} | {{SimTX API v24 navigation}} | ||
{{SimTX packet | {{SimTX packet v24 | ||
| name = StationList | | name = StationList | ||
| id = 9 | | id = 9 | ||
| hex = 0x09 | | hex = 0x09 | ||
| direction = s2c | | direction = s2c | ||
| session = [[SimTX API/Control session|Control]] | | session = [[SimTX API v24/Control session|Control]] | ||
| size = Variable | | size = Variable | ||
| permission = None | | permission = None | ||
| answers = [[SimTX API/Packets/ListStations|ListStations]] | | answers = [[SimTX API v24/Packets/ListStations|ListStations]] | ||
| group = control | | group = control | ||
}} | }} | ||
| Line 36: | Line 36: | ||
| <code>frequencyHz</code> || <code>f32</code> || Transmitter: carrier frequency. Receiver: centre frequency. | | <code>frequencyHz</code> || <code>f32</code> || Transmitter: carrier frequency. Receiver: centre frequency. | ||
|- | |- | ||
| <code>modulation</code> || <code>UTF</code> || Transmitter: [[SimTX API/Data types#Modulation|Modulation]] name. Receiver: empty. | | <code>modulation</code> || <code>UTF</code> || Transmitter: [[SimTX API v24/Data types#Modulation|Modulation]] name. Receiver: empty. | ||
|- | |- | ||
| <code>powerWatts</code> || <code>f32</code> || Transmitter: requested power. Receiver: 0. | | <code>powerWatts</code> || <code>f32</code> || Transmitter: requested power. Receiver: 0. | ||
| Line 50: | Line 50: | ||
== Usage == | == Usage == | ||
* The list is a snapshot. Poll [[SimTX API/Packets/ListStations|ListStations]] to follow changes, every few seconds at most. | * The list is a snapshot. Poll [[SimTX API v24/Packets/ListStations|ListStations]] to follow changes, every few seconds at most. | ||
* A single server sorts the list by callsign. Through the public gateway, the lists of all server nodes are merged into one, so do not rely on the order. | * A single server sorts the list by callsign. Through the public gateway, the lists of all server nodes are merged into one, so do not rely on the order. | ||
* A station's UUID changes every time it reconnects. Callsigns are not unique. | * A station's UUID changes every time it reconnects. Callsigns are not unique. | ||
* Positions are as the operator entered them. | * Positions are as the operator entered them. | ||
{{SimTX API navbox}} | {{SimTX API v24 navbox}} | ||
[[Category:SimTX API]] | [[Category:SimTX API v24]] | ||
Latest revision as of 16:17, 24 October 2026
| Packet ID | 9(0x09)
|
|---|---|
| Direction | Server → client |
| Session | Control |
| Body size | Variable |
| Permission | None |
| Answers | ListStations |
StationList lists every station currently connected to the server, both transmitters and receivers, with their frequency, mode, power and position.
Layout[edit | edit source]
| Field | Type | Description |
|---|---|---|
packetId |
u8 |
Always 9.
|
count |
i32 |
Number of stations, at most 100,000. |
stations |
count × Station |
See below. |
Station[edit | edit source]
| Field | Type | Description |
|---|---|---|
stationUuid |
UTF |
Station UUID, unique for the session. |
callsign |
UTF |
Callsign. |
transmitting |
bool |
True for a transmitter, false for a receiver. |
frequencyHz |
f32 |
Transmitter: carrier frequency. Receiver: centre frequency. |
modulation |
UTF |
Transmitter: Modulation name. Receiver: empty. |
powerWatts |
f32 |
Transmitter: requested power. Receiver: 0. |
latitudeDeg |
f64 |
Station latitude. |
longitudeDeg |
f64 |
Station longitude. |
address |
UTF |
Client address. Always empty on a control session; filled in only for moderators. |
declaredBandwidthHz |
f32 |
Transmitter: occupied bandwidth as measured by the server. Receiver: filter bandwidth. |
Usage[edit | edit source]
- The list is a snapshot. Poll ListStations to follow changes, every few seconds at most.
- A single server sorts the list by callsign. Through the public gateway, the lists of all server nodes are merged into one, so do not rely on the order.
- A station's UUID changes every time it reconnects. Callsigns are not unique.
- Positions are as the operator entered them.