ESPHome Device Builder
228 lines
9.7 KiB
YAML
228 lines
9.7 KiB
YAML
#:########################################################################################:#
|
|
# TITLE: DOWNSTAIRS LOUNGE ENTRY LIGHTSWITCH
|
|
# zorruno.com layout v1.1 2026
|
|
#:########################################################################################:#
|
|
# REPO:
|
|
# https://home.fox.co.nz/gitea/zorruno/zorruno-homeassistant/src/branch/master/esphome/esp-downstloungeentry.yaml
|
|
#:########################################################################################:#
|
|
# VERSIONS:
|
|
# v3.8 2026-07-20 Updated remote MQTT topics for the flattened downstairs lounge main lights topic
|
|
# v3.7 2026-02-25 Updated yaml to zorruno layout V1.1
|
|
# v3.6 2025-07-24 YAML tidyups
|
|
#:########################################################################################:#
|
|
# HARDWARE:
|
|
# - Zemismart KS-811 Single push button (ESP8266)
|
|
# - ESP8266 board: esp01_1m
|
|
# - Pinout/schematic:
|
|
# https://community.home-assistant.io/t/zemismart-ks-811-working-with-esphome/
|
|
#:########################################################################################:#
|
|
# OPERATION NOTES:
|
|
# - This KS-811 single button is used as a remote MQTT controller (no physical load connected).
|
|
# - Button press publishes MQTT to toggle a remote device light (based on our mirrored Relay_1 state).
|
|
# - Relay_1 is used as a mirrored state holder only (kept in sync via the remote device status topic).
|
|
#:########################################################################################:#
|
|
# MQTT COMMANDS:
|
|
# - Remote command topic:
|
|
# ${mqtt_remote_device_command_topic}
|
|
# Payloads:
|
|
# ${mqtt_remote_device_command_on}
|
|
# ${mqtt_remote_device_command_off}
|
|
#
|
|
# - Remote status topic (mirrors remote state to Relay_1):
|
|
# ${mqtt_remote_status_topic}
|
|
# Expected payloads:
|
|
# ${mqtt_remote_device_command_on}
|
|
# ${mqtt_remote_device_command_off}
|
|
#:########################################################################################:#
|
|
# OFFLINE NOTES:
|
|
# a) Home Assistant OFFLINE, but Network and MQTT ONLINE
|
|
# - Button continues to control the remote device via MQTT (broker must be reachable)
|
|
# - Relay_1 mirror continues to update from the remote status topic
|
|
# b) MQTT OFFLINE (or broker unreachable)
|
|
# - Button presses cannot control the remote device (publish fails)
|
|
# - Relay_1 mirror will not update (no remote status updates)
|
|
# c) Entire WiFi/Network OFFLINE
|
|
# - No remote control possible (MQTT unavailable)
|
|
# - 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-downstloungeentry"
|
|
friendly_name: "Downstairs Lounge Entry Lightswitch (1)"
|
|
description_comment: "Downstairs Lounge Entry Lightswitch using a Zemismart KS-811 Single Push Button. Main Lights (1) (Layout V1.1)"
|
|
device_area: "Downstairs Flat" # Allows ESP device to be automatically linked to an 'Area' in Home Assistant.
|
|
|
|
# Project Naming
|
|
project_name: "Zemismart Technologies.KS-811 Single"
|
|
project_version: "v3.8"
|
|
|
|
# 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-downstloungeentry_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" # NONE, ERROR, WARN, INFO, DEBUG (Default), VERBOSE, VERY_VERBOSE
|
|
update_interval: "60s" # update time for general sensors etc
|
|
|
|
# MQTT REMOTE Controls
|
|
mqtt_remote_device_name: "downst-lounge-main-lights"
|
|
mqtt_remote_device_command_topic: "${mqtt_command_main_topic}/${mqtt_remote_device_name}"
|
|
mqtt_remote_status_topic: "${mqtt_status_main_topic}/${mqtt_remote_device_name}"
|
|
mqtt_remote_device_command_on: "On"
|
|
mqtt_remote_device_command_off: "Off"
|
|
|
|
# Switch/Relay/Button Naming & Icons
|
|
switch_1_name: "Main Lights" # NOTE there is no physical connection to the lights on this switch
|
|
|
|
#:########################################################################################:#
|
|
# 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}"
|
|
|
|
#### 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}"
|
|
|
|
#:########################################################################################:#
|
|
# 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
|
|
|
|
#:########################################################################################:#
|
|
# LOGGING
|
|
# https://esphome.io/components/logger.html
|
|
#:########################################################################################:#
|
|
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)
|
|
#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.
|
|
#:########################################################################################:#
|
|
mqtt:
|
|
on_message:
|
|
# Mirror remote state onto Relay_1 (only toggle if a change is needed)
|
|
- topic: "${mqtt_remote_status_topic}"
|
|
payload: "${mqtt_remote_device_command_on}"
|
|
then:
|
|
- delay: 50ms
|
|
- if:
|
|
condition:
|
|
lambda: "return !id(Relay_1).state;"
|
|
then:
|
|
- switch.turn_on: Relay_1
|
|
|
|
- topic: "${mqtt_remote_status_topic}"
|
|
payload: "${mqtt_remote_device_command_off}"
|
|
then:
|
|
- delay: 50ms
|
|
- if:
|
|
condition:
|
|
lambda: "return id(Relay_1).state;"
|
|
then:
|
|
- switch.turn_off: Relay_1
|
|
|
|
#:########################################################################################:#
|
|
# STATUS LED
|
|
# https://esphome.io/components/status_led.html
|
|
#:########################################################################################:#
|
|
status_led:
|
|
pin:
|
|
number: GPIO02
|
|
inverted: yes
|
|
|
|
#:########################################################################################:#
|
|
# BINARY SENSORS
|
|
# https://esphome.io/components/binary_sensor/
|
|
#:########################################################################################:#
|
|
binary_sensor:
|
|
# GPIO16 for KS-811 first button UNLESS it is KS-811-1 in which case it is GPIO00
|
|
- platform: gpio
|
|
pin:
|
|
number: GPIO0
|
|
mode: INPUT
|
|
inverted: True
|
|
name: "Button 1: ${switch_1_name}"
|
|
on_press:
|
|
- mqtt.publish:
|
|
topic: "${mqtt_remote_device_command_topic}"
|
|
payload: !lambda |-
|
|
if (id(Relay_1).state) {
|
|
return "${mqtt_remote_device_command_off}";
|
|
} else {
|
|
return "${mqtt_remote_device_command_on}";
|
|
}
|
|
|
|
#:########################################################################################:#
|
|
# SWITCH
|
|
# https://esphome.io/components/switch/
|
|
#:########################################################################################:#
|
|
switch:
|
|
# GPIO13 for KS-811 first button UNLESS it is KS-811-1 then it is GPIO12
|
|
- platform: gpio
|
|
name: "Relay 1: ${switch_1_name}"
|
|
pin: GPIO12
|
|
id: Relay_1
|