pms5003

Documentation

Overview

Package pms5003 talks to the PMS5003 particulate matter sensor. Code is more or less ported from Pimoroni's original: https://github.com/pimoroni/pms5003-python We basically just read bytes from a serial connection.

Index

• func Close()
• func Open(pi *raspi.Adaptor) (err error)
• func Reset(pi *raspi.Adaptor) (err error)
• type Frame
  • func ReadFrame() (Frame, error)

Functions

func Close

func Close()

Close closes the connection with the PMS5003 serial port

func Open

func Open(pi *raspi.Adaptor) (err error)

Open resets and connects to the PMS5003

func Reset

func Reset(pi *raspi.Adaptor) (err error)

Reset attempts to reset the PMS5003

Types

type Frame

type Frame struct {
	Standard10     uint16
	Standard25     uint16
	Standard100    uint16
	Environment10  uint16
	Environment25  uint16
	Environment100 uint16
	Count3um       uint16
	Count5um       uint16
	Count10um      uint16
	Count25um      uint16
	Count50um      uint16
	Count100um     uint16
}

Frame is the data measured by the sensor. The standard and environment values are PM concentrations (μ g/m3). Environment values are the measure of the concentrations in the atmospheric environment. Standard values are adjusted to the U.S. Standard Atmosphere at 0 km sea level.

Reference:

• Datasheet: https://www.aqmd.gov/docs/default-source/aq-spec/resources-page/plantower-pms5003-manual_v2-3.pdf
• Discussion: https://publiclab.org/questions/samr/04-07-2019/how-to-interpret-pms5003-sensor-values
• AQI: https://en.wikipedia.org/wiki/Air_quality_index

func ReadFrame

func ReadFrame() (Frame, error)

ReadFrame reads a Frame of data from the sensor