API

SDS011Wrapper

Kind: global class

• SDS011Wrapper
  • new SDS011Wrapper(portPath)
  • .close()
  • .query() ⇒ Promise.<object>
  • .setReportingMode(mode) ⇒ Promise
  • .getReportingMode() ⇒ Promise
  • .setSleepSetting(shouldSleep) ⇒ Promise
  • .getVersion() ⇒ Promise.<string>
  • .setWorkingPeriod(time) ⇒ Promise
  • .getWorkingPeriod() ⇒ Promise.<Number>

new SDS011Wrapper(portPath)

Open sensor.

Param	Type	Description
portPath	string	Serial port path

sdS011Wrapper.close()

Close open connection and cleanup.

Kind: instance method of SDS011Wrapper

sdS011Wrapper.query() ⇒ Promise.<object>

Query sensor for it's latest reading.

Kind: instance method of SDS011Wrapper
Returns: Promise.<object> - Resolved with PM2.5 and PM10 readings. May be rejected if sensor fails to respond after a number of internal retries.

sdS011Wrapper.setReportingMode(mode) ⇒ Promise

Set reporting mode. This setting is still effective after power off.

Kind: instance method of SDS011Wrapper
Returns: Promise - Resolved when mode was set successfully. May be rejected if sensor fails to respond after a number of internal retries.

Param	Type	Description
mode	'active' | 'query'	active: data will be emitted as "data" event, query: new data has to requested manually @see query

sdS011Wrapper.getReportingMode() ⇒ Promise

Get reporting mode.

Kind: instance method of SDS011Wrapper
Returns: Promise - Resolved with either 'active' or 'query'. May be rejected if sensor fails to respond after a number of internal retries.

sdS011Wrapper.setSleepSetting(shouldSleep) ⇒ Promise

Switch to sleep mode and back. Fan and laser will be turned off while in sleep mode. Any command will wake the device - however this was not documented.

Kind: instance method of SDS011Wrapper
Returns: Promise - Resolved when operation completed successfully. May be rejected if sensor fails to respond after a number of internal retries.

Param	Type	Description
shouldSleep	boolean	whether device should sleep or not

sdS011Wrapper.getVersion() ⇒ Promise.<string>

Read software version. It will be presented in "year-month-day" format.

Kind: instance method of SDS011Wrapper
Returns: Promise.<string> - - Resolved with sensor firmware version. May be rejected if sensor fails to respond after a number of internal retries.

sdS011Wrapper.setWorkingPeriod(time) ⇒ Promise

Set working period of the sensor. This setting is still effective after power off.

Kind: instance method of SDS011Wrapper
Returns: Promise - Resolved when period was changed successfully. May be rejected if sensor fails to respond after a number of internal retries.

Param	Type	Description
time	number	Working time (0 - 30 minutes). Sensor will continuously work when set to 0.

sdS011Wrapper.getWorkingPeriod() ⇒ Promise.<Number>

Get current working period.

Kind: instance method of SDS011Wrapper
Returns: Promise.<Number> - Resolved with current period setting. May be rejected if sensor fails to respond after a number of internal retries.