Documentation
¶
Overview ¶
Copyright © 2026 OpenMANET
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
blos
Package blos manages Beyond Line-of-Sight (BLOS) mesh networking by orchestrating Tailscale VPN, VXLAN encapsulation, and Batman-adv integration.
|
Package blos manages Beyond Line-of-Sight (BLOS) mesh networking by orchestrating Tailscale VPN, VXLAN encapsulation, and Batman-adv integration. |
|
camera
Package camera discovers node cameras and publishes their Cursor-on-Target video and sensor events to ATAK.
|
Package camera discovers node cameras and publishes their Cursor-on-Target video and sensor events to ATAK. |
|
comms
Package comms provides PTT (push-to-talk) communications using pion-based RTP/RTCP.
|
Package comms provides PTT (push-to-talk) communications using pion-based RTP/RTCP. |
|
comms/announce
Package announce plays short pre-decoded voice clips ("talk group one" …) into the local speaker path when the active talk group changes.
|
Package announce plays short pre-decoded voice clips ("talk group one" …) into the local speaker path when the active talk group changes. |
|
comms/audio
Package audio hosts the malgo (miniaudio) capture/playback wrappers and the Opus broadcast encoder used by the comms subsystem.
|
Package audio hosts the malgo (miniaudio) capture/playback wrappers and the Opus broadcast encoder used by the comms subsystem. |
|
comms/audiopool
Package audiopool holds audio numeric constants and float32 buffer pools shared by sibling sub-packages of internal/comms (audio/, control/).
|
Package audiopool holds audio numeric constants and float32 buffer pools shared by sibling sub-packages of internal/comms (audio/, control/). |
|
comms/codec
Package codec defines audio encoder/decoder interfaces and an Opus implementation.
|
Package codec defines audio encoder/decoder interfaces and an Opus implementation. |
|
comms/control
Package control defines the PTT event source abstractions consumed by the comms package.
|
Package control defines the PTT event source abstractions consumed by the comms package. |
|
comms/control/alsa
Package alsa provides an AuxEventHandler that adjusts the system ALSA playback volume in response to volume up/down aux events.
|
Package alsa provides an AuxEventHandler that adjusts the system ALSA playback volume in response to volume up/down aux events. |
|
comms/device
Package device provides hardware device discovery helpers for the comms subsystem.
|
Package device provides hardware device discovery helpers for the comms subsystem. |
|
comms/gpio
Package gpio watches the Raven's 5-position talk group selector via the Linux GPIO character device (uAPI v2).
|
Package gpio watches the Raven's 5-position talk group selector via the Linux GPIO character device (uAPI v2). |
|
comms/talkgroup
Package talkgroup defines the talk group change-event vocabulary and a listener registry.
|
Package talkgroup defines the talk group change-event vocabulary and a listener registry. |
|
comms/webaudio
Package webaudio hosts the web-mode audio bridge that replaces the malgo pipeline when the comms control source is "web".
|
Package webaudio hosts the web-mode audio bridge that replaces the malgo pipeline when the comms control source is "web". |
|
gpsd
Package gpsd provides a client for connecting to and reading GPS data from a GPSD server.
|
Package gpsd provides a client for connecting to and reading GPS data from a GPSD server. |
|
instrumentation
Package instrumentation provides a generic, reusable framework for capturing runtime counters and metrics from an application into a versioned snapshot document.
|
Package instrumentation provides a generic, reusable framework for capturing runtime counters and metrics from an application into a versioned snapshot document. |
|
iwinfo
Package iwinfo retrieves wireless interface information from OpenWrt's rpcd-mod-iwinfo ubus plugin (ubus call iwinfo info/devices).
|
Package iwinfo retrieves wireless interface information from OpenWrt's rpcd-mod-iwinfo ubus plugin (ubus call iwinfo info/devices). |
|
logs
Package logs provides system-log and kernel-ring-buffer readers backed by the busybox logread and dmesg applets.
|
Package logs provides system-log and kernel-ring-buffer readers backed by the busybox logread and dmesg applets. |
|
meshjoin
Package meshjoin encodes and decodes the "share mesh" QR payload: a MeshJoinPayload serialized as binary protobuf, base64url-encoded without padding and prefixed with the format version marker "OPENMANET1:".
|
Package meshjoin encodes and decodes the "share mesh" QR payload: a MeshJoinPayload serialized as binary protobuf, base64url-encoded without padding and prefixed with the format version marker "OPENMANET1:". |
|
network/morseregdb
Package morseregdb parses the Morse Micro regulatory database CSV shipped with the HaLow firmware at /usr/share/morse-regdb/channels.csv and exposes the legal HaLow channels per (country, bandwidth).
|
Package morseregdb parses the Morse Micro regulatory database CSV shipped with the HaLow firmware at /usr/share/morse-regdb/channels.csv and exposes the legal HaLow channels per (country, bandwidth). |
|
sysupgrade
Package sysupgrade orchestrates firmware upgrade discovery, download, verification, and execution.
|
Package sysupgrade orchestrates firmware upgrade discovery, download, verification, and execution. |
|
terminal
Package terminal provides a single-session PTY backed by a shell, bridged to a WebSocket connection.
|
Package terminal provides a single-session PTY backed by a shell, bridged to a WebSocket connection. |
|
tzinfo
Package tzinfo embeds the OpenWrt/LuCI IANA→POSIX timezone table so the setup wizard can write both system.zonename (IANA) and system.timezone (POSIX) without tzdata on the device.
|
Package tzinfo embeds the OpenWrt/LuCI IANA→POSIX timezone table so the setup wizard can write both system.zonename (IANA) and system.timezone (POSIX) without tzdata on the device. |
|
wireless
Package wireless summarizes nl80211 station rate information from github.com/mdlayher/wifi and publishes it to the instrumentation snapshot registry as the "wireless" section.
|
Package wireless summarizes nl80211 station rate information from github.com/mdlayher/wifi and publishes it to the instrumentation snapshot registry as the "wireless" section. |
|
scripts
|
|
|
gen-tzinfo
command
Command gen-tzinfo converts LuCI's zoneinfo table (modules/luci-lua-runtime/luasrc/sys/zoneinfo/tzdata.lua in https://github.com/openwrt/luci) into internal/tzinfo/table.go.
|
Command gen-tzinfo converts LuCI's zoneinfo table (modules/luci-lua-runtime/luasrc/sys/zoneinfo/tzdata.lua in https://github.com/openwrt/luci) into internal/tzinfo/table.go. |
Click to show internal directories.
Click to hide internal directories.