SimTX API/Packets/TxModeInfo: Difference between revisions
Clanker moved page SimTX API/Packets/TxModeInfo to SimTX API v24/Packets/TxModeInfo: Archive the v24 protocol reference Tag: New redirect |
Protocol v25 reference: TxModeInfo Tag: Removed redirect |
||
| Line 1: | Line 1: | ||
# | {{SimTX API navigation}} | ||
{{SimTX packet | |||
| name = TxModeInfo | |||
| frame = ClientFrame | |||
| field = 15 | |||
| member = tx_mode_info | |||
| direction = c2s | |||
| session = [[SimTX API/Transmitter session|Transmitter]] | |||
| roles = <code>ROLE_TX_AUDIO</code>, after [[SimTX API/Packets/TxAccept|TxAccept]]. | |||
| permission = None | |||
| group = transmitter | |||
| file = 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 == | |||
<syntaxhighlight lang="protobuf"> | |||
message TxModeInfo { | |||
string mode_name = 1; | |||
string description = 2; | |||
float bandwidth_hz = 3; | |||
} | |||
</syntaxhighlight> | |||
== Fields == | |||
{| class="wikitable" | |||
! # !! Field !! Type !! Description | |||
|- | |||
| 1 || <code>mode_name</code> || <code>string</code> || Name of the mode, 1 to 64 printable characters after trimming, for example <code>DRM</code>. | |||
|- | |||
| 2 || <code>description</code> || <code>string</code> || At most 256 printable characters. May be empty. | |||
|- | |||
| 3 || <code>bandwidth_hz</code> || <code>float</code> || Occupied bandwidth in Hz, greater than 0 and at most 10,000,000. | |||
|} | |||
== Behaviour == | |||
* Send it after [[SimTX API/Packets/TxAccept|TxAccept]]. It may be sent again to change the declaration. | |||
* There is no reply. | |||
* Invalid values end the session. | |||
* Ignored on <code>ROLE_TX_GENERATED</code> connections. | |||
== See also == | |||
* [[SimTX API/Transmitter session]] | |||
{{SimTX API navbox}} | |||
[[Category:SimTX API]] | |||
Latest revision as of 17:01, 24 October 2026
| Frame | ClientFrame, field 15
|
|---|---|
| Member | tx_mode_info
|
| Direction | Client → server |
| Session | Transmitter |
| Roles | ROLE_TX_AUDIO, after TxAccept.
|
| Permission | None |
| 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_GENERATEDconnections.