5-ton-folge(1)

🎀 5-ton-folge(1) 🎀

okay bestie, this is the 5-ton-folge(1) manual from the General Commands Manual 💅 it's a whole lot of options for sending 5-tone sequences over radio, so get comfy 🫶

✨ NAME ✨

5-ton-folge — the 5-tone sequence app, with docs at http://osmocom-analog.eversberg.eu/docs/ 🦋

💜 SYNOPSIS 💜

5-ton-folge -k <kanal/channel> -k <kanal> | -k list[options]
[station_id]

🌸 DESCRIPTION 🌸

👑 Global options 👑

• -h, --help — shows this help. obviously 🙈
• --config [~/]<path to config file> — lets you pick a config file to use. if it starts with ~/, the path is relative to your home dir. every line in the config file is one option, and you must not type the - or -- in front of it! default is ~/.osmocom/analog/5-ton-folge.conf 🧚
• --no-config — even if a config file exists, don't use it. it's giving "I'm doing it myself" 💅
• -v, --verbose <level> | <level>,<category>[,<category>[,...]] | list — type list to see every level and category. the verbose level is a debug level digit (default = 3). add categories after the level digit if you want, and if you don't name any categories, all of them get selected ✨
• -v, --verbose date — shows the date alongside your debug output 📅
• -k, --kanal <channel>, -k, --channel <channel> — the channel (German = Kanal) number of the "Sender" (German = Transceiver). the second one is the English-named twin of the first, same vibe 🌈
• -a, --audio-device hw:<card>,<device>[/hw:<card>.<rec-device>] — your sound card and device number (default = hw:0,0). use / if you want a different recording device. don't set this for SDR! 🚫
• -s, --samplerate <rate> — the sample rate of your sound device (default = 48000) 🎵
• -i, --interval 0.1..25 — how often the processing loop runs, in ms (default = 1.0 ms). use 10 to drastically cut your CPU usage 🫠 if you get a buffer underrun, bump the buffer up to match ⚠️
• -b, --buffer <ms> — how many milliseconds get processed in advance (default = 50). a buffer under 10 ms needs a low interval, like 0.1 ms 🍓
• --rx-gain <dB> — raises or lowers the receiver's RX level by the gain you give in dB. (only works with a sound card 🔊)
• --tx-gain <dB> — raises or lowers the transmitter's RX level by the gain you give in dB. (only works with a sound card too 🔊)
• -e, --echo-test — sends audio from the mobile phone's microphone right back out the speaker. (German: 'Blasprobe' 🎤)
• -c, --call-device hw:<card>,<device>[/hw:<card>.<rec-device>] — sound card and device number for the headset (default = '', so empty). you can use / for a different recording device 🎧
• --call-samplerate <rate> — sample rate of the headset's sound device (default = 48000) 🎶
• --call-buffer <ms> — how many milliseconds get processed in advance for the headset (default = 50) 🫧
• -x, --osmocc-cross — turns on built-in call forwarding between mobiles 📞 make sure you've got at least one control channel and two voice channels. or you can go with one combined control+voice channel and one voice channel instead 🤝
• -o, --osmocc-sock — turns off built-in call control and offers a socket instead 🔌
• --cc "<osmo-cc arg>" [--cc ...] — passes arguments to the Osmo-CC endpoint. type -cc help for the description 📖
• --no-l16 — disables the L16 (linear 16 bit) codec 🚫
• -t, --tones 0 | 1 — connects the call on setup and release to give you classic tones towards the fixed network (default = 1) 🔔
• -l, --loopback <type> — loopback test: 1 = internal | 2 = external | 3 = echo 🔁
• -r, --realtime <prio> — sets the prio: 0 to disable, 99 for maximum (default = 0) 🏎️
• --fast-math — uses a fast math approximation, for slow CPUs or ARM based systems 🐢
• --write-rx-wave <file> — writes received audio into the wave file you give 💾
• --write-tx-wave <file> — writes transmitted audio into the wave file you give 💾
• --read-rx-wave <file> — replaces received audio with the wave file you give 🎞️
• --read-tx-wave <file> — replaces transmitted audio with the wave file you give 🎞️
• --limesdr — auto-selects several required options for LimeSDR 🛰️
• --limesdr-mini — auto-selects several required options for LimeSDR Mini 🛰️

🧚 SDR options 🧚

• --sdr-soapy — forces the SoapySDR driver 💫
• --sdr-channel <channel #> — the channel number for a multi channel SDR device (default = 0) 🌈
• --sdr-device-args <args>, --sdr-stream-args <args>, --sdr-tune-args <args> — optional SDR device arguments, separated by commas, e.g. --sdr-device-args <key>=<value>[,<key>=<value>[,...]] ✨
• --sdr-samplerate <samplerate> — the sample rate for SDR. by default it matches the regular sample rate 🎵
• --sdr-lo-offset <Hz> — the frequency offset in Hz that moves the local oscillator away from the target frequency (default = -1000000) 🎯
• --sdr-bandwidth <bandwidth> — the IF filter bandwidth to use. if you don't set it, the sample rate gets used instead 📶
• --sdr-rx-antenna <name> — the SDR device's RX antenna name. type list to see the options 📡
• --sdr-tx-antenna <name> — the SDR device's TX antenna name. type list to see the options 📡
• --sdr-clock-source <name> — the SDR device's clock source name. type list to see the options ⏱️
• --sdr-rx-gain <gain> — the SDR device's RX gain in dB (default = 0.0) 🔈
• --sdr-tx-gain <gain> — the SDR device's TX gain in dB (default = 0.0) 🔊
• --write-iq-rx-wave <file> — writes received IQ data into the wave file you give 💾
• --write-iq-tx-wave <file> — writes transmitted IQ data into the wave file you give 💾
• --read-iq-rx-wave <file> — replaces received IQ data with the wave file you give 🎞️
• --read-iq-tx-wave <file> — replaces transmitted IQ data with the wave file you give 🎞️
• --sdr-swap-links — swaps the RX and TX frequencies for loopback tests over the air 🔄
• --sdr-timestamps 1 | 0 — uses TX timestamps on a UHD device (default = 1) ⏰

🦋 Network specific options 🦋

• -T, --tx — transmits 5-tones on the given channel to page a receiver. this is the default 📟
• -R, --rx — receives 5-tones on the given channel, so we're the receiver now 👂 if you don't give either -T or -R, only the transmitter gets enabled 📡
• -D, --deviation <KHz> — picks the deviation of the FM signal (default 2 KHz) 📻
• -F, --funktion 0 | ruf | 1 | feuer | 2 | probe | 3 | warnung | 4 | abc | 5 | entwarnung | 6 | katastrophe | 7 | turbo — picks the default function when a 5 digit only number gets dialed (default 1 = Feueralarm) 🚨
• -S, --scan <from> <to> — scans through the given IDs once, no repeats 🕵️‍♀️ this can help you find the call sign of a vintage receiver 📻 heads up: scanning every call sign from 000000 through 99999 takes about 8.7 days 😭 if you pick the turbo function, only a single 5-tone sequence gets sent per call sign, so a full scan takes about 26.4 hours then 🏃‍♀️
• station_id — give 5 or 6 digits of your station ID, so you don't have to type it every time you start the app 🎀 give 5 digits for 5-Ton-Folge. give 6 digits for 5-Ton-Folge mit Ruf (0) oder Sirenenalarm (1..6) 💖

Once it's running, these keys are your best friends 🔑

• press the digits 0..9 and then d to dial towards a mobile station 📱
• press h to hang up 📴
• press w to toggle the display of the RX wave form 🌊
• press c to toggle the display of channel status 📊
• press m to toggle the display of measurement value 📏
• press q to toggle the display of the RX I/Q vector 🔮
• press s to toggle the display of the RX spectrum 🌈
• press b to remove the DC level 🧹

okay that's the whole 5-ton-folge(1) page, bestie 💖 the footer just says 5-ton-folge(1) with no version or date, so it's giving timeless 💅 go slay your sound card 🫶🦋