Files
zorruno-homeassistant/esphome/esp-mainhallwaymainlights.yaml
T
2026-04-04 22:36:00 +13:00

240 lines
9.7 KiB
YAML

#:########################################################################################:#
# TITLE: MAIN HALLWAY LIGHTSWITCH
# zorruno.com layout v1.1 2026
#:########################################################################################:#
# REPO:
# https://home.fox.co.nz/gitea/zorruno/zorruno-homeassistant/src/branch/master/esphome/esp-mainhallwaylights.yaml
#:########################################################################################:#
# VERSIONS:
# V1.2 2026-04-03 Fixed local button logic so physical press toggles relay; moved custom MQTT
# status publish to relay state changes; corrected ESP8266 notes and wording
# V1.1 2026-04-03 Updated yaml to zorruno layout V1.1; corrected KS-811 single naming and
# operation notes
# V1.0 2026-04-03 Initial
#:########################################################################################:#
# HARDWARE:
# - Zemismart KS-811 Single push button
#:########################################################################################:#
# OPERATION NOTES:
# - Main hallway switch with 1 output:
# 1) Main Hallway Lights
# - A single press of the physical button toggles Relay 1 ON/OFF locally
# - Relay state is published to the custom MQTT status topic for remote sync
# - Status LED uses GPIO2
#:########################################################################################:#
# MQTT COMMANDS:
# - None
#:########################################################################################:#
# OFFLINE NOTES:
# - a) Home Assistant offline (network and MQTT online):
# - Device remains on WiFi and MQTT
# - Physical button still toggles relay locally
# - b) MQTT offline (or Home Assistant and MQTT offline):
# - Physical button still toggles relay locally
# - Remote control/state sync is unavailable until MQTT returns
# - c) Entire WiFi/network offline:
# - Physical button still toggles relay locally
# - Accurate time is not needed; SNTP is not used
#:########################################################################################:#
#:########################################################################################:#
# 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-mainhallwaylights"
friendly_name: "Main Hallway Lightswitch (1)"
description_comment: "Main Hallway Lightswitch using a Zemismart KS-811 Single Push Button. Main Hallway Lights (1) (Layout V1.1)"
device_area: "Main Hallway" # Allows ESP device to be automatically linked to an 'Area' in Home Assistant.
# Project Naming
project_name: "Zemismart Technologies.KS-811 Single" # Project Details
project_version: "v1.1" # Project V denotes release of yaml file, allowing checking of deployed vs latest version
# Passwords
api_key: !secret esp-api_key # unfortunately you can't use substitutions inside secrets names
ota_pass: !secret esp-ota_pass # unfortunately you can't use substitutions inside secrets names
static_ip_address: !secret esp-mainhallwaylights_ip
mqtt_command_main_topic: !secret mqtt_command_main_topic
mqtt_status_main_topic: !secret mqtt_status_main_topic
# 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 for general sensors etc
# MQTT REMOTE Controls
mqtt_this_device_function1: "mainhallway-mainlights"
mqtt_this_device_command_topic1: "${mqtt_command_main_topic}/${mqtt_this_device_function1}"
mqtt_this_device_status_topic1: "${mqtt_status_main_topic}/${mqtt_this_device_function1}"
mqtt_command_on: "On"
mqtt_command_off: "Off"
# Switch/Relay/Button Naming & Icons
switch_1_name: "Main Hallway Lights"
#:########################################################################################:#
# 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.html
#:########################################################################################:#
esp8266:
board: esp01_1m
early_pin_init: false # Initialise pins early to known values. Recommended false where switches are involved. Defaults to true.
board_flash_mode: dout # Default is dout
#:########################################################################################:#
# LOGGING
# 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: Device-specific MQTT command triggers
# This adds device-specific MQTT command triggers to the common MQTT configuration.
#:########################################################################################:#
mqtt:
on_connect:
- mqtt.publish:
topic: "${mqtt_this_device_status_topic1}"
payload: !lambda |-
return id(Relay_1).state ? "${mqtt_command_on}" : "${mqtt_command_off}";
retain: true
on_message:
- topic: "${mqtt_this_device_command_topic1}"
payload: "${mqtt_command_on}"
then:
- delay: 50ms
- if:
condition:
lambda: 'return !id(Relay_1).state;'
then:
- switch.turn_on: Relay_1
- topic: "${mqtt_this_device_command_topic1}"
payload: "${mqtt_command_off}"
then:
- delay: 50ms
- if:
condition:
lambda: 'return id(Relay_1).state;'
then:
- switch.turn_off: Relay_1
#:########################################################################################:#
# STATUS LED
# https://esphome.io/components/status_led.html
#:########################################################################################:#
status_led:
pin:
number: GPIO02
inverted: yes
#:########################################################################################:#
# BINARY SENSORS
# https://esphome.io/components/binary_sensor/
#:########################################################################################:#
binary_sensor:
- platform: gpio
pin:
number: GPIO0
mode: INPUT
inverted: true
name: "Button 1: ${switch_1_name}"
filters:
- delayed_on: 10ms
- delayed_off: 10ms
on_press:
- if:
condition:
switch.is_on: Relay_1
then:
- switch.turn_off: Relay_1
- mqtt.publish:
topic: "${mqtt_this_device_command_topic1}"
payload: "${mqtt_command_off}"
else:
- switch.turn_on: Relay_1
- mqtt.publish:
topic: "${mqtt_this_device_command_topic1}"
payload: "${mqtt_command_on}"
#:########################################################################################:#
# SWITCH
# https://esphome.io/components/switch/
#:########################################################################################:#
switch:
- platform: gpio
name: "Relay 1: ${switch_1_name}"
pin: GPIO12
id: Relay_1
on_turn_on:
- mqtt.publish:
topic: "${mqtt_this_device_status_topic1}"
payload: "${mqtt_command_on}"
retain: true
on_turn_off:
- mqtt.publish:
topic: "${mqtt_this_device_status_topic1}"
payload: "${mqtt_command_off}"
retain: true