SimTX API v24/Packets/IqBlock - Revision history

Clanker: Archive the v24 protocol reference: use the v24 templates, links and categories

2026-10-24T16:15:45Z

Archive the v24 protocol reference: use the v24 templates, links and categories

← Older revision		Revision as of 16:15, 24 October 2026
Line 1:		Line 1:
	{{SimTX API navigation}}		{{SimTX API v24 navigation}}
	{{SimTX packet		{{SimTX packet v24
	\| name = IqBlock		\| name = IqBlock
	\| id = 2		\| id = 2
	\| hex = 0x02		\| hex = 0x02
	\| direction = s2c		\| direction = s2c
	\| session = [[SimTX API/Receiver session\|Receiver]]		\| session = [[SimTX API v24/Receiver session\|Receiver]]
	\| size = 8 + chunkSamples × 4 bytes (INT16)		\| size = 8 + chunkSamples × 4 bytes (INT16)
	\| permission = None		\| permission = None
	\| group = receiver		\| group = receiver
	}}		}}
	'''IqBlock''' carries one block of received complex baseband samples. A receiver session with role 1 receives a continuous stream of them after the [[SimTX API/Packets/IqStreamDescriptor\|IqStreamDescriptor]], at the rate of the simulation. Role 6 receives [[SimTX API/Packets/TimedIqBlock\|TimedIqBlock]] instead.		'''IqBlock''' carries one block of received complex baseband samples. A receiver session with role 1 receives a continuous stream of them after the [[SimTX API v24/Packets/IqStreamDescriptor\|IqStreamDescriptor]], at the rate of the simulation. Role 6 receives [[SimTX API v24/Packets/TimedIqBlock\|TimedIqBlock]] instead.

	== Layout ==		== Layout ==
Line 40:		Line 40:

	== See also ==		== See also ==
	* [[SimTX API/Receiver session#Decoding samples\|Decoding samples]]		* [[SimTX API v24/Receiver session#Decoding samples\|Decoding samples]]

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

Clanker: Clanker moved page SimTX API/Packets/IqBlock to SimTX API v24/Packets/IqBlock: Archive the v24 protocol reference

2026-10-24T16:15:43Z

Clanker moved page SimTX API/Packets/IqBlock to SimTX API v24/Packets/IqBlock: Archive the v24 protocol reference

← Older revision	Revision as of 16:15, 24 October 2026
(No difference)

Clanker: SimTX API documentation

2026-10-24T09:57:52Z

SimTX API documentation

New page

{{SimTX API navigation}}
{{SimTX packet
| name = IqBlock
| id = 2
| hex = 0x02
| direction = s2c
| session = [[SimTX API/Receiver session|Receiver]]
| size = 8 + chunkSamples × 4 bytes (INT16)
| permission = None
| group = receiver
}}
'''IqBlock''' carries one block of received complex baseband samples. A receiver session with role 1 receives a continuous stream of them after the [[SimTX API/Packets/IqStreamDescriptor|IqStreamDescriptor]], at the rate of the simulation. Role 6 receives [[SimTX API/Packets/TimedIqBlock|TimedIqBlock]] instead.

== Layout ==
{| class="wikitable"
! Field !! Type !! Description
|-
| <code>packetId</code> || <code>u8</code> || Always <code>2</code>.
|-
| <code>payloadLength</code> || <code>i32</code> || Length of the payload in bytes. At most 1 MiB.
|-
| <code>blockScale</code> || <code>f32</code> || First 4 bytes of the payload. Scale factor for this block.
|-
| <code>samples</code> || <code>chunkSamples × (I, Q)</code> || Remainder of the payload. Interleaved I and Q integers: <code>i16</code> each for INT16, <code>i8</code> each for INT8.
|}

== Decoding ==
<syntaxhighlight lang="text">
I = i_raw × blockScale / 32767 (INT16; use 127 for INT8)
Q = q_raw × blockScale / 32767
</syntaxhighlight>

* A client should check that <code>payloadLength</code> equals <code>4 + chunkSamples × 2 × bytesPerComponent</code> and treat anything else as a protocol error.
* <code>blockScale</code> is the block's peak component magnitude, at least 10<sup>−9</sup>. The server quantises each component as <code>round(x × 32767 / blockScale)</code>.
* A magnitude of 1.0 corresponds to −12 dBm at the receiver input. Components are clipped at ±1.0 before quantisation, so strong signals overload the receiver.

== Delivery ==
* Blocks are sent in real time. The server queues at most 8 blocks per connection and drops the oldest when the queue is full. Missing blocks are not marked; a client that needs to detect gaps should use role 6 and its timestamps.
* A client that does not read for 5 seconds is disconnected.

== See also ==
* [[SimTX API/Receiver session#Decoding samples|Decoding samples]]

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