#:########################################################################################:#
# TITLE: LOUNGE SOUTH RIGHT LIGHTSWITCH
# zorruno.com layout v1.1 2026
#:########################################################################################:#
# REPO:
# https://home.fox.co.nz/gitea/zorruno/zorruno-homeassistant/src/branch/master/esphome/esp-loungesouthrightswitch.yaml
#:########################################################################################:#
# VERSIONS:
# V4.1 2026-03-11 Updated yaml to zorruno layout V1.1
# V4.0 2025-10-04 Copied from other device
#:########################################################################################:#
# HARDWARE:
# - Zemismart KS-811 Triple push button
# - ESP8266 based
# - pinout/schematic:
#   https://community.home-assistant.io/t/zemismart-ks-811-working-with-esphome/
# - Relay 1 output on GPIO13
# - Relay 2 output on GPIO12
# - Relay 3 output on GPIO14
# - Button 1 input on GPIO16
# - Button 2 input on GPIO5
# - Button 3 input on GPIO4
# - Status LED on GPIO2
#:########################################################################################:#
# OPERATION NOTES:
# - Lounge South Right switch with 3 outputs:
#   1) Spare
#   2) Wall Washer Right
#   3) Breakfast Bar LEDs
# - Button 1 toggles Relay_1 locally
# - Button 2 toggles Relay_2 locally
# - Button 3 single click:
#   - Offline and HA Loss manual override ON:
#     - Toggles Relay_3 locally
#   - Online:
#     - No local action is taken
# - On API client connect:
#   - Applies HA Loss manual override state to Relay_3
# - HA Loss manual override defaults ON and is restored after reboot
#:########################################################################################:#
# OFFLINE NOTES:
# a) Home Assistant offline (network online):
#    - API disconnects and device switches to manual/offline behavior
#    - Button 1 and Button 2 continue to toggle relays locally
#    - Button 3 can toggle Relay_3 locally when HA Loss manual override is ON
# b) MQTT offline (or HA/MQTT offline):
#    - This yaml does not currently depend on MQTT for its switch logic
#    - Local button control continues to work
#    - Button 3 can toggle Relay_3 locally when HA Loss manual override is ON
# c) Entire WiFi/Network offline:
#    - Device operates in local manual/offline behavior only
#    - Local button control continues to work
#    - 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-loungesouthrightswitch"
  friendly_name: "Lounge South Right Lightswitch (3)"
  description_comment: "Lounge South Right Lightswitch using a Zemismart KS-811 Triple Push Button. Spare (1), Wall Washer Right (2), Breakfastbar LEDs (3) (Layout V1.1)"
  device_area: "Lounge" # Allows ESP device to be automatically linked to an 'Area' in Home Assistant.

  # Project Naming
  project_name: "Zemismart Technologies.KS-811 Triple" # Project Details
  project_version: "v4.1"  # Project V denotes release of yaml file, allowing checking of deployed vs latest version

  # 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-loungesouthrightswitch_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
  #relay_icon: "mdi:lightbulb-group"
  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

  # MQTT LOCAL Controls
  #mqtt_device_name: "bedroom2-lights"
  #mqtt_local_command_topic: "${mqtt_local_command_main_topic}/${mqtt_device_name}" # Topic we will use to command this locally without HA
  #mqtt_local_status_topic: "${mqtt_local_status_main_topic}/${mqtt_device_name}" # Topic we will use to view status locally without HA

  # Switch Naming
  switch_1_name: "Spare"
  switch_2_name: "Wall Washer Right"
  switch_3_name: "Breakfast Bar LEDs" # Connected to another esphome device at the breakfast bar LEDs

#:########################################################################################:#
# 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_current_ip_address: "${current_ip_address}"
      local_ota_pass: "${ota_pass}"

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

#:########################################################################################:#
# HOME ASSISTANT API:
#:########################################################################################:#
api:
  on_client_connected:
    then:
      - logger.log:
          level: INFO
          format: "API connected: applying override (override=%s)"
          args: ['id(ha_loss_override).state ? "true" : "false"']
      - if:
          condition:
            switch.is_on: ha_loss_override
          then:
            - switch.turn_on: Relay_3
          else:
            - switch.turn_off: Relay_3

  on_client_disconnected:
    then:
      - logger.log:
          level: WARN
          format: "API disconnected: switching to manual/offline behavior"

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

#:########################################################################################:#
# 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)
  #esp8266_store_log_strings_in_flash: false
  #tx_buffer_size: 64

#:########################################################################################:#
# STATUS LED:
# https://esphome.io/components/status_led.html
#:########################################################################################:#
status_led:
  pin:
    number: GPIO2
    inverted: true

#:########################################################################################:#
# 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 suppresses a warning.
    name: "Button 1: ${switch_1_name}"
    on_press:
      - switch.toggle: Relay_1

  - platform: gpio
    pin:
      number: GPIO5
      mode: INPUT
      inverted: true
    name: "Button 2: ${switch_2_name}"
    on_press:
      - switch.toggle: Relay_2

  - platform: gpio
    pin:
      number: GPIO4
      mode: INPUT
      inverted: true
    name: "Button 3: ${switch_3_name}"
    on_multi_click:
      - timing:
          - ON for at most 0.5s
          - OFF for at least 0.5s
        then:
          - if:
              condition:
                and:
                  - not:
                      api.connected:
                  - switch.is_on: ha_loss_override
              then:
                - switch.toggle: Relay_3
              else: []

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

  - platform: gpio
    name: "Relay 2: ${switch_2_name}"
    pin: GPIO12
    id: Relay_2

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

  # HA Loss manual override (default ON; persists across restarts)
  - platform: template
    name: "HA Loss manual override"
    id: ha_loss_override
    optimistic: true
    restore_mode: RESTORE_DEFAULT_ON