310 lines
12 KiB
YAML
310 lines
12 KiB
YAML
#:########################################################################################:#
|
|
# TITLE: CENTRAL STAIRS - BOTTOM LIGHTSWITCH
|
|
# zorruno.com layout v1.1 2026
|
|
#:########################################################################################:#
|
|
# REPO:
|
|
# https://home.fox.co.nz/gitea/zorruno/zorruno-homeassistant/src/branch/master/esphome/esp-centralstairs-bottom.yaml
|
|
#:########################################################################################:#
|
|
# VERSIONS:
|
|
# V3.7 2025-09-24 Upload to this device
|
|
# V3.5 2025-07-24 YAML tidyups
|
|
#:########################################################################################:#
|
|
# HARDWARE:
|
|
# Zemismart KS-811 Double push button (KS-811-2)
|
|
# pinout/schematic: https://community.home-assistant.io/t/zemismart-ks-811-working-with-esphome/
|
|
#:########################################################################################:#
|
|
# OPERATION NOTES:
|
|
# - Light switch at bottom of the central stairs
|
|
# - Button 1 toggles Relay 1 (Main Stair Lights - Lower) - physically connected
|
|
# - Button 2 controls Stair Footer Lights via MQTT (remote device), using Relay 2 as a local mirror state
|
|
# - On MQTT connect, publishes current Relay 1 state to mqtt_status_topic_1 to keep remote status aligned
|
|
#:########################################################################################:#
|
|
# MQTT COMMANDS:
|
|
# Remote device 1 (Main Stair Lights):
|
|
# - Command topic: ${mqtt_command_topic_1} -> ON,OFF
|
|
# - Status topic: ${mqtt_status_topic_1} -> ON,OFF
|
|
#
|
|
# Remote device 2 (Stair Footer Lights):
|
|
# - Command topic: ${mqtt_command_topic_2} -> ON,OFF
|
|
# - Status topic: ${mqtt_status_topic_2} -> ON,OFF
|
|
#:########################################################################################:#
|
|
# OFFLINE NOTES:
|
|
# a) Home Assistant OFFLINE, but Network and MQTT ONLINE
|
|
# - Physical buttons still operate (Relay 1 local toggle; Button 2 publishes MQTT for footer lights)
|
|
# - Relay 1 state continues to be published to MQTT status topic
|
|
# - HA entities are unavailable until HA returns
|
|
# b) MQTT OFFLINE (but WiFi/Network and HA API ONLINE)
|
|
# - Relay 1 still toggles locally and remains controllable from HA via API
|
|
# - Button 2 cannot control footer lights (MQTT publish fails)
|
|
# - Any MQTT state sync to remote devices will not occur while MQTT is down
|
|
# c) Entire WiFi/Network OFFLINE
|
|
# - Physical button 1 continues to toggle Relay 1 locally (standalone)
|
|
# - Physical button 2 cannot control footer lights (no network transport)
|
|
# - 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 Custom Naming
|
|
device_name: "esp-centralstairs-bottom"
|
|
friendly_name: "Central Stair Lightswitch - Bottom (2)"
|
|
description_comment: "Central Stair Lightswitch - Bottom, using Zemismart KS-811 Double Push Button. Main Stair Lights (1), Stair Footer Lights (2) (Layout V1.1)"
|
|
device_area: "Lounge" # Allows ESP device to be automatically linked to an 'Area' in Home Assistant.
|
|
|
|
# Passwords & Secrets (unfortunately you can't use substitutions inside secrets names)
|
|
api_key: !secret esp-api_key
|
|
ota_pass: !secret esp-ota_pass
|
|
static_ip_address: !secret esp-centralstairs-bottom_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}
|
|
|
|
# MQTT Device Names
|
|
mqtt_device_name_1: "stair-mainlights"
|
|
mqtt_device_name_2: "stair-footerlights"
|
|
|
|
# I/O Naming
|
|
switch_1_name: "Main Stair Lights (Lower)" # Physical, but just the lower lights below the media cabinet
|
|
switch_2_name: "Stair Footer Lights" # virtual only, nothing connected to this output
|
|
|
|
# Project Naming
|
|
project_name: "Zemismart Technologies.KS-811 Double" # Project Details
|
|
project_version: "v2.0" # Project V denotes release of yaml file, allowing checking of deployed vs latest version
|
|
|
|
# MQTT Controls
|
|
mqtt_command_main_topic: !secret mqtt_command_main_topic
|
|
mqtt_status_main_topic: !secret mqtt_status_main_topic
|
|
mqtt_command_topic_1: "${mqtt_command_main_topic}/${mqtt_device_name_1}"
|
|
mqtt_status_topic_1: "${mqtt_status_main_topic}/${mqtt_device_name_1}"
|
|
mqtt_command_topic_2: "${mqtt_command_main_topic}/${mqtt_device_name_2}"
|
|
mqtt_status_topic_2: "${mqtt_status_main_topic}/${mqtt_device_name_2}"
|
|
mqtt_command_ON: "ON"
|
|
mqtt_command_OFF: "OFF"
|
|
|
|
# General Settings
|
|
log_level: "ERROR" # Define logging level: NONE, ERROR, WARN, INFO, DEBUG (Default), VERBOSE, VERY_VERBOSE
|
|
update_interval: "60s" # update time for general sensors etc
|
|
|
|
#:########################################################################################:#
|
|
# 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}"
|
|
#on_boot:
|
|
# priority: 200
|
|
# then:
|
|
# - switch.turn_on: Relay_2
|
|
|
|
#:########################################################################################:#
|
|
# ESP PLATFORM AND FRAMEWORK:
|
|
# https://esphome.io/components/esp8266/
|
|
# https://esphome.io/components/esp32/
|
|
#:########################################################################################:#
|
|
esp8266:
|
|
board: esp01_1m
|
|
early_pin_init: false # Recommended false where switches are involved. Defaults to true.
|
|
board_flash_mode: dout # Default is dout
|
|
|
|
#:########################################################################################:#
|
|
# 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
|
|
|
|
#:########################################################################################:#
|
|
# MQTT:
|
|
# This adds device-specific MQTT command triggers to the common MQTT configuration.
|
|
#:########################################################################################:#
|
|
mqtt:
|
|
on_connect:
|
|
then:
|
|
- if:
|
|
condition:
|
|
lambda: 'return id(Relay_1).state;'
|
|
then:
|
|
- mqtt.publish:
|
|
topic: "${mqtt_status_topic_1}"
|
|
payload: "${mqtt_command_ON}"
|
|
qos: 0
|
|
retain: false
|
|
else:
|
|
- mqtt.publish:
|
|
topic: "${mqtt_status_topic_1}"
|
|
payload: "${mqtt_command_OFF}"
|
|
qos: 0
|
|
retain: false
|
|
|
|
on_message:
|
|
# Relay 1: only turn ON if currently OFF
|
|
- topic: "${mqtt_command_topic_1}"
|
|
payload: "${mqtt_command_ON}"
|
|
then:
|
|
- if:
|
|
condition:
|
|
not:
|
|
- switch.is_on: Relay_1
|
|
then:
|
|
- switch.turn_on: Relay_1
|
|
|
|
# Relay 1: only turn OFF if currently ON
|
|
- topic: "${mqtt_command_topic_1}"
|
|
payload: "${mqtt_command_OFF}"
|
|
then:
|
|
- if:
|
|
condition:
|
|
- switch.is_on: Relay_1
|
|
then:
|
|
- switch.turn_off: Relay_1
|
|
|
|
# Relay 2: only turn ON if currently OFF
|
|
- topic: "${mqtt_command_topic_2}"
|
|
payload: "${mqtt_command_ON}"
|
|
then:
|
|
- if:
|
|
condition:
|
|
not:
|
|
- switch.is_on: Relay_2
|
|
then:
|
|
- switch.turn_on: Relay_2
|
|
|
|
# Relay 2: only turn OFF if currently ON
|
|
- topic: "${mqtt_command_topic_2}"
|
|
payload: "${mqtt_command_OFF}"
|
|
then:
|
|
- if:
|
|
condition:
|
|
- switch.is_on: Relay_2
|
|
then:
|
|
- switch.turn_off: Relay_2
|
|
|
|
#:########################################################################################:#
|
|
# 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).
|
|
filters:
|
|
- delayed_on: 30ms
|
|
- delayed_off: 30ms
|
|
name: "Button 1: ${switch_1_name}"
|
|
on_press:
|
|
- switch.toggle: Relay_1
|
|
|
|
- platform: gpio
|
|
pin:
|
|
number: GPIO05
|
|
mode: INPUT
|
|
inverted: true
|
|
filters:
|
|
- delayed_on: 30ms
|
|
- delayed_off: 30ms
|
|
name: "Button 2: ${switch_2_name}"
|
|
on_press:
|
|
# Toggle the remote Footer Lights via COMMAND topic, based on our mirrored state
|
|
- if:
|
|
condition:
|
|
lambda: 'return id(Relay_2).state;'
|
|
then:
|
|
- mqtt.publish:
|
|
topic: "${mqtt_command_topic_2}"
|
|
payload: "${mqtt_command_OFF}"
|
|
retain: false
|
|
else:
|
|
- mqtt.publish:
|
|
topic: "${mqtt_command_topic_2}"
|
|
payload: "${mqtt_command_ON}"
|
|
retain: false
|
|
|
|
#:########################################################################################:#
|
|
# SWITCH COMPONENT:
|
|
# https://esphome.io/components/switch/
|
|
#:########################################################################################:#
|
|
switch:
|
|
- platform: gpio
|
|
name: "Relay 1: ${switch_1_name}"
|
|
pin: GPIO13
|
|
id: Relay_1
|
|
on_turn_on:
|
|
- mqtt.publish:
|
|
topic: "${mqtt_status_topic_1}"
|
|
payload: "${mqtt_command_ON}"
|
|
retain: false
|
|
on_turn_off:
|
|
- mqtt.publish:
|
|
topic: "${mqtt_status_topic_1}"
|
|
payload: "${mqtt_command_OFF}"
|
|
retain: false
|
|
|
|
- platform: gpio
|
|
name: "Relay 2: ${switch_2_name}"
|
|
pin: GPIO12
|
|
id: Relay_2
|
|
# No mqtt.publish here (this is a mirror only) |