forked from konnected-io/konnected-esphome
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathgarage-door-GDOv2-Q.yaml
306 lines (267 loc) · 9.17 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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
####
##
## 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
#
# 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 "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: garage-door
friendly_name: Garage Door Opener
project_name: konnected.garage-door-gdov2-q
project_version: "0.0.1"
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/ratgdo/esphome-ratgdo
refresh: 1s
####
# 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
esp32:
framework:
type: arduino
ratgdo:
id: konnected_ratgdo
input_gdo_pin: ${uart_rx_pin}
output_gdo_pin: ${uart_tx_pin}
input_obst_pin: ${input_obst_pin}
on_sync_failed:
then:
- homeassistant.service:
service: persistent_notification.create
data:
title: "${friendly_name} sync failed"
message: "Failed to communicate with garage opener on startup; Check the ${friendly_name} Rolling code counter number entity history and set the entity to one number larger than the largest value in history. [ESPHome devices](/config/devices/dashboard?domain=esphome)"
notification_id: "esphome_konnected_ratgdo_gdo_sync_failed"
cover:
- platform: ratgdo
id: garage_door
device_class: garage
name: "Garage Door"
ratgdo_id: konnected_ratgdo
light:
- platform: ratgdo
id: gdo_light
name: "Garage Light"
ratgdo_id: konnected_ratgdo
sensor:
- platform: ratgdo
id: gdo_openings
type: openings
entity_category: diagnostic
ratgdo_id: konnected_ratgdo
name: "Openings"
unit_of_measurement: "openings"
icon: mdi:open-in-app
lock:
- platform: ratgdo
id: gdo_lock_remotes
ratgdo_id: konnected_ratgdo
name: "Lock remotes"
binary_sensor:
- platform: ratgdo
type: motion
id: gdo_motion
ratgdo_id: konnected_ratgdo
name: "Motion"
device_class: motion
- platform: ratgdo
type: obstruction
id: gdo_obstruction
ratgdo_id: konnected_ratgdo
name: "Obstruction"
device_class: problem
- platform: ratgdo
type: button
id: gdo_button
ratgdo_id: konnected_ratgdo
name: "Button"
entity_category: diagnostic
- platform: ratgdo
type: motor
id: gdo_motor
ratgdo_id: konnected_ratgdo
name: "Motor"
device_class: running
entity_category: diagnostic
button:
- platform: factory_reset
name: Factory Reset
entity_category: config
number:
- platform: ratgdo
id: gdo_rolling_code_counter
type: rolling_code_counter
entity_category: config
ratgdo_id: konnected_ratgdo
name: "Rolling code counter"
mode: box
unit_of_measurement: "codes"
- platform: ratgdo
id: gdo_opening_duration
type: opening_duration
entity_category: config
ratgdo_id: konnected_ratgdo
name: "Opening duration"
unit_of_measurement: "s"
- platform: ratgdo
id: gdo_closing_duration
type: closing_duration
entity_category: config
ratgdo_id: konnected_ratgdo
name: "Closing duration"
unit_of_measurement: "s"
- platform: ratgdo
id: gdo__client_id
type: client_id
entity_category: config
ratgdo_id: konnected_ratgdo
name: "Client ID"
mode: box
####
# 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-S.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