Skip to content

Commit

Permalink
add GDO blaQ offline use case example
Browse files Browse the repository at this point in the history
  • Loading branch information
heythisisnate committed Oct 26, 2024
1 parent f0fcf4a commit e1151a0
Showing 1 changed file with 189 additions and 0 deletions.
189 changes: 189 additions & 0 deletions examples/gdo-blaq-offline-dry-contact-toggle-relay.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,189 @@
####
##
## 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://[email protected] (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
#
# Customization for the GDO blaQ to operate completely offline, and act as a relay for a dry contact
# to trigger the garage door to open or close. Useful when integrating with a legacy system that needs a dry
# contact trigger to toggle the garage door, in an offline environment.

####
# 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 "konnected-xxxxxx" where xxxxxx is a unique identifier. The device's
# hostname on your network is also defined by the name, defaulting to "konnected-xxxxxx.local". Edit this variable to
# customize the name and hostname. Note: only lowercase characters, numbers and hyphen(-) are allowed.
name: konnected
friendly_name: GDO blaQ
project_name: konnected.garage-door-gdov2-q
project_version: "1.3.3"
garage_door_cover_name: Garage Door
garage_light_name: Garage Light
garage_openings_name: Garage Openings
garage_lock_name: Lock
garage_motion_name: Motion
garage_obstruction_name: Obstruction
garage_motor_name: Motor
garage_button_name: Wall Button
garage_sync_name: Synced


####
# 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
sensor_debounce_time: 200ms
blink_on_state: "true"

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

external_components:
- source: github://konnected-io/konnected-esphome@master
components: [ secplus_gdo ]

# Un-comment below and comment above for local modification
# - source:
# type: local
# path: components
# components: [ secplus_gdo ]

####
# 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: https://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-esp32.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

####
# SECPLUS GDO
# The logic and capabilities of the GDO communication
- packages/secplus-gdo.yaml
- packages/debug.yaml

binary_sensor:
- platform: gpio
pin:
number: $input1
mode: INPUT_PULLUP
inverted: true
name: Garage Door Relay
on_click:
min_length: 50ms
max_length: 3s
then:
- cover.toggle: gdo_door

####
# LOGGER
# more: https://esphome.io/components/logger.html
logger:
level: VERY_VERBOSE
logs:
esp-idf: VERBOSE
scheduler: DEBUG
esp32.preferences: DEBUG
sensor.filter: DEBUG
rtttl: DEBUG
cover: DEBUG
sensor: DEBUG
ledc.output: INFO
json: INFO

# Remove all network services
api: !remove
wifi: !remove
ota: !remove

esphome:
# start secplus gdo without network
on_boot:
priority: 220
then:
lambda: id(gdo_blaq).start_gdo();
platformio_options:
lib_deps:
- https://github.com/konnected-io/gdolib#4a55112
build_flags:
- -DUART_SCLK_DEFAULT=UART_SCLK_APB
- -Wl,--wrap=esp_panic_handler

0 comments on commit e1151a0

Please sign in to comment.