#:########################################################################################:#
# TITLE: DOWNSTAIRS KITCHEN MAIN LIGHTSWITCH
# zorruno.com layout v1.1 2026
#:########################################################################################:#
# REPO:
# https://home.fox.co.nz/gitea/zorruno/zorruno-homeassistant/src/branch/master/esphome/esp-downstkitchlights.yaml
#:########################################################################################:#
# VERSIONS:
# v2.3 2026-07-25 Standardized MQTT payloads: "ON"/"OFF" → "On"/"Off"
# v2.2 2026-07-20 Restored direct MQTT control of pantry LEDs using the flattened topic
# v2.1 2026-02-25 Updated yaml to zorruno layout V1.1
# v2.0 2025-06-05 YAML tidyups
# v1.0 2025-03-28 Initial Version
#:########################################################################################:#
# HARDWARE:
# - Zemismart KS-811 Triple push button (ESP8266)
# - ESP8266 board: esp01_1m
# - Pinout/schematic:
#   https://community.home-assistant.io/t/zemismart-ks-811-working-with-esphome/
#:########################################################################################:#
# OPERATION NOTES:
# - Downstairs Kitchen main lightswitch (3-gang logical)
# - Relay 1: Dining Light
# - Relay 2: Kitchen Light
# - Relay 3: Extract Fan (virtual only, no power connected to 3rd relay)
# - Relay 2 publishes ON/OFF commands directly to the downstairs kitchen pantry LEDs.
#:########################################################################################:#
# MQTT COMMANDS:
# - Remote command topic:
#   ${mqtt_remote_device_command_topic}
#     Payload "${mqtt_remote_device_command_on}"  -> pantry LEDs ON
#     Payload "${mqtt_remote_device_command_off}" -> pantry LEDs OFF
#:########################################################################################:#
# OFFLINE NOTES:
# a) Home Assistant OFFLINE, but Network and MQTT ONLINE
#    - Physical buttons continue to toggle relays
#    - MQTT (if used) continues to work
#    - HA API is unavailable until HA returns
# b) MQTT OFFLINE (but WiFi/Network and HA API ONLINE)
#    - Physical buttons continue to toggle relays
#    - HA API control continues to work (if enabled)
#    - MQTT features will not work while MQTT is down
# c) Entire WiFi/Network OFFLINE
#    - Physical buttons continue to toggle relays
#    - Accurate time is NOT needed (SNTP not needed)
#:########################################################################################:#

#:########################################################################################:#
# 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-downstkitchlights"
  friendly_name: "Downstairs Kitchen Lightswitch (3)"
  description_comment: "Downstairs Kitch Main Lightswitch using a Zemismart KS-811 Triple Push Button. Dining Light (1), Kitchen Light (2), Extract Fan (3) (Layout V1.1)"
  device_area: "Downstairs Flat" # Allows ESP device to be automatically linked to an 'Area' in Home Assistant.

  # Project Naming
  project_name: "Zemismart Technologies.KS-811 Triple"
  project_version: "v2.3"

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

  # MQTT REMOTE Controls
  mqtt_command_main_topic: !secret mqtt_command_main_topic
  mqtt_remote_device_name: "downstairskitchen-pantryleds"
  mqtt_remote_device_command_topic: "${mqtt_command_main_topic}/${mqtt_remote_device_name}"
  mqtt_remote_device_command_on: "On"
  mqtt_remote_device_command_off: "Off"

  # Device Settings
  log_level: "INFO" # NONE, ERROR, WARN, INFO, DEBUG (Default), VERBOSE, VERY_VERBOSE
  update_interval: "60s" # update time for general sensors etc

  # Switch Naming
  switch_1_name: "Dining Light"
  switch_2_name: "Kitchen Light"
  switch_3_name: "Extract Fan" # 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}"

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

#:########################################################################################:#
# LOGGING
# https://esphome.io/components/logger.html
#:########################################################################################:#
logger:
  level: "${log_level}"
  #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: yes

#:########################################################################################:#
# BINARY SENSORS
# https://esphome.io/components/binary_sensor/
#:########################################################################################:#
binary_sensor:
  - platform: gpio
    pin:
      number: GPIO16
      mode: INPUT
      inverted: True
    use_interrupt: false # This 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: GPIO05
      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_press:
      - switch.toggle: Relay_3

#:########################################################################################:#
# SWITCH
# 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
    on_turn_on:
      - mqtt.publish:
          topic: "${mqtt_remote_device_command_topic}"
          payload: "${mqtt_remote_device_command_on}"
    on_turn_off:
      - mqtt.publish:
          topic: "${mqtt_remote_device_command_topic}"
          payload: "${mqtt_remote_device_command_off}"

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