ESPHome Device Builder
516 lines
20 KiB
YAML
516 lines
20 KiB
YAML
#:########################################################################################:#
|
|
# TITLE: MAIN BEDROOM MAIN LIGHTS SOUTH
|
|
# zorruno.com layout v1.1 2026
|
|
#:########################################################################################:#
|
|
# REPO:
|
|
# https://home.fox.co.nz/gitea/zorruno/zorruno-homeassistant/src/branch/master/esphome/esp-masterbdrmsouth.yaml
|
|
#:########################################################################################:#
|
|
# VERSIONS:
|
|
# v1.1 2026-06-12 North Lights now controlled via Tasmota iFan02 MQTT cmnd/stat topics.
|
|
# Relay 2 on both switches is virtual/mirror only and follows Tasmota feedback.
|
|
# Added sync guard globals/scripts to prevent MQTT/HA feedback chatter.
|
|
# v1.0 2026-06-11 Initial YAML for Master Bedroom South 3-gang switch.
|
|
#:########################################################################################:#
|
|
# HARDWARE:
|
|
# - Zemismart KS-811 Triple push button (ESP8266)
|
|
# - Pinout/Schematic: https://community.home-assistant.io/t/zemismart-ks-811-working-with-esphome/
|
|
#:########################################################################################:#
|
|
# OPERATION NOTES:
|
|
# - 3-gang KS-811 triple switch.
|
|
# - Relay 1 = Master Bedroom South Lights. PHYSICAL LOAD CONNECTED on this switch.
|
|
# - Relay 2 = Master Bedroom North Lights. VIRTUAL/MIRROR ONLY on this switch; no load connected.
|
|
# - Actual North Lights are controlled by Tasmota iFan02 entity light.tasmo_ifan02_3793_bedrm1_1.
|
|
# - Relay 3 = unused output. Forced off/internal; Button 3 does NOT toggle Relay 3.
|
|
# - Button 1 toggles South Lights locally by toggling Relay 1.
|
|
# - Button 2 requests North Lights ON/OFF via Tasmota MQTT and waits for Tasmota stat feedback.
|
|
# - Button 3 checks the Home Assistant bedside lamp jump/fade switch state and calls the opposite HA action.
|
|
# - South Lights are mirrored to the matching west switch in two ways:
|
|
# Method 1: HA blueprint sync between the relay entities (fast path when HA is online).
|
|
# Method 2: MQTT retained status sync between switches (backup path if HA is down, broker online).
|
|
# - North Lights are mirrored using:
|
|
# Method 1: HA blueprint sync between the two relay entities and light.tasmo_ifan02_3793_bedrm1_1.
|
|
# Method 2: Direct Tasmota MQTT cmnd/stat topics. Tasmota stat is the source of truth for Relay 2.
|
|
# - GPIO16 does not support interrupts; polling is used for Button 1 (suppresses warning).
|
|
#:########################################################################################:#
|
|
# MQTT COMMANDS:
|
|
# - North Lights Tasmota command topic:
|
|
# ${north_lights_tasmota_command_topic}
|
|
# Payload "ON" -> iFan02 Light ON
|
|
# Payload "OFF" -> iFan02 Light OFF
|
|
# Empty payload -> Query current Power1 state
|
|
#
|
|
# - North Lights Tasmota status topic:
|
|
# ${north_lights_tasmota_status_topic}
|
|
# Payload "ON" / "OFF" updates Relay 2 mirror state on both bedroom switches.
|
|
#
|
|
# - North Lights local command topic:
|
|
# ${mqtt_local_command_topic1}/set
|
|
# Payload "On"/"ON" -> Publish Tasmota Power1 ON command
|
|
# Payload "Off"/"OFF" -> Publish Tasmota Power1 OFF command
|
|
#
|
|
# - North Lights local status topic:
|
|
# ${mqtt_local_status_topic1}/state
|
|
# Payload "On" / "Off" retained when Relay 2 mirror changes.
|
|
# NOTE: For North Lights, this is a local status mirror only. Tasmota stat is the sync source of truth.
|
|
#
|
|
# - South Lights command topic:
|
|
# ${mqtt_local_command_topic2}/set
|
|
# Payload "On" -> Relay 1 ON
|
|
# Payload "Off" -> Relay 1 OFF
|
|
#
|
|
# - South Lights retained status/sync topic:
|
|
# ${mqtt_local_status_topic2}/state
|
|
# Payload "On" / "Off" published when Relay 1 changes state.
|
|
# This same retained status topic is also subscribed to for HA-down two-way sync.
|
|
#:########################################################################################:#
|
|
# OFFLINE NOTES:
|
|
# a) Home Assistant OFFLINE, WiFi OK, MQTT broker OK
|
|
# - Button 1 still controls/syncs South Lights between both switches via MQTT retained status.
|
|
# - Button 2 still controls the Tasmota/iFan02 North Lights via direct MQTT cmnd/stat topics.
|
|
# - iFan02/Tasmota feedback updates Relay 2 mirror state on both switches via stat topic.
|
|
# - Button 3 cannot toggle the bedside lamp because it requires Home Assistant/API.
|
|
#
|
|
# b) MQTT OFFLINE (or broker unreachable), Home Assistant/API OK
|
|
# - Button 1 and Button 2 can still control/sync through HA where the relevant HA entities are available.
|
|
# - Button 3 can still toggle the bedside lamp via Home Assistant/API.
|
|
#
|
|
# c) Home Assistant and MQTT OFFLINE, WiFi OK or entire network OFFLINE
|
|
# - Button 1 controls local Relay 1 only.
|
|
# - Button 2 cannot control the North Lights because they are on the separate Tasmota/iFan02 controller.
|
|
# - Button 3 cannot control the bedside lamp.
|
|
# - 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-masterbdrmsouth"
|
|
friendly_name: "Master Bedroom Main Lights South"
|
|
description_comment: "Master Bedroom Main Lights South using a Zemismart KS-811 Triple Push Button. South Lights physical on Relay 1, North Lights Tasmota/iFan02 mirror on Relay 2, Button 3 toggles bedside lamp jump/fade. (Layout V1.1)"
|
|
device_area: "Master Bedroom"
|
|
|
|
# Project Naming
|
|
project_name: "Zemismart Technologies.KS-811 Triple"
|
|
project_version: "v1.1"
|
|
|
|
# Passwords & Secrets
|
|
api_key: !secret esp-api_key
|
|
ota_pass: !secret esp-ota_pass
|
|
static_ip_address: !secret esp-masterbdrmsouth_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
|
|
# NOTE: device_name1 is North Lights and maps to Relay 2 mirror on both bedroom switches.
|
|
mqtt_device_name1: "masterbrdm-northlights"
|
|
mqtt_local_command_topic1: "${mqtt_command_main_topic}/${mqtt_device_name1}"
|
|
mqtt_local_status_topic1: "${mqtt_status_main_topic}/${mqtt_device_name1}"
|
|
|
|
# NOTE: device_name2 is South Lights and maps to Relay 1 on both bedroom switches.
|
|
mqtt_device_name2: "masterbrdm-southlights"
|
|
mqtt_local_command_topic2: "${mqtt_command_main_topic}/${mqtt_device_name2}"
|
|
mqtt_local_status_topic2: "${mqtt_status_main_topic}/${mqtt_device_name2}"
|
|
|
|
# Tasmota/iFan02 North Lights MQTT control and feedback
|
|
north_lights_tasmota_command_topic: "cmnd/tasmo-ifan02-3793-bedrm1-1/Power1"
|
|
north_lights_tasmota_status_topic: "stat/tasmo-ifan02-3793-bedrm1-1/Power1"
|
|
|
|
# Switch/Relay/Button Naming
|
|
switch_1_name: "Master Bedroom South Lights"
|
|
switch_2_name: "Master Bedroom North Lights"
|
|
switch_3_name: "Bedside Lamp Jump/Fade" # NOTE: Relay 3 output is unused and forced off
|
|
|
|
# Home Assistant bedside lamp entity controlled by Button 3
|
|
bedside_lamp_entity: "switch.master_bedroom_bedside_lamp_arlec_bulb_master_bedroom_bedside_lamp_arlec_bulb_jump_fade_up_down"
|
|
|
|
#:########################################################################################:#
|
|
# 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}"
|
|
|
|
#:########################################################################################:#
|
|
# 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
|
|
|
|
#:########################################################################################:#
|
|
# GLOBALS
|
|
# Used to suppress MQTT feedback loops/chatter when a relay state is being set from MQTT feedback.
|
|
#:########################################################################################:#
|
|
globals:
|
|
- id: south_update_from_mqtt
|
|
type: bool
|
|
restore_value: false
|
|
initial_value: 'false'
|
|
|
|
- id: north_update_from_tasmota
|
|
type: bool
|
|
restore_value: false
|
|
initial_value: 'false'
|
|
|
|
#:########################################################################################:#
|
|
# MQTT: Device-specific MQTT command + retained status/sync triggers
|
|
# This adds device-specific MQTT command triggers to the common MQTT configuration.
|
|
#:########################################################################################:#
|
|
mqtt:
|
|
# Query the iFan02/Tasmota light state whenever this ESP reconnects to MQTT.
|
|
# Tasmota treats an empty command payload as a status query for that command.
|
|
on_connect:
|
|
then:
|
|
- delay: 2s
|
|
- mqtt.publish:
|
|
topic: "${north_lights_tasmota_command_topic}"
|
|
payload: ""
|
|
|
|
on_message:
|
|
# -------------------------------------------------------------------------
|
|
# North Lights local command topic -> Tasmota/iFan02 command topic
|
|
# -------------------------------------------------------------------------
|
|
- topic: "${mqtt_local_command_topic1}/set"
|
|
then:
|
|
- lambda: |-
|
|
if (x == "On" || x == "ON" || x == "on") {
|
|
id(request_north_lights_on).execute();
|
|
} else if (x == "Off" || x == "OFF" || x == "off") {
|
|
id(request_north_lights_off).execute();
|
|
}
|
|
|
|
# Tasmota/iFan02 Power1 feedback is the source of truth for Relay 2 mirror state.
|
|
- topic: "${north_lights_tasmota_status_topic}"
|
|
then:
|
|
- lambda: |-
|
|
if (x == "ON" || x == "On" || x == "on") {
|
|
id(set_north_on_from_tasmota).execute();
|
|
} else if (x == "OFF" || x == "Off" || x == "off") {
|
|
id(set_north_off_from_tasmota).execute();
|
|
}
|
|
|
|
# -------------------------------------------------------------------------
|
|
# South Lights control/sync (Relay 1 on both bedroom switches)
|
|
# -------------------------------------------------------------------------
|
|
- topic: "${mqtt_local_command_topic2}/set"
|
|
then:
|
|
- lambda: |-
|
|
if (x == "On" || x == "ON" || x == "on") {
|
|
id(set_south_on_from_command).execute();
|
|
} else if (x == "Off" || x == "OFF" || x == "off") {
|
|
id(set_south_off_from_command).execute();
|
|
}
|
|
|
|
# Retained status is also subscribed to as the MQTT backup sync path.
|
|
- topic: "${mqtt_local_status_topic2}/state"
|
|
then:
|
|
- lambda: |-
|
|
if (x == "On" || x == "ON" || x == "on") {
|
|
id(set_south_on_from_mqtt).execute();
|
|
} else if (x == "Off" || x == "OFF" || x == "off") {
|
|
id(set_south_off_from_mqtt).execute();
|
|
}
|
|
|
|
#:########################################################################################:#
|
|
# 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)
|
|
# NOTE: This does not toggle Relay 2 directly. It sends the opposite command to the iFan02/Tasmota light.
|
|
# Relay 2 mirror state is then updated by the Tasmota stat/Power1 feedback topic.
|
|
- platform: gpio
|
|
pin:
|
|
number: GPIO05
|
|
mode: INPUT
|
|
inverted: true
|
|
name: "Button 2: ${switch_2_name}"
|
|
on_press:
|
|
- script.execute: toggle_north_lights
|
|
|
|
# Button 3 (GPIO04)
|
|
# NOTE: This does not toggle Relay 3. It checks the HA entity state and calls the opposite HA action.
|
|
- platform: gpio
|
|
pin:
|
|
number: GPIO4
|
|
mode: INPUT
|
|
inverted: true
|
|
name: "Button 3: ${switch_3_name}"
|
|
on_press:
|
|
- script.execute: toggle_bedside_lamp_jump_fade
|
|
|
|
# Home Assistant state import used by Button 3 so it can choose ON vs OFF explicitly.
|
|
- platform: homeassistant
|
|
id: bedside_lamp_jump_fade_state
|
|
entity_id: "${bedside_lamp_entity}"
|
|
internal: true
|
|
|
|
#:########################################################################################:#
|
|
# SCRIPT
|
|
# https://esphome.io/components/script.html
|
|
#:########################################################################################:#
|
|
script:
|
|
# ---------------------------------------------------------------------------
|
|
# North Lights scripts - Tasmota/iFan02 is source of truth
|
|
# ---------------------------------------------------------------------------
|
|
- id: request_north_lights_on
|
|
mode: restart
|
|
then:
|
|
- mqtt.publish:
|
|
topic: "${north_lights_tasmota_command_topic}"
|
|
payload: "ON"
|
|
|
|
- id: request_north_lights_off
|
|
mode: restart
|
|
then:
|
|
- mqtt.publish:
|
|
topic: "${north_lights_tasmota_command_topic}"
|
|
payload: "OFF"
|
|
|
|
- id: toggle_north_lights
|
|
mode: restart
|
|
then:
|
|
- if:
|
|
condition:
|
|
switch.is_on: relay_2
|
|
then:
|
|
- script.execute: request_north_lights_off
|
|
else:
|
|
- script.execute: request_north_lights_on
|
|
|
|
- id: set_north_on_from_tasmota
|
|
mode: restart
|
|
then:
|
|
- lambda: |-
|
|
id(north_update_from_tasmota) = true;
|
|
- switch.turn_on: relay_2
|
|
- delay: 100ms
|
|
- lambda: |-
|
|
id(north_update_from_tasmota) = false;
|
|
|
|
- id: set_north_off_from_tasmota
|
|
mode: restart
|
|
then:
|
|
- lambda: |-
|
|
id(north_update_from_tasmota) = true;
|
|
- switch.turn_off: relay_2
|
|
- delay: 100ms
|
|
- lambda: |-
|
|
id(north_update_from_tasmota) = false;
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# South Lights scripts - MQTT retained status sync with no re-publish chatter
|
|
# ---------------------------------------------------------------------------
|
|
- id: set_south_on_from_command
|
|
mode: restart
|
|
then:
|
|
- switch.turn_on: relay_1
|
|
|
|
- id: set_south_off_from_command
|
|
mode: restart
|
|
then:
|
|
- switch.turn_off: relay_1
|
|
|
|
- id: set_south_on_from_mqtt
|
|
mode: restart
|
|
then:
|
|
- lambda: |-
|
|
id(south_update_from_mqtt) = true;
|
|
- switch.turn_on: relay_1
|
|
- delay: 100ms
|
|
- lambda: |-
|
|
id(south_update_from_mqtt) = false;
|
|
|
|
- id: set_south_off_from_mqtt
|
|
mode: restart
|
|
then:
|
|
- lambda: |-
|
|
id(south_update_from_mqtt) = true;
|
|
- switch.turn_off: relay_1
|
|
- delay: 100ms
|
|
- lambda: |-
|
|
id(south_update_from_mqtt) = false;
|
|
|
|
# ---------------------------------------------------------------------------
|
|
# Button 3 - HA bedside lamp jump/fade switch
|
|
# ---------------------------------------------------------------------------
|
|
# Toggle the HA bedside lamp jump/fade switch by checking the current imported HA state first.
|
|
# If it is ON, send OFF. If it is OFF/unknown, send ON.
|
|
- id: toggle_bedside_lamp_jump_fade
|
|
mode: restart
|
|
then:
|
|
- if:
|
|
condition:
|
|
api.connected:
|
|
state_subscription_only: true
|
|
then:
|
|
- if:
|
|
condition:
|
|
binary_sensor.is_on: bedside_lamp_jump_fade_state
|
|
then:
|
|
- homeassistant.action:
|
|
action: switch.turn_off
|
|
data:
|
|
entity_id: "${bedside_lamp_entity}"
|
|
else:
|
|
- homeassistant.action:
|
|
action: switch.turn_on
|
|
data:
|
|
entity_id: "${bedside_lamp_entity}"
|
|
else:
|
|
- logger.log:
|
|
level: WARN
|
|
format: "Button 3 pressed, but Home Assistant/API is not connected. Bedside lamp not toggled."
|
|
|
|
#:########################################################################################:#
|
|
# SWITCH
|
|
# https://esphome.io/components/switch/
|
|
#:########################################################################################:#
|
|
switch:
|
|
# Relay 1 (GPIO13) - Master Bedroom South Lights - PHYSICAL LOAD CONNECTED HERE
|
|
- platform: gpio
|
|
name: "Relay 1: ${switch_1_name}"
|
|
pin: GPIO13
|
|
id: relay_1
|
|
restore_mode: RESTORE_DEFAULT_OFF
|
|
on_turn_on:
|
|
- if:
|
|
condition:
|
|
lambda: 'return !id(south_update_from_mqtt);'
|
|
then:
|
|
- mqtt.publish:
|
|
topic: "${mqtt_local_status_topic2}/state"
|
|
payload: "On"
|
|
retain: true
|
|
on_turn_off:
|
|
- if:
|
|
condition:
|
|
lambda: 'return !id(south_update_from_mqtt);'
|
|
then:
|
|
- mqtt.publish:
|
|
topic: "${mqtt_local_status_topic2}/state"
|
|
payload: "Off"
|
|
retain: true
|
|
|
|
# Relay 2 (GPIO12) - Master Bedroom North Lights - VIRTUAL/MIRROR ONLY ON THIS SWITCH
|
|
# Tasmota stat/Power1 is the source of truth. Local relay state mirrors actual North Lights state.
|
|
- platform: gpio
|
|
name: "Relay 2: ${switch_2_name}"
|
|
pin: GPIO12
|
|
id: relay_2
|
|
restore_mode: RESTORE_DEFAULT_OFF
|
|
on_turn_on:
|
|
- mqtt.publish:
|
|
topic: "${mqtt_local_status_topic1}/state"
|
|
payload: "On"
|
|
retain: true
|
|
- if:
|
|
condition:
|
|
lambda: 'return !id(north_update_from_tasmota);'
|
|
then:
|
|
- mqtt.publish:
|
|
topic: "${north_lights_tasmota_command_topic}"
|
|
payload: "ON"
|
|
on_turn_off:
|
|
- mqtt.publish:
|
|
topic: "${mqtt_local_status_topic1}/state"
|
|
payload: "Off"
|
|
retain: true
|
|
- if:
|
|
condition:
|
|
lambda: 'return !id(north_update_from_tasmota);'
|
|
then:
|
|
- mqtt.publish:
|
|
topic: "${north_lights_tasmota_command_topic}"
|
|
payload: "OFF"
|
|
|
|
# Relay 3 (GPIO14) - unused output, intentionally not exposed to Home Assistant.
|
|
# Button 3 controls the bedside lamp via Home Assistant/API instead.
|
|
- platform: gpio
|
|
name: "Relay 3: Unused Output Forced Off"
|
|
pin: GPIO14
|
|
id: relay_3
|
|
restore_mode: ALWAYS_OFF
|
|
internal: true
|