TONEDEBUG(1)

✨ TONEDEBUG(1) ✨

okay bestie, so this is tonedebug, part of the Voicetronix Telephony Tools and like... it's the little chaos goblin that helps you figure out if your tone detector settings actually detect the tones they're supposed to detect 🎀

---

🌸 SYNOPSIS 🌸

tonedebug [options]

---

💖 DESCRIPTION 💖

so basically tonedebug is your lil testing bestie for the libvpb programmable tone detector. you point it at a signal, you give it some parameters, and it tells you whether the detector would have caught that tone or not. lowkey essential.

it has three main modes of operation, periodt:

1. testing a single continuous tone 🎵
2. testing a pulsed tone (on-off-on-off vibes) 📶
3. testing a whole set of tones specified in the environment 🌈

---

👑 OPTIONS 👑

🫶 Common options (these work in every mode, no cap)

• --card number — pick exactly which card you wanna test. default is card 0 ✨
• --port number — pick exactly which port you wanna test. default is port 0 of whichever card you're testing 💅
• -w wavfile — give it a wav file to play the tones from. here's the tea though: for OpenLine and OpenSwitch cards you should play it into an FXO port with no phone line connected, and the tone detector will process the reflected signal from the hybrid circuit. the OpenPCI cards have almost no echo from that circuit, BUT an on-hook phone connected to an FXS port should produce a detectable echo signal 🦋
• -s filename.c — writes out a C function you can drop straight into your own code to configure the tone generator with the exact settings you're testing. literally so convenient 🎀

---

🧚 Environment options

if you wanna run tonedebug using settings that live in the VPB_TONE environment variables, just call it with the -e option. like so:

$ tonedebug -e --port 4 -w my.wav

that will use the environment settings to try and detect tones from my.wav played into port 4 of card 0. and that's it — there are no other options specific to this mode, it's a one-trick pony and it ate 💅

---

🎵 Continuous tone options

pass the -c option and tonedebug will test parameters suitable for a continuous tone. example time:

$ tonedebug -c 425 100 2000 -w dialtone.wav -t dial

this tries to detect 2 seconds of a 425Hz tone from dialtone.wav, played into port 0 of card 0. if it succeeds it reports a dial event. iconic.

extra options you can use in this mode:

• -c center-freq bandwidth duration — sets the primary tone characteristics: its frequency and its bandwidth in Hz, and its minimum duration in milliseconds ⏱️
• -d center-freq2 bandwidth2 — sets the second tone of a multi-frequency tone 🎶
• -q twist — sets the twist of a multi-frequency tone 🌀
• -n snr — sets the acceptable signal to noise ratio, in dB 📊
• -t dial | busy | ringback — names a predefined tone to replace with the settings you gave 👑

---

📶 Pulsed tone options

the -p options enable testing for pulsed tones. on top of all the common options AND all the continuous tone options, this mode also supports:

• -p center-freq bandwidth on-time — sets the primary tone characteristics: its frequency and its bandwidth in Hz, and its 'on' time in milliseconds 🟢
• -off off-time — the 'off' time of the pulse, in milliseconds 🔴

---

🔍 SEE ALSO 🔍

• tonetrain(1)

---

💀 BUGS 💀

ngl, we're relying on an echo from the hardware to feed the signal into the tone detector. that should really be fixed so it feeds in directly at some point in the future. it's giving "we'll get to it" energy 😭

---

🌈 AUTHOR 🌈

Ron Lee, David Rowe, Voicetronix <support@voicetronix.com.au>

this manual page was written by Ron <ron@debian.org>, for the Debian project (but it may be used by others 🫶).

---

VPB driver package · Feb 2, 2007 — and that's the whole page bestie, mwah 💋✨