st-anything/lib/ST_Anything_AdafruitBMP280_TempPress/PS_AdafruitBMP280_TempPress.h
Gašper Dobrovoljc ec125f27db
IP Configuration
2023-03-11 15:11:03 +01:00

85 lines
4.3 KiB
C++

//******************************************************************************************
// File: PS_AdafruitBMP280_TempPress.h
// Authors: Dan G Ogorchock & Daniel J Ogorchock (Father and Son)
//
// Summary: PS_AdafruitBMP280_TempPress is a class which implements the "Temperature Measurement"
// and "PressureMewasurement" device capabilities.
// It inherits from the st::PollingSensor class. The current version uses I2C to measure the
// temperature and pressure from a BMP280 series sensor using the Adafruit_BMP280 library.
//
// Create an instance of this class in your sketch's global variable section
// For Example: st::PS_AdafruitBMP280_TempPress sensor2("BMP280_1", 60, 0, "temperature1", "pressure1", false, 100, 0x77);
//
// st::PS_AdafruitBMP280_TempPress() constructor requires the following arguments
// - String &name - REQUIRED - the name of the object - must be unique, but is not used for data transfer for this device
// - long interval - REQUIRED - the polling interval in seconds
// - long offset - REQUIRED - the polling interval offset in seconds - used to prevent all polling sensors from executing at the same time
// - String strTemp - REQUIRED - name of temperature sensor to send to ST Cloud (e.g."temperature1")
// - String strPressure - REQUIRED - name of pressure sensor to send to ST Cloud (e.g. "pressure1")
// - bool In_C - OPTIONAL - true = Report Celsius, false = Report Farenheit (Farentheit is the default)
// - byte filterConstant - OPTIONAL - Value from 5% to 100% to determine how much filtering/averaging is performed 100 = none (default), 5 = maximum
// - int address - OPTIONAL - I2C address of the sensor (defaults to 0x77 for the BMP280)
//
// Filtering/Averaging
//
// Filtering the value sent to ST is performed per the following equation
//
// filteredValue = (filterConstant/100 * currentValue) + ((1 - filterConstant/100) * filteredValue)
//
// This class supports receiving configuration data from the SmartThings cloud via the ST App. A user preference
// can be configured in your phone's ST App, and then the "Configure" tile will send the data for all sensors to
// the ST Shield. For PollingSensors, this data is handled in the beSMart() function.
//
// TODO: Determine a method to persist the ST Cloud's Polling Interval data
//
// Change History:
//
// Date Who What
// ---- --- ----
// 2018-07-01 Dan & Daniel Original Creation
//
//******************************************************************************************
#ifndef ST_PS_AdafruitBMP280_TempPress_H
#define ST_PS_AdafruitBMP280_TempPress_H
#include "PollingSensor.h"
#include <Adafruit_BMP280.h>
namespace st
{
class PS_AdafruitBMP280_TempPress: public PollingSensor
{
private:
int m_nAddress; //I2C Address of the sensor
float m_fTemperatureSensorValue;//current Temperature value
float m_fPressureSensorValue; //current Pressure Value
Adafruit_BMP280 bmp; //I2C BMP280 library object
String m_strTemperature; //name of temparature sensor to use when transferring data to ST Cloud / Hubitat
String m_strPressure; //name of pressure sensor to use when transferring data to ST Cloud / Hubitat
bool m_In_C; //Return temp in C (true or false)
float m_fFilterConstant; //Filter constant % as floating point from 0.00 to 1.00
public:
//constructor - called in your sketch's global variable declaration section
PS_AdafruitBMP280_TempPress(const __FlashStringHelper *name, unsigned int interval, int offset, String strTemp = "temperature1", String strPressure = "pressure1", bool In_C = false, byte filterConstant = 100, int address = 0x77);
//destructor
virtual ~PS_AdafruitBMP280_TempPress();
//SmartThings Shield data handler (receives configuration data from ST - polling interval, and adjusts on the fly)
virtual void beSmart(const String &str);
//initialization routine
virtual void init();
//function to get data from sensor and queue results for transfer to ST Cloud
virtual void getData();
//gets
inline float getTemperatureSensorValue() const { return m_fTemperatureSensorValue; }
inline float getPressureSensorValue() const { return m_fPressureSensorValue; }
};
}
#endif