2024-02-03 10:46:26 +07:00
|
|
|
#ifndef _AIR_GRADIENT_H_
|
|
|
|
#define _AIR_GRADIENT_H_
|
|
|
|
|
2024-02-04 15:22:06 +07:00
|
|
|
#include "display/oled.h"
|
2024-02-04 15:04:38 +07:00
|
|
|
#include "main/BoardDef.h"
|
|
|
|
#include "main/HardwareWatchdog.h"
|
|
|
|
#include "main/LedBar.h"
|
|
|
|
#include "main/PushButton.h"
|
|
|
|
#include "main/StatusLed.h"
|
|
|
|
#include "pms/pms5003.h"
|
|
|
|
#include "pms/pms5003t.h"
|
2024-02-04 15:22:06 +07:00
|
|
|
#include "s8/s8.h"
|
2024-02-04 15:04:38 +07:00
|
|
|
#include "sgp41/sgp41.h"
|
2024-02-10 21:14:27 +07:00
|
|
|
#include "sht/sht.h"
|
2024-02-03 10:46:26 +07:00
|
|
|
|
2024-02-04 15:04:38 +07:00
|
|
|
/**
|
|
|
|
* @brief Class with define all the sensor has supported by Airgradient. Each
|
|
|
|
* sensor usage must be init before use.
|
|
|
|
*/
|
2024-02-03 10:46:26 +07:00
|
|
|
class AirGradient {
|
|
|
|
public:
|
|
|
|
AirGradient(BoardType type);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Plantower PMS5003 sensor
|
|
|
|
*/
|
|
|
|
PMS5003 pms5003;
|
2024-02-04 15:04:38 +07:00
|
|
|
/**
|
2024-02-04 15:22:06 +07:00
|
|
|
* @brief Plantower PMS5003T sensor: connect to PM1 connector on
|
|
|
|
* OPEN_AIR_OUTDOOR.
|
2024-02-04 15:04:38 +07:00
|
|
|
*/
|
2024-02-03 10:46:26 +07:00
|
|
|
PMS5003T pms5003t_1;
|
2024-02-04 15:04:38 +07:00
|
|
|
/**
|
2024-02-04 15:22:06 +07:00
|
|
|
* @brief Plantower PMS5003T sensor: connect to PM2 connector on
|
|
|
|
* OPEN_AIR_OUTDOOR.
|
2024-02-04 15:04:38 +07:00
|
|
|
*/
|
2024-02-03 10:46:26 +07:00
|
|
|
PMS5003T pms5003t_2;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief SenseAirS8 CO2 sensor
|
|
|
|
*/
|
|
|
|
S8 s8;
|
|
|
|
|
|
|
|
/**
|
2024-02-10 21:14:27 +07:00
|
|
|
* @brief Temperature and humidity sensor supported SHT3x and SHT4x
|
|
|
|
*
|
2024-02-06 09:38:37 +07:00
|
|
|
*/
|
2024-02-10 21:14:27 +07:00
|
|
|
Sht sht;
|
2024-02-03 10:46:26 +07:00
|
|
|
|
|
|
|
/**
|
2024-02-04 15:04:38 +07:00
|
|
|
* @brief SGP41 TVOC and NOx sensor
|
2024-02-03 10:46:26 +07:00
|
|
|
*
|
|
|
|
*/
|
|
|
|
Sgp41 sgp41;
|
|
|
|
|
|
|
|
/**
|
2024-02-04 15:04:38 +07:00
|
|
|
* @brief OLED Display
|
2024-02-03 10:46:26 +07:00
|
|
|
*
|
|
|
|
*/
|
|
|
|
Display display;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Push Button
|
|
|
|
*/
|
|
|
|
PushButton button;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief LED
|
|
|
|
*/
|
|
|
|
StatusLed statusLed;
|
2024-02-04 15:04:38 +07:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief RGB LED array
|
2024-02-04 15:22:06 +07:00
|
|
|
*
|
2024-02-04 15:04:38 +07:00
|
|
|
*/
|
2024-02-03 10:46:26 +07:00
|
|
|
LedBar ledBar;
|
|
|
|
|
|
|
|
/**
|
2024-02-04 15:04:38 +07:00
|
|
|
* @brief External hardware watchdog
|
2024-02-03 10:46:26 +07:00
|
|
|
*/
|
|
|
|
HardwareWatchdog watchdog;
|
|
|
|
|
2024-02-04 15:04:38 +07:00
|
|
|
/**
|
|
|
|
* @brief Get I2C SDA pin has of board supported
|
2024-02-04 15:22:06 +07:00
|
|
|
*
|
2024-02-04 15:04:38 +07:00
|
|
|
* @return int Pin number if -1 invalid
|
|
|
|
*/
|
2024-02-03 10:46:26 +07:00
|
|
|
int getI2cSdaPin(void);
|
2024-02-04 15:04:38 +07:00
|
|
|
/**
|
|
|
|
* @brief Get I2C SCL pin has of board supported
|
2024-02-04 15:22:06 +07:00
|
|
|
*
|
2024-02-04 15:04:38 +07:00
|
|
|
* @return int Pin number if -1 invalid
|
|
|
|
*/
|
2024-02-03 10:46:26 +07:00
|
|
|
int getI2cSclPin(void);
|
|
|
|
|
2024-02-04 15:04:38 +07:00
|
|
|
/**
|
|
|
|
* @brief Get the Board Type
|
2024-02-04 15:22:06 +07:00
|
|
|
*
|
2024-02-04 15:04:38 +07:00
|
|
|
* @return BoardType @ref BoardType
|
|
|
|
*/
|
2024-02-03 10:46:26 +07:00
|
|
|
BoardType getBoardType(void);
|
|
|
|
|
2024-02-04 15:04:38 +07:00
|
|
|
/**
|
|
|
|
* @brief Get the library version string
|
2024-02-04 15:22:06 +07:00
|
|
|
*
|
|
|
|
* @return String
|
2024-02-04 15:04:38 +07:00
|
|
|
*/
|
2024-02-03 10:46:26 +07:00
|
|
|
String getVersion(void);
|
|
|
|
|
|
|
|
private:
|
|
|
|
BoardType boardType;
|
|
|
|
};
|
|
|
|
|
|
|
|
#endif /** _AIR_GRADIENT_H_ */
|