Skip to main content

wireless-sensor-mqtt 🌡

Code style: black CI Pipeline Status Coverage Status Last Release Compatible Python Versions DOI

MQTT client reporting measurements of FT017TH wireless thermo/hygrometers

Requirements

Setup

$ pip3 install --user --upgrade wireless-sensor-mqtt

Usage

$ wireless-sensor-mqtt \
    --gdo0-gpio-line-name GPIO24 \
    --mqtt-host HOSTNAME_OR_IP_ADDRESS \
    --mqtt-topic-prefix MQTT_TOPIC_PREFIX

Measurements will be published on topics MQTT_TOPIC_PREFIX/temperature-degrees-celsius and MQTT_TOPIC_PREFIX/relative-humidity-percent (e.g., living-room/temperature-degrees-celsius with --mqtt-topic-prefix living-room).

Add --debug to get debug logs.

MQTT via TLS

TLS is enabled by default. Run wireless-sensor-mqtt --mqtt-disable-tls … to disable TLS.

MQTT Authentication

wireless-sensor-mqtt --mqtt-username me --mqtt-password secret …
# or
wireless-sensor-mqtt --mqtt-username me --mqtt-password-file /var/lib/secrets/mqtt/password …

Home Assistant 🏡

Home Assistant will detect two new sensors automatically, if connected to the same MQTT broker and MQTT discovery is enabled (enabled by default since version 0.117.0).

homeassistant: discovered sensors

When using a custom discovery_prefix, run wireless-sensor-mqtt --homeassistant-discovery-prefix custom-prefix ….

Docker 🐳

Pre-built docker images are available at https://hub.docker.com/r/fphammerle/wireless-sensor-mqtt/tags

$ sudo docker run --name wireless_sensor_mqtt \
    --device /dev/spidev0.0 --device /dev/gpiochip0 \
    fphammerle/wireless-sensor-mqtt \
    wireless-sensor-mqtt --mqtt-host HOSTNAME_OR_IP_ADDRESS …

Optionally add --read-only --cap-drop ALL --security-opt no-new-privileges before image specifier.

Annotation of signed tags docker/* contains docker image digests: https://github.com/fphammerle/wireless-sensor-mqtt/tags

Docker Compose 🐙

  1. Clone this repository.
  2. Edit docker-compose.yml.
  3. sudo docker-compose up --build

Metadata

Release files for wireless-sensor-mqtt 1.0.0

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

Source distribution (sdist)

Source distribution for wireless-sensor-mqtt 1.0.0
File Size Uploaded
wireless-sensor-mqtt-1.0.0.tar.gz 98.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for wireless-sensor-mqtt 1.0.0
File Interpreter ABI Platform
wireless_sensor_mqtt-1.0.0-py3-none-any.whl Python 3 none any Details

Total release size: 118.7 kB

Release files / wireless-sensor-mqtt-1.0.0.tar.gz

Download URL wireless-sensor-mqtt-1.0.0.tar.gz
Size 98.5 kB
Tags Source
SHA-256 checksum
How to use checksums
b39111897448a509b7ae3913faf8f0b2b2a245b5b907d4cca82e4bead781f410
BLAKE2b-256 checksum
How to use checksums
360b3c62da3dbf7ddf28f85c53c43226d8e99c62a8c08ddd6f3eb21c278b672f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.2

Release files / wireless_sensor_mqtt-1.0.0-py3-none-any.whl

Download URL wireless_sensor_mqtt-1.0.0-py3-none-any.whl
Size 20.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c49baf9420c7cc28dec279ca95af706b0de5aee36c6de3b5c06c4e4a7425d673
BLAKE2b-256 checksum
How to use checksums
50a68095b1a6b7c67b01c184f54bb252fce59b1e4e954becc1d9a22ace1d2f40
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.2
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