esphome devices & scripts
This commit is contained in:
root
@@ -6,6 +6,9 @@
|
||||
# https://home.fox.co.nz/gitea/zorruno/zorruno-homeassistant/src/branch/master/esphome/esp-mainhallwaylights.yaml
|
||||
#:########################################################################################:#
|
||||
# VERSIONS:
|
||||
# V1.3 2026-05-07 Refactored MQTT sync to use template HA switch actions; physical button and
|
||||
# HA control now publish command topics; relay callbacks publish status only
|
||||
# to prevent command ping-pong/chattering.
|
||||
# V1.2 2026-04-03 Fixed local button logic so physical press toggles relay; moved custom MQTT
|
||||
# status publish to relay state changes; corrected ESP8266 notes and wording
|
||||
# V1.1 2026-04-03 Updated yaml to zorruno layout V1.1; corrected KS-811 single naming and
|
||||
@@ -14,27 +17,38 @@
|
||||
#:########################################################################################:#
|
||||
# HARDWARE:
|
||||
# - Zemismart KS-811 Single push button
|
||||
# - ESP8266 variant
|
||||
# - Button 1: GPIO0
|
||||
# - Relay 1: GPIO12
|
||||
# - Status LED: GPIO2 (inverted)
|
||||
#:########################################################################################:#
|
||||
# OPERATION NOTES:
|
||||
# - Main hallway switch with 1 output:
|
||||
# 1) Main Hallway Lights
|
||||
# - A single press of the physical button toggles Relay 1 ON/OFF locally
|
||||
# - Relay state is published to the custom MQTT status topic for remote sync
|
||||
# - Status LED uses GPIO2
|
||||
# - A single press of the physical button toggles the Main Hallway Lights group.
|
||||
# - Home Assistant control of the exposed template switch also toggles the same group.
|
||||
# - MQTT command topic requests On/Off changes.
|
||||
# - Relay state changes publish retained status only.
|
||||
# - Relays never publish command topics directly. This prevents command ping-pong/chattering.
|
||||
#:########################################################################################:#
|
||||
# MQTT COMMANDS:
|
||||
# - None
|
||||
# - ${mqtt_this_device_command_topic1}
|
||||
# Payloads: ${mqtt_command_on}, ${mqtt_command_off}
|
||||
# - Status topic:
|
||||
# - ${mqtt_this_device_status_topic1}
|
||||
# Payloads mirror the actual relay state and are published retained.
|
||||
#:########################################################################################:#
|
||||
# OFFLINE NOTES:
|
||||
# - a) Home Assistant offline (network and MQTT online):
|
||||
# - Device remains on WiFi and MQTT
|
||||
# - Physical button still toggles relay locally
|
||||
# - Local button control continues.
|
||||
# - MQTT command/status operation continues.
|
||||
# - b) MQTT offline (or Home Assistant and MQTT offline):
|
||||
# - Physical button still toggles relay locally
|
||||
# - Remote control/state sync is unavailable until MQTT returns
|
||||
# - Local button control continues.
|
||||
# - If Home Assistant is online and connected by native ESPHome API, HA control can still
|
||||
# change the local relay but remote MQTT sync is unavailable until MQTT returns.
|
||||
# - c) Entire WiFi/network offline:
|
||||
# - Physical button still toggles relay locally
|
||||
# - Accurate time is not needed; SNTP is not used
|
||||
# - Local wall-switch button control continues.
|
||||
# - Accurate time is not needed. SNTP is not used for this device.
|
||||
#:########################################################################################:#
|
||||
|
||||
#:########################################################################################:#
|
||||
@@ -50,7 +64,7 @@ substitutions:
|
||||
|
||||
# Project Naming
|
||||
project_name: "Zemismart Technologies.KS-811 Single" # Project Details
|
||||
project_version: "v1.1" # Project V denotes release of yaml file, allowing checking of deployed vs latest version
|
||||
project_version: "v1.3" # Project V denotes release of yaml file, allowing checking of deployed vs latest version
|
||||
|
||||
# Passwords
|
||||
api_key: !secret esp-api_key # unfortunately you can't use substitutions inside secrets names
|
||||
@@ -64,17 +78,21 @@ substitutions:
|
||||
current_ip_address: ${static_ip_address}
|
||||
|
||||
# Device Settings
|
||||
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
|
||||
log_level: "INFO" # NONE, ERROR, WARN, INFO, DEBUG, VERBOSE, VERY_VERBOSE
|
||||
update_interval: "60s" # General sensor update interval
|
||||
|
||||
# MQTT REMOTE Controls
|
||||
# Default relay restore mode
|
||||
# Options: RESTORE_DEFAULT_OFF, RESTORE_DEFAULT_ON, ALWAYS_ON, ALWAYS_OFF
|
||||
relay_restore_mode: "RESTORE_DEFAULT_OFF"
|
||||
|
||||
# MQTT Remote Controls
|
||||
mqtt_this_device_function1: "mainhallway-mainlights"
|
||||
mqtt_this_device_command_topic1: "${mqtt_command_main_topic}/${mqtt_this_device_function1}"
|
||||
mqtt_this_device_status_topic1: "${mqtt_status_main_topic}/${mqtt_this_device_function1}"
|
||||
mqtt_command_on: "On"
|
||||
mqtt_command_off: "Off"
|
||||
|
||||
# Switch/Relay/Button Naming & Icons
|
||||
# Switch/Relay/Button Naming
|
||||
switch_1_name: "Main Hallway Lights"
|
||||
|
||||
#:########################################################################################:#
|
||||
@@ -123,7 +141,7 @@ packages:
|
||||
esphome:
|
||||
name: "${device_name}"
|
||||
friendly_name: "${friendly_name}"
|
||||
comment: "${description_comment}" # Appears on the esphome page in HA
|
||||
comment: "${description_comment}" # Appears on the ESPHome page in HA
|
||||
area: "${device_area}"
|
||||
project:
|
||||
name: "${project_name}"
|
||||
@@ -135,8 +153,8 @@ esphome:
|
||||
#:########################################################################################:#
|
||||
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
|
||||
early_pin_init: false # Recommended false where relays/switches are involved
|
||||
board_flash_mode: dout
|
||||
|
||||
#:########################################################################################:#
|
||||
# LOGGING
|
||||
@@ -144,15 +162,17 @@ esp8266:
|
||||
#:########################################################################################:#
|
||||
logger:
|
||||
level: "${log_level}"
|
||||
#baud_rate: 0 # set to 0 for no logging via UART, needed if you are using it for other serial things (eg PZEM)
|
||||
#baud_rate: 0 # Set to 0 for no logging via UART if UART is needed elsewhere
|
||||
#esp8266_store_log_strings_in_flash: false
|
||||
#tx_buffer_size: 64
|
||||
|
||||
#:########################################################################################:#
|
||||
# MQTT: Device-specific MQTT command triggers
|
||||
# This adds device-specific MQTT command triggers to the common MQTT configuration.
|
||||
# This extends the common MQTT package with local custom command/status topics.
|
||||
#:########################################################################################:#
|
||||
mqtt:
|
||||
# Republish current relay state whenever MQTT reconnects so retained status stays accurate
|
||||
# for subscribers that reconnect later.
|
||||
on_connect:
|
||||
- mqtt.publish:
|
||||
topic: "${mqtt_this_device_status_topic1}"
|
||||
@@ -161,23 +181,23 @@ mqtt:
|
||||
retain: true
|
||||
|
||||
on_message:
|
||||
# Mirror remote command onto Relay_1, but only if a real state change is needed.
|
||||
# Do not republish the command from here. Relay status is published by the relay callback.
|
||||
- topic: "${mqtt_this_device_command_topic1}"
|
||||
payload: "${mqtt_command_on}"
|
||||
then:
|
||||
- delay: 50ms
|
||||
- if:
|
||||
condition:
|
||||
lambda: 'return !id(Relay_1).state;'
|
||||
lambda: "return !id(Relay_1).state;"
|
||||
then:
|
||||
- switch.turn_on: Relay_1
|
||||
|
||||
- topic: "${mqtt_this_device_command_topic1}"
|
||||
payload: "${mqtt_command_off}"
|
||||
then:
|
||||
- delay: 50ms
|
||||
- if:
|
||||
condition:
|
||||
lambda: 'return id(Relay_1).state;'
|
||||
lambda: "return id(Relay_1).state;"
|
||||
then:
|
||||
- switch.turn_off: Relay_1
|
||||
|
||||
@@ -187,8 +207,55 @@ mqtt:
|
||||
#:########################################################################################:#
|
||||
status_led:
|
||||
pin:
|
||||
number: GPIO02
|
||||
inverted: yes
|
||||
number: GPIO2
|
||||
inverted: true
|
||||
|
||||
#:########################################################################################:#
|
||||
# SCRIPTS
|
||||
# https://esphome.io/components/script.html
|
||||
#:########################################################################################:#
|
||||
script:
|
||||
# Local/HA requested ON. Change the local relay immediately, then publish a non-retained
|
||||
# command so any other linked switch follows.
|
||||
- id: mainhallway_mainlights_on
|
||||
mode: restart
|
||||
then:
|
||||
- if:
|
||||
condition:
|
||||
lambda: "return !id(Relay_1).state;"
|
||||
then:
|
||||
- switch.turn_on: Relay_1
|
||||
- mqtt.publish:
|
||||
topic: "${mqtt_this_device_command_topic1}"
|
||||
payload: "${mqtt_command_on}"
|
||||
retain: false
|
||||
|
||||
# Local/HA requested OFF. Change the local relay immediately, then publish a non-retained
|
||||
# command so any other linked switch follows.
|
||||
- id: mainhallway_mainlights_off
|
||||
mode: restart
|
||||
then:
|
||||
- if:
|
||||
condition:
|
||||
lambda: "return id(Relay_1).state;"
|
||||
then:
|
||||
- switch.turn_off: Relay_1
|
||||
- mqtt.publish:
|
||||
topic: "${mqtt_this_device_command_topic1}"
|
||||
payload: "${mqtt_command_off}"
|
||||
retain: false
|
||||
|
||||
# Physical button toggle logic. This is the only place that decides ON vs OFF.
|
||||
- id: mainhallway_mainlights_toggle
|
||||
mode: restart
|
||||
then:
|
||||
- if:
|
||||
condition:
|
||||
lambda: "return id(Relay_1).state;"
|
||||
then:
|
||||
- script.execute: mainhallway_mainlights_off
|
||||
else:
|
||||
- script.execute: mainhallway_mainlights_on
|
||||
|
||||
#:########################################################################################:#
|
||||
# BINARY SENSORS
|
||||
@@ -205,29 +272,32 @@ binary_sensor:
|
||||
- delayed_on: 10ms
|
||||
- delayed_off: 10ms
|
||||
on_press:
|
||||
- if:
|
||||
condition:
|
||||
switch.is_on: Relay_1
|
||||
then:
|
||||
- switch.turn_off: Relay_1
|
||||
- mqtt.publish:
|
||||
topic: "${mqtt_this_device_command_topic1}"
|
||||
payload: "${mqtt_command_off}"
|
||||
else:
|
||||
- switch.turn_on: Relay_1
|
||||
- mqtt.publish:
|
||||
topic: "${mqtt_this_device_command_topic1}"
|
||||
payload: "${mqtt_command_on}"
|
||||
- script.execute: mainhallway_mainlights_toggle
|
||||
|
||||
#:########################################################################################:#
|
||||
# SWITCH
|
||||
# https://esphome.io/components/switch/
|
||||
#:########################################################################################:#
|
||||
switch:
|
||||
- platform: gpio
|
||||
# Exposed Home Assistant control. This is the switch to use in HA.
|
||||
- platform: template
|
||||
name: "Relay 1: ${switch_1_name}"
|
||||
id: Relay_1_HA
|
||||
lambda: |-
|
||||
return id(Relay_1).state;
|
||||
turn_on_action:
|
||||
- script.execute: mainhallway_mainlights_on
|
||||
turn_off_action:
|
||||
- script.execute: mainhallway_mainlights_off
|
||||
|
||||
# Physical relay. Kept internal so HA uses the template switch above.
|
||||
# Relay callbacks publish retained status only, not commands.
|
||||
- platform: gpio
|
||||
name: "Internal Relay 1: ${switch_1_name}"
|
||||
internal: true
|
||||
pin: GPIO12
|
||||
id: Relay_1
|
||||
restore_mode: ${relay_restore_mode}
|
||||
on_turn_on:
|
||||
- mqtt.publish:
|
||||
topic: "${mqtt_this_device_status_topic1}"
|
||||
|
||||
Reference in New Issue
Block a user