326 lines
13 KiB
YAML
326 lines
13 KiB
YAML
#:########################################################################################:#
|
|
# TITLE: MAIN BATHROOM LIGHTSWITCH 2 (OBK Converted, BK7231N)
|
|
# zorruno.com layout v1.1 2026
|
|
#:########################################################################################:#
|
|
# REPO:
|
|
# https://home.fox.co.nz/gitea/zorruno/zorruno-homeassistant/src/branch/master/esphome/esp-mainbathroomlights.yaml
|
|
#:########################################################################################:#
|
|
# VERSIONS:
|
|
# V2.2 2026-03-11 Updated yaml to zorruno layout V1.1
|
|
# V2.1 2026-02-23 Button 3 multi-click publishes MQTT commands to bathroom fan (1x/2x/3x)
|
|
# V2.0 2026-02-04 Reflash into new switch (old switch electrical failure, now a BK)
|
|
# V1.0 2025-11-23 Initial
|
|
#:########################################################################################:#
|
|
# HARDWARE:
|
|
# - Zemismart KS-811 Triple push button
|
|
# - BK7231N based switch
|
|
# - BK72XX board: generic-bk7231n-qfn32-tuya
|
|
# - pinout/schematic:
|
|
# https://community.home-assistant.io/t/zemismart-ks-811-working-with-esphome/
|
|
#:########################################################################################:#
|
|
# OPERATION NOTES:
|
|
# - Main bathroom switch with 3 outputs:
|
|
# 1) Main Lights
|
|
# 2) Shower Lights
|
|
# 3) Cabinet Lights
|
|
# - Button 1 toggles Relay_2 (as currently coded in the source yaml)
|
|
# - Button 2 toggles Relay_2
|
|
# - Button 3 immediate press action turns OFF Relay_2 and Relay_3
|
|
# - Button 3 also sends MQTT commands to the bathroom fan based on click count:
|
|
# - 1 click -> command 1
|
|
# - 2 clicks -> command 2
|
|
# - 3 clicks -> command 3
|
|
# - Relay 1 turn_on action also turns ON Relay_2 and Relay_3
|
|
# - Virtual group switch "All Main Bathroom Lights" allows grouped control in Home Assistant
|
|
#:########################################################################################:#
|
|
# MQTT COMMANDS:
|
|
# - Remote device command topic:
|
|
# - ${mqtt_remote_device1_command_topic}
|
|
# - Button 3 single click publishes:
|
|
# - ${mqtt_remote_device1_command1}
|
|
# - Button 3 double click publishes:
|
|
# - ${mqtt_remote_device1_command2}
|
|
# - Button 3 triple click publishes:
|
|
# - ${mqtt_remote_device1_command3}
|
|
#:########################################################################################:#
|
|
# OFFLINE NOTES:
|
|
# a) Home Assistant offline (network and MQTT online):
|
|
# - Local button control continues to operate the relays.
|
|
# - Button 3 MQTT fan commands can still publish if MQTT broker is online.
|
|
# - Virtual group switch in HA will be unavailable until HA returns.
|
|
# b) MQTT offline (or HA/MQTT offline):
|
|
# - Local button control continues to operate the relays.
|
|
# - Button 3 fan MQTT commands will not be sent.
|
|
# c) Entire WiFi/Network offline:
|
|
# - Local button control continues to operate the relays.
|
|
# - No MQTT control or status is available.
|
|
# - Accurate time is not needed; SNTP is not required for operation.
|
|
#:########################################################################################:#
|
|
|
|
#:########################################################################################:#
|
|
# 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-mainbathroomlights"
|
|
friendly_name: "Main Bathroom Lightswitch (3)"
|
|
description_comment: "BK7231N - Main Bathroom Lightswitch using a Zemismart KS-811 Triple Push Button. Main Lights (1), Shower Lights (2), Cabinet Lights (3) (Layout V1.1)"
|
|
device_area: "Main Bathroom" # Allows ESP device to be automatically linked to an 'Area' in Home Assistant.
|
|
|
|
# Project Naming
|
|
project_name: "Zemismart Technologies.KS-811 Triple BK7231N" # Project Details
|
|
project_version: "v2.2" # 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-mainbathroomlights_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 Lights" # Only one light (Garage Side) actually connected to this relay
|
|
switch_2_name: "Shower Lights" # Output for pario string hanging lights
|
|
switch_3_name: "Cabinet Lights" # This is virtual only, no power connected to 3rd relay
|
|
|
|
# MQTT LOCAL Controls
|
|
#mqtt_local_device_name: "masterbath-lights"
|
|
#mqtt_local_command_topic: "${mqtt_command_main_topic}/${mqtt_local_device_name}" # Topic we will use to command this locally without HA
|
|
#mqtt_local_status_topic: "${mqtt_status_main_topic}/${mqtt_local_device_name}" # Topic we will use to view status locally without HA
|
|
|
|
# MQTT REMOTE Controls
|
|
mqtt_remote_device1_name: "masterbath-fan"
|
|
mqtt_remote_device1_command_topic: "${mqtt_command_main_topic}/${mqtt_remote_device1_name}"
|
|
mqtt_remote_device1_command1: "10"
|
|
mqtt_remote_device1_command2: "20"
|
|
mqtt_remote_device1_command3: "30"
|
|
|
|
#:########################################################################################:#
|
|
# 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}"
|
|
# on_boot:
|
|
# priority: 200
|
|
# then:
|
|
# - switch.turn_on: Relay_3
|
|
|
|
#:########################################################################################:#
|
|
# 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
|
|
pin:
|
|
number: P17
|
|
mode:
|
|
input: true
|
|
pullup: true
|
|
inverted: true
|
|
name: "Button 1: ${switch_1_name}"
|
|
on_press:
|
|
- delay: 50ms
|
|
- switch.toggle: Relay_2 #(FIX shoud be relay 1)
|
|
|
|
- platform: gpio
|
|
pin:
|
|
number: P26
|
|
mode:
|
|
input: true
|
|
pullup: true
|
|
inverted: true
|
|
name: "Button 2: ${switch_2_name}"
|
|
on_press:
|
|
- delay: 50ms
|
|
- switch.toggle: Relay_2
|
|
|
|
- platform: gpio
|
|
pin:
|
|
number: P24
|
|
mode:
|
|
input: true
|
|
pullup: true
|
|
inverted: true
|
|
name: "Button 3: ${switch_3_name}"
|
|
|
|
# Keep existing actions for ANY press (immediate OFF behavior)
|
|
on_press:
|
|
- delay: 50ms
|
|
#- switch.turn_off: Relay_1
|
|
- switch.turn_off: Relay_2
|
|
- switch.turn_off: Relay_3
|
|
|
|
# Also publish MQTT commands depending on 1x/2x/3x press count
|
|
on_multi_click:
|
|
# -- Single click: one quick press & release --
|
|
- timing:
|
|
- ON for at most 400ms
|
|
- OFF for at least 200ms
|
|
then:
|
|
- mqtt.publish:
|
|
topic: "${mqtt_remote_device1_command_topic}"
|
|
payload: "${mqtt_remote_device1_command1}"
|
|
|
|
# -- Double click: two quick presses/releases --
|
|
- timing:
|
|
- ON for at most 400ms
|
|
- OFF for at most 400ms
|
|
- ON for at most 400ms
|
|
- OFF for at least 200ms
|
|
then:
|
|
- mqtt.publish:
|
|
topic: "${mqtt_remote_device1_command_topic}"
|
|
payload: "${mqtt_remote_device1_command2}"
|
|
|
|
# -- Triple click: three quick presses/releases --
|
|
- timing:
|
|
- ON for at most 400ms
|
|
- OFF for at most 400ms
|
|
- ON for at most 400ms
|
|
- OFF for at most 400ms
|
|
- ON for at most 400ms
|
|
- OFF for at least 200ms
|
|
then:
|
|
- mqtt.publish:
|
|
topic: "${mqtt_remote_device1_command_topic}"
|
|
payload: "${mqtt_remote_device1_command3}"
|
|
|
|
#:########################################################################################:#
|
|
# SWITCH COMPONENT:
|
|
# https://esphome.io/components/switch/
|
|
#:########################################################################################:#
|
|
switch:
|
|
- platform: gpio
|
|
name: "Relay 1: ${switch_1_name}"
|
|
pin: P14 #GPIO14
|
|
id: Relay_1
|
|
restore_mode: ${relay_restore_mode}
|
|
on_turn_on:
|
|
- switch.turn_on: Relay_2
|
|
- switch.turn_on: Relay_3
|
|
|
|
- platform: gpio
|
|
name: "Relay 2: ${switch_2_name}"
|
|
pin: P16 #GPIO16
|
|
id: Relay_2
|
|
restore_mode: ${relay_restore_mode}
|
|
|
|
- platform: gpio
|
|
name: "Relay 3: ${switch_3_name}"
|
|
pin: P15 #GPIO15
|
|
id: Relay_3
|
|
restore_mode: ${relay_restore_mode}
|
|
|
|
#:########################################################################################:#
|
|
# TEMPLATE COMPONENT:
|
|
# Virtual group switch for Home Assistant
|
|
#:########################################################################################:#
|
|
- platform: template
|
|
name: "All Main Bathroom Lights"
|
|
id: all_main_bathroom_lights
|
|
optimistic: false
|
|
restore_mode: RESTORE_DEFAULT_OFF
|
|
lambda: |-
|
|
return id(Relay_1).state || id(Relay_2).state || id(Relay_3).state;
|
|
turn_on_action:
|
|
- switch.turn_on: Relay_2
|
|
turn_off_action:
|
|
#- switch.turn_off: Relay_1
|
|
- switch.turn_off: Relay_2
|
|
- switch.turn_off: Relay_3 |