summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBirte Kristina Friesel <derf@finalrewind.org>2024-01-14 08:05:32 +0100
committerBirte Kristina Friesel <derf@finalrewind.org>2024-01-14 08:05:32 +0100
commit9adc68ef5c3fd7b4f64777ba857514b76e1043fe (patch)
treefc04aaed48d9cb19369ee6199399a54ba2ef5dd5
parent8d0cd5fd91fad26957cc2c0f2b339aae09df92d9 (diff)
README: nits; consistency with other ESP8266/NodeMCU drivers
-rw-r--r--README.md13
1 files changed, 7 insertions, 6 deletions
diff --git a/README.md b/README.md
index f6f6e49..312be21 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,8 @@
-# ESP8266 Lua/NodeMCU module for MH-Z19 CO₂ sensor
+# ESP8266 Lua/NodeMCU module for MH-Z19 CO₂ sensors
This repository contains an ESP8266 NodeMCU Lua module (`mh-z19.lua`) as well
as MQTT / HomeAssistant / InfluxDB gateway application example (`init.lua`) for
-the **MH-Z19** carbon dioxide (CO₂) sensor.
-
-![](https://finalrewind.org/projects/esp8266-nodemcu-mh-z19/media/preview.jpg)
+**MH-Z19** carbon dioxide (CO₂) sensors connected via UART.
## Dependencies
@@ -21,7 +19,6 @@ following modules.
* node
* softuart
* tmr
-* uart
* wifi
## Setup
@@ -80,5 +77,9 @@ influx_url = "..."
influx_attr = "..."
```
-Readings will be stored as `mh_z19[influx_attr] co2_ppm=...`.
+Readings will be stored as `mh_z19[influx_attr] co2_ppm=…`.
So, unless `influx_attr = ''`, it must start with a comma, e.g. `influx_attr = ',device=' .. device_id`.
+
+## Images
+
+![](https://finalrewind.org/projects/esp8266-nodemcu-mh-z19/media/preview.jpg)