Minor documentation improvements (15b98db5) · Commits · derf / esp8266-nodemcu-sds011

README.md

+8 −6

Original line number	Original line	Diff line number	Diff line
	# ESP8266 Lua/NodeMCU module for SDS011 PM sensors		# ESP8266 Lua/NodeMCU module for Nova SDS011 PM sensors

	This repository contains an ESP8266 NodeMCU Lua module (`sds011.lua`) as well		This repository contains an ESP8266 NodeMCU Lua module (`sds011.lua`) as well
	MQTT / HomeAssistant / InfluxDB integration example (`init.lua`) for SDS011		MQTT / HomeAssistant / InfluxDB integration example (`init.lua`) for SDS011
	particulate matter (PM2.5 and PM10) sensors.		particulate matter (PM2.5 and PM10) sensors connected via UART.

	## Dependencies		## Dependencies

	@@ -19,7 +19,6 @@ following modules.
	* node		* node
	* softuart		* softuart
	* tmr		* tmr
	* uart
	* wifi		* wifi

	## Setup		## Setup
	@@ -106,8 +105,7 @@ If desired, sds011.lua can be used to configure the SDS011 sensor.
	To use it, you need to create a config.lua file with WiFI and MQTT settings:		To use it, you need to create a config.lua file with WiFI and MQTT settings:

	```lua		```lua
	station_cfg.ssid = "..."		station_cfg = {ssid = "...", pwd = "..."}
	station_cfg.pwd = "..."
	mqtt_host = "..."		mqtt_host = "..."
	```		```

	@@ -119,5 +117,9 @@ influx_url = "..."
	influx_attr = "..."		influx_attr = "..."
	```		```

	Readings will be published as `sds011[influx_attr] pm2_5_ugm3=...,pm10_ugm3=...`		Readings will be published as `sds011[influx_attr] pm2_5_ugm3=%d.%01d,pm10_ugm3=%d.%01d`.
	So, unless `influx_attr = ''`, it must start with a comma, e.g. `influx_attr = ',device=' .. device_id`.		So, unless `influx_attr = ''`, it must start with a comma, e.g. `influx_attr = ',device=' .. device_id`.

			## Images

			![](https://finalrewind.org/projects/esp8266-nodemcu-sds011/media/preview.png)

init.lua

+1 −2

Original line number	Original line	Diff line number	Diff line
	station_cfg = {}
	publishing_mqtt = false		publishing_mqtt = false
	publishing_http = false		publishing_http = false

	@@ -10,7 +9,7 @@ mqttclient = mqtt.Client(device_id, 120)

	dofile("config.lua")		dofile("config.lua")

	print("ESP8266 " .. chip_id)		print("SDS011 " .. chip_id)

	ledpin = 4		ledpin = 4
	gpio.mode(ledpin, gpio.OUTPUT)		gpio.mode(ledpin, gpio.OUTPUT)

Admin message