/
garage-door-GDOv2-Q.yaml
199 lines (172 loc) · 6.57 KB
/
garage-door-GDOv2-Q.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
####
##
## 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-S which is built on the ESP32-S3-MINI.
# The Garage Door Opener retrofits an older style traditional garage door opener with a dry-contact trigger and has the
# following features which are included as packages below:
#
# 1. Wired contact sensor for detecting open/closed state of garage door
# 2. Optical range sensor for detecting open/closed state of garage door
# 3. Emulates a garage door opener button wired to a dry contact relay to open/close the garage door.
# 4. Adds a Garage Door "Cover" entity that is exposed to Home Assistant. The cover entity incorporates the state of the
# garage door and controls to open/close/stop it.
# 5. Flashes an onboard LED and beeps an onboard piezo sounder as a warning before automatically closing.
####
# 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.0.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: Button
####
# 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
input_obst_pin: GPIO5
warning_beep_pin: GPIO4
warning_leds_pin: GPIO3
status_led: GPIO18
external_components:
- source: github://konnected-io/konnected-esphome@master
components: [ mdns, 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.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
####
# SELF-TEST
# Self test script used to validate the hardware post-assembly
# - packages/gdo-self-test.yaml
####
# 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/konnected-esphome/garage-door-GDOv2-Q.yaml@master
import_full_config: false
####
# LOGGER
# more: https://esphome.io/components/logger.html
logger:
level: VERBOSE
# hardware_uart: UART0 -- uncomment on batch 2403; not needed on batch 2404 and newer
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:
lib_deps:
- https://github.com/konnected-io/gdolib
build_flags:
- -DUART_SCLK_DEFAULT=UART_SCLK_APB