3.5 KiB
ChirpModem modulator plugin
Introduction
This plugin transmits the chirpmodem chirp spread-spectrum format (version 1) with libchirpmodem, the C library of the chirpmodem project. The ChirpModem demodulator plugin receives it.
A transmission is one or more frames with the same message, separated by a gap, followed by a CW ID. It is generated in full on a separate thread when requested, then sent. Outside transmissions the plugin sends zeros.
The library is linked statically. Build it first and install it where CMake can
find it, for example cmake --install build --prefix ~/.local, or pass
-DCHIRPMODEM_DIR=<prefix> to the SDRangel build.
Operating rules
The rules are enforced by libchirpmodem, not by this plugin, so they cannot be bypassed from the GUI or the web API:
- The licensed (amateur) profile requires a source callsign. A frame without
one is refused and the reason is shown in the log and the report (
lastError). - Encryption is not offered: format v1 does not specify a cipher.
- The CW ID is at most 20 WPM (47 CFR 97.119(b)(1)).
The callsign in the frame does not by itself identify the station in the US
(FORMAT.md section 12). The CW ID, sent after each transmission, does. It can be
turned off, for example when the station identifies some other way, but then a
warning is shown and reported (warning), because 97.119 still requires
identification every 10 minutes and at the end of a communication.
The unlicensed profile is for ISM bands. Its selector turns red so it is not chosen by accident.
Interface
- Δf: offset of the signal centre from the device centre frequency, in Hz.
- Power and meter: level of the samples being sent.
- SF, BW: spreading factor (7 to 12) and chip rate, which is the occupied bandwidth. The receiver must use the same values.
- Mode: payload mode. Auto is non-coherent at SF 10 and above or at 62.5 kHz and below, coherent otherwise.
- Profile: licensed or unlicensed, see above.
- Src, Dst: callsigns (A-Z 0-9 - / ., at most 9 characters). The source is also the CW ID.
- Msg: the body, sent as UTF-8. Enter transmits.
- x, Gap, Amp: frames per transmission, silence between frames (and before the CW ID) in seconds, and peak amplitude as a fraction of full scale.
- CW ID, wpm: CW ID after each transmission, and its speed.
- Info line: time on air of one frame, body bytes and the most that fit one frame, and the payload mode. It turns red when the message does not fit.
- TX: transmit. The button is red while a transmission is on air.
- Status line: the rate the frames are generated at and the residual offset within it, the state, transmissions waiting, and frames and seconds sent.
- Transmissions: a log of requests, errors and transmissions sent.
- Channel spectrum: the samples being sent.
Web API and MCP
Settings are under ChirpModemModSettings, the report under
ChirpModemModReport, and actions under ChirpModemModActions (see
ChirpModemMod.yaml). To transmit:
{"tx": 1} the settings' message
{"tx": 1, "dst": "W1AW", "message": "hello"} this transmission only
Values not given come from the settings. The request is accepted (202) and
queued; whether it was sent, refused or cut off is in the report
(lastEvent, lastError, transmissions, framesSent).
If the channel rate or offset changes while a transmission is on air, it is cut off. Transmissions waiting are generated again for the new rate and offset.