//****************************************************************************************** // File: IS_Presence.h // Authors: Dan G Ogorchock & Daniel J Ogorchock (Father and Son) // // Summary: IS_Presence is a class which implements the SmartThings "Presence 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_Presence sensor1(F("presence1"), PIN_PRESENCE, LOW, true, 5000); // // st::IS_Presence() 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 // ---- --- ---- // 2019-10-12 Dan Ogorchock Original Creation // // //****************************************************************************************** #ifndef ST_IS_PRESENCE_H #define ST_IS_PRESENCE_H #include "InterruptSensor.h" namespace st { class IS_Presence: public InterruptSensor { private: //inherits everything necessary from parent InterruptSensor Class public: //constructor - called in your sketch's global variable declaration section IS_Presence(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_Presence(); //initialization function virtual void init(); //called periodically by Everything class to ensure ST Cloud is kept consistent with the state of the presence 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