zorruno/zorruno-homeassistant
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
15f348570f8e9b9eeab003a23602ba9b2ba79534
zorruno-homeassistant/esphome/esp-mainhallwaynorthlightswitch.yaml
T
root 51bff34d2e hallway esphome devices and fixes
2026-04-04 22:36:00 +13:00

329 lines
13 KiB
YAML
Raw Blame History

#:########################################################################################:#
# TITLE: MAIN HALLWAY NORTH LIGHTSWITCH
# zorruno.com layout v1.1 2026
#:########################################################################################:#
# REPO:
# https://home.fox.co.nz/gitea/zorruno/zorruno-homeassistant/src/branch/master/esphome/esp-mainhallwaynorthlightswitch.yaml
#:########################################################################################:#
# VERSIONS:
# V1.1 2026-04-04 Updated yaml to zorruno layout V1.1; checked KS-811 dual ESP8266 GPIO mapping;
# corrected Relay 2 naming; added MQTT state republish on reconnect; added
# GPIO16 polling for Button 1 compatibility; expanded notes/comments
# V1.0 2026-04-03 Initial
#:########################################################################################:#
# HARDWARE:
# - Zemismart KS-811 Double Push Button
# - ESP8266 variant
# - Community-traced dual-button pinout matches:
# - Button 1 (top): GPIO16
# - Button 2 (bottom): GPIO5
# - Relay 1: GPIO13
# - Relay 2: GPIO12
# - Status LED: GPIO2 (inverted)
#:########################################################################################:#
# OPERATION NOTES:
# - Button 1 toggles Relay 1 locally.
# - Button 2 toggles Relay 2 locally.
# - MQTT command topics can also turn each relay On or Off.
# - Custom MQTT status topics publish the actual relay state after local or MQTT changes.
# - Current relay states are also republished whenever MQTT reconnects, helping late subscribers.
# - GPIO16 on ESP8266 does not support normal GPIO interrupts, so Button 1 uses polling mode.
#:########################################################################################:#
# MQTT COMMANDS:
# - ${mqtt_this_device_command_topic1}
# Payloads: ${mqtt_command_on}, ${mqtt_command_off}
# - ${mqtt_this_device_command_topic2}
# Payloads: ${mqtt_command_on}, ${mqtt_command_off}
# - Status topics:
# - ${mqtt_this_device_status_topic1}
# - ${mqtt_this_device_status_topic2}
# Payloads mirror the actual relay state and are published retained.
#:########################################################################################:#
# OFFLINE NOTES:
# a) HA offline (network and MQTT still online)
# - Local button control continues.
# - MQTT command/status operation continues.
#
# b) MQTT offline (or HA and MQTT offline)
# - Local button control continues.
# - If Home Assistant is online and connected by native ESPHome API, HA control can still work.
# - Custom MQTT commands/status are unavailable until MQTT returns.
#
# c) Entire WiFi/network offline
# - Local wall-switch button control continues for both relays.
# - Accurate time is not needed. SNTP is not used for this device.
#:########################################################################################:#
#:########################################################################################:#
# 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-mainhallwaynorthlightswitch"
friendly_name: "Main Hallway North Lightswitch (2)"
description_comment: "Main Hallway Lightswitch using a Zemismart KS-811 Double Push Button. Main Hallway Lights (1), Night Lights (2) (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 Double"
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-mainhallwaynorthlightswitch_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" # NONE, ERROR, WARN, INFO, DEBUG, VERBOSE, VERY_VERBOSE
update_interval: "60s" # General sensor update interval
# 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"
mqtt_this_device_function2: "mainhallway-nightlights"
mqtt_this_device_command_topic2: "${mqtt_command_main_topic}/${mqtt_this_device_function2}"
mqtt_this_device_status_topic2: "${mqtt_status_main_topic}/${mqtt_this_device_function2}"
# Switch/Relay/Button Naming
switch_1_name: "Main Hallway Lights"
switch_2_name: "Main Hallway Nightlights"
#:########################################################################################:#
# 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 # Recommended false where relays/switches are involved
board_flash_mode: dout
#:########################################################################################:#
# LOGGING
# https://esphome.io/components/logger.html
#:########################################################################################:#
logger:
level: "${log_level}"
#baud_rate: 0 # Set to 0 for no logging via UART if UART is needed elsewhere
#esp8266_store_log_strings_in_flash: false
#tx_buffer_size: 64
#:########################################################################################:#
# MQTT: Device-specific MQTT command triggers
# This extends the common MQTT package with local custom command/status topics.
#:########################################################################################:#
mqtt:
# Republish current relay states whenever MQTT reconnects so retained status stays accurate
# for subscribers that reconnect later.
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
- mqtt.publish:
topic: "${mqtt_this_device_status_topic2}"
payload: !lambda |-
return id(Relay_2).state ? "${mqtt_command_on}" : "${mqtt_command_off}";
retain: true
on_message:
# Mirror remote state onto Relay_1, but only if a real state change is needed.
- topic: "${mqtt_this_device_command_topic1}"
payload: "${mqtt_command_on}"
then:
- 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:
- if:
condition:
lambda: "return id(Relay_1).state;"
then:
- switch.turn_off: Relay_1
# Mirror remote state onto Relay_2, but only if a real state change is needed.
- topic: "${mqtt_this_device_command_topic2}"
payload: "${mqtt_command_on}"
then:
- if:
condition:
lambda: "return !id(Relay_2).state;"
then:
- switch.turn_on: Relay_2
- topic: "${mqtt_this_device_command_topic2}"
payload: "${mqtt_command_off}"
then:
- if:
condition:
lambda: "return id(Relay_2).state;"
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: true
inverted: true
name: "Button 1: ${switch_1_name}"
use_interrupt: false
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}"
- platform: gpio
pin:
number: GPIO5
mode:
input: true
inverted: true
name: "Button 2: ${switch_2_name}"
filters:
- delayed_on: 10ms
- delayed_off: 10ms
on_press:
- if:
condition:
switch.is_on: Relay_2
then:
- switch.turn_off: Relay_2
- mqtt.publish:
topic: "${mqtt_this_device_command_topic2}"
payload: "${mqtt_command_off}"
else:
- switch.turn_on: Relay_2
- mqtt.publish:
topic: "${mqtt_this_device_command_topic2}"
payload: "${mqtt_command_on}"
#:########################################################################################:#
# SWITCH
# 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_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
- platform: gpio
name: "Relay 2: ${switch_2_name}"
pin: GPIO12
id: Relay_2
on_turn_on:
- mqtt.publish:
topic: "${mqtt_this_device_status_topic2}"
payload: "${mqtt_command_on}"
retain: true
on_turn_off:
- mqtt.publish:
topic: "${mqtt_this_device_status_topic2}"
payload: "${mqtt_command_off}"
retain: true
Reference in New Issue View Git Blame Copy Permalink