Jump to content

SimTX API v24/Packets/MonitorBlock: Difference between revisions

From SimTX Wiki
Clanker (talk | contribs)
SimTX API documentation
 
Clanker (talk | contribs)
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 = MonitorBlock
| name = MonitorBlock
| id = 10
| id = 10
| hex = 0x0A
| hex = 0x0A
| direction = s2c
| direction = s2c
| session = [[SimTX API/Control session|Control]]
| session = [[SimTX API v24/Control session|Control]]
| size = Variable (about 16 KiB)
| size = Variable (about 16 KiB)
| permission = None
| permission = None
| answers = [[SimTX API/Packets/StartMonitor|StartMonitor]]
| answers = [[SimTX API v24/Packets/StartMonitor|StartMonitor]]
| group = control
| group = control
}}
}}
'''MonitorBlock''' carries a block of a monitored transmitter's signal, as requested with [[SimTX API/Packets/StartMonitor|StartMonitor]]. Blocks arrive in real time until [[SimTX API/Packets/MonitorEnd|MonitorEnd]] or [[SimTX API/Packets/StopMonitor|StopMonitor]].
'''MonitorBlock''' carries a block of a monitored transmitter's signal, as requested with [[SimTX API v24/Packets/StartMonitor|StartMonitor]]. Blocks arrive in real time until [[SimTX API v24/Packets/MonitorEnd|MonitorEnd]] or [[SimTX API v24/Packets/StopMonitor|StopMonitor]].


== Layout ==
== Layout ==
Line 33: Line 33:
* A wideband transmitter produces a lot of data: 10 MS/s of complex floats is 80 MB/s. Monitor such transmitters only on a fast connection.
* A wideband transmitter produces a lot of data: 10 MS/s of complex floats is 80 MB/s. Monitor such transmitters only on a fast connection.


{{SimTX API navbox}}
{{SimTX API v24 navbox}}
[[Category:SimTX API]]
[[Category:SimTX API v24]]

Latest revision as of 16:16, 24 October 2026

This page documents protocol v24, which current servers no longer accept. See SimTX API for v25.
MonitorBlock
Packet ID 10(0x0A)
Direction Server → client
Session Control
Body size Variable (about 16 KiB)
Permission None
Answered by
Answers StartMonitor

MonitorBlock carries a block of a monitored transmitter's signal, as requested with StartMonitor. Blocks arrive in real time until MonitorEnd or StopMonitor.

Layout[edit | edit source]

Field Type Description
packetId u8 Always 10.
stationUuid UTF The monitored transmitter.
sampleRate i32 Complex samples per second: the transmitter's processing rate (its declared sample rate, at least 240,000 for WFM, at most 10,000,000).
n i32 Number of floats that follow, at most 262,144. Currently 4,096 (2,048 complex samples).
iq n × f32 Complex baseband, I and Q interleaved, centred on the carrier.

Usage[edit | edit source]

  • Demodulate the IQ with the transmitter's modulation to hear the signal.
  • Monitor blocks share the control session's output queue, which holds at most 64 packets or 8 MiB. A client that cannot keep up has its control connection closed. Read on a dedicated thread.
  • A wideband transmitter produces a lot of data: 10 MS/s of complex floats is 80 MB/s. Monitor such transmitters only on a fast connection.
SimTX API v24 reference (protocol v24, archived)
Start OverviewQuick startData typesLimits and errorsPacket list
Account service OverviewDevice loginServer directoryGame ticketsPermissionsPublic endpoints
Game protocol Connection and handshakeReceiver sessionTransmitter sessionControl sessionCatalogModeration
Handshake HandshakeHandshakeResult
Receiver ReceiverSessionRequestReceiverRetuneForwardedClientAddressIqStreamDescriptorIqBlockTimedIqBlock
Transmitter TransmitterSessionRequestSampleBlockTxModeInfoTxUpdateTxQueueTxAcceptTxRejectTxKickTxTelemetryTxUpdateAck
Control ControlAckBannerListStationsStationListServerHealthRequestServerHealthReportCoverageMapRequestCoverageMapResponseWeatherMapRequestWeatherMapResponseStartMonitorStopMonitorMonitorBlockMonitorEnd
Catalog CatalogListRequestCatalogListCatalogFetchCatalogEntryCatalogUploadCatalogUploadResultCatalogDeleteCatalogDeleteResult
Moderation KickRequestKickResultIpModerationRequestIpModerationResultBroadcastBannerModerationErrorStationImpactList
Current Protocol v25 reference