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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for wireless-sensor-mqtt-1.0.0a0.tar.gz
Algorithm Hash digest
SHA256 58fb1ec244cc5c70a88ffbb029b1c75753e6209ba8e92b5610722d836205903f
MD5 dd09e8898ce04925c6d9ca7d1b346b0b
BLAKE2b-256 98b479c3ba4f094ad37b9df65538f4d1784422150ba684ae05b7d32ec9a34316

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for wireless_sensor_mqtt-1.0.0a0-py3-none-any.whl
Algorithm Hash digest
SHA256 6d727579650832eba2e1bbbc0598e6541cf1bb1190f004f6c0457cfa0252bcb5
MD5 2d1fa39a87599dd0ed91408636f98405
BLAKE2b-256 40574e3efc59afd20adf90666c70368104081455b4068795d0350e0aa9872d99

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