Skip to main content

A Python client that connects Meshtastic radios via MQTT to Home Assistant (Hass).

Project description

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] --dev DEV --mqtt-host MQTT_HOST [--mqtt-port MQTT_PORT] --mqtt-user MQTT_USER --mqtt-password
                       MQTT_PASSWORD [--mqtt-topic-prefix MQTT_TOPIC_PREFIX] [--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.
  --version             show program's 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

meshtastic2hass-1.0.12.tar.gz (24.4 kB view details)

Uploaded Source

Built Distribution

meshtastic2hass-1.0.12-py3-none-any.whl (22.3 kB view details)

Uploaded Python 3

File details

Details for the file meshtastic2hass-1.0.12.tar.gz.

File metadata

  • Download URL: meshtastic2hass-1.0.12.tar.gz
  • Upload date:
  • Size: 24.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.19

File hashes

Hashes for meshtastic2hass-1.0.12.tar.gz
Algorithm Hash digest
SHA256 3e3953832535d7356d603bfa53e0f754ca9b38e12ea8b13760ae3c4edad30ac8
MD5 fa2779d1beae252fd3a3dd61c6618892
BLAKE2b-256 b8c8b391f65b8a564b48b78f78b3f0fe3374b4ceaa1fc7ccdcae9a8375b04f41

See more details on using hashes here.

File details

Details for the file meshtastic2hass-1.0.12-py3-none-any.whl.

File metadata

File hashes

Hashes for meshtastic2hass-1.0.12-py3-none-any.whl
Algorithm Hash digest
SHA256 c1d5b87a4e630b3a04d15b891db936f8e02798b0f0a5e89c1b61701a2b646579
MD5 8d5388bd6518e2c30371dbb5105c434a
BLAKE2b-256 3b395292e7e4af1e8580d17815729a060260d37942382255f09fef6c17d60242

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page