SimTX API v24/Packets/ReceiverRetune - Revision history

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

2026-10-24T16:16:51Z

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

← Older revision		Revision as of 16:16, 24 October 2026
Line 1:		Line 1:
	{{SimTX API navigation}}		{{SimTX API v24 navigation}}
	{{SimTX packet		{{SimTX packet v24
	\| name = ReceiverRetune		\| name = ReceiverRetune
	\| id = 13		\| id = 13
	\| hex = 0x0D		\| hex = 0x0D
	\| direction = c2s		\| direction = c2s
	\| session = [[SimTX API/Receiver session\|Receiver]]		\| session = [[SimTX API v24/Receiver session\|Receiver]]
	\| size = 4 bytes		\| size = 4 bytes
	\| permission = None		\| permission = None
	\| group = receiver		\| group = receiver
	}}		}}
	'''ReceiverRetune''' moves a running receiver to a new centre frequency without reconnecting. It is the only packet a client may send on a receiver connection after the [[SimTX API/Packets/ReceiverSessionRequest\|ReceiverSessionRequest]].		'''ReceiverRetune''' moves a running receiver to a new centre frequency without reconnecting. It is the only packet a client may send on a receiver connection after the [[SimTX API v24/Packets/ReceiverSessionRequest\|ReceiverSessionRequest]].

	== Layout ==		== Layout ==
Line 22:		Line 22:

	== Behaviour ==		== Behaviour ==
	* There is no acknowledgement and no new [[SimTX API/Packets/IqStreamDescriptor\|IqStreamDescriptor]]. Sample rate, block size and bandwidth stay the same.		* There is no acknowledgement and no new [[SimTX API v24/Packets/IqStreamDescriptor\|IqStreamDescriptor]]. Sample rate, block size and bandwidth stay the same.
	* The new frequency takes effect after a settling time of about 120 ms. Retunes received during that time are coalesced; only the latest is applied.		* The new frequency takes effect after a settling time of about 120 ms. Retunes received during that time are coalesced; only the latest is applied.
	* Expect a short gap or transient in the stream around the change.		* Expect a short gap or transient in the stream around the change.
Line 34:		Line 34:

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

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

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

2026-10-24T16:16:49Z

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

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

Clanker: SimTX API documentation

2026-10-24T09:57:53Z

SimTX API documentation

New page

{{SimTX API navigation}}
{{SimTX packet
| name = ReceiverRetune
| id = 13
| hex = 0x0D
| direction = c2s
| session = [[SimTX API/Receiver session|Receiver]]
| size = 4 bytes
| permission = None
| group = receiver
}}
'''ReceiverRetune''' moves a running receiver to a new centre frequency without reconnecting. It is the only packet a client may send on a receiver connection after the [[SimTX API/Packets/ReceiverSessionRequest|ReceiverSessionRequest]].

== Layout ==
{| class="wikitable"
! Field !! Type !! Description
|-
| <code>packetId</code> || <code>u8</code> || Always <code>13</code>.
|-
| <code>centerFreqHz</code> || <code>f32</code> || New centre frequency in hertz. Finite and ≥ 0.
|}

== Behaviour ==
* There is no acknowledgement and no new [[SimTX API/Packets/IqStreamDescriptor|IqStreamDescriptor]]. Sample rate, block size and bandwidth stay the same.
* The new frequency takes effect after a settling time of about 120 ms. Retunes received during that time are coalesced; only the latest is applied.
* Expect a short gap or transient in the stream around the change.
* A negative or non-finite frequency closes the connection. So does any packet other than ReceiverRetune.

== Example ==
<syntaxhighlight lang="text">
0D packetId 13
4A 0C 61 80 centerFreqHz 2300000.0
</syntaxhighlight>

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

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