Jump to content

Getting Started: Difference between revisions

From SimTX Wiki
← Older editNewer edit →
VisualWikitext
No edit summary
Clanker (talk | contribs)
660 edits
Cover the SimTX desktop app: install, sign in, first station, first transmission, receiving
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 takes a new user from installing the SimTX desktop app to a first transmission and to listening. '''TX means transmit''' and '''RX means receive'''. All signals are simulated; no physical transmitter, antenna or microphone is needed.


== 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 for your system 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 and Void packages, or a portable AppImage. The [https://manifest.simtx.net/install install page] explains how to add the package repository and check its signing key. Ubuntu 24.04 or Debian 13 or newer is needed.


<syntaxhighlight lang="bash">
The older Java transmitter is still on the [https://simtx.net/downloads downloads page]. Its controls differ from this guide.
java -jar simtx-transmitter-0.3.6.jar
</syntaxhighlight>


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.
== 2. Sign in and connect ==
# Open the app. The window '''Sign in to SimTX''' appears. Press '''Sign in'''.
# The app shows a code and asks you to approve this device in your browser. Press '''Open browser''', sign in to your SimTX account and approve the device. '''Copy link''' copies the address if you want to open it yourself.
# Back in the app, '''Connect to a server''' lists the servers that are online. Choose one under '''Server''' and press '''Connect'''.


The steps and screenshots here describe the 0.3.6 interface.
Your SimTX account is separate from a wiki account. '''Work offline''' skips connecting; you can connect later. The top right of the window shows the connection; select it to connect, change server or disconnect. '''Settings''', '''Account''' has '''Sign out'''.


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 .
'''Checkpoint:''' the window shows the tabs '''Transmit''', '''Receive''', '''Stations''', '''Catalog''', '''Health''' and '''Settings''', and the top right shows '''Connected'''. [[Troubleshooting]] covers an unavailable server or a failed sign-in.


== 2. Sign in and choose a server ==
== 3. Create your first station ==
# 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.
Transmissions run from a '''station''': your callsign, location, antennas and radios, saved to your account. See [[SimTX Guide/Stations]] for everything about stations.
# 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.
On first start, a short '''getting started guide''' outlines the next control to use, with dots for the four steps: '''Sign in and connect''', '''Create your station''', '''Choose what to transmit''' and '''Start TX'''. '''Skip guide''' hides it. To see it again, open '''Settings''', '''Help''', '''Getting started guide''' and press '''Show again'''.


'''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]].
# In the '''Transmit''' tab, the '''Station''' section offers '''Create a station'''. Press it. (The '''Stations''' tab, '''Mine''', '''New station''' does the same.)
# Under '''Basics''', enter a '''Name''' and your '''Callsign'''.
# Under '''Location''', press '''Pick on globe''', click the globe where the station stands and press '''Done'''. The app fills in the ground height.
# Under '''Antennas''', open the dipole the station starts with. Set the length to <code>31</code> m and the '''Height''' to <code>10</code> m. This suits the frequency used below; see [[Antenna System]] for other frequencies.
# Leave the radio under '''Radios''' as it is.
# Press '''Create station'''.


== 3. Enter a simple station setup ==
'''Checkpoint:''' the '''Station''' section of the '''Transmit''' tab shows your station under '''Transmit from'''.
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.]]
== 4. Make a first transmission ==
In the '''Transmit''' tab:
# Under '''Station''', check '''Transmit from''', '''Antenna''' and '''Radio'''. '''SWR around your frequency''' shows how well the antenna matches.
# Under '''RF signal''', set '''Frequency''' to <code>4625</code> with the unit set to '''kHz''' (4.625 MHz). Set '''Power (W)''' to <code>100</code>; the field shows the most your radio allows.
# Choose the '''Modulation''' '''AM Double Sideband Full Carrier''' and tick '''Auto''' beside '''Bandwidth (Hz)'''. Leave '''Transmitter imperfections''' closed.
# Under '''Source''', choose '''Audio file''', press '''Choose…''' and pick a short audio file. Leave '''Loop playback''' off for the first test, so the session ends when the file ends.
# Press '''Start TX'''.


# 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.
The new session appears in the list on the right:
# Under '''RF Signal''', choose '''Generic HF transceiver''' and set '''Power (W)''' to <code>100</code>.
* '''Running''' means it is on the air.
# Set '''Frequency (Hz)''' to <code>4625000</code>. This is 4625 kHz, or 4.625 MHz. Enter the value in hertz, not <code>4625</code>.
* '''Queued''' means every transmitter slot on the server is taken. It starts by itself when one is free; don't press Start TX again.
# 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.
Select the session to see the '''Radio deck''': '''FWD''' is the outgoing power, '''REF''' the reflected power, '''SWR''' the antenna match, '''ALC''' the level control, '''TEMP''' the simulated amplifier temperature and '''BUF''' the audio waiting at the server. '''Listen to own TX''' plays your signal before propagation. It tests your audio, not whether a distant listener hears it. '''Adjust while on air''' changes frequency, power and a few other settings without stopping.


== 4. Choose an audio file ==
To stop, press '''Stop''' in the Radio deck, or '''Stop all'''. '''Clear finished''' removes ended sessions from the list.
# 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.
If the session fails, read its message before changing settings. [[Troubleshooting]] covers silence, queueing, high SWR and heat. 4625 kHz is an example, not a reserved channel; choose another frequency and retune the antenna for normal use.


== 5. Start and check the transmission ==
== 5. Save your settings ==
# Press '''Start TX''' once.
'''Presets''' at the top of the Transmit tab saves the current settings under a name, or to a file with '''Save to file…'''. Choose a saved preset from the same menu to load it. Your station stays on your account and doesn't need saving.
# 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.
== 6. Receive ==
You can listen to the simulated band with any SDR program that supports rtl_tcp, such as SDR++. Receiving works without an account when you listen ad hoc.


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.
# Open the '''Receive''' tab. Under '''Where you listen''', choose '''My station''' to receive at one of your stations, '''Public station''' for another account's public station, or '''Ad-hoc''' to listen from any location with a callsign and antenna of your own.
# Under '''Tuning''', set the '''Center frequency''' and the '''Sample rate (Hz)'''.
# Press '''Start RX'''. The app starts a bridge on your computer. The '''Bridge''' section shows its address, by default <code>127.0.0.1:1234</code>.
# In your SDR program, connect an rtl_tcp source to that address. [[How to receive]] shows the SDR++ settings, and [[Guide to setting up sdr console with simtx|the SDR Console guide]] covers SDR Console.


== 6. Stop and save ==
To hear your own transmission, receive at a station some distance away and tune to 4625 kHz in AM. In a station's details in the '''Stations''' tab, '''Tune RX''' next to a transmission sets the receive frequency to it. [[Propagation Basics]] explains why a distant receiver may hear a weak signal even when your own monitor sounds clear.
# 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/Stations|Stations]]: antennas, radios, public and unlisted stations.
* [[Station Configuration|Save, load, and share station settings]]
* [[SimTX Guide/Satellites|Satellites]]: launch a satellite and work it from the ground.
* [[Modulation Modes|Choose AM, SSB, FM, or a data mode]]
* [[SimTX Guide/Rotators and tracking|Rotators and tracking]]: turn an antenna and follow a satellite.
* [[Antenna System|Change frequency and choose an antenna]]
* [[Transmission Sources]]: microphones, streams and other sources.
* [[Lua extensions|Install an extension or theme]]
* [[Modulation Modes]]: choose AM, SSB, FM or a data mode.
* [[Transmitter Interface|Look up any control]] · [[Documentation|Browse every guide]]
* [[Antenna System]]: change frequency and choose an antenna.
* [[Lua extensions]]: install an extension or theme.
* [[Documentation]]: every guide.


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

Revision as of 19:41, 24 October 2026

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

This guide takes a new user from installing the SimTX desktop app to a first transmission and to listening. TX means transmit and RX means receive. All signals are simulated; no physical transmitter, antenna or microphone is needed.

1. Install the app

Download the app for your system 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 and Void packages, or a portable AppImage. The install page explains how to add the package repository and check its signing key. Ubuntu 24.04 or Debian 13 or newer is needed.

The older Java transmitter is still on the downloads page. Its controls differ from this guide.

2. Sign in and connect

  1. Open the app. The window Sign in to SimTX appears. Press Sign in.
  2. The app shows a code and asks you to approve this device in your browser. Press Open browser, sign in to your SimTX account and approve the device. Copy link copies the address if you want to open it yourself.
  3. Back in the app, Connect to a server lists the servers that are online. Choose one under Server and press Connect.

Your SimTX account is separate from a wiki account. Work offline skips connecting; you can connect later. The top right of the window shows the connection; select it to connect, change server or disconnect. Settings, Account has Sign out.

Checkpoint: the window shows the tabs Transmit, Receive, Stations, Catalog, Health and Settings, and the top right shows Connected. Troubleshooting covers an unavailable server or a failed sign-in.

3. Create your first station

Transmissions run from a station: your callsign, location, antennas and radios, saved to your account. See SimTX Guide/Stations for everything about stations.

On first start, a short getting started guide outlines the next control to use, with dots for the four steps: Sign in and connect, Create your station, Choose what to transmit and Start TX. Skip guide hides it. To see it again, open Settings, Help, Getting started guide and press Show again.

  1. In the Transmit tab, the Station section offers Create a station. Press it. (The Stations tab, Mine, New station does the same.)
  2. Under Basics, enter a Name and your Callsign.
  3. Under Location, press Pick on globe, click the globe where the station stands and press Done. The app fills in the ground height.
  4. Under Antennas, open the dipole the station starts with. Set the length to 31 m and the Height to 10 m. This suits the frequency used below; see Antenna System for other frequencies.
  5. Leave the radio under Radios as it is.
  6. Press Create station.

Checkpoint: the Station section of the Transmit tab shows your station under Transmit from.

4. Make a first transmission

In the Transmit tab:

  1. Under Station, check Transmit from, Antenna and Radio. SWR around your frequency shows how well the antenna matches.
  2. Under RF signal, set Frequency to 4625 with the unit set to kHz (4.625 MHz). Set Power (W) to 100; the field shows the most your radio allows.
  3. Choose the Modulation AM Double Sideband Full Carrier and tick Auto beside Bandwidth (Hz). Leave Transmitter imperfections closed.
  4. Under Source, choose Audio file, press Choose… and pick a short audio file. Leave Loop playback off for the first test, so the session ends when the file ends.
  5. Press Start TX.

The new session appears in the list on the right:

  • Running means it is on the air.
  • Queued means every transmitter slot on the server is taken. It starts by itself when one is free; don't press Start TX again.

Select the session to see the Radio deck: FWD is the outgoing power, REF the reflected power, SWR the antenna match, ALC the level control, TEMP the simulated amplifier temperature and BUF the audio waiting at the server. Listen to own TX plays your signal before propagation. It tests your audio, not whether a distant listener hears it. Adjust while on air changes frequency, power and a few other settings without stopping.

To stop, press Stop in the Radio deck, or Stop all. Clear finished removes ended sessions from the list.

If the session fails, read its message before changing settings. Troubleshooting covers silence, queueing, high SWR and heat. 4625 kHz is an example, not a reserved channel; choose another frequency and retune the antenna for normal use.

5. Save your settings

Presets at the top of the Transmit tab saves the current settings under a name, or to a file with Save to file…. Choose a saved preset from the same menu to load it. Your station stays on your account and doesn't need saving.

6. Receive

You can listen to the simulated band with any SDR program that supports rtl_tcp, such as SDR++. Receiving works without an account when you listen ad hoc.

  1. Open the Receive tab. Under Where you listen, choose My station to receive at one of your stations, Public station for another account's public station, or Ad-hoc to listen from any location with a callsign and antenna of your own.
  2. Under Tuning, set the Center frequency and the Sample rate (Hz).
  3. Press Start RX. The app starts a bridge on your computer. The Bridge section shows its address, by default 127.0.0.1:1234.
  4. In your SDR program, connect an rtl_tcp source to that address. How to receive shows the SDR++ settings, and the SDR Console guide covers SDR Console.

To hear your own transmission, receive at a station some distance away and tune to 4625 kHz in AM. In a station's details in the Stations tab, Tune RX next to a transmission sets the receive frequency to it. Propagation Basics explains why a distant receiver may hear a weak signal even when your own monitor sounds clear.

Continue from here

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