Jump to content

SimTX API/Packets/TxModeInfo

From SimTX Wiki
TxModeInfo
Frame ClientFrame, field 15
Member tx_mode_info
Direction Client → server
Session Transmitter
Roles ROLE_TX_AUDIO, after TxAccept.
Permission None
Answered by
Answers
Defined in session.proto

TxModeInfo declares a human-readable name and occupied bandwidth for the signal a transmitter is sending. It is meant for clients that generate their own modulation, typically with an IQ source, such as a digital mode the server has no name for. Sending it is optional.

Definition[edit | edit source]

message TxModeInfo {
  string mode_name = 1;
  string description = 2;
  float bandwidth_hz = 3;
}

Fields[edit | edit source]

# Field Type Description
1 mode_name string Name of the mode, 1 to 64 printable characters after trimming, for example DRM.
2 description string At most 256 printable characters. May be empty.
3 bandwidth_hz float Occupied bandwidth in Hz, greater than 0 and at most 10,000,000.

Behaviour[edit | edit source]

  • Send it after TxAccept. It may be sent again to change the declaration.
  • There is no reply.
  • Invalid values end the session.
  • Ignored on ROLE_TX_GENERATED connections.

See also[edit | edit source]

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