ZigbeePM25Sensor

About

The ZigbeePM25Sensor class provides a PM2.5 air quality sensor endpoint for Zigbee networks. This endpoint implements the Zigbee Home Automation (HA) standard for particulate matter measurement devices.

Features: * PM2.5 concentration measurement in μg/m³ * Configurable measurement range * Tolerance and reporting configuration * Automatic reporting capabilities

API Reference

Constructor

ZigbeePM25Sensor

Creates a new Zigbee PM2.5 sensor endpoint.

ZigbeePM25Sensor(uint8_t endpoint);

endpoint - Endpoint number (1-254)

API Methods

setPM25

Sets the PM2.5 concentration measurement value.

bool setPM25(float pm25);

pm25 - PM2.5 concentration value in 0.1 μg/m³

This function will return true if successful, false otherwise.

setMinMaxValue

Sets the minimum and maximum measurement values.

bool setMinMaxValue(float min, float max);

min - Minimum PM2.5 concentration value in 0.1 μg/m³
max - Maximum PM2.5 concentration value in 0.1 μg/m³

This function will return true if successful, false otherwise.

setTolerance

Sets the tolerance value for measurements.

bool setTolerance(float tolerance);

tolerance - Tolerance value in 0.1 μg/m³

This function will return true if successful, false otherwise.

setReporting

Sets the reporting configuration for PM2.5 measurements.

bool setReporting(uint16_t min_interval, uint16_t max_interval, float delta);

min_interval - Minimum reporting interval in seconds
max_interval - Maximum reporting interval in seconds
delta - Minimum change required to trigger a report in 0.1 μg/m³

This function will return true if successful, false otherwise.

report

Manually reports the current PM2.5 concentration value.

bool report();

This function will return true if successful, false otherwise.

Example

PM2.5 Sensor Implementation

// Copyright 2024 Espressif Systems (Shanghai) PTE LTD
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

/**
 * @brief This example demonstrates Zigbee PM2.5 sensor.
 *
 * The example demonstrates how to use Zigbee library to create a end device PM2.5 sensor.
 *
 * Proper Zigbee mode must be selected in Tools->Zigbee mode
 * and also the correct partition scheme must be selected in Tools->Partition Scheme.
 *
 * Please check the README.md for instructions and more detailed description.
 *
 * Created by Jan Procházka (https://github.com/P-R-O-C-H-Y/)
 */

#ifndef ZIGBEE_MODE_ED
#error "Zigbee end device mode is not selected in Tools->Zigbee mode"
#endif

#include "Zigbee.h"

/* Zigbee PM2.5 sensor configuration */
#define PM2_5_SENSOR_ENDPOINT_NUMBER 1
uint8_t button = BOOT_PIN;

ZigbeePM25Sensor zbPM25Sensor = ZigbeePM25Sensor(PM2_5_SENSOR_ENDPOINT_NUMBER);

void setup() {
  Serial.begin(115200);

  // Init button switch
  pinMode(button, INPUT_PULLUP);

  // Optional: set Zigbee device name and model
  zbPM25Sensor.setManufacturerAndModel("Espressif", "ZigbeePM25Sensor");

  // Set minimum and maximum PM2.5 measurement value in µg/m³
  zbPM25Sensor.setMinMaxValue(0, 350);

  // Set tolerance for PM2.5 measurement in µg/m³
  zbPM25Sensor.setTolerance(0.1);

  // Add endpoints to Zigbee Core
  Zigbee.addEndpoint(&zbPM25Sensor);

  Serial.println("Starting Zigbee...");
  // When all EPs are registered, start Zigbee in End Device mode
  if (!Zigbee.begin()) {
    Serial.println("Zigbee failed to start!");
    Serial.println("Rebooting...");
    ESP.restart();
  } else {
    Serial.println("Zigbee started successfully!");
  }
  Serial.println("Connecting to network");
  while (!Zigbee.connected()) {
    Serial.print(".");
    delay(100);
  }
  Serial.println();

  // Set reporting interval for PM2.5 measurement to be done every 30 seconds, must be called after Zigbee.begin()
  // min_interval and max_interval in seconds, delta (PM2.5 change in µg/m³)
  // if min = 1 and max = 0, reporting is sent only when PM2.5 changes by delta
  // if min = 0 and max = 10, reporting is sent every 10 seconds or when PM2.5 changes by delta
  // if min = 0, max = 10 and delta = 0, reporting is sent every 10 seconds regardless of delta change
  zbPM25Sensor.setReporting(0, 30, 0);
}

void loop() {
  static uint32_t timeCounter = 0;
  // Read PM2.5 sensor every 2s
  if (!(timeCounter++ % 20)) {  // delaying for 100ms x 20 = 2s
    // Read sensor value - here is chip temperature used + 50 as a dummy value for demonstration
    float pm25_value = 50.5 + temperatureRead();
    Serial.printf("Updating PM2.5 sensor value to %0.1f µg/m³\r\n", pm25_value);
    zbPM25Sensor.setPM25(pm25_value);
  }

  // Checking button for factory reset and reporting
  if (digitalRead(button) == LOW) {  // Push button pressed
    // Key debounce handling
    delay(100);
    int startTime = millis();
    while (digitalRead(button) == LOW) {
      delay(50);
      if ((millis() - startTime) > 3000) {
        // If key pressed for more than 3secs, factory reset Zigbee and reboot
        Serial.println("Resetting Zigbee to factory and rebooting in 1s.");
        delay(1000);
        Zigbee.factoryReset();
      }
    }
    zbPM25Sensor.report();
  }
  delay(100);
}