#:########################################################################################:#
# TITLE: MAIN HALLWAY LIGHTSWITCH
# zorruno.com layout v1.1 2026
#:########################################################################################:#
# REPO:
# https://home.fox.co.nz/gitea/zorruno/zorruno-homeassistant/src/branch/master/esphome/esp-mainhallwaylights.yaml
#:########################################################################################:#
# VERSIONS:
# V1.3 2026-05-07 Refactored MQTT sync to use template HA switch actions; physical button and
#                 HA control now publish command topics; relay callbacks publish status only
#                 to prevent command ping-pong/chattering.
# V1.2 2026-04-03 Fixed local button logic so physical press toggles relay; moved custom MQTT
#                 status publish to relay state changes; corrected ESP8266 notes and wording
# V1.1 2026-04-03 Updated yaml to zorruno layout V1.1; corrected KS-811 single naming and
#                 operation notes
# V1.0 2026-04-03 Initial
#:########################################################################################:#
# HARDWARE:
# - Zemismart KS-811 Single push button
# - ESP8266 variant
# - Button 1: GPIO0
# - Relay 1: GPIO12
# - Status LED: GPIO2 (inverted)
#:########################################################################################:#
# OPERATION NOTES:
# - Main hallway switch with 1 output:
#   1) Main Hallway Lights
# - A single press of the physical button toggles the Main Hallway Lights group.
# - Home Assistant control of the exposed template switch also toggles the same group.
# - MQTT command topic requests On/Off changes.
# - Relay state changes publish retained status only.
# - Relays never publish command topics directly. This prevents command ping-pong/chattering.
#:########################################################################################:#
# MQTT COMMANDS:
# - ${mqtt_this_device_command_topic1}
#   Payloads: ${mqtt_command_on}, ${mqtt_command_off}
# - Status topic:
#   - ${mqtt_this_device_status_topic1}
#   Payloads mirror the actual relay state and are published retained.
#:########################################################################################:#
# OFFLINE NOTES:
# - a) Home Assistant offline (network and MQTT online):
#      - Local button control continues.
#      - MQTT command/status operation continues.
# - b) MQTT offline (or Home Assistant and MQTT offline):
#      - Local button control continues.
#      - If Home Assistant is online and connected by native ESPHome API, HA control can still
#        change the local relay but remote MQTT sync is unavailable until MQTT returns.
# - c) Entire WiFi/network offline:
#      - Local wall-switch button control continues.
#      - Accurate time is not needed. SNTP is not used for this device.
#:########################################################################################:#

#:########################################################################################:#
# 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-mainhallwaylights"
  friendly_name: "Main Hallway Lightswitch (1)"
  description_comment: "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" # Project Details
  project_version: "v1.3" # 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-mainhallwaylights_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" # NONE, ERROR, WARN, INFO, DEBUG, VERBOSE, VERY_VERBOSE
  update_interval: "60s" # General sensor update interval

  # Default relay restore mode
  # Options: RESTORE_DEFAULT_OFF, RESTORE_DEFAULT_ON, ALWAYS_ON, ALWAYS_OFF
  relay_restore_mode: "RESTORE_DEFAULT_OFF"

  # MQTT Remote Controls
  mqtt_this_device_function1: "mainhallway-mainlights"
  mqtt_this_device_command_topic1: "${mqtt_command_main_topic}/${mqtt_this_device_function1}"
  mqtt_this_device_status_topic1: "${mqtt_status_main_topic}/${mqtt_this_device_function1}"
  mqtt_command_on: "On"
  mqtt_command_off: "Off"

  # Switch/Relay/Button 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

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

#:########################################################################################:#
# ESP PLATFORM AND FRAMEWORK
# https://esphome.io/components/esp8266.html
#:########################################################################################:#
esp8266:
  board: esp01_1m
  early_pin_init: false # Recommended false where relays/switches are involved
  board_flash_mode: dout

#:########################################################################################:#
# LOGGING
# https://esphome.io/components/logger.html
#:########################################################################################:#
logger:
  level: "${log_level}"
  #baud_rate: 0 # Set to 0 for no logging via UART if UART is needed elsewhere
  #esp8266_store_log_strings_in_flash: false
  #tx_buffer_size: 64

#:########################################################################################:#
# MQTT: Device-specific MQTT command triggers
# This extends the common MQTT package with local custom command/status topics.
#:########################################################################################:#
mqtt:
  # Republish current relay state whenever MQTT reconnects so retained status stays accurate
  # for subscribers that reconnect later.
  on_connect:
    - mqtt.publish:
        topic: "${mqtt_this_device_status_topic1}"
        payload: !lambda |-
          return id(Relay_1).state ? "${mqtt_command_on}" : "${mqtt_command_off}";
        retain: true

  on_message:
    # Mirror remote command onto Relay_1, but only if a real state change is needed.
    # Do not republish the command from here. Relay status is published by the relay callback.
    - topic: "${mqtt_this_device_command_topic1}"
      payload: "${mqtt_command_on}"
      then:
        - if:
            condition:
              lambda: "return !id(Relay_1).state;"
            then:
              - switch.turn_on: Relay_1

    - topic: "${mqtt_this_device_command_topic1}"
      payload: "${mqtt_command_off}"
      then:
        - if:
            condition:
              lambda: "return id(Relay_1).state;"
            then:
              - switch.turn_off: Relay_1

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

#:########################################################################################:#
# SCRIPTS
# https://esphome.io/components/script.html
#:########################################################################################:#
script:
  # Local/HA requested ON. Change the local relay immediately, then publish a non-retained
  # command so any other linked switch follows.
  - id: mainhallway_mainlights_on
    mode: restart
    then:
      - if:
          condition:
            lambda: "return !id(Relay_1).state;"
          then:
            - switch.turn_on: Relay_1
      - mqtt.publish:
          topic: "${mqtt_this_device_command_topic1}"
          payload: "${mqtt_command_on}"
          retain: false

  # Local/HA requested OFF. Change the local relay immediately, then publish a non-retained
  # command so any other linked switch follows.
  - id: mainhallway_mainlights_off
    mode: restart
    then:
      - if:
          condition:
            lambda: "return id(Relay_1).state;"
          then:
            - switch.turn_off: Relay_1
      - mqtt.publish:
          topic: "${mqtt_this_device_command_topic1}"
          payload: "${mqtt_command_off}"
          retain: false

  # Physical button toggle logic. This is the only place that decides ON vs OFF.
  - id: mainhallway_mainlights_toggle
    mode: restart
    then:
      - if:
          condition:
            lambda: "return id(Relay_1).state;"
          then:
            - script.execute: mainhallway_mainlights_off
          else:
            - script.execute: mainhallway_mainlights_on

#:########################################################################################:#
# 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}"
    filters:
      - delayed_on: 10ms
      - delayed_off: 10ms
    on_press:
      - script.execute: mainhallway_mainlights_toggle

#:########################################################################################:#
# SWITCH
# https://esphome.io/components/switch/
#:########################################################################################:#
switch:
  # Exposed Home Assistant control. This is the switch to use in HA.
  - platform: template
    name: "Relay 1: ${switch_1_name}"
    id: Relay_1_HA
    lambda: |-
      return id(Relay_1).state;
    turn_on_action:
      - script.execute: mainhallway_mainlights_on
    turn_off_action:
      - script.execute: mainhallway_mainlights_off

  # Physical relay. Kept internal so HA uses the template switch above.
  # Relay callbacks publish retained status only, not commands.
  - platform: gpio
    name: "Internal Relay 1: ${switch_1_name}"
    internal: true
    pin: GPIO12
    id: Relay_1
    restore_mode: ${relay_restore_mode}
    on_turn_on:
      - mqtt.publish:
          topic: "${mqtt_this_device_status_topic1}"
          payload: "${mqtt_command_on}"
          retain: true
    on_turn_off:
      - mqtt.publish:
          topic: "${mqtt_this_device_status_topic1}"
          payload: "${mqtt_command_off}"
          retain: true