Skip to main content

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 ..

Metadata

Release files for meshtastic2hass 1.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for meshtastic2hass 1.1.1
File Size Uploaded
meshtastic2hass-1.1.1.tar.gz 28.6 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for meshtastic2hass 1.1.1
File Interpreter ABI Platform
meshtastic2hass-1.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 52.1 kB

Release files / meshtastic2hass-1.1.1.tar.gz

Download URL meshtastic2hass-1.1.1.tar.gz
Size 28.6 kB
Tags Source
SHA-256 checksum
How to use checksums
3fa9056c2d1f2a1f54c9410aa78b95a1681e06604a658904c4c23128b088b5b6
BLAKE2b-256 checksum
How to use checksums
cf4f575b07d023297a4cff22ff4ef6b9f8410c29f392c1e4a110381b4e4fa260
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.1-py3-none-any.whl

Download URL meshtastic2hass-1.1.1-py3-none-any.whl
Size 23.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
89b3596dbdd09a065c53a583067bb0834c540dda2efa1e1cbfbf07b889c9de22
BLAKE2b-256 checksum
How to use checksums
d5c7167fd416edf2ea572405dfb56e95495e57cca00890e6798dd839ed525160
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Release history Release notifications | RSS feed

1.1.6

2 release files

1.1.5

2 release files

1.1.4

2 release files

1.1.2

2 release files

This release

1.1.1 This release

2 release files

1.1.0

2 release files

1.0.20

2 release files

1.0.19

2 release files

1.0.18

2 release files

1.0.17

2 release files

1.0.16

2 release files

1.0.14

2 release files

1.0.13

2 release files

1.0.12

2 release files

1.0.11

2 release files

1.0.10

2 release files

1.0.9

2 release files

1.0.8

2 release files

1.0.7

2 release files

1.0.6

2 release files

1.0.5

2 release files

1.0.4

2 release files

1.0.3

2 release files

1.0.2

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page