Getting Started - Revision history

Clanker: Add screenshots of the SimTX desktop app

2026-10-24T20:48:29Z

Add screenshots of the SimTX desktop app

← Older revision		Revision as of 20:48, 24 October 2026
Line 10:		Line 10:

	== 2. Sign in and connect ==		== 2. Sign in and connect ==
			[[File:SimTX Guide Getting Started server.png\|thumb\|center\|482px\|alt=Connect to a server dialog showing Signed in at auth.simtx.net, the Server menu set to SimTX Demo, and the Work offline and Connect buttons.\|The Connect to a server dialog after sign-in, with a server chosen.]]
	# Open the app. In '''Sign in to SimTX''', press '''Sign in'''.		# Open the app. In '''Sign in to SimTX''', press '''Sign in'''.
	# Press '''Open browser''', sign in to your SimTX account and approve the device. '''Copy link''' copies the address instead.		# Press '''Open browser''', sign in to your SimTX account and approve the device. '''Copy link''' copies the address instead.
Line 17:		Line 18:

	== 3. Create your first station ==		== 3. Create your first station ==
			[[File:SimTX Guide Getting Started first station.png\|thumb\|center\|640px\|alt=Top of the Transmit tab with the Station section outlined, a guide tag reading Create the station you transmit from, and a Create a station button.\|The getting started guide outlines the Station section and points to Create a station.]]
	A '''station''' holds your callsign, location, antennas and radios. On first start, the in-app '''getting started guide''' points at each control in turn.		A '''station''' holds your callsign, location, antennas and radios. On first start, the in-app '''getting started guide''' points at each control in turn.
	# In the '''Transmit''' tab, press '''Create a station'''.		# In the '''Transmit''' tab, press '''Create a station'''.
Line 27:		Line 29:

	== 4. Make a first transmission ==		== 4. Make a first transmission ==
			[[File:SimTX Guide Getting Started transmit ready.png\|thumb\|center\|800px\|alt=Transmit tab with Demo hilltop as the station, an EFHW antenna, a 100 W radio, an SWR graph, frequency 4625 kHz, power 100 W, AM Double Sideband Full Carrier, and an empty Radio deck.\|The Transmit tab set up for a first transmission on 4625 kHz in AM.]]
	In the '''Transmit''' tab:		In the '''Transmit''' tab:
	# Set '''Frequency''' to <code>4625</code> with the unit '''kHz''', and '''Power (W)''' to <code>100</code>.		# Set '''Frequency''' to <code>4625</code> with the unit '''kHz''', and '''Power (W)''' to <code>100</code>.

Clanker: Tighten; link the full user guides

2026-10-24T19:59:36Z

Tighten; link the full user guides

Show changes

Clanker: Cover the SimTX desktop app: install, sign in, first station, first transmission, receiving

2026-10-24T19:41:26Z

Cover the SimTX desktop app: install, sign in, first station, first transmission, receiving

Show changes

Sophie-developer at 07:22, 22 October 2026

2026-10-22T07:22:21Z

← Older revision		Revision as of 07:22, 22 October 2026
Line 16:		Line 16:

	The steps and screenshots here describe the 0.3.6 interface.		The steps and screenshots here describe the 0.3.6 interface.

			You also have the option to use the new-client, which is available for download https://manifest.simtx.net for Windows, and instructions for 5+ linux distros can be found here: https://manifest.simtx.net/install .

	== 2. Sign in and choose a server ==		== 2. Sign in and choose a server ==

Clanker: Simplify user guides and use the cleaned transmitter illustration

2026-09-13T22:12:59Z

Simplify user guides and use the cleaned transmitter illustration

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

2026-09-13T21:22:01Z

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

Show changes

Bmcgeneral: Change connecting to server

2026-08-22T13:20:51Z

Change connecting to server

← Older revision		Revision as of 13:20, 22 August 2026
Line 9:		Line 9:
	When the application starts, a server selector dialog is shown before the main window.		When the application starts, a server selector dialog is shown before the main window.

	# Select a server ~~from~~ the ~~list, or press '''Add Server~~..~~.''' and enter a name, host, port (1 to 65535, default 5100~~) ~~and an optional description~~.		# Select "SimTX server" in the servers selector (Usually argon.simtx.net:5556).
	# Press '''Connect'''. The main window opens once the control connection is established.		# Press '''Connect'''. The main window opens once the control connection is established.

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

2026-08-06T09:12:29Z

Add and update user documentation for Lua extensions and the catalog

← Older revision		Revision as of 09:12, 6 August 2026
Line 4:		Line 4:
	* Java runtime (the transmitter is a Java desktop application).		* Java runtime (the transmitter is a Java desktop application).
	* Network access to a SimTX server. The default server port is '''5100'''.		* Network access to a SimTX server. The default server port is '''5100'''.
	* Optionally: audio files (wav, mp3, aiff, aif, au), a microphone, PipeWire (Linux system audio), ~~Audio URL~~ or GNU Radio for IQ input.		* Optionally: audio files (wav, mp3, aiff, aif, au), an HTTP or HTTPS audio URL, a microphone, PipeWire (Linux system audio), or GNU Radio for IQ input.

	== Connecting to a server ==		== Connecting to a server ==
Line 23:		Line 23:

	# Set a callsign in the '''Station''' section (default PA3NL) and click the world map to place the station, or type latitude and longitude directly.		# Set a callsign in the '''Station''' section (default PA3NL) and click the world map to place the station, or type latitude and longitude directly.
	# In '''Transmission Source''', keep the source type '''Audio File''' ~~and press~~ '''Choose...''' ~~to select a file~~, or drag ~~an audio~~ file onto the window. Supported formats: wav, mp3, aiff, aif, au.		# In '''Transmission Source''', keep the source type '''Audio File'''. Select '''Choose...''', drag a supported file onto the window, or select '''URL...''' for an HTTP or HTTPS stream. Supported local formats are wav, mp3, aiff, aif, and au.
	# Press '''Start TX'''.		# Press '''Start TX'''.
	# Watch the '''Radio Deck''' on the right. Before the server reports data it shows a local estimate; once telemetry arrives the header changes to measured output. The session also appears in the '''Active Sessions''' list.		# Watch the '''Radio Deck''' on the right. Before the server reports data it shows a local estimate; once telemetry arrives the header changes to measured output. The session also appears in the '''Active Sessions''' list.
Line 33:		Line 33:

	== Saving the setup ==		== Saving the setup ==
	'''~~Save Preset...~~''' stores the complete station configuration ~~(all fields, source, antenna, including an imported NEC deck) in~~ a ~~<code>.stxpreset</code>~~ file ~~that~~ '''Load Preset...''' ~~restores later~~. This is distinct from the built-in [[Radio Presets]], which only set the transmitter character.		The '''Presets''' menu stores the complete station configuration through '''Save Current Settings...''' and restores a file through '''Load Preset File...'''. The saved <code>.stxpreset</code> includes all fields, the source, and the antenna, including an imported NEC deck. This is distinct from the built-in [[Radio Presets]], which only set the transmitter character.

	== Next steps ==		== Next steps ==
Line 39:		Line 39:
	* Choose a better antenna for the target band: [[Antenna System]]		* Choose a better antenna for the target band: [[Antenna System]]
	* Understand mismatch warnings: [[SWR and Transmitter Protection]]		* Understand mismatch warnings: [[SWR and Transmitter Protection]]
			* Browse shared presets and extensions: [[Extension catalog]]

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

10.89.4.1 at 03:42, 27 July 2026

2026-07-27T03:42:57Z

← Older revision		Revision as of 03:42, 27 July 2026
Line 4:		Line 4:
	* Java runtime (the transmitter is a Java desktop application).		* Java runtime (the transmitter is a Java desktop application).
	* Network access to a SimTX server. The default server port is '''5100'''.		* Network access to a SimTX server. The default server port is '''5100'''.
	* Optionally: audio files (wav, mp3, aiff, aif, au), a microphone, PipeWire (Linux system audio) or GNU Radio for IQ input.		* Optionally: audio files (wav, mp3, aiff, aif, au), a microphone, PipeWire (Linux system audio), Audio URL or GNU Radio for IQ input.

	== Connecting to a server ==		== Connecting to a server ==

Clanker: Create getting started guide

2026-07-05T08:41:40Z

Create getting started guide

New page

This page describes how to launch the SimTX Transmitter, connect to a server and make a first transmission.

== Requirements ==
* Java runtime (the transmitter is a Java desktop application).
* Network access to a SimTX server. The default server port is '''5100'''.
* Optionally: audio files (wav, mp3, aiff, aif, au), a microphone, PipeWire (Linux system audio) or GNU Radio for IQ input.

== Connecting to a server ==
When the application starts, a server selector dialog is shown before the main window.

# Select a server from the list, or press '''Add Server...''' and enter a name, host, port (1 to 65535, default 5100) and an optional description.
# Press '''Connect'''. The main window opens once the control connection is established.

If the control connection drops later, the client shows a reconnecting notice and retries every 3 seconds. The '''Disconnect''' button returns to the server selector.

== First transmission ==
The default configuration is chosen to work immediately:

* Frequency '''4625 kHz''', power '''100 W''', modulation preselected with a '''2700 Hz''' bandwidth.
* Antenna: '''End-fed half-wave (EFHW) with 49:1 transformer''', 32.5 m wire at 10 m height. This antenna is close to resonance at 4625 kHz, which is why that frequency is the default. Changing the frequency far from resonance without changing the antenna produces a severe mismatch and very little radiated signal.

Steps:

# Set a callsign in the '''Station''' section (default PA3NL) and click the world map to place the station, or type latitude and longitude directly.
# In '''Transmission Source''', keep the source type '''Audio File''' and press '''Choose...''' to select a file, or drag an audio file onto the window. Supported formats: wav, mp3, aiff, aif, au.
# Press '''Start TX'''.
# Watch the '''Radio Deck''' on the right. Before the server reports data it shows a local estimate; once telemetry arrives the header changes to measured output. The session also appears in the '''Active Sessions''' list.

If the server is full the session is queued and the list shows the queue position, see [[Sessions and Queueing]].

== Stopping ==
Select the session in '''Active Sessions''' and press '''Stop Selected''', or press '''Stop All'''. '''Clear Finished''' removes completed entries from the list.

== Saving the setup ==
'''Save Preset...''' stores the complete station configuration (all fields, source, antenna, including an imported NEC deck) in a <code>.stxpreset</code> file that '''Load Preset...''' restores later. This is distinct from the built-in [[Radio Presets]], which only set the transmitter character.

== Next steps ==
* Learn the full interface: [[Transmitter Interface]]
* Choose a better antenna for the target band: [[Antenna System]]
* Understand mismatch warnings: [[SWR and Transmitter Protection]]

[[Category:SimTX]]

← Older revision		Revision as of 22:12, 13 September 2026
Line 6:		Line 6:
	# Open the [https://simtx.net/downloads official downloads page] and download the latest '''SimTX transmitter''' JAR file.		# Open the [https://simtx.net/downloads official downloads page] and download the latest '''SimTX transmitter''' JAR file.
	# Install '''Java 21 or newer''' for your operating system if it is not already installed. [https://adoptium.net/temurin/releases/?version=21 Eclipse Temurin] provides Java downloads: choose version 21 or newer and the installer for your system. A Java installation with desktop support is required.		# Install '''Java 21 or newer''' for your operating system if it is not already installed. [https://adoptium.net/temurin/releases/?version=21 Eclipse Temurin] provides Java downloads: choose version 21 or newer and the installer for your system. A Java installation with desktop support is required.
	# Keep the JAR in a folder where you can save files~~. The app keeps extension packages alongside the application by default~~.		# Keep the JAR in a folder where you can save files.
	# Open the JAR. If double-clicking opens an archive program or does nothing, open a terminal in the folder containing the download and run the command below, using the actual downloaded filename.		# Open the JAR. If double-clicking opens an archive program or does nothing, open a terminal in the folder containing the download and run the command below, using the actual downloaded filename.

Line 15:		Line 15:
	The filename above is an example for version 0.3.6. Use the filename on the downloads page for a newer version. <code>java -version</code> shows which Java version the terminal is using. See [[Troubleshooting#The application will not open\|startup troubleshooting]] if Java is missing or too old.		The filename above is an example for version 0.3.6. Use the filename on the downloads page for a newer version. <code>java -version</code> shows which Java version the terminal is using. See [[Troubleshooting#The application will not open\|startup troubleshooting]] if Java is missing or too old.

	~~The app checks for updates before server selection.~~ The steps and screenshots here describe the 0.3.6 interface.		The steps and screenshots here describe the 0.3.6 interface.

	== 2. Sign in and choose a server ==		== 2. Sign in and choose a server ==
	# In '''Connect your SimTX account''', use '''Open browser''' and complete SimTX sign-in. If the browser asks for a code, enter the code shown by the app. '''Copy link''' lets you open the same sign-in page manually.		# In '''Connect your SimTX account''', use '''Open browser''' and complete SimTX sign-in. If the browser asks for a code, enter the code shown by the app. '''Copy link''' lets you open the same sign-in page manually.
	# Approve the app in the browser, then return to the transmitter. The app continues when approval is received.		# Approve the app in the browser, then return to the transmitter. The app continues when approval is received.
	# In '''Select SimTX Server''', select a server and press '''Connect'''~~. The official server list supplies the address and port~~.		# In '''Select SimTX Server''', select a server and press '''Connect'''.

	Your SimTX account is separate from a wiki editing account~~. Current transmitter versions do not require copying a Discord token into a Token field~~. If the app restores an existing sign-in, it can go directly to server selection.		Your SimTX account is separate from a wiki editing account. If the app restores an existing sign-in, it can go directly to server selection.

	'''Checkpoint:''' the main window is open and the Station section identifies the selected server. Use '''Disconnect''' to return to server selection. An unavailable server or failed sign-in is covered in [[Troubleshooting]].		'''Checkpoint:''' the main window is open and the Station section identifies the selected server. Use '''Disconnect''' to return to server selection. An unavailable server or failed sign-in is covered in [[Troubleshooting]].
Line 29:		Line 29:
	The left-hand side contains the setup. Scroll down inside it if the Antenna section or Start TX is below the window edge.		The left-hand side contains the setup. Scroll down inside it if the Antenna section or Start TX is below the window edge.

	[[File:SimTX-0.3.6-first-transmission-guide.png\|thumb\|center\|900px\|alt=Annotated transmitter window with pointers to the station, RF Signal, Transmission Source, Antenna, Start TX, and monitoring controls.\|~~A prepared example in the 0.3.6 app. No server is connected in this illustration. In normal use, complete step 2~~ first.]]		[[File:SimTX-0.3.6-first-transmission-guide-clean.png\|thumb\|center\|900px\|alt=Annotated transmitter window with pointers to the station, RF Signal, Transmission Source, Antenna, Start TX, and monitoring controls.\|The main controls for your first transmission.]]

	# Under '''Station''', replace the example callsign with a name for your station. Click the map to choose the simulated station location, or enter latitude and longitude.		# Under '''Station''', replace the example callsign with a name for your station. Click the map to choose the simulated station location, or enter latitude and longitude.
Line 37:		Line 37:
	# Under '''Antenna''', choose '''Dipole''', set '''Wire Length (m)''' to <code>31</code>, '''Height (m)''' to <code>10</code>, '''Azimuth''' to <code>0</code>, and '''Feedline Loss (dB)''' to <code>1</code>.		# Under '''Antenna''', choose '''Dipole''', set '''Wire Length (m)''' to <code>31</code>, '''Height (m)''' to <code>10</code>, '''Azimuth''' to <code>0</code>, and '''Feedline Loss (dB)''' to <code>1</code>.

	This is ~~a specific example~~ for the frequency above~~, not a setting for every band. In the 0.3.6 local solver over average ground it gives an SWR estimate of about 1.26. Server conditions can change the result~~. [[Antenna System]] ~~explains how to choose a different setup.~~		This antenna setup is for the frequency above. See [[Antenna System]] when changing frequency.

	The application's original antenna default is a 32.5 m end-fed half-wave with a 49:1 transformer, at 10 m height. It remains available; the dipole example makes the first setup explicit instead of relying on a previous user's saved values.

	== 4. Choose an audio file ==		== 4. Choose an audio file ==
Line 46:		Line 44:
	# Leave '''Audio Gain''' at <code>0.9</code>. Leave '''Repeat''' off for the first test so the session ends when the file ends.		# Leave '''Audio Gain''' at <code>0.9</code>. Leave '''Repeat''' off for the first test so the session ends when the file ends.

	'''Checkpoint:''' the Audio File row shows the selected filename. ~~A URL, microphone, or external signal generator is not needed for this test.~~ [[Transmission Sources]] ~~covers those alternatives~~.		'''Checkpoint:''' the Audio File row shows the selected filename. See [[Transmission Sources]] for microphones and streams.

	== 5. Start and check the transmission ==		== 5. Start and check the transmission ==
	# Press '''Start TX''' once.		# Press '''Start TX''' once.
	# Find the new row under '''Active Sessions'''. '''Running''' means it has started. '''Queued''' means it is waiting for capacity and will start automatically; do not keep pressing Start TX.		# Find the new row under '''Active Sessions'''. '''Running''' means it has started. '''Queued''' means it is waiting for capacity and will start automatically; do not keep pressing Start TX.
	# Select the running session. ~~The~~ Radio Deck ~~displays server measurements when they arrive~~. '''FWD''' is outgoing power, '''SWR''' indicates antenna matching, and '''TEMP''' is the simulated amplifier temperature.		# Select the running session. Check the Radio Deck meters. '''FWD''' is outgoing power, '''SWR''' indicates antenna matching, and '''TEMP''' is the simulated amplifier temperature.
	# Press '''Listen to Own TX''' to check the selected signal before propagation. This tests the transmitted audio, not whether a distant listener can receive it.		# Press '''Listen to Own TX''' to check the selected signal before propagation. This tests the transmitted audio, not whether a distant listener can receive it.