IP Configuration
This commit is contained in:
Gašper Dobrovoljc
200
lib/ST_Anything_MCP23008/S_TimedRelay_MCP.cpp
Normal file
200
lib/ST_Anything_MCP23008/S_TimedRelay_MCP.cpp
Normal file
@@ -0,0 +1,200 @@
|
||||
//******************************************************************************************
|
||||
// File: S_TimedRelay_MCP.cpp
|
||||
// Authors: Dan G Ogorchock
|
||||
//
|
||||
// Summary: S_TimedRelay_MCP is a class which implements the SmartThings "Relay" device capability. It features
|
||||
// an automatic-turn-off time delay for a relay to emulate a button press.
|
||||
//
|
||||
// It inherits from the st::Sensor 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::S_TimedRelay_MCP sensor1(F("relaySwitch1"), PIN_RELAY, LOW, true, 1000, 0, 1, 0);
|
||||
//
|
||||
// st::S_TimedRelay_MCP() constructor requires the following arguments
|
||||
// - String &name - REQUIRED - the name of the object - must match the Groovy ST_Anything DeviceType tile name
|
||||
// - 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 Ouput should use inverted logic
|
||||
// - long onTime - REQUIRED - the number of milliseconds to keep the output on, DEFGAULTS to 1000 milliseconds
|
||||
// - long offTime - OPTIONAL - the number of milliseconds to keep the output off, DEFAULTS to 0
|
||||
// - int numCycles - OPTIONAL - the number of times to repeat the on/off cycle, DEFAULTS to 1
|
||||
// - byte finalState - OPTIONAL - leave in X state after finishing sequence 0 = off, 1 = on , Defaults to 0
|
||||
//
|
||||
// Change History:
|
||||
//
|
||||
// Date Who What
|
||||
// ---- --- ----
|
||||
// 2015-12-29 Dan Ogorchock Original Creation
|
||||
// 2018-08-30 Dan Ogorchock Modified comment section above to comply with new Parent/Child Device Handler requirements
|
||||
// 2019-06-23 Brian Wilson Added finalState option
|
||||
// 2020-08-17 M2_ Modified for MCP23008. Changed digitalwrite to Adafruit_MCP23008.write, and pinMode to Adafruit_MCP23008.pinMode. That's it!
|
||||
//
|
||||
//******************************************************************************************
|
||||
|
||||
#include "S_TimedRelay_MCP.h"
|
||||
|
||||
#include "Constants.h"
|
||||
#include "Everything.h"
|
||||
#include <Adafruit_MCP23008.h>
|
||||
namespace st
|
||||
{
|
||||
//private
|
||||
void S_TimedRelay_MCP::writeStateToPin()
|
||||
{
|
||||
Adafruit_MCP23008().digitalWrite(m_nOutputPin, m_bInvertLogic ? !m_bCurrentState : m_bCurrentState);
|
||||
}
|
||||
|
||||
//public
|
||||
//constructor
|
||||
S_TimedRelay_MCP::S_TimedRelay_MCP(const __FlashStringHelper *name, byte pinOutput, bool startingState, bool invertLogic, unsigned long onTime, unsigned long offTime, unsigned int numCycles, byte finalState) :
|
||||
Sensor(name),
|
||||
m_bCurrentState(startingState),
|
||||
m_bInvertLogic(invertLogic),
|
||||
m_lOnTime(onTime),
|
||||
m_lOffTime(offTime),
|
||||
m_iNumCycles(numCycles),
|
||||
m_iCurrentCount(numCycles),
|
||||
m_nfinalState(finalState),
|
||||
m_lTimeChanged(0),
|
||||
m_bTimerPending(false)
|
||||
{
|
||||
setOutputPin(pinOutput);
|
||||
|
||||
if (numCycles < 1)
|
||||
{
|
||||
m_iNumCycles = 1;
|
||||
m_iCurrentCount = 1;
|
||||
|
||||
Serial.println(F("S_TimedRelay_MCP:: INVALID Number of Cycles Requested! Must be at least 1. Setting to 1."));
|
||||
}
|
||||
}
|
||||
|
||||
//destructor
|
||||
S_TimedRelay_MCP::~S_TimedRelay_MCP()
|
||||
{
|
||||
}
|
||||
|
||||
void S_TimedRelay_MCP::init()
|
||||
{
|
||||
Everything::sendSmartString(getName() + " " + (m_bCurrentState == HIGH ? F("on") : F("off")));
|
||||
}
|
||||
|
||||
//update function
|
||||
void S_TimedRelay_MCP::update()
|
||||
{
|
||||
if (m_iCurrentCount < m_iNumCycles)
|
||||
{
|
||||
//Turn off digital output if timer has expired
|
||||
if ((m_bCurrentState == HIGH) && (millis() - m_lTimeChanged >= m_lOnTime))
|
||||
{
|
||||
if (m_nfinalState == 1) { // final state will be on
|
||||
//add one to the current count since we finished an on/off cycle, and turn on output if needed
|
||||
m_iCurrentCount++;
|
||||
if (m_iCurrentCount < m_iNumCycles)
|
||||
{
|
||||
m_bCurrentState = LOW;
|
||||
writeStateToPin();
|
||||
m_lTimeChanged = millis();
|
||||
}
|
||||
|
||||
} else {
|
||||
m_bCurrentState = LOW;
|
||||
writeStateToPin();
|
||||
m_lTimeChanged = millis();
|
||||
}
|
||||
}
|
||||
else if ((m_bCurrentState == LOW) && (millis() - m_lTimeChanged >= m_lOffTime))
|
||||
{
|
||||
if (m_nfinalState == 0) { // final state will be off
|
||||
//add one to the current count since we finished an on/off cycle, and turn on output if needed
|
||||
m_iCurrentCount++;
|
||||
if (m_iCurrentCount < m_iNumCycles)
|
||||
{
|
||||
m_bCurrentState = HIGH;
|
||||
writeStateToPin();
|
||||
m_lTimeChanged = millis();
|
||||
}
|
||||
} else {
|
||||
m_bCurrentState = HIGH;
|
||||
writeStateToPin();
|
||||
m_lTimeChanged = millis();
|
||||
}
|
||||
}
|
||||
|
||||
//Check to see if we just finished the requested number of cycles
|
||||
if (m_iCurrentCount == m_iNumCycles)
|
||||
{
|
||||
//Decrement number of active timers
|
||||
if (st::Everything::bTimersPending > 0) st::Everything::bTimersPending--;
|
||||
m_bTimerPending = false;
|
||||
|
||||
//Queue the relay status update the ST Cloud
|
||||
Everything::sendSmartString(getName() + " " + (m_bCurrentState == HIGH ? F("on") : F("off")));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
void S_TimedRelay_MCP::beSmart(const String &str)
|
||||
{
|
||||
String s = str.substring(str.indexOf(' ') + 1);
|
||||
if (st::Device::debug) {
|
||||
Serial.print(F("S_TimedRelay_MCP::beSmart s = "));
|
||||
Serial.println(s);
|
||||
}
|
||||
if ((s == F("on")) && (m_bCurrentState == LOW))
|
||||
{
|
||||
m_bCurrentState = HIGH;
|
||||
|
||||
//Save time turned on
|
||||
m_lTimeChanged = millis();
|
||||
|
||||
//Increment number of active timers
|
||||
if (!m_bTimerPending)
|
||||
{
|
||||
st::Everything::bTimersPending++;
|
||||
m_bTimerPending = true;
|
||||
}
|
||||
//Queue the relay status update the ST Cloud
|
||||
Everything::sendSmartString(getName() + " " + (m_bCurrentState == HIGH ? F("on") : F("off")));
|
||||
|
||||
//Set the initial count to zero
|
||||
m_iCurrentCount = 0;
|
||||
|
||||
//update the digital output
|
||||
writeStateToPin();
|
||||
}
|
||||
else if ((s == F("off")) && (m_bCurrentState == HIGH))
|
||||
{
|
||||
m_bCurrentState = LOW;
|
||||
|
||||
//Decrement number of active timers
|
||||
if (st::Everything::bTimersPending > 0) st::Everything::bTimersPending--;
|
||||
m_bTimerPending = false;
|
||||
|
||||
//Queue the relay status update the ST Cloud
|
||||
Everything::sendSmartString(getName() + " " + (m_bCurrentState == HIGH ? F("on") : F("off")));
|
||||
|
||||
//Reset the count to the number of required cycles to prevent Update() routine from running if someone sends an OFF command
|
||||
m_iCurrentCount = m_iNumCycles;
|
||||
|
||||
//update the digital output
|
||||
writeStateToPin();
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
//called periodically by Everything class to ensure ST Cloud is kept consistent with the state of the contact sensor
|
||||
void S_TimedRelay_MCP::refresh()
|
||||
{
|
||||
//Queue the relay status update the ST Cloud
|
||||
Everything::sendSmartString(getName() + " " + (m_bCurrentState == HIGH ? F("on") : F("off")));
|
||||
}
|
||||
|
||||
void S_TimedRelay_MCP::setOutputPin(byte pin)
|
||||
{
|
||||
m_nOutputPin = pin;
|
||||
Adafruit_MCP23008().pinMode(m_nOutputPin, OUTPUT);
|
||||
writeStateToPin();
|
||||
}
|
||||
|
||||
}
|
||||
90
lib/ST_Anything_MCP23008/S_TimedRelay_MCP.h
Normal file
90
lib/ST_Anything_MCP23008/S_TimedRelay_MCP.h
Normal file
@@ -0,0 +1,90 @@
|
||||
//******************************************************************************************
|
||||
// File: S_TimedRelay_MCP.h
|
||||
// Authors: Dan G Ogorchock
|
||||
//
|
||||
// Summary: S_TimedRelay_MCP is a class which implements the SmartThings "Relay" device capability. It features
|
||||
// an automatic-turn-off time delay for a relay to emulate a button press.
|
||||
//
|
||||
// It inherits from the st::Sensor 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::S_TimedRelay_MCP sensor1(F("relaySwitch1"), PIN_RELAY, LOW, true, 1000, 0, 1, 0);
|
||||
//
|
||||
// st::S_TimedRelay_MCP() constructor requires the following arguments
|
||||
// - String &name - REQUIRED - the name of the object - must match the Groovy ST_Anything DeviceType tile name
|
||||
// - 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 Ouput should use inverted logic
|
||||
// - long onTime - REQUIRED - the number of milliseconds to keep the output on, DEFGAULTS to 1000 milliseconds
|
||||
// - long offTime - OPTIONAL - the number of milliseconds to keep the output off, DEFAULTS to 0
|
||||
// - int numCycles - OPTIONAL - the number of times to repeat the on/off cycle, DEFAULTS to 1
|
||||
// - byte finalState - OPTIONAL - leave in X state after finishing sequence 0 = off, 1 = on , Defaults to 0
|
||||
//
|
||||
// Change History:
|
||||
//
|
||||
// Date Who What
|
||||
// ---- --- ----
|
||||
// 2015-12-29 Dan Ogorchock Original Creation
|
||||
// 2018-08-30 Dan Ogorchock Modified comment section above to comply with new Parent/Child Device Handler requirements
|
||||
// 2019-06-23 Brian Wilson Added finalState option
|
||||
// 2019-08-10 Dan Ogorchock Added public getStatus()
|
||||
// 2020-08-17 M2_ Modified for MCP23008. Only change was file name and class name.
|
||||
//
|
||||
//******************************************************************************************
|
||||
|
||||
#ifndef ST_S_TIMEDRELAY_MCP_H
|
||||
#define ST_S_TIMEDRELAY_MCP_H
|
||||
|
||||
#include "Sensor.h"
|
||||
|
||||
namespace st
|
||||
{
|
||||
class S_TimedRelay_MCP : public Sensor //inherits from parent Sensor Class
|
||||
{
|
||||
private:
|
||||
|
||||
//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
|
||||
byte m_nOutputPin; //Arduino Pin used as a Digital Output for the switch - often connected to a relay or an LED
|
||||
unsigned long m_lOnTime; //number of milliseconds to keep digital output HIGH before automatically turning off
|
||||
unsigned long m_lOffTime; //number of milliseconds to keep digital output LOW before automatically turning on
|
||||
unsigned int m_iNumCycles; //number of on/off cycles of the digital output
|
||||
unsigned int m_iCurrentCount; //current number of on/off cycles of the digital output
|
||||
byte m_nfinalState; //desired final state of the output after the cycling has completed (typical value is 0)
|
||||
unsigned long m_lTimeChanged; //time when the digital output was last changed
|
||||
bool m_bTimerPending; //true if waiting on relay timer to expire
|
||||
|
||||
void writeStateToPin(); //function to update the Arduino Digital Output Pin
|
||||
|
||||
public:
|
||||
//constructor - called in your sketch's global variable declaration section
|
||||
S_TimedRelay_MCP(const __FlashStringHelper *name, byte pinOutput, bool startingState = LOW, bool invertLogic = false, unsigned long onTime = 1000, unsigned long offTime = 0, unsigned int numCycles = 1, byte finalState = 0);
|
||||
|
||||
//destructor
|
||||
virtual ~S_TimedRelay_MCP();
|
||||
|
||||
//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();
|
||||
|
||||
//gets
|
||||
virtual byte getPin() const { return m_nOutputPin; }
|
||||
virtual bool getTimerActive() const { return m_bTimerPending; }
|
||||
virtual bool getStatus() const { return m_bCurrentState; }
|
||||
|
||||
//sets
|
||||
virtual void setOutputPin(byte pin);
|
||||
};
|
||||
}
|
||||
|
||||
|
||||
#endif
|
||||
Reference in New Issue
Block a user