97 lines
4.6 KiB
C
97 lines
4.6 KiB
C
|
//******************************************************************************************
|
||
|
|
// File: IS_DoorControl.h
|
||
|
|
// Authors: Dan G Ogorchock & Daniel J Ogorchock (Father and Son)
|
||
|
|
//
|
||
|
|
// Summary: IS_DoorControl is a class which implements the SmartThings "Door Control" device capability. It features
|
||
|
|
// an automatic-turn-off time delay for a relay to actuate a button press. This is useful for controlling
|
||
|
|
// a garage door. Use the input to monitor a magnetic door contact sensor. Use the output to control a relay to
|
||
|
|
// "press the garage door button" to open/close the garage door.
|
||
|
|
//
|
||
|
|
// It inherits from the st::InterruptSensor class and clones much from the st::Executor Class
|
||
|
|
//
|
||
|
|
// Create an instance of this class in your sketch's global variable section
|
||
|
|
// For Example: st::IS_DoorControl sensor3(F("doorControl1"), PIN_CONTACT_DOOR_1, LOW, true, PIN_RELAY_DOOR_1, LOW, true, 1000, 1000, true);
|
||
|
|
//
|
||
|
|
// st::IS_DoorControl() constructor requires the following arguments
|
||
|
|
// - String &name - REQUIRED - the name of the object - must match the Groovy ST_Anything DeviceType tile name
|
||
|
|
// - byte pinInput - 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 - REQUIRED - true == INTERNAL_PULLUP
|
||
|
|
// - byte pinOutput - REQUIRED - the Arduino Pin to be used as a digital output
|
||
|
|
// - bool startingState - REQUIRED - the value desired for the initial state of the switch. LOW = "off", HIGH = "on"
|
||
|
|
// - bool invertLogic - REQUIRED - determines whether the Arduino Digital Output should use inverted logic
|
||
|
|
// - long delayTime - REQUIRED - the number of milliseconds to keep the output on
|
||
|
|
// - long numReqCounts - OPTIONAL - number of counts before changing state of input (prevent false alarms)
|
||
|
|
// - bool useMomentary - OPTIONAL - use momentary output (true) or standard switch (false) (defaults to true)
|
||
|
|
//
|
||
|
|
// Change History:
|
||
|
|
//
|
||
|
|
// Date Who What
|
||
|
|
// ---- --- ----
|
||
|
|
// 2015-01-07 Dan Ogorchock Original Creation
|
||
|
|
// 2018-08-30 Dan Ogorchock Modified comment section above to comply with new Parent/Child Device Handler requirements
|
||
|
|
// 2018-11-07 Dan Ogorchock Added optional "numReqCounts" constructor argument/capability
|
||
|
|
// 2019-07-24 Dan Ogorchock Added parameter to use output as a simple switch instead of momentary output
|
||
|
|
//
|
||
|
|
//
|
||
|
|
//******************************************************************************************
|
||
|
|
|
||
|
|
#ifndef ST_IS_DOORCONTROL_H
|
||
|
|
#define ST_IS_DOORCONTROL_H
|
||
|
|
|
||
|
|
#include "InterruptSensor.h"
|
||
|
|
|
||
|
|
namespace st
|
||
|
|
{
|
||
|
|
class IS_DoorControl : public InterruptSensor
|
||
|
|
{
|
||
|
|
private:
|
||
|
|
//inherits everything necessary from parent InterruptSensor Class for the Contact Sensor
|
||
|
|
|
||
|
|
//following are for the digital output
|
||
|
|
bool m_bCurrentState; //HIGH or LOW
|
||
|
|
bool m_bInvertLogic; //determines whether the Arduino Digital Output should use inverted logic
|
||
|
|
bool m_bUseMomentary; //determines whether the output should be momentary or simple switch
|
||
|
|
byte m_nOutputPin; //Arduino Pin used as a Digital Output for the switch - often connected to a relay or an LED
|
||
|
|
unsigned long m_lDelayTime; //number of milliseconds to keep digital output active before automatically turning off
|
||
|
|
unsigned long m_lTimeTurnedOn; //time when the digital output was turned on
|
||
|
|
bool m_bTimerPending; //true if waiting on relay timer to expire
|
||
|
|
|
||
|
|
void writeStateToPin(); //function to update the Arduino Digital Output Pin
|
||
|
|
|
||
|
|
|
||
|
|
public:
|
||
|
|
//constructor - momentary output - called in your sketch's global variable declaration section
|
||
|
|
IS_DoorControl(const __FlashStringHelper *name, byte pinInput, bool iState, bool pullup, byte pinOutput, bool startingState, bool invertLogic, unsigned long delayTime, long numReqCounts = 0, bool useMomentary = true);
|
||
|
|
|
||
|
|
//destructor
|
||
|
|
virtual ~IS_DoorControl();
|
||
|
|
|
||
|
|
//initialization function
|
||
|
|
virtual void init();
|
||
|
|
|
||
|
|
//update function
|
||
|
|
void update();
|
||
|
|
|
||
|
|
//SmartThings Shield data handler (receives command to turn "on" or "off" the switch (digital output)
|
||
|
|
virtual void beSmart(const String &str);
|
||
|
|
|
||
|
|
//called periodically by Everything class to ensure ST Cloud is kept consistent with the state of the contact 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();
|
||
|
|
|
||
|
|
//gets
|
||
|
|
virtual byte getPin() const { return m_nOutputPin; }
|
||
|
|
|
||
|
|
//sets
|
||
|
|
virtual void setOutputPin(byte pin);
|
||
|
|
};
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
#endif
|