From 3ef0273f34928ee242fa0941f194682754069394 Mon Sep 17 00:00:00 2001 From: Bill Thomson Date: Fri, 25 Nov 2022 11:38:43 -0600 Subject: [PATCH] Update README.md --- usermods/photoresistor_sensor_mqtt_v1/README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/usermods/photoresistor_sensor_mqtt_v1/README.md b/usermods/photoresistor_sensor_mqtt_v1/README.md index 33d96bc743..f83bb01a22 100644 --- a/usermods/photoresistor_sensor_mqtt_v1/README.md +++ b/usermods/photoresistor_sensor_mqtt_v1/README.md @@ -1,10 +1,12 @@ # Photoresister sensor with MQTT -This simple usermod allows attaching a photoresistor sensor like the KY-018 and publish the readings in percentage over MQTT. The frequency of MQTT messages can be modified, and there is a threshold value that can be set so that significant changes in the readings can be published immediately instead of waiting for the next update. This was found to be a good compromise between spamming MQTT messages and delayed updates. +Enables attaching a photoresistor sensor like the KY-018 and publishing the readings as a percentage, via MQTT. The frequency of MQTT messages is user definable. +A threshold value can be set so significant changes in the readings are published immediately vice waiting for the next update. This was found to be a good compromise between excessive MQTT traffic and delayed updates. -I also found it useful to limit the frequency of analog pin reads because otherwise the board hangs. +I also found it useful to limit the frequency of analog pin reads, otherwise the board hangs. -This usermod has only been tested with the KY-018 sensor though should work for any other analog pin sensor. Note that this does not control the LED strip directly, it only publishes MQTT readings for use with other integrations like Home Assistant. +This usermod has only been tested with the KY-018 sensor though it should work for any other analog pin sensor. +Note: this does not control the LED strip directly, it only publishes MQTT readings for use with other integrations like Home Assistant. ## Installation