From 4af7a079d8111f3edadb684e60cacb254112958d Mon Sep 17 00:00:00 2001 From: "J. Nick Koston" Date: Mon, 5 Jun 2023 12:13:01 -0500 Subject: [PATCH] wip --- components/ratgdo/__init__.py | 17 +- components/ratgdo/ratgdo.cpp | 761 +++++++++++++++-------------- components/ratgdo/ratgdo.h | 94 ++-- components/ratgdo/rolling_code.cpp | 156 +++--- components/ratgdo/rolling_code.h | 16 +- 5 files changed, 543 insertions(+), 501 deletions(-) diff --git a/components/ratgdo/__init__.py b/components/ratgdo/__init__.py index d00826b..b823b12 100644 --- a/components/ratgdo/__init__.py +++ b/components/ratgdo/__init__.py @@ -1,16 +1,7 @@ -import esphome.codegen as cg -import esphome.config_validation as cv -from esphome.core import coroutine_with_priority +import esphome.codegen as cg import esphome.config_validation as cv from esphome.core import coroutine_with_priority -ratgdo_ns = cg.esphome_ns.namespace("ratgdo") + ratgdo_ns = cg.esphome_ns.namespace("ratgdo") -CONFIG_SCHEMA = cv.All( - cv.Schema({}), -) + CONFIG_SCHEMA = cv.All(cv.Schema({}), ) - -@coroutine_with_priority(1.0) -async def to_code(config): - cg.add_library("bblanchon/ArduinoJson", "6.18.5") - cg.add_define("USE_JSON") - cg.add_global(ratgdo_ns.using) + @coroutine_with_priority(1.0) async def to_code(config) :cg.add_library("bblanchon/ArduinoJson", "6.18.5") cg.add_define("USE_JSON") cg.add_global(ratgdo_ns.using) diff --git a/components/ratgdo/ratgdo.cpp b/components/ratgdo/ratgdo.cpp index 95b147c..65c0ed9 100644 --- a/components/ratgdo/ratgdo.cpp +++ b/components/ratgdo/ratgdo.cpp @@ -11,488 +11,507 @@ * GNU GENERAL PUBLIC LICENSE ************************************/ -#include "common.h" #include "ratgdo.h" +#include "common.h" #include "esphome/core/log.h" -namespace esphome -{ - namespace ratgdo - { +namespace esphome { +namespace ratgdo { - static const char *const TAG = "ratgdo"; +static const char *const TAG = "ratgdo"; - void RATGDOComponent::setup() - { - pinMode(TRIGGER_OPEN, INPUT_PULLUP); - pinMode(TRIGGER_CLOSE, INPUT_PULLUP); - pinMode(TRIGGER_LIGHT, INPUT_PULLUP); - pinMode(STATUS_DOOR, OUTPUT); - pinMode(STATUS_OBST, OUTPUT); - pinMode(INPUT_RPM1, INPUT_PULLUP); // set to pullup to add support for reed switches - pinMode(INPUT_RPM2, INPUT_PULLUP); // make sure pin doesn't float when using reed switch and fire interrupt by mistake - pinMode(INPUT_OBST, INPUT); +void RATGDOComponent::setup() { + pinMode(TRIGGER_OPEN, INPUT_PULLUP); + pinMode(TRIGGER_CLOSE, INPUT_PULLUP); + pinMode(TRIGGER_LIGHT, INPUT_PULLUP); + pinMode(STATUS_DOOR, OUTPUT); + pinMode(STATUS_OBST, OUTPUT); + pinMode(INPUT_RPM1, + INPUT_PULLUP); // set to pullup to add support for reed switches + pinMode(INPUT_RPM2, + INPUT_PULLUP); // make sure pin doesn't float when using reed switch + // and fire interrupt by mistake + pinMode(INPUT_OBST, INPUT); - attachInterrupt(TRIGGER_OPEN,isrDoorOpen,CHANGE); - attachInterrupt(TRIGGER_CLOSE,isrDoorClose,CHANGE); - attachInterrupt(TRIGGER_LIGHT,isrLight,CHANGE); - attachInterrupt(INPUT_OBST,isrObstruction,CHANGE); - attachInterrupt(INPUT_RPM1,isrRPM1,RISING); - attachInterrupt(INPUT_RPM2,isrRPM2,RISING); + attachInterrupt(TRIGGER_OPEN, isrDoorOpen, CHANGE); + attachInterrupt(TRIGGER_CLOSE, isrDoorClose, CHANGE); + attachInterrupt(TRIGGER_LIGHT, isrLight, CHANGE); + attachInterrupt(INPUT_OBST, isrObstruction, CHANGE); + attachInterrupt(INPUT_RPM1, isrRPM1, RISING); + attachInterrupt(INPUT_RPM2, isrRPM2, RISING); - LittleFS.begin(); + LittleFS.begin(); - readCounterFromFlash(); + readCounterFromFlash(); - if(useRollingCodes){ - //if(rollingCodeCounter == 0) rollingCodeCounter = 1; + if (useRollingCodes) { + // if(rollingCodeCounter == 0) rollingCodeCounter = 1; - ESP_LOGD(TAG, "Syncing rolling code counter after reboot..."); - sync(); // if rolling codes are being used (rolling code counter > 0), send reboot/sync to the opener on startup - }else{ - ESP_LOGD(TAG, "Rolling codes are disabled."); - } - } + ESP_LOGD(TAG, "Syncing rolling code counter after reboot..."); + sync(); // if rolling codes are being used (rolling code counter > 0), send + // reboot/sync to the opener on startup + } else { + ESP_LOGD(TAG, "Rolling codes are disabled."); + } +} - void RATGDOComponent::loop(){ - obstructionLoop(); - doorStateLoop(); - dryContactLoop(); - } +void RATGDOComponent::loop() { + obstructionLoop(); + doorStateLoop(); + dryContactLoop(); +} - - } // namespace ratgdo +} // namespace ratgdo } // namespace esphome +/*************************** DETECTING THE DOOR STATE + * ***************************/ +void doorStateLoop() { + static bool rotaryEncoderDetected = false; + static int lastDoorPositionCounter = 0; + static int lastDirectionChangeCounter = 0; + static int lastCounterMillis = 0; + // Handle reed switch + // This may need to be debounced, but so far in testing I haven't detected any + // bounces + if (!rotaryEncoderDetected) { + if (digitalRead(INPUT_RPM1) == LOW) { + if (doorState != "reed_closed") { + ESP_LOGD(TAG, "Reed switch closed"); + doorState = "reed_closed"; + if (isConfigFileOk) { + bootstrapManager.publish(overallStatusTopic.c_str(), "reed_closed", + true); + bootstrapManager.publish(doorStatusTopic.c_str(), "reed_closed", + true); + } + digitalWrite(STATUS_DOOR, HIGH); + } + } else if (doorState != "reed_open") { + ESP_LOGD(TAG, "Reed switch open"); + doorState = "reed_open"; + if (isConfigFileOk) { + bootstrapManager.publish(overallStatusTopic.c_str(), "reed_open", true); + bootstrapManager.publish(doorStatusTopic.c_str(), "reed_open", true); + } + digitalWrite(STATUS_DOOR, LOW); + } + } + // end reed switch handling -/*************************** DETECTING THE DOOR STATE ***************************/ -void doorStateLoop(){ - static bool rotaryEncoderDetected = false; - static int lastDoorPositionCounter = 0; - static int lastDirectionChangeCounter = 0; - static int lastCounterMillis = 0; + // If the previous and the current state of the RPM2 Signal are different, + // that means there is a rotary encoder detected and the door is moving + if (doorPositionCounter != lastDoorPositionCounter) { + rotaryEncoderDetected = true; // this disables the reed switch handler + lastCounterMillis = millis(); - // Handle reed switch - // This may need to be debounced, but so far in testing I haven't detected any bounces - if(!rotaryEncoderDetected){ - if(digitalRead(INPUT_RPM1) == LOW){ - if(doorState != "reed_closed"){ - ESP_LOGD(TAG, "Reed switch closed"); - doorState = "reed_closed"; - if(isConfigFileOk){ - bootstrapManager.publish(overallStatusTopic.c_str(), "reed_closed", true); - bootstrapManager.publish(doorStatusTopic.c_str(), "reed_closed", true); - } - digitalWrite(STATUS_DOOR,HIGH); - } - }else if(doorState != "reed_open"){ - ESP_LOGD(TAG, "Reed switch open"); - doorState = "reed_open"; - if(isConfigFileOk){ - bootstrapManager.publish(overallStatusTopic.c_str(), "reed_open", true); - bootstrapManager.publish(doorStatusTopic.c_str(), "reed_open", true); - } - digitalWrite(STATUS_DOOR,LOW); - } - } - // end reed switch handling + ESP_LOGD(TAG, "Door Position: %d", doorPositionCounter); + } - // If the previous and the current state of the RPM2 Signal are different, that means there is a rotary encoder detected and the door is moving - if(doorPositionCounter != lastDoorPositionCounter){ - rotaryEncoderDetected = true; // this disables the reed switch handler - lastCounterMillis = millis(); + // Wait 5 pulses before updating to door opening status + if (doorPositionCounter - lastDirectionChangeCounter > 5) { + if (doorState != "opening") { + ESP_LOGD(TAG, "Door Opening..."); + if (isConfigFileOk) { + bootstrapManager.publish(overallStatusTopic.c_str(), "opening", true); + bootstrapManager.publish(doorStatusTopic.c_str(), "opening", true); + } + } + lastDirectionChangeCounter = doorPositionCounter; + doorState = "opening"; + } - ESP_LOGD(TAG, "Door Position: %d", doorPositionCounter); - } + if (lastDirectionChangeCounter - doorPositionCounter > 5) { + if (doorState != "closing") { + ESP_LOGD(TAG, "Door Closing..."); + if (isConfigFileOk) { + bootstrapManager.publish(overallStatusTopic.c_str(), "closing", true); + bootstrapManager.publish(doorStatusTopic.c_str(), "closing", true); + } + } + lastDirectionChangeCounter = doorPositionCounter; + doorState = "closing"; + } - // Wait 5 pulses before updating to door opening status - if(doorPositionCounter - lastDirectionChangeCounter > 5){ - if(doorState != "opening"){ - ESP_LOGD(TAG,"Door Opening..."); - if(isConfigFileOk){ - bootstrapManager.publish(overallStatusTopic.c_str(), "opening", true); - bootstrapManager.publish(doorStatusTopic.c_str(), "opening", true); - } - } - lastDirectionChangeCounter = doorPositionCounter; - doorState = "opening"; - } + // 250 millis after the last rotary encoder pulse, the door is stopped + if (millis() - lastCounterMillis > 250) { + // if the door was closing, and is now stopped, then the door is closed + if (doorState == "closing") { + doorState = "closed"; + ESP_LOGD(TAG, "Closed"); + if (isConfigFileOk) { + bootstrapManager.publish(overallStatusTopic.c_str(), doorState.c_str(), + true); + bootstrapManager.publish(doorStatusTopic.c_str(), doorState.c_str(), + true); + } + digitalWrite(STATUS_DOOR, LOW); + } - if(lastDirectionChangeCounter - doorPositionCounter > 5){ - if(doorState != "closing"){ - ESP_LOGD(TAG,"Door Closing..."); - if(isConfigFileOk){ - bootstrapManager.publish(overallStatusTopic.c_str(), "closing", true); - bootstrapManager.publish(doorStatusTopic.c_str(), "closing", true); - } - } - lastDirectionChangeCounter = doorPositionCounter; - doorState = "closing"; - } + // if the door was opening, and is now stopped, then the door is open + if (doorState == "opening") { + doorState = "open"; + ESP_LOGD(TAG, "Open"); + if (isConfigFileOk) { + bootstrapManager.publish(overallStatusTopic.c_str(), doorState.c_str(), + true); + bootstrapManager.publish(doorStatusTopic.c_str(), doorState.c_str(), + true); + } + digitalWrite(STATUS_DOOR, HIGH); + } + } - // 250 millis after the last rotary encoder pulse, the door is stopped - if(millis() - lastCounterMillis > 250){ - // if the door was closing, and is now stopped, then the door is closed - if(doorState == "closing"){ - doorState = "closed"; - ESP_LOGD(TAG,"Closed"); - if(isConfigFileOk){ - bootstrapManager.publish(overallStatusTopic.c_str(), doorState.c_str(), true); - bootstrapManager.publish(doorStatusTopic.c_str(), doorState.c_str(), true); - } - digitalWrite(STATUS_DOOR,LOW); - } - - // if the door was opening, and is now stopped, then the door is open - if(doorState == "opening"){ - doorState = "open"; - ESP_LOGD(TAG,"Open"); - if(isConfigFileOk){ - bootstrapManager.publish(overallStatusTopic.c_str(), doorState.c_str(), true); - bootstrapManager.publish(doorStatusTopic.c_str(), doorState.c_str(), true); - } - digitalWrite(STATUS_DOOR,HIGH); - } - } - - lastDoorPositionCounter = doorPositionCounter; + lastDoorPositionCounter = doorPositionCounter; } -/*************************** DRY CONTACT CONTROL OF LIGHT & DOOR ***************************/ -void IRAM_ATTR isrDebounce(const char *type){ - static unsigned long lastOpenDoorTime = 0; - static unsigned long lastCloseDoorTime = 0; - static unsigned long lastToggleLightTime = 0; - unsigned long currentMillis = millis(); +/*************************** DRY CONTACT CONTROL OF LIGHT & DOOR + * ***************************/ +void IRAM_ATTR isrDebounce(const char *type) { + static unsigned long lastOpenDoorTime = 0; + static unsigned long lastCloseDoorTime = 0; + static unsigned long lastToggleLightTime = 0; + unsigned long currentMillis = millis(); - // Prevent ISR during the first 2 seconds after reboot - if(currentMillis < 2000) return; + // Prevent ISR during the first 2 seconds after reboot + if (currentMillis < 2000) + return; - if(strcmp(type, "openDoor") == 0){ - if(digitalRead(TRIGGER_OPEN) == LOW){ - // save the time of the falling edge - lastOpenDoorTime = currentMillis; - }else if(currentMillis - lastOpenDoorTime > 500 && currentMillis - lastOpenDoorTime < 10000){ - // now see if the rising edge was between 500ms and 10 seconds after the falling edge - dryContactDoorOpen = true; - } - } + if (strcmp(type, "openDoor") == 0) { + if (digitalRead(TRIGGER_OPEN) == LOW) { + // save the time of the falling edge + lastOpenDoorTime = currentMillis; + } else if (currentMillis - lastOpenDoorTime > 500 && + currentMillis - lastOpenDoorTime < 10000) { + // now see if the rising edge was between 500ms and 10 seconds after the + // falling edge + dryContactDoorOpen = true; + } + } - if(strcmp(type, "closeDoor") == 0){ - if(digitalRead(TRIGGER_CLOSE) == LOW){ - // save the time of the falling edge - lastCloseDoorTime = currentMillis; - }else if(currentMillis - lastCloseDoorTime > 500 && currentMillis - lastCloseDoorTime < 10000){ - // now see if the rising edge was between 500ms and 10 seconds after the falling edge - dryContactDoorClose = true; - } - } + if (strcmp(type, "closeDoor") == 0) { + if (digitalRead(TRIGGER_CLOSE) == LOW) { + // save the time of the falling edge + lastCloseDoorTime = currentMillis; + } else if (currentMillis - lastCloseDoorTime > 500 && + currentMillis - lastCloseDoorTime < 10000) { + // now see if the rising edge was between 500ms and 10 seconds after the + // falling edge + dryContactDoorClose = true; + } + } - if(strcmp(type, "toggleLight") == 0){ - if(digitalRead(TRIGGER_LIGHT) == LOW){ - // save the time of the falling edge - lastToggleLightTime = currentMillis; - }else if(currentMillis - lastToggleLightTime > 500 && currentMillis - lastToggleLightTime < 10000){ - // now see if the rising edge was between 500ms and 10 seconds after the falling edge - dryContactToggleLight = true; - } - } + if (strcmp(type, "toggleLight") == 0) { + if (digitalRead(TRIGGER_LIGHT) == LOW) { + // save the time of the falling edge + lastToggleLightTime = currentMillis; + } else if (currentMillis - lastToggleLightTime > 500 && + currentMillis - lastToggleLightTime < 10000) { + // now see if the rising edge was between 500ms and 10 seconds after the + // falling edge + dryContactToggleLight = true; + } + } } -void IRAM_ATTR isrDoorOpen(){ - isrDebounce("openDoor"); -} +void IRAM_ATTR isrDoorOpen() { isrDebounce("openDoor"); } -void IRAM_ATTR isrDoorClose(){ - isrDebounce("closeDoor"); -} +void IRAM_ATTR isrDoorClose() { isrDebounce("closeDoor"); } -void IRAM_ATTR isrLight(){ - isrDebounce("toggleLight"); -} +void IRAM_ATTR isrLight() { isrDebounce("toggleLight"); } // Fire on RISING edge of RPM1 -void IRAM_ATTR isrRPM1(){ - rpm1Pulsed = true; -} +void IRAM_ATTR isrRPM1() { rpm1Pulsed = true; } // Fire on RISING edge of RPM2 // When RPM1 HIGH on RPM2 rising edge, door closing: // RPM1: __|--|___ // RPM2: ___|--|__ -// When RPM1 LOW on RPM2 rising edge, door opening: +// When RPM1 LOW on RPM2 rising edge, door opening: // RPM1: ___|--|__ // RPM2: __|--|___ -void IRAM_ATTR isrRPM2(){ - // The encoder updates faster than the ESP wants to process, so by sampling every 5ms we get a more reliable curve - // The counter is behind the actual pulse counter, but it doesn't matter since we only need a reliable linear counter - // to determine the door direction - static unsigned long lastPulse = 0; - unsigned long currentMillis = millis(); +void IRAM_ATTR isrRPM2() { + // The encoder updates faster than the ESP wants to process, so by sampling + // every 5ms we get a more reliable curve The counter is behind the actual + // pulse counter, but it doesn't matter since we only need a reliable linear + // counter to determine the door direction + static unsigned long lastPulse = 0; + unsigned long currentMillis = millis(); - if(currentMillis - lastPulse < 5){ - return; - } + if (currentMillis - lastPulse < 5) { + return; + } - // In rare situations, the rotary encoder can be parked so that RPM2 continuously fires this ISR. - // This causes the door counter to change value even though the door isn't moving - // To solve this, check to see if RPM1 pulsed. If not, do nothing. If yes, reset the pulsed flag - if(rpm1Pulsed){ - rpm1Pulsed = false; - }else{ - return; - } + // In rare situations, the rotary encoder can be parked so that RPM2 + // continuously fires this ISR. This causes the door counter to change value + // even though the door isn't moving To solve this, check to see if RPM1 + // pulsed. If not, do nothing. If yes, reset the pulsed flag + if (rpm1Pulsed) { + rpm1Pulsed = false; + } else { + return; + } - lastPulse = millis(); + lastPulse = millis(); - // If the RPM1 state is different from the RPM2 state, then the door is opening - if(digitalRead(INPUT_RPM1)){ - doorPositionCounter--; - }else{ - doorPositionCounter++; - } + // If the RPM1 state is different from the RPM2 state, then the door is + // opening + if (digitalRead(INPUT_RPM1)) { + doorPositionCounter--; + } else { + doorPositionCounter++; + } } // handle changes to the dry contact state -void dryContactLoop(){ - if(dryContactDoorOpen){ - ESP_LOGD(TAG,"Dry Contact: open the door"); - dryContactDoorOpen = false; - openDoor(); - } +void dryContactLoop() { + if (dryContactDoorOpen) { + ESP_LOGD(TAG, "Dry Contact: open the door"); + dryContactDoorOpen = false; + openDoor(); + } - if(dryContactDoorClose){ - ESP_LOGD(TAG,"Dry Contact: close the door"); - dryContactDoorClose = false; - closeDoor(); - } + if (dryContactDoorClose) { + ESP_LOGD(TAG, "Dry Contact: close the door"); + dryContactDoorClose = false; + closeDoor(); + } - if(dryContactToggleLight){ - ESP_LOGD(TAG,"Dry Contact: toggle the light"); - dryContactToggleLight = false; - toggleLight(); - } + if (dryContactToggleLight) { + ESP_LOGD(TAG, "Dry Contact: toggle the light"); + dryContactToggleLight = false; + toggleLight(); + } } /*************************** OBSTRUCTION DETECTION ***************************/ -void IRAM_ATTR isrObstruction(){ - if(digitalRead(INPUT_OBST)){ - lastObstructionHigh = millis(); - }else{ - obstructionLowCount++; - } - +void IRAM_ATTR isrObstruction() { + if (digitalRead(INPUT_OBST)) { + lastObstructionHigh = millis(); + } else { + obstructionLowCount++; + } } -void obstructionLoop(){ - long currentMillis = millis(); - static unsigned long lastMillis = 0; +void obstructionLoop() { + long currentMillis = millis(); + static unsigned long lastMillis = 0; - // the obstruction sensor has 3 states: clear (HIGH with LOW pulse every 7ms), obstructed (HIGH), asleep (LOW) - // the transitions between awake and asleep are tricky because the voltage drops slowly when falling asleep - // and is high without pulses when waking up + // the obstruction sensor has 3 states: clear (HIGH with LOW pulse every 7ms), + // obstructed (HIGH), asleep (LOW) the transitions between awake and asleep + // are tricky because the voltage drops slowly when falling asleep and is high + // without pulses when waking up - // If at least 3 low pulses are counted within 50ms, the door is awake, not obstructed and we don't have to check anything else + // If at least 3 low pulses are counted within 50ms, the door is awake, not + // obstructed and we don't have to check anything else - // Every 50ms - if(currentMillis - lastMillis > 50){ - // check to see if we got between 3 and 8 low pulses on the line - if(obstructionLowCount >= 3 && obstructionLowCount <= 8){ - obstructionCleared(); + // Every 50ms + if (currentMillis - lastMillis > 50) { + // check to see if we got between 3 and 8 low pulses on the line + if (obstructionLowCount >= 3 && obstructionLowCount <= 8) { + obstructionCleared(); - // if there have been no pulses the line is steady high or low - }else if(obstructionLowCount == 0){ - // if the line is high and the last high pulse was more than 70ms ago, then there is an obstruction present - if(digitalRead(INPUT_OBST) && currentMillis - lastObstructionHigh > 70){ - obstructionDetected(); - }else{ - // asleep - } - } + // if there have been no pulses the line is steady high or low + } else if (obstructionLowCount == 0) { + // if the line is high and the last high pulse was more than 70ms ago, + // then there is an obstruction present + if (digitalRead(INPUT_OBST) && currentMillis - lastObstructionHigh > 70) { + obstructionDetected(); + } else { + // asleep + } + } - lastMillis = currentMillis; - obstructionLowCount = 0; - } + lastMillis = currentMillis; + obstructionLowCount = 0; + } } -void obstructionDetected(){ - static unsigned long lastInterruptTime = 0; - unsigned long interruptTime = millis(); - // Anything less than 100ms is a bounce and is ignored - if(interruptTime - lastInterruptTime > 250){ - doorIsObstructed = true; - digitalWrite(STATUS_OBST,HIGH); +void obstructionDetected() { + static unsigned long lastInterruptTime = 0; + unsigned long interruptTime = millis(); + // Anything less than 100ms is a bounce and is ignored + if (interruptTime - lastInterruptTime > 250) { + doorIsObstructed = true; + digitalWrite(STATUS_OBST, HIGH); - ESP_LOGD(TAG,"Obstruction Detected"); + ESP_LOGD(TAG, "Obstruction Detected"); - if(isConfigFileOk){ - bootstrapManager.publish(overallStatusTopic.c_str(), "obstructed", true); - bootstrapManager.publish(obstructionStatusTopic.c_str(), "obstructed", true); - } - } - lastInterruptTime = interruptTime; + if (isConfigFileOk) { + bootstrapManager.publish(overallStatusTopic.c_str(), "obstructed", true); + bootstrapManager.publish(obstructionStatusTopic.c_str(), "obstructed", + true); + } + } + lastInterruptTime = interruptTime; } -void obstructionCleared(){ - if(doorIsObstructed){ - doorIsObstructed = false; - digitalWrite(STATUS_OBST,LOW); +void obstructionCleared() { + if (doorIsObstructed) { + doorIsObstructed = false; + digitalWrite(STATUS_OBST, LOW); - ESP_LOGD(TAG,"Obstruction Cleared"); + ESP_LOGD(TAG, "Obstruction Cleared"); - if(isConfigFileOk){ - bootstrapManager.publish(overallStatusTopic.c_str(), "clear", true); - bootstrapManager.publish(obstructionStatusTopic.c_str(), "clear", true); - } - } + if (isConfigFileOk) { + bootstrapManager.publish(overallStatusTopic.c_str(), "clear", true); + bootstrapManager.publish(obstructionStatusTopic.c_str(), "clear", true); + } + } } -void sendDoorStatus(){ - ESP_LOGD(TAG,"Door state %s", doorState); +void sendDoorStatus() { + ESP_LOGD(TAG, "Door state %s", doorState); - if(isConfigFileOk){ - bootstrapManager.publish(overallStatusTopic.c_str(), doorState.c_str(), true); - bootstrapManager.publish(doorStatusTopic.c_str(), doorState.c_str(), true); - } + if (isConfigFileOk) { + bootstrapManager.publish(overallStatusTopic.c_str(), doorState.c_str(), + true); + bootstrapManager.publish(doorStatusTopic.c_str(), doorState.c_str(), true); + } } -void sendCurrentCounter(){ - String msg = String(rollingCodeCounter); - ESP_LOGD(TAG, "Current counter %d", rollingCodeCounter); - if(isConfigFileOk){ - bootstrapManager.publish(rollingCodeTopic.c_str(), msg.c_str(), true); - } -} - -/********************************** MANAGE HARDWARE BUTTON *****************************************/ -void manageHardwareButton(){ +void sendCurrentCounter() { + String msg = String(rollingCodeCounter); + ESP_LOGD(TAG, "Current counter %d", rollingCodeCounter); + if (isConfigFileOk) { + bootstrapManager.publish(rollingCodeTopic.c_str(), msg.c_str(), true); + } } +/********************************** MANAGE HARDWARE BUTTON + * *****************************************/ +void manageHardwareButton() {} /************************* DOOR COMMUNICATION *************************/ /* * Transmit a message to the door opener over uart1 * The TX1 pin is controlling a transistor, so the logic is inverted * A HIGH state on TX1 will pull the 12v line LOW - * - * The opener requires a specific duration low/high pulse before it will accept a message + * + * The opener requires a specific duration low/high pulse before it will accept + * a message */ -void transmit(byte* payload, unsigned int length){ - digitalWrite(OUTPUT_GDO, HIGH); // pull the line high for 1305 micros so the door opener responds to the message - delayMicroseconds(1305); - digitalWrite(OUTPUT_GDO, LOW); // bring the line low +void transmit(byte *payload, unsigned int length) { + digitalWrite(OUTPUT_GDO, HIGH); // pull the line high for 1305 micros so the + // door opener responds to the message + delayMicroseconds(1305); + digitalWrite(OUTPUT_GDO, LOW); // bring the line low - delayMicroseconds(1260); // "LOW" pulse duration before the message start - swSerial.write(payload, length); + delayMicroseconds(1260); // "LOW" pulse duration before the message start + swSerial.write(payload, length); } -void sync(){ - if(!useRollingCodes) return; +void sync() { + if (!useRollingCodes) + return; - getRollingCode("reboot1"); - transmit(rollingCode,CODE_LENGTH); - delay(45); + getRollingCode("reboot1"); + transmit(rollingCode, CODE_LENGTH); + delay(45); - getRollingCode("reboot2"); - transmit(rollingCode,CODE_LENGTH); - delay(45); + getRollingCode("reboot2"); + transmit(rollingCode, CODE_LENGTH); + delay(45); - getRollingCode("reboot3"); - transmit(rollingCode,CODE_LENGTH); - delay(45); + getRollingCode("reboot3"); + transmit(rollingCode, CODE_LENGTH); + delay(45); - getRollingCode("reboot4"); - transmit(rollingCode,CODE_LENGTH); - delay(45); + getRollingCode("reboot4"); + transmit(rollingCode, CODE_LENGTH); + delay(45); - getRollingCode("reboot5"); - transmit(rollingCode,CODE_LENGTH); - delay(45); + getRollingCode("reboot5"); + transmit(rollingCode, CODE_LENGTH); + delay(45); - getRollingCode("reboot6"); - transmit(rollingCode,CODE_LENGTH); - delay(45); + getRollingCode("reboot6"); + transmit(rollingCode, CODE_LENGTH); + delay(45); - writeCounterToFlash(); + writeCounterToFlash(); } -void openDoor(){ - if(doorState == "open" || doorState == "opening"){ - ESP_LOGD(TAG, "The door is already %s", doorState); - return; - } +void openDoor() { + if (doorState == "open" || doorState == "opening") { + ESP_LOGD(TAG, "The door is already %s", doorState); + return; + } - doorState = "opening"; // It takes a couple of pulses to detect opening/closing. by setting here, we can avoid bouncing from rapidly repeated commands + doorState = "opening"; // It takes a couple of pulses to detect + // opening/closing. by setting here, we can avoid + // bouncing from rapidly repeated commands - if(useRollingCodes){ - getRollingCode("door1"); - transmit(rollingCode,CODE_LENGTH); + if (useRollingCodes) { + getRollingCode("door1"); + transmit(rollingCode, CODE_LENGTH); - delay(40); + delay(40); - getRollingCode("door2"); - transmit(rollingCode,CODE_LENGTH); + getRollingCode("door2"); + transmit(rollingCode, CODE_LENGTH); - writeCounterToFlash(); - }else{ - for(int i=0; i<4; i++){ - ESP_LOGD(TAG, "sync_code[%d]", i); + writeCounterToFlash(); + } else { + for (int i = 0; i < 4; i++) { + ESP_LOGD(TAG, "sync_code[%d]", i); - transmit(SYNC_CODE[i],CODE_LENGTH); - delay(45); - } - ESP_LOGD(TAG, "door_code") - transmit(DOOR_CODE,CODE_LENGTH); - } + transmit(SYNC_CODE[i], CODE_LENGTH); + delay(45); + } + ESP_LOGD(TAG, "door_code") + transmit(DOOR_CODE, CODE_LENGTH); + } } -void closeDoor(){ - if(doorState == "closed" || doorState == "closing"){ - ESP_LOGD(TAG, "The door is already %s", doorState); - return; - } +void closeDoor() { + if (doorState == "closed" || doorState == "closing") { + ESP_LOGD(TAG, "The door is already %s", doorState); + return; + } - doorState = "closing"; // It takes a couple of pulses to detect opening/closing. by setting here, we can avoid bouncing from rapidly repeated commands + doorState = "closing"; // It takes a couple of pulses to detect + // opening/closing. by setting here, we can avoid + // bouncing from rapidly repeated commands - if(useRollingCodes){ - getRollingCode("door1"); - transmit(rollingCode,CODE_LENGTH); + if (useRollingCodes) { + getRollingCode("door1"); + transmit(rollingCode, CODE_LENGTH); - delay(40); + delay(40); - getRollingCode("door2"); - transmit(rollingCode,CODE_LENGTH); - - writeCounterToFlash(); - }else{ - for(int i=0; i<4; i++){ - ESP_LOGD(TAG, "sync_code[%d]", i); + getRollingCode("door2"); + transmit(rollingCode, CODE_LENGTH); + writeCounterToFlash(); + } else { + for (int i = 0; i < 4; i++) { + ESP_LOGD(TAG, "sync_code[%d]", i); - transmit(SYNC_CODE[i],CODE_LENGTH); - delay(45); - } - ESP_LOGD(TAG, "door_code") - transmit(DOOR_CODE,CODE_LENGTH); - } + transmit(SYNC_CODE[i], CODE_LENGTH); + delay(45); + } + ESP_LOGD(TAG, "door_code") + transmit(DOOR_CODE, CODE_LENGTH); + } } -void toggleLight(){ - if(useRollingCodes){ - getRollingCode("light"); - transmit(rollingCode,CODE_LENGTH); - writeCounterToFlash(); - }else{ - for(int i=0; i<4; i++){ - ESP_LOGD(TAG, "sync_code[%d]", i); +void toggleLight() { + if (useRollingCodes) { + getRollingCode("light"); + transmit(rollingCode, CODE_LENGTH); + writeCounterToFlash(); + } else { + for (int i = 0; i < 4; i++) { + ESP_LOGD(TAG, "sync_code[%d]", i); - transmit(SYNC_CODE[i],CODE_LENGTH); - delay(45); - } - ESP_LOGD(TAG, "light_code") - transmit(LIGHT_CODE,CODE_LENGTH); - } + transmit(SYNC_CODE[i], CODE_LENGTH); + delay(45); + } + ESP_LOGD(TAG, "light_code") + transmit(LIGHT_CODE, CODE_LENGTH); + } } diff --git a/components/ratgdo/ratgdo.h b/components/ratgdo/ratgdo.h index a062fd9..c604157 100644 --- a/components/ratgdo/ratgdo.h +++ b/components/ratgdo/ratgdo.h @@ -14,63 +14,82 @@ #ifndef _RATGDO_H #define _RATGDO_H - #include "BootstrapManager.h" // Must use the https://github.com/PaulWieland/arduinoImprovBootstrapper fork, ratgdo branch #include "SoftwareSerial.h" // Using espsoftwareserial https://github.com/plerup/espsoftwareserial -#include "rolling_code.h" #include "home_assistant.h" +#include "rolling_code.h" SoftwareSerial swSerial; -/********************************** BOOTSTRAP MANAGER *****************************************/ +/********************************** BOOTSTRAP MANAGER + * *****************************************/ BootstrapManager bootstrapManager; -/********************************** PIN DEFINITIONS *****************************************/ -#define OUTPUT_GDO D4 // red control terminal / GarageDoorOpener (UART1 TX) pin is D4 on D1 Mini -#define TRIGGER_OPEN D5 // dry contact for opening door +/********************************** PIN DEFINITIONS + * *****************************************/ +#define OUTPUT_GDO \ + D4 // red control terminal / GarageDoorOpener (UART1 TX) pin is D4 on D1 Mini +#define TRIGGER_OPEN D5 // dry contact for opening door #define TRIGGER_CLOSE D6 // dry contact for closing door -#define TRIGGER_LIGHT D3 // dry contact for triggering light (no discrete light commands, so toggle only) +#define TRIGGER_LIGHT \ + D3 // dry contact for triggering light (no discrete light commands, so toggle + // only) #define STATUS_DOOR D0 // output door status, HIGH for open, LOW for closed -#define STATUS_OBST D8 // output for obstruction status, HIGH for obstructed, LOW for clear -#define INPUT_RPM1 D1 // RPM1 rotary encoder input OR reed switch if not soldering to the door opener logic board -#define INPUT_RPM2 D2 // RPM2 rotary encoder input OR not used if using reed switch +#define STATUS_OBST \ + D8 // output for obstruction status, HIGH for obstructed, LOW for clear +#define INPUT_RPM1 \ + D1 // RPM1 rotary encoder input OR reed switch if not soldering to the door + // opener logic board +#define INPUT_RPM2 \ + D2 // RPM2 rotary encoder input OR not used if using reed switch #define INPUT_OBST D7 // black obstruction sensor terminal - -/********************************** MQTT TOPICS *****************************************/ +/********************************** MQTT TOPICS + * *****************************************/ String doorCommandTopic = ""; // will be mqttTopicPrefix/deviceName/command -String setCounterTopic = ""; // will be mqttTopicPrefix/deviceName/set_code_counter +String setCounterTopic = + ""; // will be mqttTopicPrefix/deviceName/set_code_counter -String doorCommand = ""; // will be [open|close|light] -String overallStatusTopic = ""; // legacy from 1.0. Will be mqttTopicPrefix/deviceName/status +String doorCommand = ""; // will be [open|close|light] +String overallStatusTopic = + ""; // legacy from 1.0. Will be mqttTopicPrefix/deviceName/status String availabilityStatusTopic = ""; // online|offline -String obstructionStatusTopic = ""; // obstructed|clear -String doorStatusTopic = ""; // open|opening|closing|closed|reed_open|reed_closed -String rollingCodeTopic = ""; // broadcast the current rolling code count for debugging purposes +String obstructionStatusTopic = ""; // obstructed|clear +String doorStatusTopic = + ""; // open|opening|closing|closed|reed_open|reed_closed +String rollingCodeTopic = + ""; // broadcast the current rolling code count for debugging purposes -/********************************** GLOBAL VARS *****************************************/ +/********************************** GLOBAL VARS + * *****************************************/ bool setupComplete = false; unsigned int rollingCodeCounter; byte rollingCode[CODE_LENGTH]; -String doorState = "unknown"; // will be [online|offline|opening|open|closing|closed|obstructed|clear|reed_open|reed_closed] +String doorState = + "unknown"; // will be + // [online|offline|opening|open|closing|closed|obstructed|clear|reed_open|reed_closed] -unsigned int obstructionLowCount = 0; // count obstruction low pulses -unsigned long lastObstructionHigh = 0; // count time between high pulses from the obst ISR +unsigned int obstructionLowCount = 0; // count obstruction low pulses +unsigned long lastObstructionHigh = + 0; // count time between high pulses from the obst ISR bool doorIsObstructed = false; bool dryContactDoorOpen = false; bool dryContactDoorClose = false; bool dryContactToggleLight = false; -int doorPositionCounter = 0; // calculate the door's movement and position -bool rpm1Pulsed = false; // did rpm1 get a pulse or not - eliminates an issue when the sensor is parked on a high pulse which fires rpm2 isr +int doorPositionCounter = 0; // calculate the door's movement and position +bool rpm1Pulsed = + false; // did rpm1 get a pulse or not - eliminates an issue when the sensor + // is parked on a high pulse which fires rpm2 isr -/********************************** FUNCTION DECLARATION *****************************************/ +/********************************** FUNCTION DECLARATION + * *****************************************/ void callback(char *topic, byte *payload, unsigned int length); void manageDisconnections(); void manageQueueSubscription(); void manageHardwareButton(); -void transmit(byte* payload, unsigned int length); +void transmit(byte *payload, unsigned int length); void sync(); void openDoor(); void closeDoor(); @@ -85,7 +104,8 @@ void sendDoorStatus(); void doorStateLoop(); void dryContactLoop(); -/********************************** INTERRUPT SERVICE ROUTINES ***********************************/ +/********************************** INTERRUPT SERVICE ROUTINES + * ***********************************/ void IRAM_ATTR isrDebounce(const char *type); void IRAM_ATTR isrDoorOpen(); void IRAM_ATTR isrDoorClose(); @@ -95,14 +115,20 @@ void IRAM_ATTR isrRPM1(); void IRAM_ATTR isrRPM2(); /*** Static Codes ***/ -byte SYNC1[] = {0x55,0x01,0x00,0x61,0x12,0x49,0x2c,0x92,0x5b,0x24,0x96,0x86,0x0b,0x65,0x96,0xd9,0x8f,0x26,0x4a}; -byte SYNC2[] = {0x55,0x01,0x00,0x08,0x34,0x93,0x49,0xb4,0x92,0x4d,0x20,0x26,0x1b,0x4d,0xb4,0xdb,0xad,0x76,0x93}; -byte SYNC3[] = {0x55,0x01,0x00,0x06,0x1b,0x2c,0xbf,0x4b,0x6d,0xb6,0x4b,0x18,0x20,0x92,0x09,0x20,0xf2,0x11,0x2c}; -byte SYNC4[] = {0x55,0x01,0x00,0x95,0x29,0x36,0x91,0x29,0x36,0x9a,0x69,0x05,0x2f,0xbe,0xdf,0x6d,0x16,0xcb,0xe7}; -byte* SYNC_CODE[] = {SYNC1,SYNC2,SYNC3,SYNC4}; +byte SYNC1[] = {0x55, 0x01, 0x00, 0x61, 0x12, 0x49, 0x2c, 0x92, 0x5b, 0x24, + 0x96, 0x86, 0x0b, 0x65, 0x96, 0xd9, 0x8f, 0x26, 0x4a}; +byte SYNC2[] = {0x55, 0x01, 0x00, 0x08, 0x34, 0x93, 0x49, 0xb4, 0x92, 0x4d, + 0x20, 0x26, 0x1b, 0x4d, 0xb4, 0xdb, 0xad, 0x76, 0x93}; +byte SYNC3[] = {0x55, 0x01, 0x00, 0x06, 0x1b, 0x2c, 0xbf, 0x4b, 0x6d, 0xb6, + 0x4b, 0x18, 0x20, 0x92, 0x09, 0x20, 0xf2, 0x11, 0x2c}; +byte SYNC4[] = {0x55, 0x01, 0x00, 0x95, 0x29, 0x36, 0x91, 0x29, 0x36, 0x9a, + 0x69, 0x05, 0x2f, 0xbe, 0xdf, 0x6d, 0x16, 0xcb, 0xe7}; +byte *SYNC_CODE[] = {SYNC1, SYNC2, SYNC3, SYNC4}; -byte DOOR_CODE[] = {0x55,0x01,0x00,0x94,0x3f,0xef,0xbc,0xfb,0x7f,0xbe,0xfc,0xa6,0x1a,0x4d,0xa6,0xda,0x8d,0x36,0xb3}; +byte DOOR_CODE[] = {0x55, 0x01, 0x00, 0x94, 0x3f, 0xef, 0xbc, 0xfb, 0x7f, 0xbe, + 0xfc, 0xa6, 0x1a, 0x4d, 0xa6, 0xda, 0x8d, 0x36, 0xb3}; -byte LIGHT_CODE[] = {0x55,0x01,0x00,0x94,0x3f,0xef,0xbc,0xfb,0x7f,0xbe,0xff,0xa6,0x1a,0x4d,0xa6,0xda,0x8d,0x76,0xb1}; +byte LIGHT_CODE[] = {0x55, 0x01, 0x00, 0x94, 0x3f, 0xef, 0xbc, 0xfb, 0x7f, 0xbe, + 0xff, 0xa6, 0x1a, 0x4d, 0xa6, 0xda, 0x8d, 0x76, 0xb1}; #endif \ No newline at end of file diff --git a/components/ratgdo/rolling_code.cpp b/components/ratgdo/rolling_code.cpp index e33c087..c08e316 100644 --- a/components/ratgdo/rolling_code.cpp +++ b/components/ratgdo/rolling_code.cpp @@ -1,97 +1,99 @@ -#include "common.h" #include "rolling_code.h" +#include "common.h" #include "secplus.h" -void readCounterFromFlash(){ - //Open the file - File file = LittleFS.open("/rollingcode.txt", "r"); +void readCounterFromFlash() { + // Open the file + File file = LittleFS.open("/rollingcode.txt", "r"); - //Check if the file exists - if(!file){ - Serial.println("rollingcode.txt doesn't exist. creating..."); + // Check if the file exists + if (!file) { + Serial.println("rollingcode.txt doesn't exist. creating..."); - writeCounterToFlash(); - return; - } + writeCounterToFlash(); + return; + } - rollingCodeCounter = file.parseInt(); + rollingCodeCounter = file.parseInt(); - //Close the file - file.close(); + // Close the file + file.close(); } -void writeCounterToFlash(){ - //Open the file - File file = LittleFS.open("/rollingcode.txt", "w"); - - //Write to the file - file.print(rollingCodeCounter); - delay(1); - //Close the file - file.close(); - - Serial.println("Write successful"); +void writeCounterToFlash() { + // Open the file + File file = LittleFS.open("/rollingcode.txt", "w"); + + // Write to the file + file.print(rollingCodeCounter); + delay(1); + // Close the file + file.close(); + + Serial.println("Write successful"); } -void getRollingCode(const char *command){ - Serial.print("rolling code for "); - Serial.print(rollingCodeCounter); - Serial.print("|"); - Serial.print(command); - Serial.print(" : "); +void getRollingCode(const char *command) { + Serial.print("rolling code for "); + Serial.print(rollingCodeCounter); + Serial.print("|"); + Serial.print(command); + Serial.print(" : "); - uint64_t id = 0x539; - uint64_t fixed = 0; - uint32_t data = 0; + uint64_t id = 0x539; + uint64_t fixed = 0; + uint32_t data = 0; - if(strcmp(command,"reboot1") == 0){ - fixed = 0x400000000; - data = 0x0000618b; - }else if(strcmp(command,"reboot2") == 0){ - fixed = 0; - data = 0x01009080; - }else if(strcmp(command,"reboot3") == 0){ - fixed = 0; - data = 0x0000b1a0; - }else if(strcmp(command,"reboot4") == 0){ - fixed = 0; - data = 0x01009080; - }else if(strcmp(command,"reboot5") == 0){ - fixed = 0x300000000; - data = 0x00008092; - }else if(strcmp(command,"reboot6") == 0){ - fixed = 0x300000000; - data = 0x00008092; - }else if(strcmp(command,"door1") == 0){ - fixed = 0x200000000; - data = 0x01018280; - }else if(strcmp(command,"door2") == 0){ - fixed = 0x200000000; - data = 0x01009280; - }else if(strcmp(command,"light") == 0){ - fixed = 0x200000000; - data = 0x00009281; - }else{ - Serial.println("ERROR: Invalid command"); - return; - } + if (strcmp(command, "reboot1") == 0) { + fixed = 0x400000000; + data = 0x0000618b; + } else if (strcmp(command, "reboot2") == 0) { + fixed = 0; + data = 0x01009080; + } else if (strcmp(command, "reboot3") == 0) { + fixed = 0; + data = 0x0000b1a0; + } else if (strcmp(command, "reboot4") == 0) { + fixed = 0; + data = 0x01009080; + } else if (strcmp(command, "reboot5") == 0) { + fixed = 0x300000000; + data = 0x00008092; + } else if (strcmp(command, "reboot6") == 0) { + fixed = 0x300000000; + data = 0x00008092; + } else if (strcmp(command, "door1") == 0) { + fixed = 0x200000000; + data = 0x01018280; + } else if (strcmp(command, "door2") == 0) { + fixed = 0x200000000; + data = 0x01009280; + } else if (strcmp(command, "light") == 0) { + fixed = 0x200000000; + data = 0x00009281; + } else { + Serial.println("ERROR: Invalid command"); + return; + } - fixed = fixed | id; + fixed = fixed | id; - encode_wireline(rollingCodeCounter, fixed, data, rollingCode); + encode_wireline(rollingCodeCounter, fixed, data, rollingCode); - printRollingCode(); + printRollingCode(); - if(strcmp(command,"door1") != 0){ // door2 is created with same counter and should always be called after door1 - rollingCodeCounter = (rollingCodeCounter + 1) & 0xfffffff; - } - return; + if (strcmp(command, "door1") != 0) { // door2 is created with same counter and + // should always be called after door1 + rollingCodeCounter = (rollingCodeCounter + 1) & 0xfffffff; + } + return; } -void printRollingCode(){ - for(int i = 0; i < CODE_LENGTH; i++){ - if(rollingCode[i] <= 0x0f) Serial.print("0"); - Serial.print(rollingCode[i],HEX); - } - Serial.println(""); +void printRollingCode() { + for (int i = 0; i < CODE_LENGTH; i++) { + if (rollingCode[i] <= 0x0f) + Serial.print("0"); + Serial.print(rollingCode[i], HEX); + } + Serial.println(""); } \ No newline at end of file diff --git a/components/ratgdo/rolling_code.h b/components/ratgdo/rolling_code.h index c6c8dfd..62a7313 100644 --- a/components/ratgdo/rolling_code.h +++ b/components/ratgdo/rolling_code.h @@ -1,18 +1,22 @@ #ifndef _RATGDO_ROLLING_CODE_H #define _RATGDO_ROLLING_CODE_H -#include -#include -#include #include "BootstrapManager.h" +#include +#include +#include extern "C" { #include "secplus.h" } -void readCounterFromFlash(); // get the rolling code counter from setup.json & return it -void writeCounterToFlash(); // write the counter back to setup.json -void getRollingCode(const char *command); // get the next rolling code for type [reboot1,reboot2,reboot3,reboot4,reboot5,door1,light] +void readCounterFromFlash(); // get the rolling code counter from setup.json & + // return it +void writeCounterToFlash(); // write the counter back to setup.json +void getRollingCode( + const char + *command); // get the next rolling code for type + // [reboot1,reboot2,reboot3,reboot4,reboot5,door1,light] void printRollingCode(); #endif \ No newline at end of file