Documentation: Difference between revisions
SimTX API documentation |
Point the developer section at the protocol v25 reference |
||
| Line 44: | Line 44: | ||
== Build your own software == | == Build your own software == | ||
The [[SimTX API]] reference is for developers who want to receive, transmit or read station data from their own programs. | The [[SimTX API]] reference is for developers who want to receive, transmit or read station data from their own programs. | ||
* [[SimTX API/Quick start]]: receive IQ | * [[SimTX API/Quick start]]: receive IQ with a short standard-library program. | ||
* [[SimTX API/Account service]]: sign-in, server directory, game tickets and public endpoints. | * [[SimTX API/Account service]]: sign-in, stations and satellites, server directory, game tickets and public endpoints. | ||
* [[SimTX API/Connection and handshake]]: the | * [[SimTX API/Connection and handshake]]: the game protocol, version 25: TLS, the preface and the hello. | ||
* [[SimTX API/Receiver session]] | * [[SimTX API/Receiver session]], [[SimTX API/Transmitter session]] and [[SimTX API/Control session]]: the kinds of game session. | ||
* [[SimTX API/Packet list]]: every | * [[SimTX API/Stations]] and [[SimTX API/Satellites]]: persistent stations and user-launched satellites. | ||
* [[SimTX API/Packet list]]: every message, each with its own page. | |||
== Other receiver and digital-mode guides == | == Other receiver and digital-mode guides == | ||
Revision as of 17:22, 24 October 2026
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
- SimTX Transmitter: what the application does and how the simulation fits together.
- Getting Started: download, Java, sign-in, server selection, first transmission, and saving.
- Transmitter Interface: illustrated control reference.
- Transmission Sources: audio files, streams, microphone, PipeWire, and external IQ.
- Station Configuration: callsign, location, and complete station presets.
- Sessions and Queueing: start, stop, monitor, live edit, and reconnect.
- Troubleshooting: a symptom-by-symptom checklist.
- Radio terms: short explanations of unfamiliar terms and units.
Choose the signal and radio
- Modulation Modes: choosing a mode and the full bandwidth table.
- Radio Presets: simulated equipment types and their power levels.
- Advanced Transmitter Settings: every transmitter parameter, range, and default.
- SWR and Transmitter Protection: matching the antenna and understanding reduced power.
- Power Amplifier Behaviour: heating, cooling, foldback, and session damage.
Antennas and coverage
- Antenna System: choose an antenna and tune it for the frequency.
- Dipole Antenna · Inverted-V Antenna · Vertical Antenna
- Yagi Antenna · Full-Wave Loop Antenna
- End-Fed Half-Wave Antenna · Longwire Antenna · Beverage Antenna
- Propagation Basics: nearby and distant reception, day and night, noise, and fading.
- Antenna Calculations: wavelength, wire lengths, decibels, SWR, and the path budget.
- NEC File Import: custom geometry, supported cards, and limitations.
Use extensions
- 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
Read Creating Lua extensions first. It contains a complete small package and the edit, reload, and test cycle.
- Lua extension manifest: package identity, versions, types, and dependencies.
- Lua extension API: registration, controls, inputs, and common helpers.
- Lua modulation API: audio and IQ blocks, images, video, files, and sample rates.
- Lua audio add-on API: the audio processing callback and block operations.
- Lua action API: tools that read settings or control the transmitter.
- Lua theme API: colors, fonts, and appearance.
Build your own software
The SimTX API reference is for developers who want to receive, transmit or read station data from their own programs.
- SimTX API/Quick start: receive IQ with a short standard-library program.
- SimTX API/Account service: sign-in, stations and satellites, server directory, game tickets and public endpoints.
- SimTX API/Connection and handshake: the game protocol, version 25: TLS, the preface and the hello.
- SimTX API/Receiver session, SimTX API/Transmitter session and SimTX API/Control session: the kinds of game session.
- SimTX API/Stations and SimTX API/Satellites: persistent stations and user-launched satellites.
- SimTX API/Packet list: every message, each with its own page.
Other receiver and digital-mode guides
These community guides use additional software and assume the basic SimTX workflow is understood.
Station descriptions are listed separately in Category:Radio Stations.