yaml layout updates to v1.x
This commit is contained in:
@@ -1,67 +1,98 @@
|
||||
##########################################################################################
|
||||
##########################################################################################
|
||||
# CENTRAL STAIRS - BOTTOM LIGHTSWITCH
|
||||
# V3.7 2025-09-24 upload to this device
|
||||
#:########################################################################################:#
|
||||
# TITLE: CENTRAL STAIRS - BOTTOM LIGHTSWITCH
|
||||
# zorruno.com layout v1.1 2026
|
||||
#:########################################################################################:#
|
||||
# REPO:
|
||||
# https://home.fox.co.nz/gitea/zorruno/zorruno-homeassistant/src/branch/master/esphome/esp-centralstairs-bottom.yaml
|
||||
#:########################################################################################:#
|
||||
# VERSIONS:
|
||||
# V3.7 2025-09-24 Upload to this device
|
||||
# V3.5 2025-07-24 YAML tidyups
|
||||
##########################################################################################
|
||||
# Zemismart KS-811 Double push button
|
||||
# pinout/schematic https://community.home-assistant.io/t/zemismart-ks-811-working-with-esphome/
|
||||
#:########################################################################################:#
|
||||
# HARDWARE:
|
||||
# Zemismart KS-811 Double push button (KS-811-2)
|
||||
# pinout/schematic: https://community.home-assistant.io/t/zemismart-ks-811-working-with-esphome/
|
||||
#:########################################################################################:#
|
||||
# OPERATION NOTES:
|
||||
# - Light switch at bottom of the central stairs
|
||||
# - Button 1 toggles Relay 1 (Main Stair Lights - Lower) - physically connected
|
||||
# - Button 2 controls Stair Footer Lights via MQTT (remote device), using Relay 2 as a local mirror state
|
||||
# - On MQTT connect, publishes current Relay 1 state to mqtt_status_topic_1 to keep remote status aligned
|
||||
#:########################################################################################:#
|
||||
# MQTT COMMANDS:
|
||||
# Remote device 1 (Main Stair Lights):
|
||||
# - Command topic: ${mqtt_command_topic_1} -> ON,OFF
|
||||
# - Status topic: ${mqtt_status_topic_1} -> ON,OFF
|
||||
#
|
||||
# NOTES
|
||||
# - Light switch at top of the stairs, only the footer lights physically connected.
|
||||
#
|
||||
##########################################################################################
|
||||
##########################################################################################
|
||||
# Remote device 2 (Stair Footer Lights):
|
||||
# - Command topic: ${mqtt_command_topic_2} -> ON,OFF
|
||||
# - Status topic: ${mqtt_status_topic_2} -> ON,OFF
|
||||
#:########################################################################################:#
|
||||
# OFFLINE NOTES:
|
||||
# a) Home Assistant OFFLINE, but Network and MQTT ONLINE
|
||||
# - Physical buttons still operate (Relay 1 local toggle; Button 2 publishes MQTT for footer lights)
|
||||
# - Relay 1 state continues to be published to MQTT status topic
|
||||
# - HA entities are unavailable until HA returns
|
||||
# b) MQTT OFFLINE (but WiFi/Network and HA API ONLINE)
|
||||
# - Relay 1 still toggles locally and remains controllable from HA via API
|
||||
# - Button 2 cannot control footer lights (MQTT publish fails)
|
||||
# - Any MQTT state sync to remote devices will not occur while MQTT is down
|
||||
# c) Entire WiFi/Network OFFLINE
|
||||
# - Physical button 1 continues to toggle Relay 1 locally (standalone)
|
||||
# - Physical button 2 cannot control footer lights (no network transport)
|
||||
# - Timeclocks will drift without network (SNTP). Time of day can be reset by powering off then on again at 12pm (midday)
|
||||
#:########################################################################################:#
|
||||
|
||||
##########################################################################################
|
||||
# SPECIFIC DEVICE VARIABLE SUBSTITUTIONS
|
||||
#:########################################################################################:#
|
||||
# SUBSTITUTIONS: Specific device variable substitutions
|
||||
# If NOT using a secrets file, just replace these with the passwords etc (in quotes)
|
||||
##########################################################################################
|
||||
#:########################################################################################:#
|
||||
substitutions:
|
||||
# Device Custom Naming
|
||||
device_name: "esp-centralstairs-bottom"
|
||||
friendly_name: "Central Stair Lightswitch - Bottom (2)"
|
||||
description_comment: "Central Stair Lightswitch - Bottom, using Zemismart KS-811 Double Push Button. Main Stair Lights (1), Stair Footer Lights (2)"
|
||||
description_comment: "Central Stair Lightswitch - Bottom, using Zemismart KS-811 Double Push Button. Main Stair Lights (1), Stair Footer Lights (2) (Layout V1.1)"
|
||||
device_area: "Lounge" # Allows ESP device to be automatically linked to an 'Area' in Home Assistant.
|
||||
|
||||
# Passwords & Secrets (unfortunately you can't use substitutions inside secrets names)
|
||||
api_key: !secret esp-api_key
|
||||
ota_pass: !secret esp-ota_pass
|
||||
static_ip_address: !secret esp-centralstairs-bottom_ip
|
||||
|
||||
# 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}
|
||||
|
||||
# MQTT Device Names
|
||||
mqtt_device_name_1: "stair-mainlights"
|
||||
mqtt_device_name_2: "stair-footerlights"
|
||||
|
||||
# I/O Naming
|
||||
switch_1_name: "Main Stair Lights (Lower)" # Physical, but just the lower lights below the media cabinet
|
||||
switch_2_name: "Stair Footer Lights" # virtual only, nothing connected to this output
|
||||
#relay_1_name: "Garage Lights"
|
||||
#button_1_name: "Power Button"
|
||||
#relay_icon: "mdi:lightbulb-group"
|
||||
|
||||
# Project Naming
|
||||
project_name: "Zemismart Technologies.KS-811 Double" # Project Details
|
||||
project_version: "v2.0" # Project V denotes release of yaml file, allowing checking of deployed vs latest version
|
||||
project_name: "Zemismart Technologies.KS-811 Double" # Project Details
|
||||
project_version: "v2.0" # Project V denotes release of yaml file, allowing checking of deployed vs latest version
|
||||
|
||||
# MQTT Controls
|
||||
mqtt_command_main_topic: !secret mqtt_command_main_topic
|
||||
mqtt_status_main_topic: !secret mqtt_status_main_topic
|
||||
mqtt_command_topic_1: "${mqtt_command_main_topic}/${mqtt_device_name_1}"
|
||||
mqtt_command_topic_1: "${mqtt_command_main_topic}/${mqtt_device_name_1}"
|
||||
mqtt_status_topic_1: "${mqtt_status_main_topic}/${mqtt_device_name_1}"
|
||||
mqtt_command_topic_2: "${mqtt_command_main_topic}/${mqtt_device_name_2}"
|
||||
mqtt_command_topic_2: "${mqtt_command_main_topic}/${mqtt_device_name_2}"
|
||||
mqtt_status_topic_2: "${mqtt_status_main_topic}/${mqtt_device_name_2}"
|
||||
mqtt_command_ON: "ON"
|
||||
mqtt_command_OFF: "OFF"
|
||||
|
||||
# Passwords & Secrets (unfortunately you can't use substitutions inside secrets names)
|
||||
api_key: !secret esp-api_key
|
||||
ota_pass: !secret esp-ota_pass
|
||||
|
||||
# General Settings
|
||||
log_level: "ERROR" # Define logging level: NONE, ERROR, WARN, INFO, DEBUG (Default), VERBOSE, VERY_VERBOSE
|
||||
update_interval: "60s" # update time for for general sensors etc
|
||||
update_interval: "60s" # update time for general sensors etc
|
||||
|
||||
#########################################################################################
|
||||
#:########################################################################################:#
|
||||
# PACKAGES: Included Common Packages
|
||||
# https://esphome.io/components/packages.html
|
||||
##########################################################################################
|
||||
# Comment some of these out where not needed, eg MQTT, Web portal, SNTP, General Sensors
|
||||
##########################################################################################
|
||||
#:########################################################################################:#
|
||||
packages:
|
||||
#### WIFI, Network (Static/DHCP/IPV6 etc), Fallback AP, Safemode ####
|
||||
common_wifi: !include
|
||||
@@ -70,6 +101,7 @@ packages:
|
||||
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
|
||||
@@ -83,23 +115,23 @@ packages:
|
||||
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
|
||||
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_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
|
||||
#:########################################################################################:#
|
||||
# ESPHOME:
|
||||
# https://esphome.io/components/esphome.html
|
||||
#########################################################################################
|
||||
#:########################################################################################:#
|
||||
esphome:
|
||||
name: "${device_name}"
|
||||
friendly_name: "${friendly_name}"
|
||||
@@ -108,39 +140,39 @@ esphome:
|
||||
project:
|
||||
name: "${project_name}"
|
||||
version: "${project_version}"
|
||||
#on_boot:
|
||||
#on_boot:
|
||||
# priority: 200
|
||||
# then:
|
||||
# - switch.turn_on: Relay_2
|
||||
|
||||
#########################################################################################
|
||||
# ESP Platform and Framework
|
||||
# https://esphome.io/components/esp32.html
|
||||
#########################################################################################
|
||||
#:########################################################################################:#
|
||||
# ESP PLATFORM AND FRAMEWORK:
|
||||
# https://esphome.io/components/esp8266/
|
||||
# https://esphome.io/components/esp32/
|
||||
#:########################################################################################:#
|
||||
esp8266:
|
||||
board: esp01_1m
|
||||
early_pin_init: False # Initialise pins early to known values. Recommended false where switches are involved. Defaults to True.
|
||||
early_pin_init: false # Recommended false where switches are involved. Defaults to true.
|
||||
board_flash_mode: dout # Default is dout
|
||||
|
||||
#########################################################################################
|
||||
# ESPHome Logging Enable
|
||||
#:########################################################################################:#
|
||||
# LOGGING: ESPHome Logging Enable
|
||||
# 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)
|
||||
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 COMMANDS
|
||||
#:########################################################################################:#
|
||||
# MQTT:
|
||||
# This adds device-specific MQTT command triggers to the common MQTT configuration.
|
||||
##########################################################################################
|
||||
#:########################################################################################:#
|
||||
mqtt:
|
||||
on_connect:
|
||||
then:
|
||||
- if:
|
||||
# Status of relay 1, which has an actual light connected
|
||||
condition:
|
||||
lambda: 'return id(Relay_1).state;'
|
||||
then:
|
||||
@@ -199,26 +231,26 @@ mqtt:
|
||||
then:
|
||||
- switch.turn_off: Relay_2
|
||||
|
||||
#########################################################################################
|
||||
# STATUS LED
|
||||
#:########################################################################################:#
|
||||
# STATUS LED:
|
||||
# https://esphome.io/components/status_led.html
|
||||
#########################################################################################
|
||||
#:########################################################################################:#
|
||||
status_led:
|
||||
pin:
|
||||
number: GPIO2
|
||||
inverted: yes
|
||||
inverted: true
|
||||
|
||||
#########################################################################################
|
||||
# BINARY SENSORS
|
||||
#:########################################################################################:#
|
||||
# BINARY SENSORS:
|
||||
# https://esphome.io/components/binary_sensor/
|
||||
#########################################################################################
|
||||
#:########################################################################################:#
|
||||
binary_sensor:
|
||||
- platform: gpio
|
||||
pin:
|
||||
number: GPIO16
|
||||
mode: INPUT
|
||||
inverted: True
|
||||
use_interrupt: false # GPIO16 pin doesn't support interrupts so use polling. Only supresses a warning.
|
||||
inverted: true
|
||||
use_interrupt: false # GPIO16 does not support interrupts so use polling (suppresses warning).
|
||||
filters:
|
||||
- delayed_on: 30ms
|
||||
- delayed_off: 30ms
|
||||
@@ -230,7 +262,7 @@ binary_sensor:
|
||||
pin:
|
||||
number: GPIO05
|
||||
mode: INPUT
|
||||
inverted: True
|
||||
inverted: true
|
||||
filters:
|
||||
- delayed_on: 30ms
|
||||
- delayed_off: 30ms
|
||||
@@ -251,10 +283,10 @@ binary_sensor:
|
||||
payload: "${mqtt_command_ON}"
|
||||
retain: false
|
||||
|
||||
#########################################################################################
|
||||
# SWITCH COMPONENT
|
||||
#:########################################################################################:#
|
||||
# SWITCH COMPONENT:
|
||||
# https://esphome.io/components/switch/
|
||||
#########################################################################################
|
||||
#:########################################################################################:#
|
||||
switch:
|
||||
- platform: gpio
|
||||
name: "Relay 1: ${switch_1_name}"
|
||||
@@ -275,4 +307,4 @@ switch:
|
||||
name: "Relay 2: ${switch_2_name}"
|
||||
pin: GPIO12
|
||||
id: Relay_2
|
||||
# No mqtt.publish here (this is a mirror only)
|
||||
# No mqtt.publish here (this is a mirror only)
|
||||
Reference in New Issue
Block a user