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.0a2.tar.gz (98.5 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for wireless-sensor-mqtt-1.0.0a2.tar.gz
Algorithm Hash digest
SHA256 214681db668d7e93f30a0dbee2d6be9da1f04a71e791aa7c66b30a7a01de691d
MD5 2ba91c5d07d46dd44390da4328dafe51
BLAKE2b-256 de6488af2c13cb15610a65dfe882819a7dbb5216f619e49f046eea33fc7b8abb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for wireless_sensor_mqtt-1.0.0a2-py3-none-any.whl
Algorithm Hash digest
SHA256 264879e717a0ac35f0db5fbeb71925bb5670d878d6a24245d8e53a72cad9abaf
MD5 95a3257082540f7d918da52a366bf36c
BLAKE2b-256 4a9e90b3bc0ccc478d03deeebaeeed14d63d23986f8ee50c9c519d875e32f501

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