zorruno-homeassistant/esphome/esp-garageentrylights.yaml

#:########################################################################################:#
# TITLE: GARAGE ENTRY LIGHTSWITCH (OBK CONVERTED, BK7231N)
# zorruno.com layout v1.1 2026
#:########################################################################################:#
# REPO:
# https://home.fox.co.nz/gitea/zorruno/zorruno-homeassistant/src/branch/master/esphome/esp-garageentrylights.yaml
#:########################################################################################:#
# VERSIONS:
# V1.1 2026-03-11 Updated yaml to zorruno layout V1.1
# V1.0 2025-11-23 Initial
#:########################################################################################:#
# HARDWARE:
# - Zemismart KS-811 Triple push button (OBK converted, BK7231N)
# - ESPHome bk72xx: generic-bk7231n-qfn32-tuya
# - Status LED: P22
# - Buttons: P17 (Btn1), P26 (Btn2), P24 (Btn3)
# - Relays: P14 (Relay1), P16 (Relay2), P15 (Relay3)
# - Pinout/schematic: https://community.home-assistant.io/t/zemismart-ks-811-working-with-esphome/
#:########################################################################################:#
# OPERATION NOTES:
# - 3 button / 3 relay wall switch
# - Button 1 toggles Relay 1 (Corridor Lights)
# - Button 2 toggles Relay 2 (Patio Lights)
# - Button 3 toggles Relay 3 (Garage Lights)
# - Default relay restore mode is controlled via substitution: relay_restore_mode
# - WiFi package overrides:
#   - min_auth_mode removed (WPA2-only not supported on bk72xx)
#   - reboot_timeout overridden to 15min
#   - fast_connect forced false
# - MQTT keepalive overridden to 15s
#:########################################################################################:#
# OFFLINE NOTES:
# a) Home Assistant OFFLINE, but Network and MQTT ONLINE
#    - Physical buttons still toggle relays locally
#    - MQTT (from common package) continues if broker is reachable
# b) MQTT OFFLINE (but WiFi/Network and HA API ONLINE)
#    - Physical buttons still toggle relays locally
#    - HA/API control remains available (switch entities)
#    - MQTT diagnostics/publishes (common_mqtt) will fail while MQTT is down
# c) Entire WiFi/Network OFFLINE
#    - Physical buttons still toggle relays locally (standalone operation)
#    - No HA API and no MQTT connectivity until network returns
#    - Accurate time is not needed (SNTP not required)
#:########################################################################################:#


#:########################################################################################:#
# 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-garageentrylights"
  friendly_name: "Garage Entry Lightswitch (3)"
  description_comment: "BK7231N - Garage Entry Lightswitch using a Zemismart KS-811 Triple Push Button. Corridor Light (1), Patio Lights (2), Garage Lights (3) (Layout V1.1)"
  device_area: "Garage" # Allows ESP device to be automatically linked to an 'Area' in Home Assistant.

  # Project Naming
  project_name: "Zemismart Technologies.KS-811 Triple BK7231N"
  project_version: "v1.1"

  # 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-garageentrylights_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}

  # Device Settings
  log_level: "NONE" # NONE, ERROR, WARN, INFO, DEBUG (Default), VERBOSE, VERY_VERBOSE
  update_interval: "60s" # update time 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: "Corridor Lights" # Only one light (Garage Side) actually connected to this relay
  switch_2_name: "Patio Lights" # Output for patio string hanging lights
  switch_3_name: "Garage Lights" # This is virtual only, no power connected to 3rd relay


#:########################################################################################:#
# 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}"

  #### 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 OVERRIDES:
# These override or remove items from included packages above
#:########################################################################################:#
wifi:
  min_auth_mode: !remove # The WPA2-only mode works on esp32/esp8266, not bk72xx
  reboot_timeout: 15min  # override selection from common package
  fast_connect: false    # force off, in case package vars change

mqtt:
  keepalive: 15s # override value from 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}"

mdns:
  disabled: true


#:########################################################################################:#
# BK72XX:
# https://devices.esphome.io/board/bk72xx/
#:########################################################################################:#
bk72xx:
  board: generic-bk7231n-qfn32-tuya


#:########################################################################################:#
# LOGGING:
# https://esphome.io/components/logger.html
#:########################################################################################:#
logger:
  level: "${log_level}"
  id: logger_id


#:########################################################################################:#
# STATUS LED:
# https://esphome.io/components/status_led.html
#:########################################################################################:#
status_led:
  pin:
    number: P22
    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_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}"
    on_press:
      - delay: 50ms
      - switch.toggle: Relay_3


#:########################################################################################:#
# SWITCH COMPONENT:
# https://esphome.io/components/switch/
#:########################################################################################:#
switch:
  - platform: gpio
    name: "Relay 1: ${switch_1_name}"
    pin: P14
    id: Relay_1
    restore_mode: ${relay_restore_mode}

  - platform: gpio
    name: "Relay 2: ${switch_2_name}"
    pin: P16
    id: Relay_2
    restore_mode: ${relay_restore_mode}

  - platform: gpio
    name: "Relay 3: ${switch_3_name}"
    pin: P15
    id: Relay_3
    restore_mode: ${relay_restore_mode}