summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md33
1 files changed, 20 insertions, 13 deletions
diff --git a/README.md b/README.md
index 16b668f..9996647 100644
--- a/README.md
+++ b/README.md
@@ -1,16 +1,15 @@
# ESP8266 Lua/NodeMCU module for Vindriktning PM1006 PM sensors
-This repository contains an ESP8266 NodeMCU Lua module (`pm1006.lua`) as well
-as MQTT / HomeAssistant / InfluxDB integration example (`init.lua`) for
-**PM1006** particulate matter (PM2.5) sensors found in IKEA Vindriktning.
+[esp8266-nodemcu-pm1006](https://finalrewind.org/projects/esp8266-nodemcu-pm1006/)
+provides an ESP8266 NodeMCU Lua module (`pm1006.lua`) as well as MQTT /
+HomeAssistant / InfluxDB integration example (`init.lua`) for **PM1006**
+particulate matter (PM2.5) sensors found in IKEA Vindriktning.
## Dependencies
-pm1006.lua has been tested with Lua 5.1 on NodeMCU firmware 3.0.1 (Release
+**pm1006.lua** has been tested with Lua 5.1 on NodeMCU firmware 3.0.1 (Release
202112300746, integer build). It does not require any special modules.
-
-
Most practical applications (such as the example in init.lua) need the
following modules.
@@ -26,14 +25,14 @@ following modules.
Connect the Vindriktning PCB to your ESP8266/NodeMCU board as [documented by
Hypfer](https://github.com/Hypfer/esp8266-vindriktning-particle-sensor):
-* Vindriktning +5V → NodeMCU 5V
-* Vindriktning GND → ESP8266/NodeMCU GND
-* Vindriktning REST → NodeMCU D2 (ESP8266 GPIO4)
+* Vindriktning test point "+5V" → NodeMCU 5V (→ ESP8266 3V3 via LDO)
+* Vindriktning test point "GND" → ESP8266/NodeMCU GND
+* Vindriktning test point "REST" → NodeMCU D2 (ESP8266 GPIO4)
-If you use a different UART pin, you need to adjust the softuart.setup call in
-the examples provided in this repository to reflect that change. Keep in mind
-that some ESP8266 pins must have well-defined logic levels at boot time and may
-therefore be unsuitable for PM1006 connection.
+If you use a different UART pin, you need to adjust the `softuart.setup` call
+in the examples provided in this repository to reflect that change. Keep in
+mind that some ESP8266 pins must have well-defined logic levels at boot time
+and may therefore be unsuitable for PM1006 connection.
## Usage
@@ -76,3 +75,11 @@ influx_attr = "..."
Readings will be published as `vindriktning[influx_attr] pm2_5_ugm3=%d.%01d`.
So, unless `influx_attr = ''`, it must start with a comma, e.g. `influx_attr = ',device=' .. device_id`.
+
+## Resources
+
+Mirrors of the esp8266-nodemcu-pm1006 repository are maintained at the following locations:
+
+* [Chaosdorf](https://chaosdorf.de/git/derf/esp8266-nodemcu-pm1006)
+* [git.finalrewind.org](https://git.finalrewind.org/esp8266-nodemcu-pm1006/)
+* [GitHub](https://github.com/derf/esp8266-nodemcu-pm1006)