193 lines
8.1 KiB
YAML
193 lines
8.1 KiB
YAML
#:########################################################################################:#
|
|
# TITLE: MAIN HALLWAY LIGHTSWITCH 1 (BK7231N)
|
|
# zorruno.com layout v1.1 2026
|
|
#:########################################################################################:#
|
|
# REPO:
|
|
# https://home.fox.co.nz/gitea/zorruno/zorruno-homeassistant/src/branch/master/esphome/esp-mainhallwaylights1.yaml
|
|
#:########################################################################################:#
|
|
# VERSIONS:
|
|
# V1.1 2026-04-03 Updated yaml to zorruno layout V1.1; corrected KS-811 single naming and operation notes; updated BK7231N single-switch pin mapping
|
|
# V1.0 2026-04-03 Initial
|
|
#:########################################################################################:#
|
|
# HARDWARE:
|
|
# - Zemismart KS-811 Single push button
|
|
# - BK7231N based switch
|
|
# - BK72XX board: generic-bk7231n-qfn32-tuya
|
|
# - BK7231N single-switch pin mapping checked against KS-811 BK references
|
|
#:########################################################################################:#
|
|
# OPERATION NOTES:
|
|
# - Main hallway switch with 1 output:
|
|
# 1) Main Hallway Lights
|
|
# - A single press of the physical button toggles Relay 1 ON/OFF
|
|
# - Status LED uses P22
|
|
#:########################################################################################:#
|
|
# MQTT COMMANDS:
|
|
# - None
|
|
#:########################################################################################:#
|
|
# OFFLINE NOTES:
|
|
# - a) Home Assistant offline (network and MQTT online):
|
|
# - Device remains on WiFi and MQTT
|
|
# - Physical button still toggles relay locally
|
|
# - b) MQTT offline (or Home Assistant and MQTT offline):
|
|
# - Physical button still toggles relay locally
|
|
# - Remote control/state 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
|
|
#:########################################################################################:#
|
|
|
|
#:########################################################################################:#
|
|
# 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-mainhallwaylights1"
|
|
friendly_name: "Main Hallway Lightswitch (1)"
|
|
description_comment: "BK7231N - Main Hallway Lightswitch using a Zemismart KS-811 Single Push Button. Main Hallway Lights (1) (Layout V1.1)"
|
|
device_area: "Main Hallway" # Allows ESP device to be automatically linked to an 'Area' in Home Assistant.
|
|
|
|
# Project Naming
|
|
project_name: "Zemismart Technologies.KS-811 Single BK7231N" # Project Details
|
|
project_version: "v1.1" # 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
|
|
ota_pass: !secret esp-ota_pass # unfortunately you can't use substitutions inside secrets names
|
|
static_ip_address: !secret esp-mainhallwaylights1_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" # Define logging level: NONE, ERROR, WARN, INFO, DEBUG (Default), VERBOSE, VERY_VERBOSE
|
|
update_interval: "60s" # update time for for general sensors etc
|
|
|
|
# Default relay restore mode
|
|
# Options: RESTORE_DEFAULT_OFF, RESTORE_DEFAULT_ON, ALWAYS_ON, ALWAYS_OFF
|
|
relay_restore_mode: "RESTORE_DEFAULT_OFF"
|
|
|
|
# Switch Naming
|
|
switch_1_name: "Main Hallway Lights"
|
|
|
|
#:########################################################################################:#
|
|
# 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
|
|
|
|
#:########################################################################################:#
|
|
# PACKAGE ITEM REMOVALS / OVERRIDES:
|
|
#:########################################################################################:#
|
|
wifi:
|
|
min_auth_mode: !remove # The WPA2 only works on esp32/8266
|
|
reboot_timeout: 15min # override the selection from the common package
|
|
fast_connect: false # optional; force off in case package vars change
|
|
|
|
mqtt:
|
|
keepalive: 15s # overriding the value from the common package
|
|
|
|
#:########################################################################################:#
|
|
# 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}"
|
|
|
|
#:########################################################################################:#
|
|
# BUILD FOR BK CHIPSET:
|
|
# bk72xx
|
|
# https://devices.esphome.io/board/bk72xx/
|
|
#:########################################################################################:#
|
|
bk72xx:
|
|
board: generic-bk7231n-qfn32-tuya
|
|
|
|
#:########################################################################################:#
|
|
# LOGGER:
|
|
# 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)
|
|
id: logger_id
|
|
|
|
#:########################################################################################:#
|
|
# STATUS LED:
|
|
# https://esphome.io/components/status_led.html
|
|
#:########################################################################################:#
|
|
status_led:
|
|
pin:
|
|
number: P22 # GPIO22
|
|
inverted: true
|
|
|
|
#:########################################################################################:#
|
|
# BINARY SENSORS:
|
|
# https://esphome.io/components/binary_sensor/
|
|
#:########################################################################################:#
|
|
binary_sensor:
|
|
- platform: gpio
|
|
id: button_1
|
|
internal: true
|
|
pin:
|
|
number: P24 # GPIO24
|
|
mode:
|
|
input: true
|
|
pullup: true
|
|
inverted: true
|
|
filters:
|
|
- delayed_on: 20ms
|
|
on_press:
|
|
- switch.toggle: Relay_1
|
|
|
|
#:########################################################################################:#
|
|
# SWITCH COMPONENT:
|
|
# https://esphome.io/components/switch/
|
|
#:########################################################################################:#
|
|
switch:
|
|
- platform: gpio
|
|
name: "Relay 1: ${switch_1_name}"
|
|
pin: P16 # GPIO16
|
|
id: Relay_1
|
|
restore_mode: ${relay_restore_mode} |