Skip to content

Magic Mirror 2 module for PMSx003(PMS5003/PMS7003) series dust sensor.

Notifications You must be signed in to change notification settings

gimdh/MMM-Plantower

Repository files navigation

MMM-Plantower

The MMM-Plantower is a module for MagicMirror². It can monitor air quality data from Plantower PMS3003, PMS5003, and PMS7003 sensors.

Screenshot

screenshot

  • Measurements change color as air quality gets worse (Blue -> Green -> Orange -> Red).

Install

cd ~/MagicMirror/modules
git clone https://github.com/gimdh/MMM-Plantower
cd MMM-Plantower
npm install

Configuration

Option Description
serialPort Directory of serial port

Type: string
Example: /dev/ttyS0
No default value is set and must be provided by user
updateInterval The update interval of air quailty in seconds.

Type: int
Example for 30 seconds: 30
Default value: 5
Note: Module waits for sensor to send data. Therefore it may not strictly follow the interval. Also, setting it too low is not recommended.
titleText Widget title text

Type: string
Default value: Indoor Dust Measure

Dependencies

  • python3
  • plantower python package (Install via pip3 install plantower)

Test PMSX003 module

  1. Navigate to the module folder ./MagicMirror/MMM-Plantower.
  2. Run python3 pollData.py {connected_serial_port_device}.
  3. Script should print JSON with air quality readings.

Credit

MMM-BME280 for overall module architecture and design.

About

Magic Mirror 2 module for PMSx003(PMS5003/PMS7003) series dust sensor.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published