Files
zorruno-homeassistant/esphome/esp-loungesouthleftswitch.yaml
T
2026-04-03 21:34:23 +13:00

285 lines
11 KiB
YAML

#:########################################################################################:#
# TITLE: LOUNGE SOUTH LEFT LIGHTSWITCH
# zorruno.com layout v1.1 2026
#:########################################################################################:#
# REPO:
# https://home.fox.co.nz/gitea/zorruno/zorruno-homeassistant/src/branch/master/esphome/esp-loungesouthleftswitch.yaml
#:########################################################################################:#
# VERSIONS:
# V4.1 2026-03-11 Updated yaml to zorruno layout V1.1
# V4.0 2025-10-04 Copied from other device
#:########################################################################################:#
# HARDWARE:
# - Zemismart KS-811 Double push button
# - ESP8266 based
# - pinout/schematic:
# https://community.home-assistant.io/t/zemismart-ks-811-working-with-esphome/
# - Relay 1 output on GPIO13
# - Relay 2 output on GPIO12
# - Button 1 input on GPIO16
# - Button 2 input on GPIO5
# - Status LED on GPIO2
#:########################################################################################:#
# OPERATION NOTES:
# - Lounge South Left switch with 2 outputs:
# 1) Wall Washer Left
# 2) Outside Light 1
# - Button 1 toggles Relay_1 locally
# - Button 2 toggles Relay_2 locally
# - Relay_2 is synchronised with a remote MQTT device:
# - Remote device name: garage-corridor-lights
# - Remote ON/OFF commands are mirrored locally
# - Local Relay_2 ON/OFF changes are published back to the remote topic
# - A guard flag is used to prevent MQTT feedback loops when Relay_2 state changes originate remotely
#:########################################################################################:#
# MQTT COMMANDS:
# - Remote command topic:
# - ${mqtt_remote_command_topic}
# - Remote status topic:
# - ${mqtt_remote_status_topic}
# - Payloads used:
# - ON
# - OFF
#:########################################################################################:#
# OFFLINE NOTES:
# a) Home Assistant offline (network and MQTT online):
# - Local button control continues to operate both relays
# - Relay_2 MQTT sync with the remote device continues if MQTT broker is online
#
# b) MQTT offline (or HA/MQTT offline):
# - Local button control continues to operate both relays
# - Relay_2 sync to the remote MQTT device is unavailable
#
# c) Entire WiFi/Network offline:
# - Local button control continues to operate both relays
# - Relay_2 sync to the remote MQTT device is unavailable
# - Accurate time is not needed; SNTP is not required for operation
#:########################################################################################:#
#:########################################################################################:#
# 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-loungesouthleftswitch"
friendly_name: "Lounge South Left Lightswitch (2)"
description_comment: "Lounge South Left Lightswitch using a Zemismart KS-811 Double Push Button. Wall Washer Left (1), Outside Light 1 (2) (Layout V1.1)"
device_area: "Lounge" # Allows ESP device to be automatically linked to an 'Area' in Home Assistant.
# Project Naming
project_name: "Zemismart Technologies.KS-811 Double" # Project Details
project_version: "v4.1" # Project V denotes release of yaml file, allowing checking of deployed vs latest version
# Passwords & Secrets
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-loungesouthleftswitch_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_command_main_topic: !secret mqtt_command_main_topic
mqtt_status_main_topic: !secret mqtt_status_main_topic
# Device Settings
#relay_icon: "mdi:lightbulb-group"
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_remote_device_name: "garage-corridor-lights"
mqtt_remote_command_topic: "${mqtt_command_main_topic}/${mqtt_remote_device_name}"
mqtt_remote_status_topic: "${mqtt_status_main_topic}/${mqtt_remote_device_name}"
mqtt_remote_device_command_ON: "ON"
mqtt_remote_device_command_OFF: "OFF"
# Switch Naming
switch_1_name: "Wall Washer Left"
switch_2_name: "Outside Light 1"
#:########################################################################################:#
# 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
#:########################################################################################:#
# LOGGER:
# https://esphome.io/components/logger.html
#:########################################################################################:#
logger:
level: "${log_level}" #INFO Level suggested, or DEBUG for testing
#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
#:########################################################################################:#
# GLOBAL VARIABLES:
#:########################################################################################:#
globals:
- id: relay2_change_origin_remote
type: bool
restore_value: false
initial_value: "false"
#:########################################################################################:#
# 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 # This pin doesn't support interrupts so use polling. Only suppresses a warning.
name: "Button 1: ${switch_1_name}"
on_press:
- switch.toggle: Relay_1
- platform: gpio
pin:
number: GPIO5
mode: INPUT
inverted: true
name: "Button 2: ${switch_2_name}"
on_press:
- switch.toggle: Relay_2
#:########################################################################################:#
# TEXT SENSOR COMPONENT:
# https://esphome.io/components/text_sensor/
#:########################################################################################:#
text_sensor:
- platform: mqtt_subscribe
id: remote2_status
topic: "${mqtt_remote_status_topic}"
on_value:
then:
- if:
condition:
lambda: |-
return x == "${mqtt_remote_device_command_ON}";
then:
- if:
condition:
not:
switch.is_on: Relay_2
then:
- lambda: |-
id(relay2_change_origin_remote) = true;
- switch.turn_on: Relay_2
- if:
condition:
lambda: |-
return x == "${mqtt_remote_device_command_OFF}";
then:
- if:
condition:
switch.is_on: Relay_2
then:
- lambda: |-
id(relay2_change_origin_remote) = true;
- switch.turn_off: Relay_2
#:########################################################################################:#
# 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
on_turn_on:
- if:
condition:
lambda: 'return !id(relay2_change_origin_remote);'
then:
- mqtt.publish:
topic: "${mqtt_remote_command_topic}"
payload: "${mqtt_remote_device_command_ON}"
- lambda: 'id(relay2_change_origin_remote) = false;'
on_turn_off:
- if:
condition:
lambda: 'return !id(relay2_change_origin_remote);'
then:
- mqtt.publish:
topic: "${mqtt_remote_command_topic}"
payload: "${mqtt_remote_device_command_OFF}"
- lambda: 'id(relay2_change_origin_remote) = false;'