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

151 lines
3.8 KiB
C++

//******************************************************************************************
// File: InterruptSensor.cpp
// Authors: Dan G Ogorchock & Daniel J Ogorchock (Father and Son)
//
// Summary: st::InterruptSensor is a generic class which inherits from st::Sensor. This is the
// parent class for the st::IS_Motion, IS_Contact, and IS_DoorControl classes.
// In general, this file should not need to be modified.
//
// Change History:
//
// Date Who What
// ---- --- ----
// 2015-01-03 Dan & Daniel Original Creation
// 2015-03-17 Dan Added optional "numReqCounts" constructor argument/capability
// 2019-09-22 Dan Ogorchock ESP8266 support for using A0 pin as a digital input
//
//
//******************************************************************************************
#include "InterruptSensor.h"
#include "Constants.h"
#include "Everything.h"
namespace st
{
//private
//Checks to see if the pin has changed state. If so calls appropriate function.
void InterruptSensor::checkIfTriggered()
{
bool inputState;
#if defined(ARDUINO_ARCH_ESP8266)
if (m_nInterruptPin == A0)
{
if (m_nLoopCounter == 1000) { //reading an analog input every pass through loop() is too slow
inputState = analogRead(A0) > 512 ? HIGH : LOW;
m_nLoopCounter = 0;
}
else {
m_nLoopCounter++;
return;
}
}
else {
inputState = digitalRead(m_nInterruptPin);
}
#else
inputState = digitalRead(m_nInterruptPin);
#endif
if (inputState == m_bInterruptState && !m_bStatus) //new interrupt
{
m_nCurrentDownCount = m_nRequiredCounts;
m_nCurrentUpCount++;
if (m_nCurrentUpCount >= m_nRequiredCounts)
{
m_bStatus = true;
m_bInitRequired = false;
runInterrupt();
}
}
else if ((inputState != m_bInterruptState && m_bStatus) || m_bInitRequired) //interrupt has ended OR Init called us
{
m_nCurrentUpCount = 0;
m_nCurrentDownCount--;
if (m_nCurrentDownCount <= 0)
{
m_bStatus = false;
m_bInitRequired = false;
runInterruptEnded();
}
}
}
//public
//constructor
InterruptSensor::InterruptSensor(const __FlashStringHelper *name, byte pin, bool iState, bool pullup, long numReqCounts) :
Sensor(name),
m_bInterruptState(iState),
m_bStatus(false),
m_bPullup(pullup),
m_bInitRequired(true),
m_nRequiredCounts(numReqCounts),
m_nCurrentUpCount(0),
m_nCurrentDownCount(numReqCounts),
m_nLoopCounter(0)
{
setInterruptPin(pin);
}
//destructor
InterruptSensor::~InterruptSensor()
{
}
//initialization function
void InterruptSensor::init()
{
checkIfTriggered();
}
//update function
void InterruptSensor::update()
{
checkIfTriggered();
}
//handles start of an interrupt - all derived classes should implement this virtual function
void InterruptSensor::runInterrupt()
{
if(debug)
{
Everything::sendSmartString(getName()+F(" triggered ") + (m_bInterruptState?F("HIGH"):F("LOW)")));
}
}
//handles the end of an interrupt - all derived classes should implement this virtual function
void InterruptSensor::runInterruptEnded()
{
if(debug)
{
Everything::sendSmartString(getName()+F(" ended ") + (m_bInterruptState?F("LOW)"):F("HIGH)")));
}
}
//sets the pin to be monitored, and set the Arduino pinMode based on constructor data
void InterruptSensor::setInterruptPin(byte pin)
{
m_nInterruptPin=pin;
#if defined(ARDUINO_ARCH_ESP8266)
if (pin == A0)
{
pinMode(m_nInterruptPin, INPUT);
return;
}
#endif
if(!m_bPullup)
{
pinMode(m_nInterruptPin, INPUT);
}
else
{
pinMode(m_nInterruptPin, INPUT_PULLUP);
}
}
//debug flag to determine if debug print statements are executed (set value in your sketch)
bool InterruptSensor::debug=false;
}