#:########################################################################################:#
# TITLE: LOUNGE WEST SWITCH (Single Switch from entranceway)
# zorruno.com layout v1.1 2026
#:########################################################################################:#
# REPO:
# https://home.fox.co.nz/gitea/zorruno/zorruno-homeassistant/src/branch/master/esphome/esp-loungewestswitch.yaml
#:########################################################################################:#
# VERSIONS:
# V4.1 2026-03-11 Updated yaml to zorruno layout V1.1
# V4.0 2025-10-04 Copy from other device
#:########################################################################################:#
# HARDWARE:
# - Zemismart KS-811 Single push button
# - ESP8266 based
# - pinout/schematic:
#   https://community.home-assistant.io/t/zemismart-ks-811-working-with-esphome/
# - Button input on GPIO0
# - Relay output on GPIO12
# - Status LED on GPIO2
#:########################################################################################:#
# OPERATION NOTES:
# - Single wall switch used for Lounge West / entranceway control
# - This device uses Home Assistant scene calls when API is connected
# - Single click:
#   - Online and HA Loss manual override ON:
#     - If last scene is not "All Off", call scene "All Off"
#     - If last scene is "All Off", call scene "Bright"
#   - Offline and HA Loss manual override ON:
#     - Toggle physical Relay_1
# - Double click:
#   - Online only, calls Home Assistant script for scene "Night Light"
# - Long hold (4s+):
#   - Online only, calls Home Assistant script for scene "All Off"
#   - Also fires Home Assistant event esphome.lounge_switch_hold
# - On API client connect:
#   - Applies override state to Relay_1
# - HA Loss manual override switch defaults ON and is restored after reboot
#:########################################################################################:#
# OFFLINE NOTES:
# a) Home Assistant offline (network online):
#    - API will disconnect and device switches to manual/offline behavior
#    - Single click can still toggle Relay_1 when HA Loss manual override is ON
#    - Double click and long hold actions that require Home Assistant are ignored
#
# b) MQTT offline (or HA/MQTT offline):
#    - This yaml does not currently depend on MQTT for its switch logic
#    - If Home Assistant/API is offline, device falls back to manual/offline behavior
#    - Single click can still toggle Relay_1 when HA Loss manual override is ON
#
# c) Entire WiFi/Network offline:
#    - Device operates in local manual/offline behavior only
#    - Single click can still toggle Relay_1 when HA Loss manual override is ON
#    - Double click and long hold Home Assistant scene/event actions are unavailable
#    - 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-loungewestswitch"
  friendly_name: "Lounge West Single Switch (1)"
  description_comment: "Main Lounge from entranceway lightswitch using a Zemismart KS-811 Single Push Button. Main Lights (1) (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 Single" # 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-loungewestswitch_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: "DEBUG" # 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: "lounge-north-switch"
  #mqtt_local_command_topic: "${mqtt_command_main_topic}/${mqtt_device_name}" # Topic we will use to command this locally without HA
  #mqtt_local_status_topic: "${mqtt_status_main_topic}/${mqtt_device_name}" # Topic we will use to view status locally without HA

  # MQTT REMOTE Controls
  #mqtt_remote_device_name: "lounge-main-lights"
  #mqtt_remote_device_command_topic: "${mqtt_command_main_topic}/${mqtt_remote_device_name}"
  #mqtt_remote_status_topic: "${mqtt_status_main_topic}/${mqtt_remote_device_name}" # Topic we will use to view status locally without HA
  #mqtt_remote_device_command_on: "On"
  #mqtt_remote_device_command_off: "Off"

  # Switch/Relay/Button Naming & Icons
  switch_1_name: "Main Lights" # NOTE there is no physical connection to the lights on this switch, it is connected to the dimmer ESPhome for the pelmet 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_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}"

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_1
          else:
            - switch.turn_off: Relay_1

  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: GPIO0
      mode: INPUT
      inverted: true
    name: "Button 1: ${switch_1_name}"
    on_multi_click:

      # --- Double click: send "Night Light" (only if HA connected). ---
      - timing:
          - ON for at most 0.5s
          - OFF for at most 0.5s
          - ON for at most 0.5s
          - OFF for at least 0.2s
        then:
          - if:
              condition:
                api.connected:
              then:
                - homeassistant.service:
                    service: script.lounge_set_scene
                    data:
                      scene_name: "Night Light"
                - logger.log:
                    level: INFO
                    format: "BTN: Double click -> Scene Night Light"
              else:
                - logger.log:
                    level: INFO
                    format: "BTN: Double click ignored (no HA connection)"

      # --- Single short click ---
      # Online (and override ON): use HA's last scene to decide.
      #   If last != "All Off"  -> send "All Off"
      #   If last == "All Off"  -> send "Bright"
      # Offline (and override ON): toggle physical Relay_1
      - timing:
          - ON for at most 0.5s
          - OFF for at least 0.5s
        then:
          - if:
              condition:
                and:
                  - switch.is_on: ha_loss_override
                  - api.connected:
              then:
                - if:
                    condition:
                      lambda: |-
                        // Defensive: treat empty/unknown as "not All Off" so we go to a safe "All Off".
                        auto s = id(ha_last_scene).state;
                        if (s.empty() || s == "unknown" || s == "unavailable") return true;
                        return s != "All Off";
                    then:
                      - homeassistant.service:
                          service: script.lounge_set_scene
                          data:
                            scene_name: "All Off"
                      - logger.log:
                          level: INFO
                          format: "BTN: Single click (online) -> Last scene was not 'All Off' -> Set 'All Off'"
                    else:
                      - homeassistant.service:
                          service: script.lounge_set_scene
                          data:
                            scene_name: "Bright"
                      - logger.log:
                          level: INFO
                          format: "BTN: Single click (online) -> Last scene was 'All Off' -> Set 'Bright'"
              else:
                # OFFLINE path: only act if override ON; toggle physical relay
                - if:
                    condition:
                      and:
                        - switch.is_on: ha_loss_override
                        - not:
                            api.connected:
                    then:
                      - if:
                          condition:
                            lambda: |-
                              return id(Relay_1).state;
                          then:
                            - switch.turn_off: Relay_1
                            - logger.log:
                                level: INFO
                                format: "BTN: Single click (offline) -> Relay_1 OFF"
                          else:
                            - switch.turn_on: Relay_1
                            - logger.log:
                                level: INFO
                                format: "BTN: Single click (offline) -> Relay_1 ON"
                    else:
                      - logger.log:
                          level: INFO
                          format: "BTN: Single click ignored (override OFF)"

      # --- Long hold: ON for at least 4s (only if HA connected) ---
      - timing:
          - ON for at least 4s
        then:
          - if:
              condition:
                api.connected:
              then:
                - homeassistant.service:
                    service: script.lounge_set_scene
                    data:
                      scene_name: "All Off"
                - homeassistant.event:
                    event: esphome.lounge_switch_hold
                    data:
                      action: "hold"
                - logger.log:
                    level: INFO
                    format: "BTN: Long press -> Scene All Off + HA event (hold)"
              else:
                - logger.log:
                    level: INFO
                    format: "BTN: Long press ignored (no HA connection)"

#:########################################################################################:#
# TEXT SENSOR COMPONENT:
# https://esphome.io/components/text_sensor/
#:########################################################################################:#
text_sensor:
  - platform: homeassistant
    id: ha_last_scene
    entity_id: input_text.lounge_last_scene
    on_value:
      - logger.log:
          level: DEBUG
          format: "HA last scene now: %s"
          args: ["x.c_str()"]

#:########################################################################################:#
# SWITCH COMPONENT:
# https://esphome.io/components/switch/
#:########################################################################################:#
switch:
  # GPIO13 for KS-811 first button UNLESS it is KS-811-1 then it is GPIO12
  - platform: gpio
    name: "Relay 1: ${switch_1_name}"
    pin: GPIO12
    id: Relay_1
    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