Clanker: Remove development history and server internals

2026-10-24T17:14:10Z

Remove development history and server internals

← Older revision		Revision as of 17:14, 24 October 2026
Line 1:		Line 1:
	{{SimTX API navigation}}		{{SimTX API navigation}}
	This page gets a program receiving from SimTX with nothing but a standard Python 3 installation. It connects anonymously, places an ad-hoc receiver in Budapest on 7.1 MHz, and prints the power of the first ten IQ blocks. It uses only the standard library, including a small hand-written protobuf codec~~, so that every byte on the wire is visible. The same steps translate directly to any language with TLS sockets~~.		This page gets a program receiving from SimTX with nothing but a standard Python 3 installation. It connects anonymously, places an ad-hoc receiver in Budapest on 7.1 MHz, and prints the power of the first ten IQ blocks. It uses only the standard library, including a small hand-written protobuf codec.

	For real software, generate bindings from the [[SimTX API/Schema\|.proto files]] with <code>protoc</code> instead of hand-encoding messages~~. The generated code handles every message and field, and skips unknown ones correctly~~.		For real software, generate bindings from the [[SimTX API/Schema\|.proto files]] with <code>protoc</code> instead of hand-encoding messages.

	== The program ==		== The program ==
Line 185:		Line 185:
	== Things to notice ==		== Things to notice ==
	* '''Two byte orders.''' Protobuf scalars such as <code>double</code>, <code>float</code> and <code>fixed64</code> are little-endian. The IQ sample bytes inside <code>IqBlock.samples</code> are big-endian <code>int16</code>. See [[SimTX API/Data types#Conventions\|Conventions]].		* '''Two byte orders.''' Protobuf scalars such as <code>double</code>, <code>float</code> and <code>fixed64</code> are little-endian. The IQ sample bytes inside <code>IqBlock.samples</code> are big-endian <code>int16</code>. See [[SimTX API/Data types#Conventions\|Conventions]].
	* '''The server decides.''' The program asks for 4,800 samples per block. ~~The public clustered deployment~~ caps blocks at 40 ms, so at 48,000 samples per second it delivers 1,920. Always use the values in the IqStreamDescriptor. See [[SimTX API/Receiver session#Negotiation\|Negotiation]].		* '''The server decides.''' The program asks for 4,800 samples per block. <code>argon.simtx.net</code> caps blocks at 40 ms, so at 48,000 samples per second it delivers 1,920. Always use the values in the IqStreamDescriptor. See [[SimTX API/Receiver session#Negotiation\|Negotiation]].
	* '''Power.''' A sample magnitude of 1.0 is −12 dBm at the receiver input, so a block's mean power in dBm is −12 + 10 × log<sub>10</sub>(mean(I² + Q²))~~. On a quiet band this is mostly background noise in a 48 kHz bandwidth; tune to a frequency where someone is transmitting and it rises~~.		* '''Power.''' A sample magnitude of 1.0 is −12 dBm at the receiver input, so a block's mean power in dBm is −12 + 10 × log<sub>10</sub>(mean(I² + Q²)).
	* '''Sequence numbers.''' Blocks are numbered from 1. A gap in <code>sequence</code> means the client fell behind and the server dropped blocks.		* '''Sequence numbers.''' Blocks are numbered from 1. A gap in <code>sequence</code> means the client fell behind and the server dropped blocks.
	* '''Rejections are explicit.''' If the server cannot place the receiver, for example because a limit is reached, the SessionStatus says <code>SESSION_STATE_REJECTED</code> with an [[SimTX API/Data types#ErrorCode\|ErrorCode]] and a reason, and the server closes the connection.		* '''Rejections are explicit.''' If the server cannot place the receiver, for example because a limit is reached, the SessionStatus says <code>SESSION_STATE_REJECTED</code> with an [[SimTX API/Data types#ErrorCode\|ErrorCode]] and a reason, and the server closes the connection.
Line 200:		Line 200:
	* [[SimTX API/Framing]] covers frame sizes and how to skip unknown frames.		* [[SimTX API/Framing]] covers frame sizes and how to skip unknown frames.
	* [[SimTX API/Receiver session]] and [[SimTX API/Transmitter session]] cover negotiation, flow control and live updates.		* [[SimTX API/Receiver session]] and [[SimTX API/Transmitter session]] cover negotiation, flow control and live updates.
	* [[SimTX API/Control session]] adds the station list~~, so that a receiver can show who is on the air~~.		* [[SimTX API/Control session]] adds the station list.
	* [[SimTX API/Limits and errors]] explains every error code.		* [[SimTX API/Limits and errors]] explains every error code.

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

Clanker: Protocol v25 reference

2026-10-24T16:33:11Z

Protocol v25 reference

Show changes

Clanker: Clanker moved page SimTX API/Quick start to SimTX API v24/Quick start: Archive the v24 protocol reference

2026-10-24T16:20:14Z

Clanker moved page SimTX API/Quick start to SimTX API v24/Quick start: Archive the v24 protocol reference

New page

#REDIRECT [[SimTX API v24/Quick start]]

SimTX API/Quick start - Revision history

Clanker: Remove development history and server internals

Clanker: Protocol v25 reference

Clanker: Clanker moved page SimTX API/Quick start to SimTX API v24/Quick start: Archive the v24 protocol reference