Jump to content

SimTX API v24/Packets/StartMonitor: Difference between revisions

From SimTX Wiki
VisualWikitext
Clanker (talk | contribs)
660 edits
SimTX API documentation
 
Clanker (talk | contribs)
660 edits
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 = StartMonitor
| name = StartMonitor
| id = 6
| id = 6
| hex = 0x06
| hex = 0x06
| direction = c2s
| direction = c2s
| session = [[SimTX API/Control session|Control]]
| session = [[SimTX API v24/Control session|Control]]
| size = 2 + UUID length (38 bytes)
| size = 2 + UUID length (38 bytes)
| permission = Authenticated; own transmitters only (moderators: <code>monitor.any</code>)
| permission = Authenticated; own transmitters only (moderators: <code>monitor.any</code>)
| reply = [[SimTX API/Packets/MonitorBlock|MonitorBlock]] stream, ended by [[SimTX API/Packets/MonitorEnd|MonitorEnd]]
| reply = [[SimTX API v24/Packets/MonitorBlock|MonitorBlock]] stream, ended by [[SimTX API v24/Packets/MonitorEnd|MonitorEnd]]
| group = control
| group = control
}}
}}
Line 19: Line 19:
| <code>packetId</code> || <code>u8</code> || Always <code>6</code>.
| <code>packetId</code> || <code>u8</code> || Always <code>6</code>.
|-
|-
| <code>stationUuid</code> || <code>UTF</code> || UUID of the transmitter, as listed in [[SimTX API/Packets/StationList|StationList]].
| <code>stationUuid</code> || <code>UTF</code> || UUID of the transmitter, as listed in [[SimTX API v24/Packets/StationList|StationList]].
|}
|}


== Rules ==
== Rules ==
* On a control session, the transmitter must belong to the same account as the control session, on any connection. An anonymous control session cannot monitor anything.
* On a control session, the transmitter must belong to the same account as the control session, on any connection. An anonymous control session cannot monitor anything.
* Authenticated control sessions require a <code>control</code> [[SimTX API/Game tickets|ticket]], which the account service issues only to credentials with <code>catalog.publish</code>.
* Authenticated control sessions require a <code>control</code> [[SimTX API v24/Game tickets|ticket]], which the account service issues only to credentials with <code>catalog.publish</code>.
* On a [[SimTX API/Moderation session|moderation session]], any transmitter may be monitored with <code>monitor.any</code>.
* On a [[SimTX API v24/Moderation session|moderation session]], any transmitter may be monitored with <code>monitor.any</code>.
* If monitoring is not possible, the server answers with [[SimTX API/Packets/MonitorEnd|MonitorEnd]] and a reason.
* If monitoring is not possible, the server answers with [[SimTX API v24/Packets/MonitorEnd|MonitorEnd]] and a reason.
* Not a heavy request. The stream starts with the newest samples; there is no backlog.
* Not a heavy request. The stream starts with the newest samples; there is no backlog.


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

Latest revision as of 16:17, 24 October 2026

This page documents protocol v24, which current servers no longer accept. See SimTX API for v25.
v24 overviewQuick startAccount serviceHandshakeAll packetsData typesLimits and errorsCurrent reference (v25)
StartMonitor
Packet ID 6(0x06)
Direction Client → server
Session Control
Body size 2 + UUID length (38 bytes)
Permission Authenticated; own transmitters only (moderators: monitor.any)
Answered by MonitorBlock stream, ended by MonitorEnd
Answers

StartMonitor asks the server to stream the signal of one of the account's own transmitters back to the client, so that an operator can hear what they are sending. The stream is the transmitter's complex baseband after the modulator and amplifier model, before the antenna and propagation.

Layout[edit | edit source]

Field Type Description
packetId u8 Always 6.
stationUuid UTF UUID of the transmitter, as listed in StationList.

Rules[edit | edit source]

  • On a control session, the transmitter must belong to the same account as the control session, on any connection. An anonymous control session cannot monitor anything.
  • Authenticated control sessions require a control ticket, which the account service issues only to credentials with catalog.publish.
  • On a moderation session, any transmitter may be monitored with monitor.any.
  • If monitoring is not possible, the server answers with MonitorEnd and a reason.
  • Not a heavy request. The stream starts with the newest samples; there is no backlog.
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
Retrieved from "https://wiki.simtx.net/index.php?title=SimTX_API_v24/Packets/StartMonitor&oldid=2220"