Skip to main content

MQTT client reporting measurements of FT017TH wireless thermo/hygrometers

Project description

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

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

wireless-sensor-mqtt-1.0.0.tar.gz (98.5 kB view details)

Uploaded Source

Built Distribution

wireless_sensor_mqtt-1.0.0-py3-none-any.whl (20.2 kB view details)

Uploaded Python 3

File details

Details for the file wireless-sensor-mqtt-1.0.0.tar.gz.

File metadata

  • Download URL: wireless-sensor-mqtt-1.0.0.tar.gz
  • Upload date:
  • Size: 98.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for wireless-sensor-mqtt-1.0.0.tar.gz
Algorithm Hash digest
SHA256 b39111897448a509b7ae3913faf8f0b2b2a245b5b907d4cca82e4bead781f410
MD5 f8f8f0d317cbd50541954ece3d6b1719
BLAKE2b-256 360b3c62da3dbf7ddf28f85c53c43226d8e99c62a8c08ddd6f3eb21c278b672f

See more details on using hashes here.

File details

Details for the file wireless_sensor_mqtt-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for wireless_sensor_mqtt-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c49baf9420c7cc28dec279ca95af706b0de5aee36c6de3b5c06c4e4a7425d673
MD5 340a1b7fb782fe4df6021362a7dd27f0
BLAKE2b-256 50a68095b1a6b7c67b01c184f54bb252fce59b1e4e954becc1d9a22ace1d2f40

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