esphome-ratgdo/components/ratgdo/ratgdo.h

/************************************
 * Rage
 * Against
 * The
 * Garage
 * Door
 * Opener
 *
 * Copyright (C) 2022  Paul Wieland
 *
 * GNU GENERAL PUBLIC LICENSE
 ************************************/

#pragma once
#include "esphome/core/component.h"
#include "esphome/core/preferences.h"
#include <Arduino.h>


#include "SoftwareSerial.h"
extern "C" {
#include "secplus.h"
}

#define CODE_LENGTH 19 // the length of each command sent to the 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 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 INPUT_OBST D7 // black obstruction sensor terminal

namespace esphome {
namespace ratgdo {

class RATGDOComponent : public Component {
 public:
    void setup() override;
    void loop() override;
    /********************************** GLOBAL VARS
     * *****************************************/
    unsigned int rollingCodeCounter;
    SoftwareSerial swSerial;
    byte rollingCode[CODE_LENGTH];
    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

    bool useRollingCodes = true; // use rolling codes or not
    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

    /********************************** FUNCTION DECLARATION
     * *****************************************/
    void set_rolling_codes(bool useRollingCodes);
    void transmit(byte *payload, unsigned int length);
    void sync();
    void openDoor();
    void closeDoor();
    void toggleLight();

    void obstructionLoop();
    void obstructionDetected();
    void obstructionCleared();

    void sendDoorStatus();

    void doorStateLoop();
    void dryContactLoop();

    /********************************** INTERRUPT SERVICE ROUTINES
     * ***********************************/
    void IRAM_ATTR isrDebounce(const char *type);
    void IRAM_ATTR isrDoorOpen();
    void IRAM_ATTR isrDoorClose();
    void IRAM_ATTR isrLight();
    void IRAM_ATTR isrObstruction();
    void IRAM_ATTR isrRPM1();
    void IRAM_ATTR isrRPM2();



   protected:
      ESPPreferenceObject pref_;
      bool useRollingCodes_;


}; // RATGDOComponent

} // namespace ratgdo
} // namespace esphome