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

63 lines
2.2 KiB
C++

//******************************************************************************************
// File: IS_Water.h
// Authors: Dan G Ogorchock & Daniel J Ogorchock (Father and Son)
//
// Summary: IS_Water is a class which implements the Hubitat "Water Sensor" device capability.
// It inherits from the st::InterruptSensor class.
//
// Create an instance of this class in your sketch's global variable section
// For Example: st::IS_Water sensor6(F("water1"), PIN_WATER, HIGH, true, 500);
//
// st::IS_Water() constructor requires the following arguments
// - String &name - REQUIRED - the name of the object - must match the Groovy ST_Anything DeviceType tile name
// - byte pin - REQUIRED - the Arduino Pin to be used as a digital input
// - bool iState - REQUIRED - LOW or HIGH - determines which value indicates the interrupt is true
// - bool internalPullup - OPTIONAL - true == INTERNAL_PULLUP
// - long numReqCounts - OPTIONAL - number of counts before changing state of input (prevent false alarms)
//
// Change History:
//
// Date Who What
// ---- --- ----
// 2020-06-30 Dan Ogorchock Original Creation
//
//
//******************************************************************************************
#ifndef ST_IS_WATER_H
#define ST_IS_WATER_H
#include "InterruptSensor.h"
namespace st
{
class IS_Water: public InterruptSensor
{
private:
//inherits everything necessary from parent InterruptSensor Class
public:
//constructor - called in your sketch's global variable declaration section
IS_Water(const __FlashStringHelper *name, byte pin, bool iState, bool internalPullup = false, long numReqCounts = 0); //(defaults to NOT using internal pullup resistors, and required counts = 0)
//destructor
virtual ~IS_Water();
//initialization function
virtual void init();
//called periodically by Everything class to ensure the Hub is kept consistent with the state of the water sensor
virtual void refresh();
//handles what to do when interrupt is triggered
virtual void runInterrupt();
//handles what to do when interrupt is ended
virtual void runInterruptEnded();
};
}
#endif