MQTT client reporting measurements of FT017TH wireless thermo/hygrometers
Project description
wireless-sensor-mqtt 🌡
MQTT client reporting measurements of FT017TH wireless thermo/hygrometers
Requirements
- MQTT broker
- FT017TH sensor
- CC1101 transceiver
- Linux machine with CC1101 connected to SPI port &
GDO0
connected to some GPIO pin (wiring instructions for raspberry pi)
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).
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 🐙
- Clone this repository.
- Edit
docker-compose.yml
. sudo docker-compose up --build
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file wireless-sensor-mqtt-1.0.0a2.tar.gz
.
File metadata
- Download URL: wireless-sensor-mqtt-1.0.0a2.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
Algorithm | Hash digest | |
---|---|---|
SHA256 | 214681db668d7e93f30a0dbee2d6be9da1f04a71e791aa7c66b30a7a01de691d |
|
MD5 | 2ba91c5d07d46dd44390da4328dafe51 |
|
BLAKE2b-256 | de6488af2c13cb15610a65dfe882819a7dbb5216f619e49f046eea33fc7b8abb |
File details
Details for the file wireless_sensor_mqtt-1.0.0a2-py3-none-any.whl
.
File metadata
- Download URL: wireless_sensor_mqtt-1.0.0a2-py3-none-any.whl
- Upload date:
- Size: 20.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 264879e717a0ac35f0db5fbeb71925bb5670d878d6a24245d8e53a72cad9abaf |
|
MD5 | 95a3257082540f7d918da52a366bf36c |
|
BLAKE2b-256 | 4a9e90b3bc0ccc478d03deeebaeeed14d63d23986f8ee50c9c519d875e32f501 |