st-anything/lib/ST_Anything/PollingSensor.h

74 lines
2.5 KiB
C
Raw Normal View History

2023-03-11 14:11:03 +00:00
//******************************************************************************************
// File: PollingSensor.cpp
// Authors: Dan G Ogorchock & Daniel J Ogorchock (Father and Son)
//
// Summary: st::PollingSensor is a generic class which inherits from st::Sensor. This is the
// parent class for the st::PS_Illuminace, st::PS_Water, and PS_TemperatureHumidity classes.
//
// In general, this file should not need to be modified.
//
// st::PollingSensor() 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
//
// Change History:
//
// Date Who What
// ---- --- ----
// 2015-01-03 Dan & Daniel Original Creation
//
//
//******************************************************************************************
#ifndef ST_POLLINGSENSOR_H
#define ST_POLLINGSENSOR_H
#include "Sensor.h"
namespace st
{
class PollingSensor: public Sensor
{
private:
unsigned long m_nPreviousTime; //in milliseconds - time of last poll
long m_nDeltaTime; //in milliseconds - elapsed time since last poll
long m_nInterval; //in milliseconds - polling interval for the sensor
long m_nOffset; //in milliseconds - offset to prevent all Polling sensors from running at the same time
virtual bool checkInterval(); //returns true and resets m_nDeltaTime if m_nInterval has been reached
public:
//constructor
PollingSensor(const __FlashStringHelper *name, long interval, long offset=0);
//destructor
virtual ~PollingSensor();
//initialization function
virtual void init();
//called periodically by Everything class to ensure ST Cloud is kept consistent with the state of each Device subclass object
virtual void refresh();
//update function
virtual void update();
//function to get data from sensor and queue results for transfer to ST Cloud
virtual void getData();
//gets
virtual void offset(long os) {m_nOffset=os;} //offset the delta time from its current value
//sets
virtual void setInterval(long interval) {m_nInterval=interval;}
//debug flag to determine if debug print statements are executed (set value in your sketch)
static bool debug;
};
}
#endif