Files
zorruno-homeassistant/esphome/esp-downstbathswitch.yaml
T
2026-02-25 21:05:21 +13:00

262 lines
9.9 KiB
YAML

#:########################################################################################:#
# TITLE: DOWNSTAIRS BATHROOM MAIN LIGHTSWITCH
# zorruno.com layout v1.1 2026
#:########################################################################################:#
# REPO:
# https://home.fox.co.nz/gitea/zorruno/zorruno-homeassistant/src/branch/master/esphome/esp-downstbathswitch.yaml
#:########################################################################################:#
# VERSIONS:
# V2.0 2025-06-05 YAML Tidyups
# V1.0 2025-02-14 Initial Version
#:########################################################################################:#
# HARDWARE:
# Zemismart KS-811 Triple push button (KS-811-3)
# pinout/schematic: https://community.home-assistant.io/t/zemismart-ks-811-working-with-esphome/
#:########################################################################################:#
# OPERATION NOTES:
# - Triple wall switch for Downstairs Bathroom
# - Button 1 toggles Relay 1 (Main Lights)
# - Button 2 toggles Relay 2 (Cabinet Light)
# - Button 3 controls Relay 3 (Extract Fan) using multi-click timing:
# - Single click: toggle, or run for 5 minutes then off
# - Double click: run for 30 minutes then off
# - Triple click: run for 4 hours then off
# - Hold (2s+): toggle permanently
#:########################################################################################:#
# OFFLINE NOTES:
# a) Home Assistant OFFLINE, but Network and MQTT ONLINE
# - Switch continues operating locally (buttons drive relays)
# - If MQTT is used elsewhere in your system, this device itself does not require it for basic operation
# b) MQTT OFFLINE (but WiFi/Network and HA API ONLINE)
# - Switch continues operating locally (buttons drive relays)
# - HA can still control/read the relays via API
# c) Entire WiFi/Network OFFLINE
# - Switch continues operating locally (buttons drive relays)
# - Timeclocks will drift without network (SNTP). Time of day can be reset by powering off then on again at 12pm (midday)
#:########################################################################################:#
#:########################################################################################:#
# SUBSTITUTIONS: Specific device variable substitutions
# If NOT using a secrets file, just replace these with the passwords etc (in quotes)
#:########################################################################################:#
substitutions:
# Device Naming
device_name: "esp-downstbathswitch"
friendly_name: "Downstairs Bath Lightswitch (3)"
description_comment: "Downstairs Bathroom Main Lightswitch using a Zemismart KS-811 Triple Push Button. Main Light (1), Cabinet Light (2), Extract Fan (3) (Layout V1.1)"
device_area: "Downstairs Flat" # Allows ESP device to be automatically linked to an 'Area' in Home Assistant.
# Project Naming
project_name: "Zemismart Technologies.KS-811 Triple" # Project Details
project_version: "v2.0" # Project V denotes release of yaml file, allowing checking of deployed vs latest version
# Passwords (unfortunately you cannot use substitutions inside secrets names)
api_key: !secret esp-downstbathswitch_api_key
ota_pass: !secret esp-downstbathswitch_ota_pass
static_ip_address: !secret esp-downstbathswitch_ip
# If we are changing IP addresses, you must update the current IP address here, otherwise it remains
# Don't forget to switch it back when changed.
current_ip_address: ${static_ip_address}
# Device Settings
log_level: "INFO" # Define logging level: NONE, ERROR, WARN, INFO, DEBUG (Default), VERBOSE, VERY_VERBOSE
update_interval: "60s" # update time for general sensors etc
# Switch Naming
switch_1_name: "Main Lights"
switch_2_name: "Cabinet Light"
switch_3_name: "Extract Fan" # This is virtual only, no power connected to 3rd relay
#:########################################################################################:#
# PACKAGES: Included Common Packages
# https://esphome.io/components/packages.html
#:########################################################################################:#
packages:
#### WIFI, Network (Static/DHCP/IPV6 etc), Fallback AP, Safemode ####
common_wifi: !include
file: common/network_common.yaml
vars:
local_device_name: "${device_name}"
local_static_ip_address: "${static_ip_address}"
local_ota_pass: "${ota_pass}"
local_current_ip_address: "${current_ip_address}"
#### HOME ASSISTANT API (choose encryption or no encryption options) ####
common_api: !include
file: common/api_common.yaml
#file: common/api_common_noencryption.yaml
vars:
local_api_key: "${api_key}"
#### MQTT ####
common_mqtt: !include
file: common/mqtt_common.yaml
vars:
local_device_name: "${device_name}"
#### WEB PORTAL ####
#common_webportal: !include common/webportal_common.yaml
#### SNTP (Only use if you want/need accurate timeclocks) ####
common_sntp: !include common/sntp_common.yaml
#### DIAGNOSTICS Sensors ####
diag_basic: !include common/include_basic_diag_sensors.yaml
diag_more: !include common/include_more_diag_sensors.yaml
diag_debug: !include common/include_debug_diag_sensors.yaml
#diag_resetcount: !include common/include_resetcount_diag_sensors.yaml
#:########################################################################################:#
# ESPHOME:
# https://esphome.io/components/esphome.html
#:########################################################################################:#
esphome:
name: "${device_name}"
friendly_name: "${friendly_name}"
comment: "${description_comment}" # Appears on the esphome page in HA
area: "${device_area}"
project:
name: "${project_name}"
version: "${project_version}"
#:########################################################################################:#
# ESP PLATFORM AND FRAMEWORK:
# https://esphome.io/components/esp8266/
# https://esphome.io/components/esp32/
#:########################################################################################:#
esp8266:
board: esp01_1m
#:########################################################################################:#
# LOGGING: ESPHome Logging Enable
# https://esphome.io/components/logger.html
#:########################################################################################:#
logger:
level: "${log_level}"
#baud_rate: 0 # set to 0 for no logging via UART, needed if you are using it for other serial things (eg PZEM)
#esp8266_store_log_strings_in_flash: false
#tx_buffer_size: 64
#:########################################################################################:#
# STATUS LED:
# https://esphome.io/components/status_led.html
#:########################################################################################:#
status_led:
pin:
number: GPIO2
inverted: true
#:########################################################################################:#
# BINARY SENSORS:
# https://esphome.io/components/binary_sensor/
#:########################################################################################:#
binary_sensor:
- platform: gpio
pin:
number: GPIO16
mode: INPUT
inverted: true
use_interrupt: false # GPIO16 does not support interrupts so use polling (suppresses warning).
name: "Button 1: ${switch_1_name}"
on_press:
- switch.toggle: Relay_1
- platform: gpio
pin:
number: GPIO05
mode: INPUT
inverted: true
name: "Button 2: ${switch_2_name}"
on_press:
- switch.toggle: Relay_2
- platform: gpio
pin:
number: GPIO4
mode: INPUT
inverted: true
name: "Button 3: ${switch_3_name}"
on_multi_click:
# Single click: 1 press -> relay on for 5 minutes
- timing:
- ON for at most 0.5s
- OFF for at least 0.5s
then:
- if:
condition:
lambda: 'return id(Relay_3).state;'
then:
- switch.turn_off: Relay_3
else:
- switch.turn_on: Relay_3
- delay: 5min
- switch.turn_off: Relay_3
# Double click: 2 presses -> relay on for 30 minutes
- timing:
- ON for at most 0.5s
- OFF for at most 0.5s
- ON for at most 0.5s
- OFF for at least 0.5s
then:
- if:
condition:
lambda: 'return id(Relay_3).state;'
then:
- switch.turn_off: Relay_3
else:
- switch.turn_on: Relay_3
- delay: 30min
- switch.turn_off: Relay_3
# Triple click: 3 presses -> relay on for 4 hours
- timing:
- ON for at most 0.5s
- OFF for at most 0.5s
- ON for at most 0.5s
- OFF for at most 0.5s
- ON for at most 0.5s
- OFF for at least 0.2s
then:
- if:
condition:
lambda: 'return id(Relay_3).state;'
then:
- switch.turn_off: Relay_3
else:
- switch.turn_on: Relay_3
- delay: 4h
- switch.turn_off: Relay_3
# Hold: pressed for 2 seconds or more -> relay toggles permanently
- timing:
- ON for at least 2s
then:
- if:
condition:
lambda: 'return id(Relay_3).state;'
then:
- switch.turn_off: Relay_3
else:
- switch.turn_on: Relay_3
#:########################################################################################:#
# SWITCH COMPONENT:
# https://esphome.io/components/switch/
#:########################################################################################:#
switch:
- platform: gpio
name: "Relay 1: ${switch_1_name}"
pin: GPIO13
id: Relay_1
- platform: gpio
name: "Relay 2: ${switch_2_name}"
pin: GPIO12
id: Relay_2
- platform: gpio
name: "Relay 3: ${switch_3_name}"
pin: GPIO14
id: Relay_3