#:########################################################################################:#
# TITLE: GARAGE LIGHTS
# zorruno.com layout v1.1 2026
#:########################################################################################:#
# REPO:
# https://home.fox.co.nz/gitea/zorruno/zorruno-homeassistant/src/branch/master/esphome/esp-garagelights.yaml
#:########################################################################################:#
# VERSIONS:
# V2.1 2026-03-04 Updated yaml to zorruno layout V1.1
# V2.0 2025-10-22 Latest layout with home MQTT code
# V1.0 2025-10-22 Initial Version
#:########################################################################################:#
# HARDWARE:
# - Sonoff Basic R1 (ESP8266)
#:########################################################################################:#
# OPERATION NOTES:
# - Garage light relay control using Sonoff Basic R1 (GPIO12 relay, GPIO3 button, GPIO13 LED)
# - Physical button toggles relay locally
# - MQTT command topic controls relay ON/OFF
# - MQTT status topic publishes relay state on changes and on MQTT reconnect
#:########################################################################################:#
# MQTT COMMANDS:
# - Command topic:
#   ${mqtt_command_topic_1}
#     Payload "${mqtt_command_ON}"  -> relay ON
#     Payload "${mqtt_command_OFF}" -> relay OFF
# - Status topic:
#   ${mqtt_status_topic_1}
#     Payload "${mqtt_command_ON}" / "${mqtt_command_OFF}" published on relay changes and MQTT reconnect
#:########################################################################################:#
# OFFLINE NOTES:
# a) Home Assistant OFFLINE, but Network and MQTT ONLINE
#    - Physical button still toggles relay locally
#    - MQTT commands still control relay and status publishes still occur
# b) MQTT OFFLINE (but WiFi/Network and HA API ONLINE)
#    - Physical button still toggles relay locally
#    - HA/API control still works (switch entity), but MQTT commands/status publishes will not work
# c) Entire WiFi/Network OFFLINE
#    - Physical button still toggles relay locally (standalone)
#    - No HA API and no MQTT until network returns
#    - Accurate time is NOT needed (SNTP not required) for core operation
#:########################################################################################:#


#:########################################################################################:#
# SUBSTITUTIONS: Specific device variable substitutions
# If NOT using a secrets file, just replace these with the passwords etc (in quotes)
#:########################################################################################:#
substitutions:
  # Device Custom Naming
  device_name: "esp-garagelights"
  friendly_name: "Garage Lights"
  description_comment: "Garage Lights :: Sonoff Basic (Layout V1.1)"
  device_area: "Garage" # Allows ESP device to be automatically linked to an 'Area' in Home Assistant.
  static_ip_address: !secret esp-garagelights_ip

  # Project Naming
  project_name: "Sonoff Technologies.Sonoff Basic V1" # Project Details
  project_version: "v2.1"  # Project V denotes release of yaml file, allowing checking of deployed vs latest version

  # Passwords & Secrets (unfortunately you can't use substitutions inside secrets names)
  api_key: !secret esp-api_key
  ota_pass: !secret esp-ota_pass

  # 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 Controls
  mqtt_device_name_1: "garage-lights"
  mqtt_command_main_topic: !secret mqtt_command_main_topic
  mqtt_status_main_topic: !secret mqtt_status_main_topic
  mqtt_command_topic_1: "${mqtt_command_main_topic}/${mqtt_device_name_1}"
  mqtt_status_topic_1: "${mqtt_status_main_topic}/${mqtt_device_name_1}"
  mqtt_command_ON: "ON"
  mqtt_command_OFF: "OFF"

  # I/O Naming
  relay_1_name: "Garage Lights"
  button_1_name: "Power Button"
  relay_icon: "mdi:lightbulb-group"

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


#:########################################################################################:#
# 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}"
#  platformio_options:
#    build_flags:
#      - "-Os"                   # optimize for size
#      - "-Wl,--gc-sections"     # drop unused code/data
#      - "-fno-exceptions"       # strip C++ exceptions
#      - "-fno-rtti"             # strip C++ RTTI


#:########################################################################################:#
# ESP PLATFORM AND FRAMEWORK:
# https://esphome.io/components/esp8266.html
#:########################################################################################:#
esp8266:
  board: esp01_1m # Sonoff Basic R1
  restore_from_flash: true # restore some values on reboot

preferences:
  flash_write_interval: 5min

mdns:
  disabled: false


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


#:########################################################################################:#
# SWITCH COMPONENT:
# https://esphome.io/components/switch/
# Sonoff Basic R1 Relay Switch is GPIO12
#:########################################################################################:#
switch:
  - platform: gpio
    name: "${relay_1_name}"
    pin: GPIO12
    id: relay1
    restore_mode: RESTORE_DEFAULT_OFF
    icon: "${relay_icon}"


#:########################################################################################:#
# BINARY SENSORS:
# https://esphome.io/components/binary_sensor/
# Sonoff Basic R1 Button is GPIO03
#:########################################################################################:#
binary_sensor:
  # Actual button input
  - platform: gpio
    pin:
      number: GPIO3
      mode: INPUT_PULLUP
      inverted: true
    name: "${button_1_name}"
    id: power_button
    filters:
      - delayed_on: 20ms
    on_click:
      - min_length: 20ms
        max_length: 500ms
        then:
          - lambda: |-
              if (id(relay1).state) {
                // Relay is ON: turn it OFF
                id(relay1).turn_off();
              } else {
                // Relay is OFF: turn it ON
                id(relay1).turn_on();
              }

  # Mimics actual relay status
  - platform: template
    name: "${relay_1_name} Status"
    lambda: |-
      return id(relay1).state;
    on_press:
      - mqtt.publish:
          topic: "${mqtt_status_topic_1}"
          payload: "${mqtt_command_ON}"
    on_release:
      - mqtt.publish:
          topic: "${mqtt_status_topic_1}"
          payload: "${mqtt_command_OFF}"


#:########################################################################################:#
# STATUS LED:
# https://esphome.io/components/status_led.html
# Sonoff Basic R1 LED is GPIO13
#:########################################################################################:#
status_led:
  pin:
    number: GPIO13
    inverted: true


#:########################################################################################:#
# MQTT:
# This adds device-specific MQTT command triggers to the common MQTT configuration.
#:########################################################################################:#
mqtt:
  on_message:
    # Relay 1 control (only act and publish if a change is needed)
    - topic: "${mqtt_command_topic_1}"
      payload: "${mqtt_command_ON}"
      then:
        - if:
            condition:
              not:
                switch.is_on: relay1
            then:
              - switch.turn_on: relay1
              - mqtt.publish:
                  topic: "${mqtt_status_topic_1}"
                  payload: "${mqtt_command_ON}"
                  #retain: true

    - topic: "${mqtt_command_topic_1}"
      payload: "${mqtt_command_OFF}"
      then:
        - if:
            condition:
              not:
                switch.is_off: relay1
            then:
              - switch.turn_off: relay1
              - mqtt.publish:
                  topic: "${mqtt_status_topic_1}"
                  payload: "${mqtt_command_OFF}"
                  #retain: true

  # Announce current state whenever MQTT (re)connects
  on_connect:
    then:
      - mqtt.publish:
          topic: "${mqtt_status_topic_1}"
          payload: !lambda 'return id(relay1).state ? "ON" : "OFF";'
          #retain: true