326 lines
11 KiB
YAML
326 lines
11 KiB
YAML
#:########################################################################################:#
|
|
# TITLE: OFFICE MAIN LIGHTSWITCH
|
|
# zorruno.com layout v1.1 2026
|
|
#:########################################################################################:#
|
|
# REPO:
|
|
# https://home.fox.co.nz/gitea/zorruno/zorruno-homeassistant/src/branch/master/esphome/esp-officelights.yaml
|
|
#:########################################################################################:#
|
|
# VERSIONS:
|
|
# v2.1 2026-02-25 Updated yaml to zorruno layout V1.1
|
|
# v2.0 2025-06-05 YAML Tidyups
|
|
# v1.0 2025-05-31 Initial Version
|
|
#:########################################################################################:#
|
|
# HARDWARE:
|
|
# - Zemismart KS-811 Triple push button (ESP8266)
|
|
# - Pinout/Schematic: https://community.home-assistant.io/t/zemismart-ks-811-working-with-esphome/
|
|
#:########################################################################################:#
|
|
# OPERATION NOTES:
|
|
# - Office 3-gang KS-811 (Triple) wall switch.
|
|
# - Button 1 toggles Relay 1 (Nighttime Lights) - only relay actually wired to a load.
|
|
# - Button 2 toggles Relay 2 (Daytime Lights) - virtual only (no physical load connected).
|
|
# - Button 3 toggles Relay 3 (Spare) - virtual only (no physical load connected).
|
|
# - GPIO16 does not support interrupts; polling is used for Button 1.
|
|
#:########################################################################################:#
|
|
# OFFLINE NOTES:
|
|
# a) Home Assistant OFFLINE, WiFi OK
|
|
# - Physical buttons still control relays locally.
|
|
# - MQTT is optional; device operates as a normal switch without HA.
|
|
#
|
|
# b) MQTT OFFLINE (or broker unreachable)
|
|
# - Physical buttons still control relays locally.
|
|
# - HA/API control (if available) still works, but no MQTT command/status.
|
|
#
|
|
# c) Entire WiFi/Network OFFLINE
|
|
# - Physical buttons still control relays locally.
|
|
# - Accurate time is NOT needed (SNTP not needed).
|
|
#:########################################################################################:#
|
|
|
|
|
|
#:########################################################################################:#
|
|
# 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-officelights"
|
|
friendly_name: "Office Main Lightswitch (3)"
|
|
description_comment: "Office Main Lightswitch using a Zemismart KS-811 Triple Push Button. Bunker Light A (1), Spare A (2), Spare B (3) (Layout V1.1)"
|
|
device_area: "Office"
|
|
|
|
# Project Naming
|
|
project_name: "Zemismart Technologies.KS-811 Triple"
|
|
project_version: "v2.1"
|
|
|
|
# Passwords & Secrets
|
|
api_key: !secret esp-api_key
|
|
ota_pass: !secret esp-ota_pass
|
|
static_ip_address: !secret esp-officelights_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"
|
|
update_interval: "60s"
|
|
|
|
# MQTT LOCAL Controls
|
|
# Topic that remote things will use to command this locally without HA
|
|
mqtt_local_device1_name: "office-main-lights-left"
|
|
mqtt_local_command1_topic: "${mqtt_command_main_topic}/${mqtt_local_device1_name}"
|
|
mqtt_local_status1_topic: "${mqtt_status_main_topic}/${mqtt_local_device1_name}"
|
|
|
|
mqtt_local_device2_name: "office-main-lights-right"
|
|
mqtt_local_command2_topic: "${mqtt_command_main_topic}/${mqtt_local_device2_name}"
|
|
mqtt_local_status2_topic: "${mqtt_status_main_topic}/${mqtt_local_device2_name}"
|
|
|
|
# Switch Naming
|
|
switch_1_name: "Nighttime Lights" # Only one light (Bunker Light) actually connected to this relay
|
|
switch_2_name: "Daytime Lights" # Virtual only, no power connected to 2nd relay
|
|
switch_3_name: "Spare" # Virtual only, no power connected to 3rd 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_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}"
|
|
|
|
#### 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}"
|
|
area: "${device_area}"
|
|
project:
|
|
name: "${project_name}"
|
|
version: "${project_version}"
|
|
#on_boot:
|
|
# priority: 200
|
|
# then:
|
|
# - switch.turn_on: relay_3
|
|
|
|
#:########################################################################################:#
|
|
# ESP PLATFORM AND FRAMEWORK
|
|
# https://esphome.io/components/esp8266.html
|
|
#:########################################################################################:#
|
|
esp8266:
|
|
board: esp01_1m
|
|
early_pin_init: false
|
|
board_flash_mode: dout
|
|
|
|
#:########################################################################################:#
|
|
# LOGGING
|
|
# https://esphome.io/components/logger.html
|
|
#:########################################################################################:#
|
|
logger:
|
|
level: "${log_level}"
|
|
#baud_rate: 0
|
|
id: logger_id
|
|
|
|
#:########################################################################################:#
|
|
# 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:
|
|
# Button 1 (GPIO16) - polling (GPIO16 has no interrupts)
|
|
- platform: gpio
|
|
pin:
|
|
number: GPIO16
|
|
mode: INPUT
|
|
inverted: true
|
|
use_interrupt: false
|
|
name: "Button 1: ${switch_1_name}"
|
|
on_press:
|
|
- switch.toggle: Relay_1
|
|
|
|
# Button 2 (GPIO05)
|
|
- platform: gpio
|
|
pin:
|
|
number: GPIO05
|
|
mode: INPUT
|
|
inverted: true
|
|
name: "Button 2: ${switch_2_name}"
|
|
on_press:
|
|
- switch.toggle: Relay_2
|
|
|
|
# Button 3 (GPIO4)
|
|
- platform: gpio
|
|
pin:
|
|
number: GPIO4
|
|
mode: INPUT
|
|
inverted: true
|
|
name: "Button 3: ${switch_3_name}"
|
|
on_press:
|
|
- switch.toggle: Relay_3
|
|
|
|
#:########################################################################################:#
|
|
# 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);
|
|
|
|
- topic: "${mqtt_local_command2_topic}"
|
|
payload: "On"
|
|
then:
|
|
- script.stop: relay_2_timer_script
|
|
- switch.turn_on: Relay_2
|
|
|
|
- topic: "${mqtt_local_command2_topic}"
|
|
payload: "Off"
|
|
then:
|
|
- script.stop: relay_2_timer_script
|
|
- switch.turn_off: Relay_2
|
|
|
|
- topic: "${mqtt_local_command2_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_2_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
|
|
|
|
- id: relay_2_timer_script
|
|
mode: restart
|
|
parameters:
|
|
timer_duration_ms: int
|
|
then:
|
|
- switch.turn_on: Relay_2
|
|
- delay: !lambda "return timer_duration_ms;"
|
|
- switch.turn_off: Relay_2
|
|
|
|
#:########################################################################################:#
|
|
# SWITCH
|
|
# https://esphome.io/components/switch/
|
|
#:########################################################################################:#
|
|
switch:
|
|
# Relay 1 (GPIO13)
|
|
- platform: gpio
|
|
name: "Relay 1: ${switch_1_name}"
|
|
pin: GPIO13
|
|
id: Relay_1
|
|
|
|
# Relay 2 (GPIO12)
|
|
- platform: gpio
|
|
name: "Relay 2: ${switch_2_name}"
|
|
pin: GPIO12
|
|
id: Relay_2
|
|
|
|
# Relay 3 (GPIO14)
|
|
- platform: gpio
|
|
name: "Relay 3: ${switch_3_name}"
|
|
pin: GPIO14
|
|
id: Relay_3 |