Metadata-Version: 2.4
Name: meshtastic-gateway
Version: 0.3.0
Summary: MQTT bridge, Prometheus metrics, and HTTP send API for USB-tethered Meshtastic devices
Project-URL: Homepage, https://codeberg.org/goern/meshtastic-gateway
Project-URL: Source, https://codeberg.org/goern/meshtastic-gateway
Project-URL: Issues, https://codeberg.org/goern/meshtastic-gateway/issues
Author-email: Christoph Görn <anthropic.secluded483@passmail.net>
License-Expression: GPL-3.0-or-later
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Communications :: Ham Radio
Requires-Python: >=3.11
Requires-Dist: meshtastic<3,>=2.3
Requires-Dist: paho-mqtt>=2.0
Requires-Dist: prometheus-client>=0.19
Requires-Dist: pypubsub>=4.0
Provides-Extra: dev
Requires-Dist: mypy>=1.10; extra == 'dev'
Requires-Dist: pre-commit>=3.7; extra == 'dev'
Requires-Dist: pytest-cov>=5.0; extra == 'dev'
Requires-Dist: pytest>=8.0; extra == 'dev'
Requires-Dist: ruff>=0.5; extra == 'dev'
Description-Content-Type: text/markdown

# meshtastic-gateway

MQTT bridge, Prometheus metrics, and HTTP send API for USB-tethered
Meshtastic devices.

## Install

```bash
pip install meshtastic-gateway
```

## Usage

```bash
meshtastic-gateway /dev/meshtastic0 --port 9464 --allow-net 100.64.0.0/10
```

To expose `meshtastic_lora_nodes_active` for more than the default
15-minute window, repeat `--active-window-seconds`:

```bash
meshtastic-gateway --active-window-seconds 300 --active-window-seconds 3600
```

See [docs/metrics.md](docs/metrics.md) for the Prometheus metric reference,
[docs/runbooks/debugging-lora-rf.md](docs/runbooks/debugging-lora-rf.md)
for diagnosing RF / mesh problems from the metrics,
and [docs/runbooks/hardware-loopback-test.md](docs/runbooks/hardware-loopback-test.md)
for smoke testing on a real device.

## License

GPL-3.0-or-later. See [LICENSE](LICENSE).
