Transmitter Interface - Revision history

Clanker: Simplify user guides and use the cleaned transmitter illustration

2026-09-13T22:13:14Z

Simplify user guides and use the cleaned transmitter illustration

← Older revision		Revision as of 22:13, 13 September 2026
Line 5:		Line 5:

	== Read the window in this order ==		== Read the window in this order ==
	[[File:SimTX-0.3.6-first-transmission-guide.png\|thumb\|center\|900px\|alt=Transmitter window with annotated configuration and monitoring areas.\|The 0.3.6 interface~~, shown offline~~ with the first-transmission example. On a smaller screen, scroll the left pane to reach the antenna and Start TX.]]		[[File:SimTX-0.3.6-first-transmission-guide-clean.png\|thumb\|center\|900px\|alt=Transmitter window with annotated configuration and monitoring areas.\|The 0.3.6 interface with the first-transmission example. On a smaller screen, scroll the left pane to reach the antenna and Start TX.]]

	# '''Station''': name and place the virtual station.		# '''Station''': name and place the virtual station.
Line 16:		Line 16:

	== Server selector ==		== Server selector ==
	After ~~browser-based account sign-~~in, ~~the selector lists official servers with their names, addresses, and descriptions. Select~~ a ~~row~~ and use '''Connect''' to open the main window. '''Disconnect''' returns to this selector~~. The current interface does not offer Add Server or require a manually entered port.~~		After signing in, select a server and use '''Connect''' to open the main window. '''Disconnect''' returns to this selector.

	~~Earlier versions exposed manual server configuration, with 5100 as the generic default port. That is legacy behavior, not the current sign-in workflow~~.

	If the connection to the server drops while the application is running, the title area indicates that the client is reconnecting and retries every 3 seconds.		If the connection to the server drops while the application is running, the title area indicates that the client is reconnecting and retries every 3 seconds.
Line 73:		Line 71:
	\| BUF \|\| s \|\| Audio buffer fill		\| BUF \|\| s \|\| Audio buffer fill
	\|}		\|}
	Before ~~the server reports measurements~~ the deck shows ~~a local~~ estimate ~~computed from the antenna configuration~~. ~~Once telemetry arrives~~ the ~~header switches to measured output~~. If the amplifier overheats the header shows a PA OVERHEATED warning, see [[Power Amplifier Behaviour]].		Before transmission, the deck shows an estimate. During transmission, it shows the selected session’s measurements. If the amplifier overheats the header shows a PA OVERHEATED warning, see [[Power Amplifier Behaviour]].

	== Active Sessions ==		== Active Sessions ==

Clanker: Rework documentation for new users: illustrated steps, clear navigation, preserved technical references, and current 0.3.6 behavior

2026-09-13T21:22:08Z

Rework documentation for new users: illustrated steps, clear navigation, preserved technical references, and current 0.3.6 behavior

← Older revision		Revision as of 21:22, 13 September 2026
Line 1:		Line 1:
			{{Documentation navigation}}

	This page is a reference for the SimTX Transmitter application window. The window is split into a configuration form on the left and a live monitoring area on the right, with a status bar at the bottom.		This page is a reference for the SimTX Transmitter application window. The window is split into a configuration form on the left and a live monitoring area on the right, with a status bar at the bottom.


			== Read the window in this order ==
			[[File:SimTX-0.3.6-first-transmission-guide.png\|thumb\|center\|900px\|alt=Transmitter window with annotated configuration and monitoring areas.\|The 0.3.6 interface, shown offline with the first-transmission example. On a smaller screen, scroll the left pane to reach the antenna and Start TX.]]

			# '''Station''': name and place the virtual station.
			# '''RF Signal''': choose the radio frequency, output power, and modulation.
			# '''Transmission Source''': choose the sound or data to send.
			# '''Antenna''': match the antenna to that frequency.
			# '''Start TX''': create a session, then select it in the list on the right.

			The right-hand meters describe the selected session, or an estimate before transmission. A nonzero local estimate does not mean a transmission has started. The complete first-use sequence is in [[Getting Started]].

	== Server selector ==		== Server selector ==
	~~Shown at startup and after a disconnect. It~~ lists ~~known~~ servers with their ~~details~~ and ~~provides:~~		After browser-based account sign-in, the selector lists official servers with their names, addresses, and descriptions. Select a row and use '''Connect''' to open the main window. '''Disconnect''' returns to this selector. The current interface does not offer Add Server or require a manually entered port.
	* '''~~Add Server...~~'''~~: name, host, port (1~~ to ~~65535, default 5100), optional description~~.
	* '''~~Connect~~'''~~: establishes~~ the ~~control connection and opens~~ the ~~main window~~.		Earlier versions exposed manual server configuration, with 5100 as the generic default port. That is legacy behavior, not the current sign-in workflow.

	If the connection to the server drops while the application is running, the title area indicates that the client is reconnecting and retries every 3 seconds.		If the connection to the server drops while the application is running, the title area indicates that the client is reconnecting and retries every 3 seconds.
Line 10:		Line 24:
	== Station section ==		== Station section ==
	* '''Server''' row with a '''Disconnect''' button (returns to the server selector).		* '''Server''' row with a '''Disconnect''' button (returns to the server selector).
	* '''Token''': optional personal access token used for linked-account permissions, including catalog publication. [[Extension catalog]] explains how it is obtained.
	* '''Callsign''': station identifier shown to the server and other users. Persisted between runs.		* '''Callsign''': station identifier shown to the server and other users. Persisted between runs.
	* '''Location''': a clickable world map that fills the '''Lat''' and '''Lon''' fields. Coordinates can also be typed directly. Persisted between runs.		* '''Location''': a clickable world map that fills the '''Lat''' and '''Lon''' fields. Coordinates can also be typed directly. Persisted between runs.
Line 33:		Line 46:
	== Antenna section ==		== Antenna section ==
	* '''Type''': antenna selector, default EFHW + 49:1 unun. See [[Antenna System]].		* '''Type''': antenna selector, default EFHW + 49:1 unun. See [[Antenna System]].
	* '''Wire Length (m)''': main dimension of the antenna. The label adapts to the type (Circumference for the loop, Element Length for the vertical, Driven Element for the Yagis). A value of 0 ~~means resonant~~ length ~~at the operating frequency~~.		* '''Wire Length (m)''': main dimension of the antenna. The label adapts to the type (Circumference for the loop, Element Length for the vertical, Driven Element for the Yagis). A value of 0 selects the nominal type-specific template length; it does not guarantee low SWR. The EFHW template uses 32.5 m.
	* '''Height (m)''': feedpoint or apex height above ground. Default 10.		* '''Height (m)''': feedpoint or apex height above ground. Default 10.
	* '''Azimuth (°)''': orientation, 0 is north. Disabled for the vertical, which is omnidirectional.		* '''Azimuth (°)''': orientation, 0 is north. Disabled for the vertical, which is omnidirectional.

Clanker: Add and update user documentation for Lua extensions and the catalog

2026-08-06T09:12:30Z

Add and update user documentation for Lua extensions and the catalog

← Older revision		Revision as of 09:12, 6 August 2026
Line 10:		Line 10:
	== Station section ==		== Station section ==
	* '''Server''' row with a '''Disconnect''' button (returns to the server selector).		* '''Server''' row with a '''Disconnect''' button (returns to the server selector).
			* '''Token''': optional personal access token used for linked-account permissions, including catalog publication. [[Extension catalog]] explains how it is obtained.
	* '''Callsign''': station identifier shown to the server and other users. Persisted between runs.		* '''Callsign''': station identifier shown to the server and other users. Persisted between runs.
	* '''Location''': a clickable world map that fills the '''Lat''' and '''Lon''' fields. Coordinates can also be typed directly. Persisted between runs.		* '''Location''': a clickable world map that fills the '''Lat''' and '''Lon''' fields. Coordinates can also be typed directly. Persisted between runs.
Line 17:		Line 18:
	* '''Power (W)''': requested transmitter output power. Default 100.		* '''Power (W)''': requested transmitter output power. Default 100.
	* '''Radio Preset''': selects a transmitter character, see [[Radio Presets]]. Selecting a preset overwrites the power field and all advanced settings.		* '''Radio Preset''': selects a transmitter character, see [[Radio Presets]]. Selecting a preset overwrites the power field and all advanced settings.
	* '''Modulation''': the modulation mode, see [[Modulation Modes]].		* '''Modulation''': the built-in or installed Lua modulation mode, see [[Modulation Modes]] and [[Lua extensions]]. Installed modes add their own controls and inputs below the standard fields.
	* '''Bandwidth (Hz)''' with an '''Auto''' checkbox. Auto fills the typical bandwidth of the selected mode. Default 2700.		* '''Bandwidth (Hz)''' with an '''Auto''' checkbox. Auto fills the typical bandwidth of the selected mode. Default 2700.
	* '''Low-cut (Hz)''': audio low-frequency cutoff. Default 350. Editable only for modes where it applies.		* '''Low-cut (Hz)''': audio low-frequency cutoff. Default 350. Editable only for modes where it applies.
Line 27:		Line 28:
	* '''Microphone''': device selector, visible only for the Microphone source.		* '''Microphone''': device selector, visible only for the Microphone source.
	* '''Tone (Hz)''': test tone frequency, default 1000. For the GNU Radio IQ source this field is relabelled '''IQ Port'''.		* '''Tone (Hz)''': test tone frequency, default 1000. For the GNU Radio IQ source this field is relabelled '''IQ Port'''.
	* '''Audio File''' row with '''Choose...'''. ~~Audio~~ files can also be dragged onto the window (wav, mp3, aiff, aif, au).		* '''Audio File''' row with '''Choose...''', '''URL...''', and '''Repeat'''. Local files can also be dragged onto the window (wav, mp3, aiff, aif, au). URL accepts HTTP and HTTPS audio streams. Repeat restarts a local file when it ends.
	A hint line below the controls describes the currently selected source.		A hint line below the controls describes the currently selected source.

Line 40:		Line 41:
	== Start row ==		== Start row ==
	* '''Start TX''': starts a transmission session with the current configuration.		* '''Start TX''': starts a transmission session with the current configuration.
	* '''~~Save Preset...''' and '''Load Preset...~~''': ~~store~~ or ~~restore the complete station configuration as~~ a <code>.stxpreset</code> file. ~~This~~ includes every field, the source selection and any imported NEC deck.		* '''Presets''': applies installed presets, saves the current settings, or loads a <code>.stxpreset</code> file. A preset includes every field, the source selection, and any imported NEC deck.

	== Radio Deck ==		== Radio Deck ==
Line 62:		Line 63:

	== Active Sessions ==		== Active Sessions ==
	A list of the operator's sessions with id, callsign, frequency, modulation, power, status, source, SWR, bandwidth and server address. ~~Buttons:~~ '''Stop Selected''', '''Stop All''', '''Clear Finished'''. Session states are described in [[Sessions and Queueing]].		A list of the operator's sessions with id, callsign, frequency, modulation, power, status, source, SWR, bandwidth, and server address. '''Listen to Own TX''' monitors the selected running signal as received by the server before propagation. '''Live Edit''' changes its frequency, power, bandwidth, low cut, final drive, PA headroom, and compression without starting a new session. Frequency changes take effect on Enter, while the other fields apply after a short pause. '''Auto Reconnect''' restarts a session after a connection error. Other buttons are '''Stop Selected''', '''Stop All''', and '''Clear Finished'''. Session states are described in [[Sessions and Queueing]].

			== Footer controls ==
			* '''Extensions''': lists installed packages, runs tools, reports loading problems, and provides package creation and editing. See [[Lua extensions]].
			* '''Add-ons''': enables, configures, and orders installed Lua audio processors.
			* '''Catalog''': browses, installs, and publishes shared extensions and presets. See [[Extension catalog]].
			* '''Theme''': selects the system appearance or an installed Lua theme.

	[[Category:SimTX]]		[[Category:SimTX]]

Clanker: Create interface reference

2026-07-05T08:42:27Z

Create interface reference

New page

This page is a reference for the SimTX Transmitter application window. The window is split into a configuration form on the left and a live monitoring area on the right, with a status bar at the bottom.

== Server selector ==
Shown at startup and after a disconnect. It lists known servers with their details and provides:
* '''Add Server...''': name, host, port (1 to 65535, default 5100), optional description.
* '''Connect''': establishes the control connection and opens the main window.

If the connection to the server drops while the application is running, the title area indicates that the client is reconnecting and retries every 3 seconds.

== Station section ==
* '''Server''' row with a '''Disconnect''' button (returns to the server selector).
* '''Callsign''': station identifier shown to the server and other users. Persisted between runs.
* '''Location''': a clickable world map that fills the '''Lat''' and '''Lon''' fields. Coordinates can also be typed directly. Persisted between runs.

== RF Signal section ==
* '''Frequency (Hz)''': carrier frequency. Default 4625000 (4625 kHz), chosen to match the default antenna, see [[Getting Started]].
* '''Power (W)''': requested transmitter output power. Default 100.
* '''Radio Preset''': selects a transmitter character, see [[Radio Presets]]. Selecting a preset overwrites the power field and all advanced settings.
* '''Modulation''': the modulation mode, see [[Modulation Modes]].
* '''Bandwidth (Hz)''' with an '''Auto''' checkbox. Auto fills the typical bandwidth of the selected mode. Default 2700.
* '''Low-cut (Hz)''': audio low-frequency cutoff. Default 350. Editable only for modes where it applies.
* '''Show advanced transmitter settings''': expands the fifteen fine-tuning fields, see [[Advanced Transmitter Settings]].

== Transmission Source section ==
* '''Source Type''': see [[Transmission Sources]].
* '''Audio Gain''': input level, default 0.9.
* '''Microphone''': device selector, visible only for the Microphone source.
* '''Tone (Hz)''': test tone frequency, default 1000. For the GNU Radio IQ source this field is relabelled '''IQ Port'''.
* '''Audio File''' row with '''Choose...'''. Audio files can also be dragged onto the window (wav, mp3, aiff, aif, au).
A hint line below the controls describes the currently selected source.

== Antenna section ==
* '''Type''': antenna selector, default EFHW + 49:1 unun. See [[Antenna System]].
* '''Wire Length (m)''': main dimension of the antenna. The label adapts to the type (Circumference for the loop, Element Length for the vertical, Driven Element for the Yagis). A value of 0 means resonant length at the operating frequency.
* '''Height (m)''': feedpoint or apex height above ground. Default 10.
* '''Azimuth (°)''': orientation, 0 is north. Disabled for the vertical, which is omnidirectional.
* '''Feedline Loss (dB)''': fixed loss between transmitter and antenna.
* '''Import NEC...''' and '''Use built-in''': load or clear a custom antenna geometry, see [[NEC File Import]].

== Start row ==
* '''Start TX''': starts a transmission session with the current configuration.
* '''Save Preset...''' and '''Load Preset...''': store or restore the complete station configuration as a <code>.stxpreset</code> file. This includes every field, the source selection and any imported NEC deck.

== Radio Deck ==
The right-hand panel shows six meters:
{| class="wikitable"
! Meter !! Unit !! Meaning
|-
| FWD || W || Forward output power
|-
| REF || W || Reflected power returning from the antenna
|-
| SWR || :1 || Standing wave ratio at the transmitter
|-
| ALC || dB || Automatic level control action
|-
| TEMP || °C || Power amplifier finals temperature
|-
| BUF || s || Audio buffer fill
|}
Before the server reports measurements the deck shows a local estimate computed from the antenna configuration. Once telemetry arrives the header switches to measured output. If the amplifier overheats the header shows a PA OVERHEATED warning, see [[Power Amplifier Behaviour]].

== Active Sessions ==
A list of the operator's sessions with id, callsign, frequency, modulation, power, status, source, SWR, bandwidth and server address. Buttons: '''Stop Selected''', '''Stop All''', '''Clear Finished'''. Session states are described in [[Sessions and Queueing]].

[[Category:SimTX]]