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

77 lines
3.6 KiB
C++

//******************************************************************************************
// File: PS_10kThermistor.cpp
// Authors: D. Johnson (_M2) based on the work of Dan G Ogorchock & Daniel J Ogorchock (Father and Son)
//
// Summary: PS_10kThermistor is a class which implements the Hubitat "Temperature Measurement" device capability.
// It inherits from the st::PollingSensor class. The current version uses an analog input to measure the
// value of a simple thermal resistor using another 10k resistor as a voltage divider.
//
// The last four arguments of the constructor are used as arguments to configure the resistance of the parts.
// The first number is the resistance of the thermistor. Second is R1. Third is the thermistor coefficient. Last is your preference of units.
// Create an instance of this class in your sketch's global variable section
// For Example: st::PS_10kThermistor sensor1(F("temperature1"), 120, 0, PIN_THERMISTOR, 10000, 10000, 3300, "F");
//
// st::PS_10kThermistor() constructor requires the following arguments
// - String &name - REQUIRED - the name of the object - must match the Groovy ST_Anything DeviceType tile name
// - 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
// - byte pin - REQUIRED - the Arduino Pin to be used as a digital output
// - int tl - OPTIONAL - resistance of the thermocouple at the nominal temperature (usually 25C, 77F)
// - int r1 - OPTIONAL - actual measured resistance of the voltage divider resistor
// - int BCOEFF - OPTIONAL - The beta coefficient of the thermistor (usually 3000-4000). Tweak this number to calibrate.
// - int tempNOM - OPTIONAL - The nominal temperature of the thermistor @10k (usually 25C, 77F).
// - int unit - OPTIONAL - Use the letter F for Farhenheit, C for Celsius
//
//
// TODO: Determine a method to persist the ST Cloud's Polling Interval data
//
// Change History:
//
// Date Who What
// ---- --- ----
// 2015-01-03 Dan & Daniel Original Creation
// 2017-08-30 Dan Ogorchock Modified comment section above to comply with new Parent/Child Device Handler requirements
// 2019-12-23 D. Johnson Created 10k_Thermistor using PS_Illuminance as example
//
//******************************************************************************************
#ifndef ST_PS_10KTHERMISTOR_H
#define ST_PS_10KTHERMISTOR_H
#include "PollingSensor.h"
namespace st
{
class PS_10kThermistor: public PollingSensor
{
private:
byte m_nAnalogInputPin;
float m_nSensorValue;
int thermResistance;
int r1Resistance;
int BetaCoeff;
int TEMPNOMINAL;
char UNIT;
public:
//constructor - called in your sketch's global variable declaration section
PS_10kThermistor(const __FlashStringHelper *name, unsigned int interval, int offset, byte analogInputPin, int t1=10000, int r1=10000, int BCOEFF=3300, int tempNom=25, char unit='F');
//destructor
virtual ~PS_10kThermistor();
//SmartThings Shield data handler (receives configuration data from ST - polling interval, and adjusts on the fly)
virtual void beSmart(const String &str);
//function to get data from sensor and queue results for transfer to ST Cloud
virtual void getData();
//gets
inline byte getPin() const {return m_nAnalogInputPin;}
inline byte getSensorValue() const {return m_nSensorValue;}
//sets
void setPin(byte pin);
};
}
#endif