Edit esp-masterbdrmwest.yaml

esphome/esp-masterbdrmwest.yaml

@@ -0,0 +1,359 @@
+#:########################################################################################:#
+# TITLE: MASTER BEDROOM MAIN LIGHTS WEST
+# zorruno.com layout v1.1 2026
+#:########################################################################################:#
+# REPO:
+# https://home.fox.co.nz/gitea/zorruno/zorruno-homeassistant/src/branch/master/esphome/esp-masterbdrmwest.yaml
+#:########################################################################################:#
+# VERSIONS:
+# v1.0 2026-06-11 Initial YAML for Master Bedroom West 3-gang switch.
+#:########################################################################################:#
+# HARDWARE:
+# - Zemismart KS-811 Triple push button (ESP8266)
+# - Pinout/Schematic: https://community.home-assistant.io/t/zemismart-ks-811-working-with-esphome/
+#:########################################################################################:#
+# OPERATION NOTES:
+# - 3-gang KS-811 triple switch.
+# - Relay 1 = Master Bedroom South Lights. VIRTUAL/MIRROR ONLY on this switch; no load connected.
+# - Relay 2 = Master Bedroom North Lights. PHYSICAL LOAD CONNECTED on this switch.
+# - Relay 3 = unused output. Forced off/internal; Button 3 does NOT toggle Relay 3.
+# - Button 1 toggles South Lights locally by toggling Relay 1.
+# - Button 2 toggles North Lights locally by toggling Relay 2.
+# - Button 3 checks the Home Assistant bedside lamp jump/fade switch state and calls the opposite HA action.
+# - Relay 1 and Relay 2 are mirrored to the matching south switch in two ways:
+#     Method 1: HA blueprint sync between the relay entities (fast path when HA is online).
+#     Method 2: MQTT retained status sync between switches (backup path if HA is down, broker online).
+# - GPIO16 does not support interrupts; polling is used for Button 1 (suppresses warning).
+#:########################################################################################:#
+# MQTT COMMANDS:
+# - North Lights command topic:
+#   ${mqtt_local_command_topic1}/set
+#     Payload "On"  -> Relay 2 ON
+#     Payload "Off" -> Relay 2 OFF
+#
+# - North Lights retained status/sync topic:
+#   ${mqtt_local_status_topic1}/state
+#     Payload "On" / "Off" published when Relay 2 changes state.
+#     This same retained status topic is also subscribed to for HA-down two-way sync.
+#
+# - South Lights command topic:
+#   ${mqtt_local_command_topic2}/set
+#     Payload "On"  -> Relay 1 ON
+#     Payload "Off" -> Relay 1 OFF
+#
+# - South Lights retained status/sync topic:
+#   ${mqtt_local_status_topic2}/state
+#     Payload "On" / "Off" published when Relay 1 changes state.
+#     This same retained status topic is also subscribed to for HA-down two-way sync.
+#:########################################################################################:#
+# OFFLINE NOTES:
+# a) Home Assistant OFFLINE, WiFi OK, MQTT broker OK
+# - Button 1 and Button 2 still control/sync both switches via MQTT retained status topics.
+# - Button 3 cannot toggle the bedside lamp because it requires Home Assistant/API.
+#
+# b) MQTT OFFLINE (or broker unreachable), Home Assistant/API OK
+# - Button 1 and Button 2 still control/sync both switches via the HA blueprint.
+# - Button 3 can still toggle the bedside lamp via Home Assistant/API.
+#
+# c) Home Assistant and MQTT OFFLINE, WiFi OK or entire network OFFLINE
+# - Button 1 controls local Relay 1 only.
+# - Button 2 controls local Relay 2 only.
+# - Button 3 cannot control the bedside lamp.
+# - 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-masterbdrmwest"
+  friendly_name: "Master Bedroom Main Lights West"
+  description_comment: "Master Bedroom Main Lights West using a Zemismart KS-811 Triple Push Button. South Lights virtual on Relay 1, North Lights physical on Relay 2, Button 3 toggles bedside lamp jump/fade. (Layout V1.1)"
+  device_area: "Master Bedroom"
+
+  # Project Naming
+  project_name: "Zemismart Technologies.KS-811 Triple"
+  project_version: "v1.0"
+
+  # Passwords & Secrets
+  api_key: !secret esp-api_key
+  ota_pass: !secret esp-ota_pass
+  static_ip_address: !secret esp-masterbdrmwest_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"
+  update_interval: "60s"
+
+  # MQTT LOCAL Controls
+  # NOTE: device_name1 is North Lights and maps to Relay 2 on both bedroom switches.
+  mqtt_device_name1: "masterbrdm-northlights"
+  mqtt_local_command_topic1: "${mqtt_command_main_topic}/${mqtt_device_name1}"
+  mqtt_local_status_topic1: "${mqtt_status_main_topic}/${mqtt_device_name1}"
+
+  # NOTE: device_name2 is South Lights and maps to Relay 1 on both bedroom switches.
+  mqtt_device_name2: "masterbrdm-southlights"
+  mqtt_local_command_topic2: "${mqtt_command_main_topic}/${mqtt_device_name2}"
+  mqtt_local_status_topic2: "${mqtt_status_main_topic}/${mqtt_device_name2}"
+
+  # Switch/Relay/Button Naming
+  switch_1_name: "Master Bedroom South Lights"
+  switch_2_name: "Master Bedroom North Lights"
+  switch_3_name: "Bedside Lamp" # NOTE: Relay 3 output is unused and forced off
+
+  # Home Assistant bedside lamp entity controlled by Button 3
+  bedside_lamp_entity: "switch.master_bedroom_bedside_lamp_arlec_bulb_master_bedroom_bedside_lamp_arlec_bulb_jump_fade_up_down"
+
+#:########################################################################################:#
+# 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}"
+
+  #### 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}"
+  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
+  board_flash_mode: dout
+
+#:########################################################################################:#
+# LOGGING
+# https://esphome.io/components/logger.html
+#:########################################################################################:#
+logger:
+  level: "${log_level}"
+  #baud_rate: 0
+
+#:########################################################################################:#
+# MQTT: Device-specific MQTT command + retained status/sync triggers
+# This adds device-specific MQTT command triggers to the common MQTT configuration.
+#:########################################################################################:#
+mqtt:
+  on_message:
+    # -------------------------------------------------------------------------
+    # North Lights control/sync (Relay 2 on both bedroom switches)
+    # -------------------------------------------------------------------------
+    - topic: "${mqtt_local_command_topic1}/set"
+      payload: "On"
+      then:
+        - switch.turn_on: relay_2
+    - topic: "${mqtt_local_command_topic1}/set"
+      payload: "Off"
+      then:
+        - switch.turn_off: relay_2
+
+    # Retained status is also subscribed to as the MQTT backup sync path.
+    - topic: "${mqtt_local_status_topic1}/state"
+      payload: "On"
+      then:
+        - switch.turn_on: relay_2
+    - topic: "${mqtt_local_status_topic1}/state"
+      payload: "Off"
+      then:
+        - switch.turn_off: relay_2
+
+    # -------------------------------------------------------------------------
+    # South Lights control/sync (Relay 1 on both bedroom switches)
+    # -------------------------------------------------------------------------
+    - topic: "${mqtt_local_command_topic2}/set"
+      payload: "On"
+      then:
+        - switch.turn_on: relay_1
+    - topic: "${mqtt_local_command_topic2}/set"
+      payload: "Off"
+      then:
+        - switch.turn_off: relay_1
+
+    # Retained status is also subscribed to as the MQTT backup sync path.
+    - topic: "${mqtt_local_status_topic2}/state"
+      payload: "On"
+      then:
+        - switch.turn_on: relay_1
+    - topic: "${mqtt_local_status_topic2}/state"
+      payload: "Off"
+      then:
+        - switch.turn_off: relay_1
+
+#:########################################################################################:#
+# 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:
+  # Button 1 (GPIO16) - polling (GPIO16 has no interrupts)
+  - platform: gpio
+    pin:
+      number: GPIO16
+      mode: INPUT
+      inverted: true
+    use_interrupt: false
+    name: "Button 1: ${switch_1_name}"
+    on_press:
+      - switch.toggle: relay_1
+
+  # Button 2 (GPIO05)
+  - platform: gpio
+    pin:
+      number: GPIO05
+      mode: INPUT
+      inverted: true
+    name: "Button 2: ${switch_2_name}"
+    on_press:
+      - switch.toggle: relay_2
+
+  # Button 3 (GPIO04)
+  # NOTE: This does not toggle Relay 3. It checks the HA entity state and calls the opposite HA action.
+  - platform: gpio
+    pin:
+      number: GPIO4
+      mode: INPUT
+      inverted: true
+    name: "Button 3: ${switch_3_name}"
+    on_press:
+      - script.execute: toggle_bedside_lamp_jump_fade
+
+  # Home Assistant state import used by Button 3 so it can choose ON vs OFF explicitly.
+  - platform: homeassistant
+    id: bedside_lamp_jump_fade_state
+    entity_id: "${bedside_lamp_entity}"
+    internal: true
+
+#:########################################################################################:#
+# SCRIPT
+# https://esphome.io/components/script.html
+#:########################################################################################:#
+script:
+  # Toggle the HA bedside lamp jump/fade switch by checking the current imported HA state first.
+  # If it is ON, send OFF. If it is OFF/unknown, send ON.
+  - id: toggle_bedside_lamp_jump_fade
+    mode: restart
+    then:
+      - if:
+          condition:
+            api.connected:
+              state_subscription_only: true
+          then:
+            - if:
+                condition:
+                  binary_sensor.is_on: bedside_lamp_jump_fade_state
+                then:
+                  - homeassistant.action:
+                      action: switch.turn_off
+                      data:
+                        entity_id: "${bedside_lamp_entity}"
+                else:
+                  - homeassistant.action:
+                      action: switch.turn_on
+                      data:
+                        entity_id: "${bedside_lamp_entity}"
+          else:
+            - logger.log:
+                level: WARN
+                format: "Button 3 pressed, but Home Assistant/API is not connected. Bedside lamp not toggled."
+
+#:########################################################################################:#
+# SWITCH
+# https://esphome.io/components/switch/
+#:########################################################################################:#
+switch:
+  # Relay 1 (GPIO13) - Master Bedroom South Lights - VIRTUAL/MIRROR ONLY ON THIS SWITCH
+  - platform: gpio
+    name: "Relay 1: ${switch_1_name}"
+    pin: GPIO13
+    id: relay_1
+    restore_mode: RESTORE_DEFAULT_OFF
+    on_turn_on:
+      - mqtt.publish:
+          topic: "${mqtt_local_status_topic2}/state"
+          payload: "On"
+          retain: true
+    on_turn_off:
+      - mqtt.publish:
+          topic: "${mqtt_local_status_topic2}/state"
+          payload: "Off"
+          retain: true
+
+  # Relay 2 (GPIO12) - Master Bedroom North Lights - PHYSICAL LOAD CONNECTED HERE
+  - platform: gpio
+    name: "Relay 2: ${switch_2_name}"
+    pin: GPIO12
+    id: relay_2
+    restore_mode: RESTORE_DEFAULT_OFF
+    on_turn_on:
+      - mqtt.publish:
+          topic: "${mqtt_local_status_topic1}/state"
+          payload: "On"
+          retain: true
+    on_turn_off:
+      - mqtt.publish:
+          topic: "${mqtt_local_status_topic1}/state"
+          payload: "Off"
+          retain: true
+
+  # Relay 3 (GPIO14) - unused output, intentionally not exposed to Home Assistant.
+  # Button 3 controls the bedside lamp via Home Assistant/API instead.
+  - platform: gpio
+    name: "Relay 3: Unused Output Forced Off"
+    pin: GPIO14
+    id: relay_3
+    restore_mode: ALWAYS_OFF
+    internal: true