summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDaniel Friesel <derf@finalrewind.org>2022-04-18 10:53:58 +0200
committerDaniel Friesel <derf@finalrewind.org>2022-04-18 10:53:58 +0200
commit30a87091a706e685dc88cba0d817d907bf6f52a9 (patch)
tree70d15736683b4d594eb3a580c95b0c9998cb5e02 /README.md
parent87f3d0c12c21963a7a9e6056c4d67dce3cf1980f (diff)
README: configuration needs to be written via (soft)uart
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/README.md b/README.md
index d37441f..5dcde07 100644
--- a/README.md
+++ b/README.md
@@ -69,12 +69,12 @@ mqtt_host = "..."
If desired, **sds011.lua** can be used to configure the SDS011 sensor.
Currently, the following commands are supported
-* `sds011.set_report_mode(active)`
+* `port:write(sds011.set_report_mode(active))`
* active == true: periodically report PM2.5 and PM10 values via UART
* active == false: only report PM2.5 and PM10 values when queried
-* `sds011.sleep(sleep)`
+* `port:write(sds011.sleep(sleep))`
* sleep == true: put sensor into sleep mode. The fan is turned off, no further measurements are performed
* sleep == false: wake up sensor.
-* `sds011.set_work_period(period)`
+* `port:write(sds011.set_work_period(period))`
* period == 0: continuous operation (about one measurement per second)
* 0 < *period* ≤ 30: about one measurement every *period* minutes; fan turned off in-between