petrovgp/esp-pms

readme

# ESP-IDF Component: *esp-pms*

[![ESP-IDF](https://img.shields.io/badge/ESP--IDF-%E2%9A%99-blue)](https://github.com/espressif/esp-idf) [![License](https://img.shields.io/github/license/petrovgp/esp-pms)](LICENSE) ![GitHub Release](https://img.shields.io/github/v/release/petrovgp/esp-pms)

ESP-IDF component for Plantower PMSX003 air quality sensors.

## Available sensors support

| Sensor Model | Status                                                                |
|--------------|-----------------------------------------------------------------------|
| PMS1003      | ![Supported](https://img.shields.io/badge/support-yes-brightgreen) ** |
| PMS3003      | ![Supported](https://img.shields.io/badge/support-yes-brightgreen)    |
| PMS5003      | ![Supported](https://img.shields.io/badge/support-yes-brightgreen)    |
| PMS5003T     | ![Supported](https://img.shields.io/badge/support-yes-brightgreen)    |
| PMS5003ST    | ![Not supported](https://img.shields.io/badge/support-no-red)         |
| PMS6003      | ![Supported](https://img.shields.io/badge/support-yes-brightgreen) ** |
| PMS7003      | ![Supported](https://img.shields.io/badge/support-yes-brightgreen) ** |
| PMS9003M     | ![Supported](https://img.shields.io/badge/support-yes-brightgreen) ** |
| PMSA003      | ![Supported](https://img.shields.io/badge/support-yes-brightgreen) ** |
| PMSX003-N    | ![Not supported](https://img.shields.io/badge/support-no-red) ***     |

\* sensors are supported, but not all data is parsed

\*\* sensors are supported under PMS_TYPE_5003 

\*\*\* unverified, no available datasheet

## Setup

Clone this repository in your project **components directory** (or create one if it is missing):

```Shell
cd ~/esp-idf-projects/myproject/components
git clone https://github.com/petrovgp/esp-pms.git
```

Add components directory to **project main CMakeLists.txt**:

```CMake
cmake_minimum_required(VERSION 3.16)
set(EXTRA_COMPONENT_DIRS /home/user/esp-idf-projects/myproject/components)
include($ENV{IDF_PATH}/tools/cmake/project.cmake)
project(myproject)
```

## Example usage

Two examples are provided with this component:
- Active queue - sensor usage in active mode with FreeRTOS queues
- Passive sleep - sensor usage in passive mode with sleep state

## License

Distributed under the MIT License.  
See [LICENSE](LICENSE) for more information.