SimTX API v24/Packets/TxTelemetry: Difference between revisions
Appearance
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 = TxTelemetry | | name = TxTelemetry | ||
| id = 7 | | id = 7 | ||
| hex = 0x07 | | hex = 0x07 | ||
| direction = s2c | | direction = s2c | ||
| session = [[SimTX API/Transmitter session|Transmitter]] | | session = [[SimTX API v24/Transmitter session|Transmitter]] | ||
| size = 81 bytes | | size = 81 bytes | ||
| permission = None | | permission = None | ||
| group = transmitter | | group = transmitter | ||
}} | }} | ||
'''TxTelemetry''' reports the state of a transmitter while it is on air: power at each point of the chain, standing-wave ratio, amplifier compression and temperature, and the server's playout buffer. The server sends it about every 50 ms from [[SimTX API/Packets/TxAccept|TxAccept]] until the session ends. These are the values behind the meters of the official transmitter. | '''TxTelemetry''' reports the state of a transmitter while it is on air: power at each point of the chain, standing-wave ratio, amplifier compression and temperature, and the server's playout buffer. The server sends it about every 50 ms from [[SimTX API v24/Packets/TxAccept|TxAccept]] until the session ends. These are the values behind the meters of the official transmitter. | ||
== Layout == | == Layout == | ||
| Line 70: | Line 70: | ||
* [[Power Amplifier Behaviour]] | * [[Power Amplifier Behaviour]] | ||
{{SimTX API navbox}} | {{SimTX API v24 navbox}} | ||
[[Category:SimTX API]] | [[Category:SimTX API v24]] | ||
Latest revision as of 16:19, 24 October 2026
| Packet ID | 7(0x07)
|
|---|---|
| Direction | Server → client |
| Session | Transmitter |
| Body size | 81 bytes |
| Permission | None |
TxTelemetry reports the state of a transmitter while it is on air: power at each point of the chain, standing-wave ratio, amplifier compression and temperature, and the server's playout buffer. The server sends it about every 50 ms from TxAccept until the session ends. These are the values behind the meters of the official transmitter.
Layout[edit | edit source]
| Field | Type | Description |
|---|---|---|
packetId |
u8 |
Always 7.
|
sequence |
i64 |
Increments with each telemetry packet. |
serverTimeMillis |
i64 |
Server wall-clock time, Unix milliseconds. |
actualFrequencyHz |
f32 |
Frequency on air, including any frequency offset. |
requestedPowerWatts |
f32 |
Power requested, after the account limit. |
forwardPowerWatts |
f32 |
Power leaving the amplifier toward the antenna. |
deliveredPowerWatts |
f32 |
Power actually accepted by the antenna. |
reflectedPowerWatts |
f32 |
Power reflected back by the mismatch. |
vswr |
f32 |
Voltage standing-wave ratio at the feed point. |
mismatchLossDb |
f32 |
Loss due to the mismatch, in dB. |
transformerLossDb |
f32 |
Loss in the matching transformer, in dB. |
foldbackLossDb |
f32 |
Power reduction by SWR protection, in dB. |
alcDb |
f32 |
Automatic level control reduction, in dB. |
bufferSeconds |
f32 |
Samples waiting in the server's playout buffer, in seconds. |
finalsTemperatureC |
f32 |
Temperature of the final amplifier, °C. |
thermalFoldbackDb |
f32 |
Power reduction by thermal protection, in dB. |
paCompressionDb |
f32 |
Amplifier gain compression, in dB. |
paHeatWatts |
f32 |
Heat dissipated in the amplifier, in watts. |
paEfficiencyPercent |
f32 |
Amplifier efficiency, percent. |
paThermalFaultActive |
bool |
True while the amplifier is in thermal fault. |
Usage[edit | edit source]
- Pacing:
bufferSecondsis the most useful field for a streaming client. It should stay above zero (otherwise listeners hear gaps) and below about two seconds (otherwise latency grows and input may be discarded). - Antenna match: a high
vswrwith largereflectedPowerWattsandfoldbackLossDbmeans the antenna is not resonant on the frequency. See SWR and Transmitter Protection. - Heat:
finalsTemperatureC,thermalFoldbackDbandpaThermalFaultActivefollow the amplifier model described in Power Amplifier Behaviour. - Telemetry is coalesced. A slow reader gets the most recent values rather than a backlog;
sequencemay skip. - The client must keep reading. A client that does not read for 5 seconds is disconnected.
In Python: struct.unpack(">qq16f?", body).