test.yaml

####
##
## Konnected Garage Door Opener blaQ (GDOv2-Q)
## Firmware configuration for ESPHome
##
## filename: garage-door-esp32.yaml
## GitHub: https://github.com/konnected-io/konnected-esphome
## Buy Konnected hardware: https://konnected.io
## Help & Support: https://help@konnected.io (support is provided for purchasers of Konnected hardware)
##
## Copyright© 2023 Konnected Inc.
##
## Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation
## files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy,
## modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software
## is furnished to do so, subject to the following conditions:
##
## The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
##
## THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
## OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
## LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
## IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
##
####

####
# INTRODUCTION
#
# This ESPHome based firmware configuration is designed for the Konnected Garage Door Opener GDOv2-Q (GDO blaQ)
# which is designed as a smart garage door accessory for Security+ and Security+ 2.0 garage openers manufactured
# by Chamberlain Group brands including Chamberlain, LiftMaster, Craftsman and Merlin (Australia).
#

####
# GENERAL SETTINGS
# Customize these variables to your preferences and needs
# more: https://esphome.io/guides/configuration-types.html#substitutions

####
# GENERAL SETTINGS
# Customize these variables to your preferences and needs
# more: https://esphome.io/guides/configuration-types.html#substitutions
substitutions:

  ####
  # NAME
  # By default, the name of the ESPHome device is "garage-door-xxxxxx" where xxxxxx is a unique identifier. The device's
  # hostname on your network is also defined by the name, defaulting to "garage-door-xxxxxx.local". Edit this variable to
  # customize the name and hostname. Note: only lowercase characters, numbers and hyphen(-) are allowed.
  name: konnected
  friendly_name: Garage Door Opener
  project_name: konnected.garage-door-gdov2-q
  project_version: "0.0.2"
  garage_door_cover_name: Garage Door

  ####
  # GARAGE DOOR OPENER MOMENTARY DURATION
  # Duration to make the relay contact closure for the garage door opener button circuit.
  garage_door_opener_momentary_duration: 300ms

  ####
  # OPEN GARAGE DOOR DISTANCE MARGIN OF ERROR
  # The margin of error (+/-) in meters from the value above to consider the garage door in the open position.
  open_garage_door_distance_margin_of_error: "0.05"

  ####
  # GARAGE DOOR CLOSE WARNING DURATION
  # Duration to blink the warning LED and beep the buzzer before the garage door closes.
  garage_door_close_warning_duration: 5s

  ####
  # ADDITIONAL SETTTINGS
  warning_beep_pulse_time: 100ms
  warning_beep_pause_time: 130ms
  warning_beep_internal_only: "true"
  warning_beep_shared: "false"
  sensor_debounce_time: 200ms
  range_sensor_polling_time: 2500ms
  range_sensor_debounce_time: 3s
  blink_on_state: "true"

  ####
  # INTERNAL MAPPINGS
  # DO NOT EDIT these when using Konnected hardware
  uart_tx_pin: GPIO1
  uart_rx_pin: GPIO2
  input_obst_pin: GPIO5
  warning_beep_pin: GPIO4
  warning_leds_pin: GPIO3
  status_led: GPIO18

external_components:
  #- source:
  #    type: git
  #    url: https://github.com/konnected-io/esphome-secplus-gdo.git
  #  refresh: 1s
  - source:
      type: local
      path: components

####
# PACKAGES
# Each package includes a Garage Door Opener feature described
# Remove or comment out any packages that you do not need or want.
packages:

  remote_package:
    url: http://github.com/konnected-io/konnected-esphome
    ref: master
    refresh: 5min
    files:

      ####
      # CORE
      # This package is required and sets up core ESPHome features.
      - packages/core-esp32-s3.yaml

      ####
      # WIFI
      # Enables WiFi connectivity and diagnostics. Uncommet below to enable WiFi.
      # wifi: !include packages/wifi.yaml
      - packages/wifi.yaml

      ####
      # WARNING LED
      # Enables the onboard warning LED light, with strobe effect. Used to visually warn of garage door automatic closing.
      # warning_led: !include packages/warning-led.yaml
      - packages/warning-led.yaml

      ####
      # PRE-CLOSE WARNING
      # Enables a pleasant and customizable pre-close warning tone  using the onboard piezo buzzer. Used to audibly
      # warn of a garage door automatic closing.
      - packages/buzzer-rtttl.yaml
      - packages/pre-close-warning-tones.yaml

      ####
      # STATUS LED
      # Enables the onboard blue status LED as an activity/error indicator
      # status_led: !include packages/status-led.yaml
      - packages/status-led.yaml

      ####
      # SELF-TEST
      # Self test script used to validate the hardware post-assembly
      # - packages/gdo-self-test.yaml

script:
  - id: pc_warn
    then:
      - button.press: pre_close_warning

secplus_gdo:
  id: konnected_blaq
  input_gdo_pin: ${uart_rx_pin}
  output_gdo_pin: ${uart_tx_pin}
  input_obst_pin: ${input_obst_pin}

light:
  - platform: secplus_gdo
    name: garage_light
    secplus_gdo_id: konnected_blaq
    id: gdo_light

cover:
  - platform: secplus_gdo
    name: garage_door
    secplus_gdo_id: konnected_blaq
    id: gdo_door
    pre_close_warning_duration: $garage_door_close_warning_duration
    pre_close_warning_start:
      - script.execute:
          id: pc_warn
    pre_close_warning_end:
      - script.stop: pc_warn
      - light.turn_off: warning_led
      #- light.turn_off: warning_beep

sensor:
  - platform: secplus_gdo
    secplus_gdo_id: konnected_blaq
    id: gdo_openings
    type: openings
    name: "Garage Door Openings"
    unit_of_measurement: "openings"
    icon: mdi:open-in-app

lock:
  - platform: secplus_gdo
    id: gdo_lock_remotes
    secplus_gdo_id: konnected_blaq
    name: "Lock remotes"

binary_sensor:
  - platform: secplus_gdo
    name: "Garage Motion Sensor"
    id: gdo_motion
    secplus_gdo_id: konnected_blaq
    device_class: motion
    type: motion
  - platform: secplus_gdo
    name: "Garage Door Obstruction Sensor"
    id: gdo_obst
    secplus_gdo_id: konnected_blaq
    device_class: problem
    type: obstruction
  - platform: secplus_gdo
    name: "Garage Door Motor"
    id: gdo_motor
    secplus_gdo_id: konnected_blaq
    entity_category: diagnostic
    type: motor
  - platform: secplus_gdo
    name: "Garage Button"
    id: gdo_button
    secplus_gdo_id: konnected_blaq
    entity_category: diagnostic
    type: button

switch:
  - platform: secplus_gdo
    id: "gdo_learn"
    type: learn
    secplus_gdo_id: konnected_blaq
    name: "Learn"
    icon: mdi:plus-box
    entity_category: config

select:
  - platform: secplus_gdo
    id: gdo_protocol
    secplus_gdo_id: konnected_blaq
    name: protocol
    icon: mdi:settings
    entity_category: config

button:
  - platform: factory_reset
    name: Factory Reset
    entity_category: config

number:
  - platform: secplus_gdo
    name: Garage door opening duration
    secplus_gdo_id: konnected_blaq
    entity_category: config
    id: gdo_open_duration
    type: open_duration
    unit_of_measurement: "ms"

  - platform: secplus_gdo
    name: Garage door closing duration
    secplus_gdo_id: konnected_blaq
    entity_category: config
    id: gdo_close_duration
    type: close_duration
    unit_of_measurement: "ms"

####
# DASHBOARD IMPORT
# Enables automatic discovery and upgrades via ESPHome Dashboard
# more: https://esphome.io/guides/getting_started_hassio.html
dashboard_import:
  package_import_url: github://konnected-io/esphome-secplus-gdo/test.yaml@master
  import_full_config: false

####
# LOGGER
# more: https://esphome.io/components/logger.html
logger:
  level: VERBOSE
  hardware_uart: UART0
  logs:
    ledc.output: INFO
    vl53l0x: DEBUG
    sensor: INFO
    json: INFO
    api: DEBUG

####
# NATIVE API
# Enables the native ESPHome API
# more: https://esphome.io/components/api.html
api:

####
# OTA UPDATES
# Enables over-the-air updates
# more: https://esphome.io/components/ota.html
ota:

improv_serial:

esp32_improv:
  authorizer: false

web_server:
  include_internal: true

esphome:
  platformio_options:
    build_flags:
      - -L"../../../gdolib"
      - -llibgdolib.a -llibsecplus.a