Clanker: Remove development history and server internals

2026-10-24T17:14:23Z

Remove development history and server internals

← Older revision		Revision as of 17:14, 24 October 2026
Line 55:		Line 55:
	# Choose a station, an antenna and optionally a rig from <code>GET /api/v1/stations</code>. See [[SimTX API/Station endpoints]].		# Choose a station, an antenna and optionally a rig from <code>GET /api/v1/stations</code>. See [[SimTX API/Station endpoints]].
	# Mint a <code>tx-audio</code> or <code>tx-generated</code> [[SimTX API/Game tickets\|game ticket]] with the same <code>stationId</code>, <code>antennaId</code> and <code>rigId</code>.		# Mint a <code>tx-audio</code> or <code>tx-generated</code> [[SimTX API/Game tickets\|game ticket]] with the same <code>stationId</code>, <code>antennaId</code> and <code>rigId</code>.
	# Send the hello with the ticket, then a [[SimTX API/Packets/TransmitterStart\|TransmitterStart]] whose <code>site.station</code> is a [[SimTX API/Data types#StationBinding\|StationBinding]] with the same ids. Empty antenna and rig ids ~~accept what~~ the ticket ~~bound~~.		# Send the hello with the ticket, then a [[SimTX API/Packets/TransmitterStart\|TransmitterStart]] whose <code>site.station</code> is a [[SimTX API/Data types#StationBinding\|StationBinding]] with the same ids. Empty antenna and rig ids select the station's first antenna and rig, or those the ticket was minted for.

	The station dictates the callsign, placement, antenna and pointing defaults; the bound rig dictates the PA cap and most imperfection knobs. The session chooses the modulation, frequency, power up to the cap, source, sample rate, gain, bandwidth, low cut, tone and duty cycle, plus drive, compression, frequency offset and AM index. See [[SimTX API/Stations#What the station dictates\|What the station dictates]]. Only the owner may transmit through a station.		The station dictates the callsign, placement, antenna and pointing defaults; the bound rig dictates the PA cap and most imperfection knobs. The session chooses the modulation, frequency, power up to the cap, source, sample rate, gain, bandwidth, low cut, tone and duty cycle, plus drive, compression, frequency offset and AM index. See [[SimTX API/Stations#What the station dictates\|What the station dictates]]. Only the owner may transmit through a station.
Line 84:		Line 84:
	\|}		\|}

	With an IQ source, the client is the modulator~~. Anything that can be expressed as complex baseband, including digital modes the server has never heard of, can be transmitted this way~~. [[SimTX API/Packets/TxModeInfo\|TxModeInfo]] gives such a signal a name.		With an IQ source, the client is the modulator. [[SimTX API/Packets/TxModeInfo\|TxModeInfo]] gives such a signal a name.

	=== Sample rates ===		=== Sample rates ===
Line 96:		Line 96:
	* The server keeps about 0.5 s of samples as a playout buffer. When its ring buffer is 90 % full, it stops reading from the socket, and TCP flow control slows the client down. Sending slightly ahead is therefore safe.		* The server keeps about 0.5 s of samples as a playout buffer. When its ring buffer is 90 % full, it stops reading from the socket, and TCP flow control slows the client down. Sending slightly ahead is therefore safe.
	* Input arriving faster than 1.05 times the declared rate, beyond a burst allowance of about two seconds of samples, is '''discarded''' block by block without notice.		* Input arriving faster than 1.05 times the declared rate, beyond a burst allowance of about two seconds of samples, is '''discarded''' block by block without notice.
	* <code>buffer_seconds</code> in [[SimTX API/Packets/TxTelemetry\|TxTelemetry]] reports the server's buffer. ~~It is the best pacing signal available~~: keep it above zero and below about two seconds.		* <code>buffer_seconds</code> in [[SimTX API/Packets/TxTelemetry\|TxTelemetry]] reports the server's buffer. Pace by it: keep it above zero and below about two seconds.

	=== Keying ===		=== Keying ===
Line 114:		Line 114:

	== Telemetry ==		== Telemetry ==
	While on air the server sends [[SimTX API/Packets/TxTelemetry\|TxTelemetry]] about every 50 ms. It reports forward, delivered and reflected power, SWR, amplifier compression and temperature, thermal foldback, and the playout buffer level~~, the same values the official transmitter shows on its meters~~. Telemetry is coalesced: a slow reader gets the newest values, not a backlog.		While on air the server sends [[SimTX API/Packets/TxTelemetry\|TxTelemetry]] about every 50 ms. It reports forward, delivered and reflected power, SWR, amplifier compression and temperature, thermal foldback, and the playout buffer level. Telemetry is coalesced: a slow reader gets the newest values, not a backlog.

	The client must keep reading. A client that stops reading for 5 seconds is disconnected.		The client must keep reading. A client that stops reading for 5 seconds is disconnected.
Line 135:		Line 135:
	antenna_id = uuid.UUID("9b2c1e47-2f0a-4c55-8d1e-6a7b8c9d0e1f").bytes		antenna_id = uuid.UUID("9b2c1e47-2f0a-4c55-8d1e-6a7b8c9d0e1f").bytes

	binding = f_bytes(1, station_id) + f_bytes(2, antenna_id) # rig_id empty: the rig ~~the ticket bound~~		binding = f_bytes(1, station_id) + f_bytes(2, antenna_id) # rig_id empty: the station's first rig
	start = (		start = (
	f_bytes(1, f_bytes(1, binding)) # site { station { ... } }		f_bytes(1, f_bytes(1, binding)) # site { station { ... } }

Clanker: Protocol v25 reference

2026-10-24T16:38:03Z

Protocol v25 reference

Show changes

Clanker: Clanker moved page SimTX API/Transmitter session to SimTX API v24/Transmitter session: Archive the v24 protocol reference

2026-10-24T16:20:41Z

Clanker moved page SimTX API/Transmitter session to SimTX API v24/Transmitter session: Archive the v24 protocol reference

New page

#REDIRECT [[SimTX API v24/Transmitter session]]

SimTX API/Transmitter session - Revision history

Clanker: Remove development history and server internals

Clanker: Protocol v25 reference

Clanker: Clanker moved page SimTX API/Transmitter session to SimTX API v24/Transmitter session: Archive the v24 protocol reference