Configuration

September 7, 2026 ยท View on GitHub

GGWave transceiver

The GGWave class is configured via a config dict:

KeyDefaultDescription
ggwave-rxpath of ggwave-rx on $PATH, else ~/.local/bin/ggwave-rxPath to the ggwave-rx binary used to listen for incoming audio.
ggwave-clipath of ggwave-cli on $PATH, else ~/.local/bin/ggwave-cliPath to the ggwave-cli binary used to emit audio locally.
remoteFalse (forced to True if ggwave-cli is not found)When set, audio is generated via the ggwave-to-file web service and played back instead of using the local ggwave-cli binary.

The same config dict is forwarded by GGWaveMaster and GGWaveSlave to the underlying transceiver, so these settings are shared across roles. The GGWave protocol id, transmit volume, and sample rate used when generating audio remotely are fixed in code, not configurable.

Master

ParameterDescription
pairing passwordThe code shown/broadcast as HMPSWD:. Generated if not supplied.
hostThe hub address emitted as HMHOST:. Auto-detected from the local IP if not supplied.
silent modeWhen enabled, the password is not auto-broadcast; the caller emits it on demand.

Slave

ParameterDescription
access keyThe key sent back as HMKEY:. Generated if not supplied.

On receiving HMHOST:, the slave normalises the host to a WebSocket URL and saves it as the default master in its NodeIdentity.

Audio capture

GGWave needs raw audio at the configured sample rate. Capture/playback details and microphone requirements are covered in microphone.md.