zorruno/zorruno-homeassistant
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
809f9ada66c893e1c4dd8e84ca21ee904c9f0f01
zorruno-homeassistant/esphome/esp-laundrylights.yaml
T

313 lines
12 KiB
YAML
Raw Blame History

#:########################################################################################:#
# 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.7 2026-04-24 Reviewed MQTT timer control, corrected notes, added local MQTT status publishing
# 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 single click toggles Relay 2 locally
# - Relay 2 is turned ON at boot
# - MQTT command topic supports external control of Relay 1, such as from an occupancy sensor
# - MQTT payload On turns Relay 1 ON and cancels any active timer
# - MQTT payload Off turns Relay 1 OFF and cancels any active timer
# - MQTT numeric payloads from 1 to 3600 turn Relay 1 ON for that many seconds
# - Any MQTT payload outside 1 to 3600 seconds is ignored
# - Relay 1 status is published to the local MQTT status topic as On or Off
# - This switch is used for:
# - Laundry Lights (1)
# - Laundry Power Enable (2)
#:########################################################################################:#
# MQTT COMMANDS:
# - Local command topic:
# - ${mqtt_local_command1_topic}
# - Accepted command payloads:
# - On
# - Off
# - 1 to 3600 seconds
# - Local status topic:
# - ${mqtt_local_status_topic}
# - Published status payloads:
# - On
# - Off
#:########################################################################################:#
# OFFLINE NOTES:
# a) Home Assistant offline (network and MQTT online):
# - Local buttons and local relays continue to work
# - MQTT control and MQTT timer commands continue to work if the MQTT broker is online
#
# b) MQTT offline (or HA/MQTT offline):
# - Local buttons and local relays continue to work
# - MQTT control, MQTT timer commands, and MQTT status publishing are unavailable
#
# c) Entire WiFi/Network offline:
# - Local buttons and local relays continue to work
# - MQTT control, MQTT timer commands, and MQTT status publishing are 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.7" # 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
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
#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 LOCAL Controls
mqtt_local_device1_name: "laundry-lights"
mqtt_local_command1_topic: "${mqtt_command_main_topic}/${mqtt_local_device1_name}" # Topic that remote things will use to command this locally without HA
mqtt_local_status_topic: "${mqtt_status_main_topic}/${mqtt_local_device1_name}" # Topic that remote things will use to view local Relay 1 status without HA
# Switch Naming
switch_1_name: "Laundry Lights"
switch_2_name: "Laundry Power Enable"
#:########################################################################################:#
# 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
#:########################################################################################:#
# BINARY SENSORS:
# https://esphome.io/components/binary_sensor/
#:########################################################################################:#
binary_sensor:
- platform: gpio
pin:
number: GPIO16
mode: INPUT
inverted: true
use_interrupt: false # This device GPIO pin doesn't support them
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 toggles 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
#:########################################################################################:#
# MQTT COMPONENT:
# Device-specific MQTT command triggers
# https://esphome.io/components/mqtt.html
#:########################################################################################:#
mqtt:
on_message:
- topic: "${mqtt_local_command1_topic}"
payload: "On"
then:
- script.stop: relay_1_timer_script
- switch.turn_on: Relay_1
- topic: "${mqtt_local_command1_topic}"
payload: "Off"
then:
- script.stop: relay_1_timer_script
- switch.turn_off: Relay_1
- topic: "${mqtt_local_command1_topic}"
then:
- lambda: |-
if (x.empty()) {
return;
}
bool numeric_payload = true;
for (char c : x) {
if (c < '0' || c > '9') {
numeric_payload = false;
break;
}
}
if (!numeric_payload) {
return;
}
const int timer_seconds = atoi(x.c_str());
if (timer_seconds < 1 || timer_seconds > 3600) {
return;
}
id(relay_1_timer_script)->execute(timer_seconds * 1000);
#:########################################################################################:#
# SCRIPT COMPONENT:
# Relay 1 timer script
# mode: restart means a new valid timer value restarts the timer from zero
# https://esphome.io/components/script.html
#:########################################################################################:#
script:
- id: relay_1_timer_script
mode: restart
parameters:
timer_duration_ms: int
then:
- switch.turn_on: Relay_1
- delay: !lambda "return timer_duration_ms;"
- switch.turn_off: Relay_1
#:########################################################################################:#
# 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_local_status_topic}"
payload: "On"
on_turn_off:
- mqtt.publish:
topic: "${mqtt_local_status_topic}"
payload: "Off"
- platform: gpio
name: "Relay 2: ${switch_2_name}"
pin: GPIO12
id: Relay_2
Reference in New Issue View Git Blame Copy Permalink