forked from konnected-io/konnected-esphome
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathgarage-door-GDOv2-S.yaml
222 lines (193 loc) · 8.06 KB
/
garage-door-GDOv2-S.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
####
##
## Konnected Garage Door Opener (ESP32)
## 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: Garage Door Opener
project_name: konnected.garage-door-gdov2-s
project_version: "1.2.1"
garage_door_cover_name: Garage Door
switch_name: STR output
####
# 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
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
door_control_pin: GPIO1
wired_sensor_pin: GPIO5
warning_beep_pin: GPIO4
warning_leds_pin: GPIO3
output_switch_pin: GPIO2
status_led: GPIO18
sda: GPIO6
scl: GPIO7
####
# 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
####
# GARAGE DOOR WIRED SENSOR
# Enables a wired contact sensor for reporting the open or closed state of the garage door
# via the physical INPUT terminals.
- packages/garage-door-wired-sensor.yaml
####
# GARAGE DOOR RANGE SENSOR
# Enables the optical laser range sensor included with some Konnected Garage Door opener models to detect
# the open/closed state of an overhead garage door.
- packages/vl53l0x-range-sensor.yaml
####
# GARAGE DOOR COVER
# The Garage Door Cover is the main user interface entity representing a garage door in Home Assistant.
# more: https://www.home-assistant.io/integrations/cover/
# CHOOSE ONE of the following cover packages depending on the sensors used to determine the open/closed state of the door.
#
# 1. RANGE SENSOR ONLY - Include this line and remove or comment out the garage_door_wired_sensor package below.
- packages/garage-door-cover-range.yaml
#
# 2. WIRED SENSOR ONLY - Include this line and remove or comment out the vl53l0x_range_sensor package below.
# - packages/garage-door-cover-wired.yaml
#
# 3. WIRED & RANGE SENSORS - Include this line.
# - packages/garage-door-cover-wired-and-range.yaml
####
# GARAGE DOOR OPENER BUTTON
# Enables the garage door opener relay labeled DOOR on the Konnected Garage Door Opener as a button entity. When
# pressed, the relay will close the dry contact, simulating a physical press of the garage door opener wall button.
- packages/garage-door-opener-button.yaml
####
# SWITCH
# Enables 12V switched output labeled STR on the Konnected Garage Door opener as a switch entity
# switch: !include packages/switch.yaml
- packages/switch.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
####
# WIFI
# Enables WiFi connectivity and diagnostics. Uncommet below to enable WiFi.
# wifi: !include packages/wifi.yaml
- packages/wifi.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
####
# 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: DEBUG
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: