Meshtastic to Home Assistant (Hass)
A Python client for use with Meshtastic devices. The client connects to a mesh radio via USB serial port. Telemetry and position messages from the mesh are published to an MQTT broker and further into Home Assistant. All MQTT entities will by auto discovered in Home Assistant.
Usage
usage: meshtastic2hass [-h] [--config CONFIG] [--dev DEV] [--mqtt-host MQTT_HOST] [--mqtt-port MQTT_PORT] [--mqtt-user MQTT_USER]
[--mqtt-password MQTT_PASSWORD] [--mqtt-topic-prefix MQTT_TOPIC_PREFIX] [--use-network USE_NETWORK]
[--hostname HOSTNAME] [--version]
Connects Meshtastic radios via MQTT to Home Assistant (Hass).
options:
-h, --help show this help message and exit
--config CONFIG Path to configuration file in TOML format.
--dev DEV The device the Meshtastic device is connected to, i.e. /dev/ttyUSB0
--mqtt-host MQTT_HOST
The MQTT broker host name or IP.
--mqtt-port MQTT_PORT
The MQTT broker port.
--mqtt-user MQTT_USER
The MQTT broker user name.
--mqtt-password MQTT_PASSWORD
The MQTT broker password.
--mqtt-topic-prefix MQTT_TOPIC_PREFIX
The MQTT topic prefix
--use-network USE_NETWORK
Use network connection to Meshtastic interface instead of serial
--hostname HOSTNAME Meshtastic interface network hostname or IP
--version show programs version number and exit
Node Filter
By default all received Meshtastic nodes will create entities in Home Assistant.
This might be an undesired behavior when only some nodes are of interest. A node filter can be defined in config.toml.
filter_nodes = [] takes a set of Meshtastic nodes short names to be includes in filter. Only these nodes will be forwarded to home assistant via MQTT topic, hence creating entities. Keep empty to forward all nodes.
Receiving channels text from nodes is not filtered at all.
Build
Requires tox. Builds an sdist and wheel into dist/, versioned from the current git tag/commit:
tox -e clean # remove old build/dist/*.egg-info
tox -e build
Install
Published on PyPI as meshtastic2hass:
pip install meshtastic2hass
# or, for an isolated CLI install:
pipx install meshtastic2hass
In some environments, use pip3 instead of pip.
To install from a clone of this repository instead (e.g. to try unreleased changes on main), replace meshtastic2hass above with ..
1 maintainer
Metadata
1 maintainer
Release files for meshtastic2hass 1.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| meshtastic2hass-1.1.0.tar.gz | 28.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| meshtastic2hass-1.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 51.9 kB
Release files / meshtastic2hass-1.1.0.tar.gz
| Download URL | meshtastic2hass-1.1.0.tar.gz |
|---|---|
| Size | 28.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9a647ab22c408d7ccb964d9f49c5f3bd8767a1b52937c363d01ae72af7d0442a
|
|
BLAKE2b-256 checksum How to use checksums |
5a5025ac53a762af4e0b2445ad62d958be4b0a936c482aa7b14eb75ea764f6b4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
Release files / meshtastic2hass-1.1.0-py3-none-any.whl
| Download URL | meshtastic2hass-1.1.0-py3-none-any.whl |
|---|---|
| Size | 23.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
cae3354599f1b1d92f8a529e81277b2805ba6b2d17f41e816cc4d7b4077603e4
|
|
BLAKE2b-256 checksum How to use checksums |
f7629bdd2ce6eeb4e789b31121bca3c4daa72408d848e35392d093ae2ed50cae
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
