yaml layout updates to v1.x
This commit is contained in:
root
@@ -1,29 +1,66 @@
|
||||
#############################################
|
||||
#############################################
|
||||
# UNDERHOUSE LIGHTS
|
||||
# Controlled by a Sonoff 4Ch R2
|
||||
# https://github.com/jvyoralek/homeassistant-config/blob/master/esphome/sonoff-4ch.yaml
|
||||
#
|
||||
#:########################################################################################:#
|
||||
# TITLE: UNDERHOUSE LIGHTS
|
||||
# zorruno.com layout v1.1 2026
|
||||
#:########################################################################################:#
|
||||
# REPO:
|
||||
# https://home.fox.co.nz/gitea/zorruno/zorruno-homeassistant/src/branch/master/esphome/esp-underhouselights.yaml
|
||||
#:########################################################################################:#
|
||||
# VERSIONS:
|
||||
# V1.1 2026-02-25 Updated yaml to zorruno layout V1.1
|
||||
# V1.0 2025-06-18 Initial Version
|
||||
#:########################################################################################:#
|
||||
# HARDWARE:
|
||||
# Controlled by a Sonoff 4Ch R2
|
||||
# Reference YAML: https://github.com/jvyoralek/homeassistant-config/blob/master/esphome/sonoff-4ch.yaml
|
||||
#
|
||||
##########################################################################################
|
||||
##########################################################################################
|
||||
# GPIO (Sonoff 4Ch R2):
|
||||
# - Relays: GPIO12, GPIO05, GPIO04, GPIO15
|
||||
# - Buttons: GPIO00, GPIO09, GPIO10, GPIO14
|
||||
# - Status LED: GPIO13
|
||||
# - Extra "Remote Switch" inputs used here: GPIO03, GPIO02
|
||||
#:########################################################################################:#
|
||||
# OPERATION NOTES:
|
||||
# - 4-channel relay controller for underhouse lighting circuits.
|
||||
# - Local buttons toggle each relay (button1..button4).
|
||||
# - Two extra GPIO inputs act as "remote switches" that toggle relay1 and relay2.
|
||||
# - MQTT local command topics allow ON/OFF control per relay (see MQTT COMMANDS).
|
||||
#:########################################################################################:#
|
||||
# MQTT COMMANDS:
|
||||
# Relay control (local MQTT):
|
||||
# - ${mqtt_local_command_topic}/relay1/set -> ON, OFF
|
||||
# - ${mqtt_local_command_topic}/relay2/set -> ON, OFF
|
||||
# - ${mqtt_local_command_topic}/relay3/set -> ON, OFF
|
||||
# - ${mqtt_local_command_topic}/relay4/set -> ON, OFF
|
||||
#:########################################################################################:#
|
||||
# OFFLINE NOTES:
|
||||
# a) Home Assistant OFFLINE, but Network and MQTT ONLINE
|
||||
# - Device remains controllable via MQTT local command topics.
|
||||
# - Local buttons and remote switch inputs continue to toggle relays.
|
||||
# b) MQTT OFFLINE (but WiFi/Network and HA API ONLINE)
|
||||
# - Device remains controllable via Home Assistant API.
|
||||
# - MQTT local commands will not work while MQTT is down.
|
||||
# - Local buttons and remote switch inputs continue to toggle relays.
|
||||
# c) Entire WiFi/Network OFFLINE
|
||||
# - Local buttons and remote switch inputs continue to toggle relays.
|
||||
# - No HA API or MQTT control available.
|
||||
# - SNTP is not needed (no timeclocks used).
|
||||
#:########################################################################################:#
|
||||
|
||||
##########################################################################################
|
||||
# SPECIFIC DEVICE VARIABLE SUBSTITUTIONS
|
||||
#:########################################################################################:#
|
||||
# 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-underhouselights"
|
||||
friendly_name: "Underhouse Lights"
|
||||
description_comment: "Underhouse Lights Control :: Sonoff 4Ch R2"
|
||||
device_area: "Underhouse" # Allows ESP device to be automatically linked to an 'Area' in Home Assistant.
|
||||
description_comment: "Underhouse Lights Control :: Sonoff 4Ch R2 (Layout V1.1)"
|
||||
device_area: "Underhouse" # Allows ESP device to be automatically linked to an 'Area' in Home Assistant.
|
||||
|
||||
# Project Naming
|
||||
project_name: "Sonoff Technologies.Sonoff 4Ch R2" # Project Details
|
||||
project_version: "v1.0" # Project V denotes release of yaml file, allowing checking of deployed vs latest version
|
||||
|
||||
project_name: "Sonoff Technologies.Sonoff 4Ch R2" # Project Details
|
||||
project_version: "v1.1" # 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
|
||||
@@ -31,9 +68,13 @@ substitutions:
|
||||
mqtt_local_command_main_topic: !secret mqtt_command_main_topic
|
||||
mqtt_local_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: "ERROR" # Define logging level: NONE, ERROR, WARN, INFO, DEBUG (Default), VERBOSE, VERY_VERBOSE
|
||||
update_interval: "60s" # update time for for general sensors etc
|
||||
log_level: "ERROR" # NONE, ERROR, WARN, INFO, DEBUG (Default), VERBOSE, VERY_VERBOSE
|
||||
update_interval: "60s" # update time for general sensors etc
|
||||
|
||||
# MQTT Controls
|
||||
mqtt_device_name: "underhouse-lights-control"
|
||||
@@ -43,21 +84,24 @@ substitutions:
|
||||
# Switch Naming
|
||||
switch_1_name: "Underhouse Entrance Lights"
|
||||
button_1_name: "Button 1"
|
||||
relay_1_icon: "mdi:lightbulb"
|
||||
relay_1_icon: "mdi:lightbulb"
|
||||
|
||||
switch_2_name: "Underhouse Storage Lights"
|
||||
button_2_name: "Button 2"
|
||||
relay_2_icon: "mdi:lightbulb"
|
||||
relay_2_icon: "mdi:lightbulb"
|
||||
|
||||
switch_3_name: "Spare 3"
|
||||
button_3_name: "Button 3"
|
||||
relay_3_icon: "mdi:lightbulb"
|
||||
relay_3_icon: "mdi:lightbulb"
|
||||
|
||||
switch_4_name: "Spare 4"
|
||||
button_4_name: "Button 4"
|
||||
relay_4_icon: "mdi:lightbulb"
|
||||
relay_4_icon: "mdi:lightbulb"
|
||||
|
||||
##########################################################################################
|
||||
#:########################################################################################:#
|
||||
# PACKAGES: Included Common Packages
|
||||
# https://esphome.io/components/packages.html
|
||||
##########################################################################################
|
||||
#:########################################################################################:#
|
||||
packages:
|
||||
#### WIFI, Network (Static/DHCP/IPV6 etc), Fallback AP, Safemode ####
|
||||
common_wifi: !include
|
||||
@@ -66,6 +110,7 @@ packages:
|
||||
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
|
||||
@@ -79,93 +124,86 @@ packages:
|
||||
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
|
||||
#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
|
||||
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
|
||||
#:########################################################################################:#
|
||||
# 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}"
|
||||
# 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/esp32.html
|
||||
##########################################################################################
|
||||
#:########################################################################################:#
|
||||
# ESP PLATFORM AND FRAMEWORK:
|
||||
# https://esphome.io/components/esp8266/
|
||||
#:########################################################################################:#
|
||||
esp8266:
|
||||
board: esp01_1m # The original sonoff basic
|
||||
restore_from_flash: True # restore some values on reboot
|
||||
board: esp01_1m
|
||||
restore_from_flash: true
|
||||
|
||||
preferences:
|
||||
flash_write_interval: 5min
|
||||
|
||||
mdns:
|
||||
disabled: False
|
||||
disabled: false
|
||||
|
||||
##########################################################################################
|
||||
# ESPHome Logging Enable
|
||||
#:########################################################################################:#
|
||||
# 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
|
||||
level: "${log_level}"
|
||||
baud_rate: 0 # set to 0 for no logging via UART, needed if you are using it for other serial things
|
||||
|
||||
##########################################################################################
|
||||
# SWITCH COMPONENT
|
||||
#:########################################################################################:#
|
||||
# SWITCH COMPONENT:
|
||||
# https://esphome.io/components/switch/
|
||||
##########################################################################################
|
||||
# Sonoff 4Ch R2 Relays are GPIO12,05,04,15
|
||||
#############################################
|
||||
# Sonoff 4Ch R2 Relays are GPIO12, GPIO05, GPIO04, GPIO15
|
||||
#:########################################################################################:#
|
||||
switch:
|
||||
- platform: gpio
|
||||
id: relay1
|
||||
name: "${switch_1_name}"
|
||||
pin: GPIO12
|
||||
icon: "${relay_1_icon}"
|
||||
icon: "${relay_1_icon}"
|
||||
|
||||
- platform: gpio
|
||||
id: relay2
|
||||
name: "${switch_2_name}"
|
||||
pin: GPIO5
|
||||
icon: "${relay_2_icon}"
|
||||
icon: "${relay_2_icon}"
|
||||
|
||||
- platform: gpio
|
||||
id: relay3
|
||||
id: relay3
|
||||
name: "${switch_3_name}"
|
||||
pin: GPIO4
|
||||
icon: "${relay_3_icon}"
|
||||
icon: "${relay_3_icon}"
|
||||
|
||||
- platform: gpio
|
||||
id: relay4
|
||||
name: "${switch_4_name}"
|
||||
pin: GPIO15
|
||||
icon: "${relay_4_icon}"
|
||||
icon: "${relay_4_icon}"
|
||||
|
||||
##########################################################################################
|
||||
# BINARY SENSORS
|
||||
#:########################################################################################:#
|
||||
# BINARY SENSORS:
|
||||
# https://esphome.io/components/binary_sensor/
|
||||
##########################################################################################
|
||||
# Sonoff 4Ch R2 Buttons are GPIO00,09,10,14
|
||||
#############################################
|
||||
# Sonoff 4Ch R2 Buttons are GPIO00, GPIO09, GPIO10, GPIO14
|
||||
#:########################################################################################:#
|
||||
binary_sensor:
|
||||
- platform: gpio
|
||||
id: button1
|
||||
@@ -173,40 +211,44 @@ binary_sensor:
|
||||
pin:
|
||||
number: GPIO0
|
||||
mode: INPUT_PULLUP
|
||||
inverted: True
|
||||
inverted: true
|
||||
on_press:
|
||||
- switch.toggle: relay1
|
||||
- switch.toggle: relay1
|
||||
|
||||
- platform: gpio
|
||||
id: button2
|
||||
name: "${button_2_name}"
|
||||
pin:
|
||||
number: GPIO9
|
||||
mode: INPUT_PULLUP
|
||||
inverted: True
|
||||
inverted: true
|
||||
on_press:
|
||||
- switch.toggle: relay2
|
||||
- switch.toggle: relay2
|
||||
|
||||
- platform: gpio
|
||||
id: button3
|
||||
name: "${button_3_name}"
|
||||
pin:
|
||||
number: GPIO10
|
||||
mode: INPUT_PULLUP
|
||||
inverted: True
|
||||
inverted: true
|
||||
on_press:
|
||||
- switch.toggle: relay3
|
||||
- switch.toggle: relay3
|
||||
|
||||
- platform: gpio
|
||||
id: button4
|
||||
name: "${button_4_name}"
|
||||
pin:
|
||||
number: GPIO14
|
||||
mode: INPUT_PULLUP
|
||||
inverted: True
|
||||
inverted: true
|
||||
on_press:
|
||||
- switch.toggle: relay4
|
||||
- switch.toggle: relay4
|
||||
|
||||
# Extra remote switch input -> toggles relay 1
|
||||
- platform: gpio
|
||||
pin:
|
||||
number: GPIO03
|
||||
number: GPIO3
|
||||
mode: INPUT_PULLUP
|
||||
inverted: true
|
||||
name: "${switch_1_name} Remote Switch"
|
||||
@@ -219,15 +261,15 @@ binary_sensor:
|
||||
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();
|
||||
}
|
||||
|
||||
# Extra remote switch input -> toggles relay 2
|
||||
- platform: gpio
|
||||
pin:
|
||||
number: GPIO02
|
||||
number: GPIO2
|
||||
mode: INPUT_PULLUP
|
||||
inverted: true
|
||||
name: "${switch_2_name} Remote Switch"
|
||||
@@ -240,28 +282,24 @@ binary_sensor:
|
||||
then:
|
||||
- lambda: |-
|
||||
if (id(relay2).state) {
|
||||
// Relay is ON: turn it OFF
|
||||
id(relay2).turn_off();
|
||||
} else {
|
||||
// Relay is OFF: turn it ON
|
||||
id(relay2).turn_on();
|
||||
}
|
||||
|
||||
##########################################################################################
|
||||
# STATUS LED
|
||||
|
||||
#:########################################################################################:#
|
||||
# STATUS LED:
|
||||
# https://esphome.io/components/status_led.html
|
||||
##########################################################################################
|
||||
# Sonoff Basic R1 LED is GPIO13
|
||||
#############################################
|
||||
#:########################################################################################:#
|
||||
status_led:
|
||||
pin:
|
||||
number: GPIO13
|
||||
inverted: yes
|
||||
inverted: true
|
||||
|
||||
##########################################################################################
|
||||
# MQTT COMMANDS
|
||||
#:########################################################################################:#
|
||||
# MQTT:
|
||||
# This adds device-specific MQTT command triggers to the common MQTT configuration.
|
||||
##########################################################################################
|
||||
#:########################################################################################:#
|
||||
mqtt:
|
||||
on_message:
|
||||
# Relay 1 control
|
||||
@@ -273,6 +311,7 @@ mqtt:
|
||||
payload: "OFF"
|
||||
then:
|
||||
- switch.turn_off: relay1
|
||||
|
||||
# Relay 2 control
|
||||
- topic: "${mqtt_local_command_topic}/relay2/set"
|
||||
payload: "ON"
|
||||
@@ -282,6 +321,7 @@ mqtt:
|
||||
payload: "OFF"
|
||||
then:
|
||||
- switch.turn_off: relay2
|
||||
|
||||
# Relay 3 control
|
||||
- topic: "${mqtt_local_command_topic}/relay3/set"
|
||||
payload: "ON"
|
||||
@@ -290,8 +330,9 @@ mqtt:
|
||||
- topic: "${mqtt_local_command_topic}/relay3/set"
|
||||
payload: "OFF"
|
||||
then:
|
||||
- switch.turn_off: relay3
|
||||
# Relay 4 control
|
||||
- switch.turn_off: relay3
|
||||
|
||||
# Relay 4 control
|
||||
- topic: "${mqtt_local_command_topic}/relay4/set"
|
||||
payload: "ON"
|
||||
then:
|
||||
@@ -299,6 +340,4 @@ mqtt:
|
||||
- topic: "${mqtt_local_command_topic}/relay4/set"
|
||||
payload: "OFF"
|
||||
then:
|
||||
- switch.turn_off: relay4
|
||||
|
||||
|
||||
- switch.turn_off: relay4
|
||||
Reference in New Issue
Block a user