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

313 lines
12 KiB
YAML

#:########################################################################################:#
# TITLE: LAUNDRY MAIN LIGHTSWITCH
# zorruno.com layout v1.1 2026
#:########################################################################################:#
# REPO:
# https://home.fox.co.nz/gitea/zorruno/zorruno-homeassistant/src/branch/master/esphome/esp-laundrylights.yaml
#:########################################################################################:#
# VERSIONS:
# V3.6 2026-03-11 Updated yaml to zorruno layout V1.1
# V3.5 2025-07-24 YAML tidyups
# V3.0 2025-06-05 YAML tidyups
# V2.0 2025-06-01 Was initially a 3 button switch, now 2
# V1.0 2025-05-30 Initial Version
#:########################################################################################:#
# 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:
# - Button 1 toggles Relay 1 for the laundry lights
# - Button 2 supports two actions:
# - Single click toggles Relay 2 locally
# - Hold for 2 seconds or more sends MQTT ON/OFF to the remote device
# - Relay 2 is turned ON at boot
# - Remote MQTT status is subscribed to and normalised to ON/OFF/TRUE/FALSE/1/0
# - If the remote state is unknown, a hold on Button 2 defaults to sending ON
# - This switch is used for:
# - Laundry Lights (1)
# - Laundry Power Enable (2)
#:########################################################################################:#
# MQTT COMMANDS:
# - Remote device command topic:
# - ${mqtt_remote1_command_topic}
# - Remote device status topic:
# - ${mqtt_remote1_status_topic}
# - Hold Button 2:
# - Sends OFF if remote state is known and currently ON
# - Sends ON otherwise
#:########################################################################################:#
# OFFLINE NOTES:
# a) Home Assistant offline (network and MQTT online):
# - Local buttons and local relays continue to work
# - Remote MQTT control/status for Button 2 hold still works if the MQTT broker is online
#
# b) MQTT offline (or HA/MQTT offline):
# - Local buttons and local relays continue to work
# - Button 2 single click still toggles Relay 2 locally
# - Button 2 hold cannot control the remote MQTT device
#
# c) Entire WiFi/Network offline:
# - Local buttons and local relays continue to work
# - Remote MQTT control/status 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-laundrylights"
friendly_name: "Laundry Main Lightswitch (2)"
description_comment: "Laundry Main Lightswitch using a Zemismart KS-811 Double Push Button. Laundry Lights (1), Laundry Power Signal (2) (Layout V1.1)"
device_area: "Laundry" # 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: "v3.6" # 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-laundrylights_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_remote1_device_name: "3dprinter-power"
mqtt_remote1_command_topic: "${mqtt_command_main_topic}/${mqtt_remote1_device_name}" # Topic we will use to command this locally without HA
mqtt_remote1_status_topic: "${mqtt_status_main_topic}/${mqtt_remote1_device_name}" # Topic we will use to view status locally without HA
# Switch Naming
switch_1_name: "Laundry Lights"
switch_2_name: "Laundry Power Enable" # This is virtual only, no power connected to 3rd relay
#switch_3_name: "Fan 3 Relay"
#switch_4_name: "Fan 4 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_current_ip_address: "${current_ip_address}"
local_ota_pass: "${ota_pass}"
#### 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.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
#:########################################################################################:#
# STATUS LED:
# https://esphome.io/components/status_led.html
#:########################################################################################:#
status_led:
pin:
number: GPIO2
inverted: true
#:########################################################################################:#
# GLOBAL VARIABLES:
#:########################################################################################:#
globals:
- id: remote1_state
type: bool
restore_value: false
initial_value: "false"
- id: remote1_known
type: bool
restore_value: false
initial_value: "false"
#:########################################################################################:#
# BINARY SENSORS:
# https://esphome.io/components/binary_sensor/
#:########################################################################################:#
binary_sensor:
- platform: gpio
pin:
number: GPIO16
mode: INPUT
inverted: true
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_multi_click:
# SINGLE CLICK: quick tap -> toggle Relay_2
- timing:
- ON for at most 0.5s
- OFF for at least 0.5s
then:
- if:
condition:
lambda: |-
return id(Relay_2).state;
then:
- switch.turn_off: Relay_2
else:
- switch.turn_on: Relay_2
# HOLD: pressed for 2s or more -> toggle remote; default to ON if unknown
- timing:
- ON for at least 2s
then:
- if:
condition:
lambda: |-
return id(remote1_known) && id(remote1_state); // known AND currently ON
then:
- mqtt.publish:
topic: "${mqtt_remote1_command_topic}"
payload: "OFF"
retain: false
else:
- mqtt.publish:
topic: "${mqtt_remote1_command_topic}"
payload: "ON"
retain: false
#:########################################################################################:#
# TEXT SENSORS:
#:########################################################################################:#
text_sensor:
- platform: mqtt_subscribe
id: remote1_status
internal: true
topic: "${mqtt_remote1_status_topic}"
on_value:
then:
- lambda: |-
// copy, trim whitespace, uppercase
std::string s = x;
// trim leading/trailing whitespace
auto notspace = [](int ch) { return !std::isspace(ch); };
s.erase(s.begin(), std::find_if(s.begin(), s.end(), notspace));
s.erase(std::find_if(s.rbegin(), s.rend(), notspace).base(), s.end());
for (auto &c : s) c = (char) toupper(c);
bool recognized = false;
if (s == "ON" || s == "1" || s == "TRUE") {
id(remote1_state) = true;
id(remote1_known) = true;
recognized = true;
} else if (s == "OFF" || s == "0" || s == "FALSE") {
id(remote1_state) = false;
id(remote1_known) = true;
recognized = true;
} else {
// unknown payload (e.g. "ONLINE", "OFFLINE", JSON, etc.)
id(remote1_known) = false;
}
ESP_LOGI("remote1_status", "Parsed status='%s' -> known=%s state=%s",
s.c_str(),
id(remote1_known) ? "true" : "false",
id(remote1_state) ? "ON" : "OFF");
#:########################################################################################:#
# 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