yaml layout updates to v1.x
This commit is contained in:
+118
-84
@@ -1,35 +1,67 @@
|
||||
#############################################
|
||||
#############################################
|
||||
# 3D PRINTER POWER AND SWITCH
|
||||
#:########################################################################################:#
|
||||
# TITLE: 3D PRINTER POWER AND SWITCH
|
||||
# zorruno.com layout v1.1 2026
|
||||
#:########################################################################################:#
|
||||
# REPO:
|
||||
# https://home.fox.co.nz/gitea/zorruno/zorruno-homeassistant/src/branch/master/esphome/esp-3dprinterpow.yaml
|
||||
#:########################################################################################:#
|
||||
# VERSIONS:
|
||||
# V1.1 2026-02-25 Updated yaml to zorruno layout V1.1
|
||||
# V1.0 2025-06-29 Initial Version
|
||||
#############################################
|
||||
# Sonoff POW R1
|
||||
#:########################################################################################:#
|
||||
# HARDWARE:
|
||||
# Sonoff POW R1 (ESP8266)
|
||||
# https://devices.esphome.io/devices/Sonoff-POW-R1
|
||||
#:########################################################################################:#
|
||||
# OPERATION NOTES:
|
||||
# - Inline power monitor (HLW8012) plus relay control for the 3D printer power feed
|
||||
# - Local MQTT control (ON/OFF) without needing Home Assistant
|
||||
# - Publishes current relay state on boot (burst) and on relay changes
|
||||
# - "Running" binary sensor is derived from measured power > 4 W (with delayed_off)
|
||||
#:########################################################################################:#
|
||||
# MQTT COMMANDS:
|
||||
# - Command topic (local):
|
||||
# ${mqtt_local_command_topic}
|
||||
# Payload "ON" -> relay ON + status LED ON
|
||||
# Payload "OFF" -> relay OFF + status LED OFF
|
||||
#
|
||||
# NOTES
|
||||
# -
|
||||
#
|
||||
#############################################
|
||||
#############################################
|
||||
# - Status topic (local):
|
||||
# ${mqtt_local_status_topic}
|
||||
# Payload "ON"/"OFF" published on relay state changes, plus a short burst on boot
|
||||
#:########################################################################################:#
|
||||
# OFFLINE NOTES:
|
||||
# a) Home Assistant OFFLINE, but Network and MQTT ONLINE
|
||||
# - Device remains controllable via MQTT local command topic
|
||||
# - Status publishes to MQTT still occur (relay state burst + changes)
|
||||
# - HA entities are unavailable until HA returns
|
||||
# b) MQTT OFFLINE (but WiFi/Network and HA API ONLINE)
|
||||
# - Device remains controllable from Home Assistant via API (if enabled)
|
||||
# - Local MQTT commands will not work and status publishes will fail while MQTT is down
|
||||
# c) Entire WiFi/Network OFFLINE
|
||||
# - No HA API and no MQTT control available
|
||||
# - Local button still toggles the relay (and status LED follows)
|
||||
# - Accurate time is NOT needed (SNTP not needed)
|
||||
#:########################################################################################:#
|
||||
|
||||
#############################################
|
||||
# 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-3dprinterpow"
|
||||
friendly_name: "3D Printer Power"
|
||||
description_comment: "3D Printer inline monitor and switch override using a Sonoff Pow R1."
|
||||
device_area: "Bedroom 3" # Allows ESP device to be automatically linked to an 'Area' in Home Assistant.
|
||||
description_comment: "3D Printer inline monitor and switch override using a Sonoff Pow R1. (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.POW R1" # Project Details
|
||||
project_version: "v1" # Project V denotes release of yaml file, allowing checking of deployed vs latest version
|
||||
|
||||
project_name: "Sonoff Technologies.POW R1" # Project Details
|
||||
project_version: "v1.1" # Project V denotes release of yaml file, allowing checking of deployed vs latest version
|
||||
|
||||
# Passwords & Secrets
|
||||
api_key: !secret esp-api_key
|
||||
ota_pass: !secret esp-ota_pass
|
||||
ota_pass: !secret esp-ota_pass
|
||||
static_ip_address: !secret esp-3dprinterpow_ip # unfortunately you can't use substitutions inside secrets names
|
||||
mqtt_command_main_topic: !secret mqtt_command_main_topic
|
||||
mqtt_status_main_topic: !secret mqtt_status_main_topic
|
||||
@@ -42,16 +74,16 @@ substitutions:
|
||||
mqtt_local_device_name: "3dprinter-power"
|
||||
mqtt_local_command_topic: "${mqtt_command_main_topic}/${mqtt_local_device_name}" # Topic we will use to command this locally without HA
|
||||
mqtt_local_status_topic: "${mqtt_status_main_topic}/${mqtt_local_device_name}" # Topic we will use to view status locally without HA
|
||||
|
||||
# Device Settings
|
||||
log_level: "INFO" # Define logging level: NONE, ERROR, WARN, INFO, DEBUG (Default), VERBOSE, VERY_VERBOSE
|
||||
update_interval: "60s" # update time for for general sensors etc
|
||||
entity_prefix: "Load" # Simple device name where we want to prefix a sensor or switch, eg "Load" Current.
|
||||
|
||||
##########################################################################################
|
||||
# Device Settings
|
||||
log_level: "INFO" # NONE, ERROR, WARN, INFO, DEBUG (default), VERBOSE, VERY_VERBOSE
|
||||
update_interval: "60s" # update time for for general sensors etc
|
||||
entity_prefix: "Load" # Simple device name where we want to prefix a sensor or switch, eg "Load" Current.
|
||||
|
||||
#:########################################################################################:#
|
||||
# PACKAGES: Included Common Packages
|
||||
# https://esphome.io/components/packages.html
|
||||
##########################################################################################
|
||||
#:########################################################################################:#
|
||||
packages:
|
||||
#### WIFI, Network (Static/DHCP/IPV6 etc), Fallback AP, Safemode ####
|
||||
common_wifi: !include
|
||||
@@ -74,23 +106,23 @@ 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}"
|
||||
@@ -104,80 +136,74 @@ esphome:
|
||||
then:
|
||||
- script.execute: publish_state_burst
|
||||
|
||||
#############################################
|
||||
# ESP Platform and Framework
|
||||
# https://esphome.io/components/esp32.html
|
||||
#############################################
|
||||
#:########################################################################################:#
|
||||
# ESP PLATFORM AND FRAMEWORK:
|
||||
# https://esphome.io/components/esp8266/
|
||||
#:########################################################################################:#
|
||||
esp8266:
|
||||
board: esp01_1m
|
||||
early_pin_init: False # Initialise pins early to known values. Recommended false where switches are involved. Defaults to True.
|
||||
early_pin_init: false # Recommended false where switches are involved. Defaults to true.
|
||||
board_flash_mode: dout # Default is dout
|
||||
|
||||
#############################################
|
||||
# ESPHome Logging Enable
|
||||
#:########################################################################################:#
|
||||
# LOGGING: ESPHome Logging Enable
|
||||
# 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)
|
||||
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
|
||||
|
||||
##########################################################################################
|
||||
# MQTT COMMANDS
|
||||
#:########################################################################################:#
|
||||
# MQTT: Device-specific MQTT command triggers
|
||||
# This adds device-specific MQTT command triggers to the common MQTT configuration.
|
||||
##########################################################################################
|
||||
#:########################################################################################:#
|
||||
mqtt:
|
||||
on_message:
|
||||
# Switch control from MQTT
|
||||
- topic: "${mqtt_local_command_topic}"
|
||||
payload: "ON"
|
||||
then:
|
||||
- switch.turn_on: relay
|
||||
- light.turn_on: led
|
||||
- switch.turn_on: relay
|
||||
- light.turn_on: led
|
||||
- topic: "${mqtt_local_command_topic}"
|
||||
payload: "OFF"
|
||||
then:
|
||||
- switch.turn_off: relay
|
||||
- light.turn_off: led
|
||||
- switch.turn_off: relay
|
||||
- light.turn_off: led
|
||||
|
||||
#############################################
|
||||
# STATUS LED
|
||||
# https://esphome.io/components/status_led.html
|
||||
#############################################
|
||||
#status_led:
|
||||
# pin:
|
||||
# number: GPIO2
|
||||
# inverted: yes
|
||||
|
||||
#############################################
|
||||
# SENSORS
|
||||
#:########################################################################################:#
|
||||
# BINARY SENSORS:
|
||||
# https://esphome.io/components/binary_sensor/
|
||||
#############################################
|
||||
#:########################################################################################:#
|
||||
binary_sensor:
|
||||
- platform: gpio
|
||||
pin:
|
||||
number: GPIO00
|
||||
number: GPIO0
|
||||
mode: INPUT_PULLUP
|
||||
inverted: True
|
||||
name: Button
|
||||
inverted: true
|
||||
name: "Button"
|
||||
on_press:
|
||||
- switch.toggle: virtual_button
|
||||
|
||||
- platform: template
|
||||
name: ${entity_prefix} Running
|
||||
name: "${entity_prefix} Running"
|
||||
filters:
|
||||
- delayed_off: 15s
|
||||
lambda: |-
|
||||
if (isnan(id(power).state)) {
|
||||
return {};
|
||||
} else if (id(power).state > 4) {
|
||||
// Running
|
||||
return true;
|
||||
} else {
|
||||
// Not running
|
||||
return false;
|
||||
}
|
||||
|
||||
#:########################################################################################:#
|
||||
# SENSORS COMPONENT:
|
||||
# https://esphome.io/components/sensor/
|
||||
#:########################################################################################:#
|
||||
sensor:
|
||||
- platform: hlw8012
|
||||
sel_pin: 5
|
||||
@@ -185,20 +211,17 @@ sensor:
|
||||
cf1_pin: 13
|
||||
update_interval: 2s
|
||||
current:
|
||||
name: ${entity_prefix} Current
|
||||
name: "${entity_prefix} Current"
|
||||
voltage:
|
||||
name: ${entity_prefix} Voltage
|
||||
name: "${entity_prefix} Voltage"
|
||||
power:
|
||||
name: ${entity_prefix} Power
|
||||
name: "${entity_prefix} Power"
|
||||
id: power
|
||||
#on_value_range:
|
||||
# - above: 4.0
|
||||
# then:
|
||||
# - light.turn_on: led
|
||||
# - below: 3.0
|
||||
# then:
|
||||
# - light.turn_off: led
|
||||
|
||||
#:########################################################################################:#
|
||||
# SWITCH COMPONENT:
|
||||
# https://esphome.io/components/switch/
|
||||
#:########################################################################################:#
|
||||
switch:
|
||||
- platform: template
|
||||
name: "Relay"
|
||||
@@ -215,7 +238,6 @@ switch:
|
||||
id: relay
|
||||
pin: GPIO12
|
||||
restore_mode: RESTORE_DEFAULT_ON
|
||||
# restore_mode: ALWAYS_ON # Or RESTORE_DEFAULT_ON/RESTORE_DEFAULT_OFF
|
||||
on_turn_on:
|
||||
- mqtt.publish:
|
||||
topic: "${mqtt_local_status_topic}"
|
||||
@@ -227,19 +249,31 @@ switch:
|
||||
payload: "OFF"
|
||||
retain: false
|
||||
|
||||
#:########################################################################################:#
|
||||
# OUTPUT COMPONENT:
|
||||
# https://esphome.io/components/output/
|
||||
#:########################################################################################:#
|
||||
output:
|
||||
- platform: esp8266_pwm
|
||||
id: pow_blue_led
|
||||
pin:
|
||||
number: GPIO15
|
||||
inverted: True
|
||||
inverted: true
|
||||
|
||||
#:########################################################################################:#
|
||||
# LIGHT COMPONENT:
|
||||
# https://esphome.io/components/light/
|
||||
#:########################################################################################:#
|
||||
light:
|
||||
- platform: monochromatic
|
||||
name: Status LED
|
||||
name: "Status LED"
|
||||
output: pow_blue_led
|
||||
id: led
|
||||
|
||||
#:########################################################################################:#
|
||||
# SCRIPT COMPONENT:
|
||||
# https://esphome.io/components/script.html
|
||||
#:########################################################################################:#
|
||||
script:
|
||||
- id: publish_state_burst
|
||||
mode: restart
|
||||
|
||||
Reference in New Issue
Block a user