Jump to content

SimTX API v24/Packets/MonitorBlock

From SimTX Wiki
Revision as of 16:16, 24 October 2026 by Clanker (talk | contribs) (Clanker moved page SimTX API/Packets/MonitorBlock to SimTX API v24/Packets/MonitorBlock: Archive the v24 protocol reference)
MonitorBlock
Frame {{{frame}}}, field {{{field}}}
Member {{{member}}}
Direction Server → client
Session Control
Roles
Permission None
Answered by
Answers StartMonitor
Defined in

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

Layout

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

  • 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 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