Jump to content

Getting Started: Difference between revisions

From SimTX Wiki
← Older edit
VisualWikitext
Clanker (talk | contribs)
660 edits
Simplify user guides and use the cleaned transmitter illustration
Clanker (talk | contribs)
660 edits
Add screenshots of the SimTX desktop app
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Documentation navigation}}
{{Documentation navigation}}


This guide takes a new user from downloading SimTX to sending an audio file. '''TX means transmit.''' All signals in this guide are simulated; a physical transmitter, antenna, or microphone is not required.
This guide goes from installing the SimTX desktop app to a first transmission and listening to it. TX means transmit and RX means receive.


== 1. Download and open the transmitter ==
== 1. Install the app ==
# Open the [https://simtx.net/downloads official downloads page] and download the latest '''SimTX transmitter''' JAR file.
Download the app from the [https://manifest.simtx.net SimTX downloads page]:
# 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.
* '''Windows''': the 64-bit <code>.exe</code> installer.
# Keep the JAR in a folder where you can save files.
* '''macOS''': the <code>.dmg</code> for Apple Silicon. The first time, right-click the app and choose '''Open''' to get past the macOS security warning.
# 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.
* '''Linux''': <code>.deb</code>, <code>.rpm</code>, Arch or Void packages, or an AppImage. The [https://manifest.simtx.net/install install page] explains how to add the package repository. Ubuntu 24.04 or Debian 13 or newer is needed.


<syntaxhighlight lang="bash">
== 2. Sign in and connect ==
java -jar simtx-transmitter-0.3.6.jar
[[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.]]
</syntaxhighlight>
# 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.
# In '''Connect to a server''', choose a '''Server''' and press '''Connect'''.


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 top right of the window then shows the server and '''Connected'''. '''Work offline''' opens the app without connecting.


The steps and screenshots here describe the 0.3.6 interface.
== 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.
# In the '''Transmit''' tab, press '''Create a station'''.
# Under '''Basics''', enter a '''Name''' and your '''Callsign'''.
# Under '''Location''', press '''Pick on globe''', click where the station stands and press '''Done'''.
# Under '''Antennas''', open the dipole and set the length to <code>31</code> m and the '''Height''' to <code>10</code> m. This suits the frequency below.
# Press '''Create station'''.


== 2. Sign in and choose a server ==
The station now shows under '''Transmit from'''. See [[SimTX Guide/Stations|Stations]].
# 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.
# In '''Select SimTX Server''', select a server and press '''Connect'''.


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.
== 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:
# Set '''Frequency''' to <code>4625</code> with the unit '''kHz''', and '''Power (W)''' to <code>100</code>.
# Choose the '''Modulation''' '''AM Double Sideband Full Carrier''' and tick '''Auto''' beside '''Bandwidth (Hz)'''.
# Under '''Source''', choose '''Audio file''', press '''Choose…''' and pick a short audio file.
# Press '''Start TX'''.


'''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]].
The session appears in the '''Sessions''' list as '''Running'''. '''Queued''' means every transmitter slot is taken; it starts by itself when one is free. Select the session to see the '''Radio deck''' meters. '''Listen to own TX''' plays your signal as transmitted. '''Stop''' ends it.


== 3. Enter a simple station setup ==
[[SimTX Guide/Transmitting|Transmitting]] covers every control. If the session fails, its message says why; see [[SimTX Guide/Troubleshooting|Troubleshooting]].
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-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.]]
== 5. Receive ==
You need an SDR program that supports rtl_tcp, such as SDR++.
# Open the '''Receive''' tab. Under '''Where you listen''', choose '''My station''', '''Public station''', or '''Ad-hoc''' for any location without an account.
# Set the '''Center frequency''' to <code>4625</code> kHz and the '''Sample rate (Hz)''' to <code>250000</code>.
# Press '''Start RX'''.
# In your SDR program, connect an rtl_tcp source to <code>127.0.0.1:1234</code> and tune to 4625 kHz in AM.


# 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.
[[How to receive]] shows the settings in SDR++, and [[SimTX Guide/Receiving|Receiving]] covers every receive control. [[Propagation Basics]] explains how distance, band and time of day change what a receiver hears.
# Under '''RF Signal''', choose '''Generic HF transceiver''' and set '''Power (W)''' to <code>100</code>.
# Set '''Frequency (Hz)''' to <code>4625000</code>. This is 4625 kHz, or 4.625 MHz. Enter the value in hertz, not <code>4625</code>.
# Choose '''AM Double Sideband Full Carrier''' and tick '''Auto''' beside Bandwidth. This selects a 10000 Hz bandwidth for ordinary AM audio. Leave the advanced transmitter settings closed.
# 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 antenna setup is for the frequency above. See [[Antenna System]] when changing frequency.
 
== 4. Choose an audio file ==
# Under '''Transmission Source''', select '''Audio File'''.
# Press '''Choose...''' and select a short audio file. WAV, MP3, AIFF, AIF, and AU are supported. A supported file can also be dragged onto the window.
# 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. See [[Transmission Sources]] for microphones and streams.
 
== 5. Start and check the transmission ==
# 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.
# 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.
 
To check reception elsewhere, use a receiver connected to the '''same server''', tune to '''4625 kHz''', and select '''AM''' with a suitable bandwidth. [[Propagation Basics]] explains why a distant receiver may hear a weak signal even when the local monitor sounds clear.
 
If the session fails, read its error before changing settings. See [[Troubleshooting]] for silence, queueing, high SWR, and heat warnings. The default frequency is an example, not a reserved empty channel; choose another frequency and retune the antenna if needed for normal operation.
 
== 6. Stop and save ==
# Select the session and press '''Stop Selected''', or use '''Stop All''' to end all your sessions. A non-repeating file also finishes by itself.
# Use '''Clear Finished''' to remove completed rows from the list.
# Open '''Presets''' and choose '''Save Current Settings...'''. Save the <code>.stxpreset</code> file with a descriptive name.
 
Restore it later with '''Presets''' > '''Load Preset File...'''. Keep any referenced audio files available at their saved paths. This station preset saves the complete setup; '''Radio Preset''' only sets the simulated radio's power and character.


== Continue from here ==
== Continue from here ==
* [[Transmission Sources|Transmit a microphone or audio stream]]
* [[SimTX Guide]]: all user guides.
* [[Station Configuration|Save, load, and share station settings]]
* [[Transmission Sources]]: microphones, streams and other sources.
* [[Modulation Modes|Choose AM, SSB, FM, or a data mode]]
* [[Modulation Modes]]: choosing a mode.
* [[Antenna System|Change frequency and choose an antenna]]
* [[Antenna System]]: changing frequency and choosing an antenna.
* [[Lua extensions|Install an extension or theme]]
* [[Lua extensions]]: extensions and themes.
* [[Transmitter Interface|Look up any control]] · [[Documentation|Browse every guide]]


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

Latest revision as of 20:48, 24 October 2026

Home · Start here · All guides · Solve a problem · Radio terms · Developer API

This guide goes from installing the SimTX desktop app to a first transmission and listening to it. TX means transmit and RX means receive.

1. Install the app[edit | edit source]

Download the app from the SimTX downloads page:

  • Windows: the 64-bit .exe installer.
  • macOS: the .dmg for Apple Silicon. The first time, right-click the app and choose Open to get past the macOS security warning.
  • Linux: .deb, .rpm, Arch or Void packages, or an AppImage. The install page explains how to add the package repository. Ubuntu 24.04 or Debian 13 or newer is needed.

2. Sign in and connect[edit | edit source]

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.
  1. Open the app. In Sign in to SimTX, press Sign in.
  2. Press Open browser, sign in to your SimTX account and approve the device. Copy link copies the address instead.
  3. In Connect to a server, choose a Server and press Connect.

The top right of the window then shows the server and Connected. Work offline opens the app without connecting.

3. Create your first station[edit | edit source]

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.

  1. In the Transmit tab, press Create a station.
  2. Under Basics, enter a Name and your Callsign.
  3. Under Location, press Pick on globe, click where the station stands and press Done.
  4. Under Antennas, open the dipole and set the length to 31 m and the Height to 10 m. This suits the frequency below.
  5. Press Create station.

The station now shows under Transmit from. See Stations.

4. Make a first transmission[edit | edit source]

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:

  1. Set Frequency to 4625 with the unit kHz, and Power (W) to 100.
  2. Choose the Modulation AM Double Sideband Full Carrier and tick Auto beside Bandwidth (Hz).
  3. Under Source, choose Audio file, press Choose… and pick a short audio file.
  4. Press Start TX.

The session appears in the Sessions list as Running. Queued means every transmitter slot is taken; it starts by itself when one is free. Select the session to see the Radio deck meters. Listen to own TX plays your signal as transmitted. Stop ends it.

Transmitting covers every control. If the session fails, its message says why; see Troubleshooting.

5. Receive[edit | edit source]

You need an SDR program that supports rtl_tcp, such as SDR++.

  1. Open the Receive tab. Under Where you listen, choose My station, Public station, or Ad-hoc for any location without an account.
  2. Set the Center frequency to 4625 kHz and the Sample rate (Hz) to 250000.
  3. Press Start RX.
  4. In your SDR program, connect an rtl_tcp source to 127.0.0.1:1234 and tune to 4625 kHz in AM.

How to receive shows the settings in SDR++, and Receiving covers every receive control. Propagation Basics explains how distance, band and time of day change what a receiver hears.

Continue from here[edit | edit source]

Retrieved from "https://wiki.simtx.net/index.php?title=Getting_Started&oldid=2508"