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/components/binary_sensor/binary_sensor.h"
#include "esphome/core/component.h"
#include "esphome/core/defines.h"
#include "esphome/core/hal.h"
#include "esphome/core/preferences.h"

#include "callbacks.h"
#include "macros.h"
#include "observable.h"
#include "protocol.h"
#include "ratgdo_state.h"

namespace esphome {
class InternalGPIOPin;
namespace ratgdo {

    class RATGDOComponent;
    typedef Parented<RATGDOComponent> RATGDOClient;

    const float DOOR_POSITION_UNKNOWN = -1.0;
    const float DOOR_DELTA_UNKNOWN = -2.0;
    const uint16_t PAIRED_DEVICES_UNKNOWN = 0xFF;

    struct RATGDOStore {
        int obstruction_low_count = 0; // count obstruction low pulses

        static void IRAM_ATTR HOT isr_obstruction(RATGDOStore* arg)
        {
            arg->obstruction_low_count++;
        }
    };

    using protocol::Args;
    using protocol::Result;

    class RATGDOComponent : public Component {
    public:
        void setup() override;
        void loop() override;
        void dump_config() override;

        void init_protocol();

        void obstruction_loop();

        float start_opening { -1 };
        observable<float> opening_duration { 0 };
        float start_closing { -1 };
        observable<float> closing_duration { 0 };
        observable<uint32_t> closing_delay { 0 };

        observable<int16_t> target_distance_measurement { -1 };
        std::vector<int16_t> distance_measurement { std::vector<int16_t>(30, -1) }; // the length of this vector determines how many in-range readings are required for presence detection to change states
        observable<int16_t> last_distance_measurement { 0 };

        observable<uint16_t> openings { 0 }; // number of times the door has been opened
        observable<uint16_t> paired_total { PAIRED_DEVICES_UNKNOWN };
        observable<uint16_t> paired_remotes { PAIRED_DEVICES_UNKNOWN };
        observable<uint16_t> paired_keypads { PAIRED_DEVICES_UNKNOWN };
        observable<uint16_t> paired_wall_controls { PAIRED_DEVICES_UNKNOWN };
        observable<uint16_t> paired_accessories { PAIRED_DEVICES_UNKNOWN };

        observable<DoorState> door_state { DoorState::UNKNOWN };
        observable<float> door_position { DOOR_POSITION_UNKNOWN };
        observable<DoorActionDelayed> door_action_delayed { DoorActionDelayed::NO };

        unsigned long door_start_moving { 0 };
        float door_start_position { DOOR_POSITION_UNKNOWN };
        float door_move_delta { DOOR_DELTA_UNKNOWN };

        observable<LightState> light_state { LightState::UNKNOWN };
        observable<LockState> lock_state { LockState::UNKNOWN };
        observable<ObstructionState> obstruction_state { ObstructionState::UNKNOWN };
        observable<MotorState> motor_state { MotorState::UNKNOWN };
        observable<ButtonState> button_state { ButtonState::UNKNOWN };
        observable<MotionState> motion_state { MotionState::UNKNOWN };
        observable<LearnState> learn_state { LearnState::UNKNOWN };
        observable<VehicleDetectedState> vehicle_detected_state { VehicleDetectedState::NO };
        observable<VehicleArrivingState> vehicle_arriving_state { VehicleArrivingState::NO };
        observable<VehicleLeavingState> vehicle_leaving_state { VehicleLeavingState::NO };

        OnceCallbacks<void(DoorState)> on_door_state_;

        observable<bool> sync_failed { false };

        void set_output_gdo_pin(InternalGPIOPin* pin) { this->output_gdo_pin_ = pin; }
        void set_input_gdo_pin(InternalGPIOPin* pin) { this->input_gdo_pin_ = pin; }
        void set_input_obst_pin(InternalGPIOPin* pin) { this->input_obst_pin_ = pin; }

        // dry contact methods
        void set_dry_contact_open_sensor(esphome::binary_sensor::BinarySensor* dry_contact_open_sensor_);
        void set_dry_contact_close_sensor(esphome::binary_sensor::BinarySensor* dry_contact_close_sensor_);
        void set_discrete_open_pin(InternalGPIOPin* pin) { this->protocol_->set_discrete_open_pin(pin); }
        void set_discrete_close_pin(InternalGPIOPin* pin) { this->protocol_->set_discrete_close_pin(pin); }

        Result call_protocol(Args args);

        void received(const DoorState door_state);
        void received(const LightState light_state);
        void received(const LockState lock_state);
        void received(const ObstructionState obstruction_state);
        void received(const LightAction light_action);
        void received(const MotorState motor_state);
        void received(const ButtonState button_state);
        void received(const MotionState motion_state);
        void received(const LearnState light_state);
        void received(const Openings openings);
        void received(const TimeToClose ttc);
        void received(const PairedDeviceCount pdc);
        void received(const BatteryState pdc);

        // door
        void door_toggle();
        void door_open();
        void door_close();
        void door_stop();

        void door_action(DoorAction action);
        void ensure_door_action(DoorAction action, uint32_t delay = 1500);
        void door_move_to_position(float position);
        void set_door_position(float door_position) { this->door_position = door_position; }
        void set_opening_duration(float duration);
        void set_closing_duration(float duration);
        void set_closing_delay(uint32_t delay) { this->closing_delay = delay; }
        void schedule_door_position_sync(float update_period = 500);
        void door_position_update();
        void cancel_position_sync_callbacks();
        void set_target_distance_measurement(int16_t distance);
        void set_distance_measurement(int16_t distance);
        void calculate_presence();
        void presence_change(bool sensor_value);

        // light
        void light_toggle();
        void light_on();
        void light_off();
        LightState get_light_state() const;

        // lock
        void lock_toggle();
        void lock();
        void unlock();

        // Learn & Paired
        void activate_learn();
        void inactivate_learn();
        void query_paired_devices();
        void query_paired_devices(PairedDevice kind);
        void clear_paired_devices(PairedDevice kind);

        // button functionality
        void query_status();
        void query_openings();
        void sync();

        // children subscriptions
        void subscribe_rolling_code_counter(std::function<void(uint32_t)>&& f);
        void subscribe_opening_duration(std::function<void(float)>&& f);
        void subscribe_closing_duration(std::function<void(float)>&& f);
        void subscribe_closing_delay(std::function<void(uint32_t)>&& f);
        void subscribe_openings(std::function<void(uint16_t)>&& f);
        void subscribe_paired_devices_total(std::function<void(uint16_t)>&& f);
        void subscribe_paired_remotes(std::function<void(uint16_t)>&& f);
        void subscribe_paired_keypads(std::function<void(uint16_t)>&& f);
        void subscribe_paired_wall_controls(std::function<void(uint16_t)>&& f);
        void subscribe_paired_accessories(std::function<void(uint16_t)>&& f);
        void subscribe_door_state(std::function<void(DoorState, float)>&& f);
        void subscribe_light_state(std::function<void(LightState)>&& f);
        void subscribe_lock_state(std::function<void(LockState)>&& f);
        void subscribe_obstruction_state(std::function<void(ObstructionState)>&& f);
        void subscribe_motor_state(std::function<void(MotorState)>&& f);
        void subscribe_button_state(std::function<void(ButtonState)>&& f);
        void subscribe_motion_state(std::function<void(MotionState)>&& f);
        void subscribe_sync_failed(std::function<void(bool)>&& f);
        void subscribe_learn_state(std::function<void(LearnState)>&& f);
        void subscribe_door_action_delayed(std::function<void(DoorActionDelayed)>&& f);
        void subscribe_distance_measurement(std::function<void(int16_t)>&& f);
        void subscribe_vehicle_detected_state(std::function<void(VehicleDetectedState)>&& f);
        void subscribe_vehicle_arriving_state(std::function<void(VehicleArrivingState)>&& f);
        void subscribe_vehicle_leaving_state(std::function<void(VehicleLeavingState)>&& f);

    protected:
        RATGDOStore isr_store_ {};
        protocol::Protocol* protocol_;
        bool obstruction_sensor_detected_ { false };
        bool presence_detect_window_active_ { false };

        InternalGPIOPin* output_gdo_pin_;
        InternalGPIOPin* input_gdo_pin_;
        InternalGPIOPin* input_obst_pin_;
        esphome::binary_sensor::BinarySensor* dry_contact_open_sensor_;
        esphome::binary_sensor::BinarySensor* dry_contact_close_sensor_;
    }; // RATGDOComponent

} // namespace ratgdo
} // namespace esphome