SimTX API v24/Packet list

This page lists every packet of the SimTX API v24 game protocol, version 24. Client-to-server and server-to-client packets have separate ID spaces, so the same number can mean different things in each direction: ID 1 is ReceiverSessionRequest when the client sends it and IqStreamDescriptor when the server does.

Framing

After the handshake, every packet in either direction is:

u8      packetId
...     body, as defined on the packet's page

There is no length prefix. A reader must know the layout of every packet it can receive in order to find where the next one starts. A server that receives an ID it does not know, or that is not allowed in the current session, closes the connection. A client should do the same, since it can no longer find packet boundaries.

The handshake itself has no packet ID byte from the client. The server's reply, HandshakeResult, does carry its ID (30).

Client to server

ID	Hex	Packet	Session	Summary
—	—	Handshake	All	Opens the connection: magic, version, role and credential.
1	0x01	ReceiverSessionRequest	Receiver	Station, antenna and tuning for a receiver.
2	0x02	TransmitterSessionRequest	Transmitter	Station, antenna, mode and power for a transmitter.
3	0x03	SampleBlock	Transmitter	Audio or IQ samples to transmit.
4	0x04	ListStations	Control	Requests the station list.
5	0x05	KickRequest	Moderation	Disconnects stations.
6	0x06	StartMonitor	Control	Starts monitoring a transmitter's output.
7	0x07	StopMonitor	Control	Stops monitoring.
8	0x08	WeatherMapRequest	Control	Requests a tropospheric weather raster.
9	0x09	IpModerationRequest	Moderation	Bans or unbans an IP address.
10	0x0A	ServerHealthRequest	Control	Requests a server health report.
11	0x0B	ForwardedClientAddress	Receiver	Real client address, sent by trusted proxies.
12	0x0C	BroadcastBanner	Moderation	Shows a banner to every control client.
13	0x0D	ReceiverRetune	Receiver	Changes the receiver's centre frequency.
14	0x0E	TxModeInfo	Transmitter	Declares a custom mode name and bandwidth.
19	0x13	TxUpdate	Transmitter	Changes transmitter settings while on air.
20	0x14	CatalogListRequest	Control	Requests the extension catalog index.
21	0x15	CatalogFetch	Control	Downloads one catalog entry.
22	0x16	CatalogUpload	Control	Publishes an extension or preset.
24	0x18	CoverageMapRequest	Control	Requests a predicted coverage raster.
26	0x1A	CatalogDelete	Control	Deletes a catalog entry.

IDs 15 to 18, 23 and 25 are unassigned in this direction.

Server to client

ID	Hex	Packet	Session	Summary
1	0x01	IqStreamDescriptor	Receiver	Negotiated sample rate, block size and format.
2	0x02	IqBlock	Receiver	One block of received IQ samples.
3	0x03	TxAccept	Transmitter	The transmitter is on air.
4	0x04	TxQueue	Transmitter	Position in the transmitter queue.
5	0x05	TxReject	Transmitter	The request was refused.
6	0x06	TxKick	Transmitter	The transmitter was taken off air.
7	0x07	TxTelemetry	Transmitter	Power, SWR, temperature and buffer level.
8	0x08	ControlAck	Control	The control session is ready.
9	0x09	StationList	Control	All stations on the server.
10	0x0A	MonitorBlock	Control	Samples of a monitored transmitter.
11	0x0B	MonitorEnd	Control	Monitoring has ended.
12	0x0C	ModerationError	Moderation	A moderation request failed.
13	0x0D	KickResult	Moderation	Number of sessions kicked.
14	0x0E	WeatherMapResponse	Control	Weather raster and conditions at its centre.
15	0x0F	IpModerationResult	Moderation	Outcome of an IP ban or unban.
16	0x10	ServerHealthReport	Control	Server load and session statistics.
17	0x11	Banner	Control	Server-wide notice to display.
18	0x12	StationImpactList	Moderation	Interference analysis of transmitters.
21	0x15	CatalogUploadResult	Control	Outcome of a catalog upload.
23	0x17	TxUpdateAck	Transmitter	Outcome of each field of a TxUpdate.
24	0x18	CatalogList	Control	The extension catalog index.
25	0x19	CatalogEntry	Control	The files of one catalog entry.
27	0x1B	CoverageMapResponse	Control	Predicted coverage raster.
29	0x1D	CatalogDeleteResult	Control	Outcome of a catalog delete.
30	0x1E	HandshakeResult	All	Accepts or rejects the handshake.
31	0x1F	TimedIqBlock	Receiver	IQ block with a UTC timestamp.

IDs 19, 20, 22, 26 and 28 are unassigned in this direction.

By session

• Receiver session: roles 1 and 6.
• Transmitter session: roles 2 and 3.
• Control session: role 4, including the extension catalog.
• Moderation session: role 5.

The packet pages are also grouped in Category:SimTX API v24 packets.