Jump to content

Documentation: Difference between revisions

From SimTX Wiki
Clanker (talk | contribs)
Point the developer section at the protocol v25 reference
Clanker (talk | contribs)
Tighten; list all user guides
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{Documentation navigation}}
{{Documentation navigation}}
This index separates practical guides from detailed references. New users should begin with [[Getting Started]], then choose the topic needed for their next task.


== Start and operate ==
== Start and operate ==
* [[SimTX Transmitter]]: what the application does and how the simulation fits together.
* [[SimTX Transmitter]]: what the application does and how the simulation fits together.
* [[Getting Started]]: download, Java, sign-in, server selection, first transmission, and saving.
* [[Getting Started]]: install the desktop app, sign in, create a station, transmit and receive.
* [[Transmitter Interface]]: illustrated control reference.
* [[Transmitter Interface]]: the Java transmitter's window, control by control.
* [[Transmission Sources]]: audio files, streams, microphone, PipeWire, and external IQ.
* [[Transmission Sources]]: audio files, streams, microphone, PipeWire, and external IQ.
* [[Station Configuration]]: callsign, location, and complete station presets.
* [[Station Configuration]]: callsign, location and station presets in the Java transmitter.
* [[Sessions and Queueing]]: start, stop, monitor, live edit, and reconnect.
* [[Sessions and Queueing]]: start, stop, monitor, live edit, and reconnect.
* [[Troubleshooting]]: a symptom-by-symptom checklist.
* [[Troubleshooting]]: a symptom-by-symptom checklist for the Java transmitter.
* [[Radio terms]]: short explanations of unfamiliar terms and units.
* [[Radio terms]]: short explanations of unfamiliar terms and units.


Line 22: Line 20:
== Antennas and coverage ==
== Antennas and coverage ==
* [[Antenna System]]: choose an antenna and tune it for the frequency.
* [[Antenna System]]: choose an antenna and tune it for the frequency.
* [[Dipole Antenna]] · [[Inverted-V Antenna]] · [[Vertical Antenna]]
* [[Dipole Antenna]], [[Inverted-V Antenna]], [[Vertical Antenna]]
* [[Yagi Antenna]] · [[Full-Wave Loop Antenna]]
* [[Yagi Antenna]], [[Full-Wave Loop Antenna]]
* [[End-Fed Half-Wave Antenna]] · [[Longwire Antenna]] · [[Beverage Antenna]]
* [[End-Fed Half-Wave Antenna]], [[Longwire Antenna]], [[Beverage Antenna]]
* [[Propagation Basics]]: nearby and distant reception, day and night, noise, and fading.
* [[Propagation Basics]]: nearby and distant reception, day and night, noise, and fading.
* [[Antenna Calculations]]: wavelength, wire lengths, decibels, SWR, and the path budget.
* [[Antenna Calculations]]: wavelength, wire lengths, decibels, SWR, and the path budget.
Line 41: Line 39:
* [[Lua action API]]: tools that read settings or control the transmitter.
* [[Lua action API]]: tools that read settings or control the transmitter.
* [[Lua theme API]]: colors, fonts, and appearance.
* [[Lua theme API]]: colors, fonts, and appearance.
== User guides ==
* [[SimTX Guide]]: all user guides for the desktop app.
* [[SimTX Guide/Transmitting]]: the Transmit tab, sources, presets, sessions and push-to-talk.
* [[SimTX Guide/Receiving]]: the Receive tab and the bridge to your SDR program.
* [[SimTX Guide/Stations]]: stations, antennas, radios and visibility.
* [[SimTX Guide/Satellites]]: launching a satellite, passes, Doppler and deorbiting.
* [[SimTX Guide/Rotators and tracking]]: turning an antenna and following a satellite.
* [[SimTX Guide/Map and coverage]]: the globe, station lists and coverage maps.
* [[SimTX Guide/Catalog and add-ons]]: shared presets and packages, add-ons and actions.
* [[SimTX Guide/Health]]: the server health report.
* [[SimTX Guide/Settings and shortcuts]]: settings, the command palette and shortcuts.
* [[SimTX Guide/Troubleshooting]]: problems and the app's messages.


== Build your own software ==
== Build your own software ==
Line 52: Line 63:


== Other receiver and digital-mode guides ==
== Other receiver and digital-mode guides ==
These community guides use additional software and assume the basic SimTX workflow is understood.
* [[Guide to setting up sdr console with simtx|SDR Console setup]]
* [[Guide to setting up sdr console with simtx|SDR Console setup]]
* [[DATV RX Tutorial|Digital television reception]]
* [[DATV RX Tutorial|Digital television reception]]
* [[DATV TX Tutorial|Digital television transmission]]
* [[DATV TX Tutorial|Digital television transmission]]
* [[DRM TX tutorial|DRM transmission]]
* [[DRM TX tutorial|DRM transmission]]
 
* [[:Category:Radio Stations|Community radio stations]]: stations described by their operators.
Station descriptions are listed separately in [[:Category:Radio Stations]].


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

Latest revision as of 20:06, 24 October 2026

Start and operate[edit | edit source]

Choose the signal and radio[edit | edit source]

Antennas and coverage[edit | edit source]

Use extensions[edit | edit source]

  • Lua extensions: install and use modes, audio add-ons, tools, themes, and libraries.
  • Extension catalog: preview, install, update, and publish shared packages and presets.

Write extensions[edit | edit source]

Read Creating Lua extensions first. It contains a complete small package and the edit, reload, and test cycle.

User guides[edit | edit source]

Build your own software[edit | edit source]

The SimTX API reference is for developers who want to receive, transmit or read station data from their own programs.

Other receiver and digital-mode guides[edit | edit source]