Edit esp-3dprinterpow.yaml
This commit is contained in:
ESPHome Device Builder
+127
-68
@@ -6,79 +6,101 @@
|
||||
# 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
|
||||
# V1.2 2026-07-11
|
||||
# - Removed the optimistic template relay switch.
|
||||
# - Exposed the actual GPIO12 relay directly to Home Assistant.
|
||||
# - Physical button and MQTT commands now control the same relay entity.
|
||||
# - Status LED is now synchronised from the real relay state callbacks.
|
||||
# - Prevents the Home Assistant switch state becoming desynchronised from the relay.
|
||||
#
|
||||
# V1.1 2026-02-25
|
||||
# - Updated YAML to zorruno layout V1.1.
|
||||
#
|
||||
# V1.0 2025-06-29
|
||||
# - Initial version.
|
||||
#:########################################################################################:#
|
||||
# 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)
|
||||
# - Inline power monitor using the HLW8012.
|
||||
# - GPIO12 directly controls the 3D printer power relay.
|
||||
# - The physical button toggles the real relay.
|
||||
# - Home Assistant directly controls and reports the real relay state.
|
||||
# - Local MQTT ON/OFF control works without needing Home Assistant.
|
||||
# - The status LED follows the actual relay state.
|
||||
# - Publishes current relay state on boot and whenever the relay changes.
|
||||
# - "Running" binary sensor is derived from measured power greater than 4 W.
|
||||
#:########################################################################################:#
|
||||
# MQTT COMMANDS:
|
||||
# - Command topic (local):
|
||||
# - Command topic:
|
||||
# ${mqtt_local_command_topic}
|
||||
# Payload "ON" -> relay ON + status LED ON
|
||||
# Payload "OFF" -> relay OFF + status LED OFF
|
||||
#
|
||||
# - Status topic (local):
|
||||
# Payload "ON" -> relay ON
|
||||
# Payload "OFF" -> relay OFF
|
||||
#
|
||||
# - Status topic:
|
||||
# ${mqtt_local_status_topic}
|
||||
# Payload "ON"/"OFF" published on relay state changes, plus a short burst on boot
|
||||
#
|
||||
# Payload "ON"/"OFF" is published:
|
||||
# - whenever the actual relay state changes;
|
||||
# - as a short status burst following 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
|
||||
# - Device remains controllable through the MQTT local command topic.
|
||||
# - Relay status changes continue to publish through MQTT.
|
||||
# - Home Assistant entities remain unavailable until HA returns.
|
||||
#
|
||||
# b) MQTT OFFLINE, but WiFi/Network and HA API ONLINE
|
||||
# - Device remains controllable from Home Assistant through the native API.
|
||||
# - Local MQTT commands do not work while MQTT is unavailable.
|
||||
# - MQTT status publishing resumes when MQTT reconnects.
|
||||
#
|
||||
# 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)
|
||||
# - No Home Assistant API or MQTT control is available.
|
||||
# - The local physical button continues to toggle the relay.
|
||||
# - The status LED continues to follow the real relay state.
|
||||
# - Accurate time is not needed.
|
||||
#:########################################################################################:#
|
||||
|
||||
|
||||
#:########################################################################################:#
|
||||
# SUBSTITUTIONS: Specific device variable substitutions
|
||||
# If NOT using a secrets file, just replace these with the passwords etc (in quotes)
|
||||
# If not using a secrets file, replace these with the required values 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. (Layout V1.1)"
|
||||
device_area: "Underhouse" # 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"
|
||||
|
||||
# Project Naming
|
||||
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
|
||||
project_name: "Sonoff Technologies.POW R1"
|
||||
project_version: "v1.2"
|
||||
|
||||
# Passwords & Secrets
|
||||
# Passwords and Secrets
|
||||
api_key: !secret esp-api_key
|
||||
ota_pass: !secret esp-ota_pass
|
||||
static_ip_address: !secret esp-3dprinterpow_ip # unfortunately you can't use substitutions inside secrets names
|
||||
static_ip_address: !secret esp-3dprinterpow_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.
|
||||
# If changing IP addresses, update the current IP address here.
|
||||
# Switch it back once the address change is complete.
|
||||
current_ip_address: ${static_ip_address}
|
||||
|
||||
# MQTT LOCAL Controls
|
||||
# MQTT Local Controls
|
||||
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
|
||||
mqtt_local_command_topic: "${mqtt_command_main_topic}/${mqtt_local_device_name}"
|
||||
mqtt_local_status_topic: "${mqtt_status_main_topic}/${mqtt_local_device_name}"
|
||||
|
||||
# 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.
|
||||
log_level: "INFO"
|
||||
update_interval: "60s"
|
||||
entity_prefix: "Load"
|
||||
|
||||
#:########################################################################################:#
|
||||
# PACKAGES: Included Common Packages
|
||||
@@ -126,14 +148,26 @@ packages:
|
||||
esphome:
|
||||
name: "${device_name}"
|
||||
friendly_name: "${friendly_name}"
|
||||
comment: "${description_comment}" # Appears on the esphome page in HA
|
||||
comment: "${description_comment}"
|
||||
area: "${device_area}"
|
||||
|
||||
project:
|
||||
name: "${project_name}"
|
||||
version: "${project_version}"
|
||||
|
||||
on_boot:
|
||||
priority: -10
|
||||
then:
|
||||
# Ensure the status LED reflects the restored physical relay state.
|
||||
- if:
|
||||
condition:
|
||||
switch.is_on: relay
|
||||
then:
|
||||
- light.turn_on: led
|
||||
else:
|
||||
- light.turn_off: led
|
||||
|
||||
# Publish a short MQTT status burst after startup.
|
||||
- script.execute: publish_state_burst
|
||||
|
||||
#:########################################################################################:#
|
||||
@@ -142,78 +176,91 @@ esphome:
|
||||
#:########################################################################################:#
|
||||
esp8266:
|
||||
board: esp01_1m
|
||||
early_pin_init: false # Recommended false where switches are involved. Defaults to true.
|
||||
board_flash_mode: dout # Default is dout
|
||||
|
||||
# Recommended false where switches are involved.
|
||||
early_pin_init: false
|
||||
|
||||
# Default is DOUT for this hardware.
|
||||
board_flash_mode: dout
|
||||
|
||||
#:########################################################################################:#
|
||||
# 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}"
|
||||
|
||||
# Set to 0 if the UART is required for another component.
|
||||
#baud_rate: 0
|
||||
|
||||
#esp8266_store_log_strings_in_flash: false
|
||||
#tx_buffer_size: 64
|
||||
|
||||
#:########################################################################################:#
|
||||
# MQTT: Device-specific MQTT command triggers
|
||||
# This adds device-specific MQTT command triggers to the common MQTT configuration.
|
||||
# Adds local ON/OFF relay control 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
|
||||
|
||||
- topic: "${mqtt_local_command_topic}"
|
||||
payload: "OFF"
|
||||
then:
|
||||
- switch.turn_off: relay
|
||||
- light.turn_off: led
|
||||
|
||||
#:########################################################################################:#
|
||||
# BINARY SENSORS:
|
||||
# https://esphome.io/components/binary_sensor/
|
||||
#:########################################################################################:#
|
||||
binary_sensor:
|
||||
# Physical Sonoff button.
|
||||
- platform: gpio
|
||||
name: "Button"
|
||||
|
||||
pin:
|
||||
number: GPIO0
|
||||
mode: INPUT_PULLUP
|
||||
inverted: true
|
||||
name: "Button"
|
||||
on_press:
|
||||
- switch.toggle: virtual_button
|
||||
|
||||
on_press:
|
||||
then:
|
||||
- switch.toggle: relay
|
||||
|
||||
# Indicates when the connected 3D printer is consuming more than 4 W.
|
||||
- platform: template
|
||||
name: "${entity_prefix} Running"
|
||||
|
||||
filters:
|
||||
- delayed_off: 15s
|
||||
|
||||
lambda: |-
|
||||
if (isnan(id(power).state)) {
|
||||
return {};
|
||||
} else if (id(power).state > 4) {
|
||||
return true;
|
||||
} else {
|
||||
return false;
|
||||
}
|
||||
|
||||
return id(power).state > 4.0f;
|
||||
|
||||
#:########################################################################################:#
|
||||
# SENSORS COMPONENT:
|
||||
# SENSOR COMPONENT:
|
||||
# https://esphome.io/components/sensor/
|
||||
#:########################################################################################:#
|
||||
sensor:
|
||||
- platform: hlw8012
|
||||
sel_pin: 5
|
||||
cf_pin: 14
|
||||
cf1_pin: 13
|
||||
sel_pin: GPIO5
|
||||
cf_pin: GPIO14
|
||||
cf1_pin: GPIO13
|
||||
update_interval: 2s
|
||||
|
||||
current:
|
||||
name: "${entity_prefix} Current"
|
||||
|
||||
voltage:
|
||||
name: "${entity_prefix} Voltage"
|
||||
|
||||
power:
|
||||
name: "${entity_prefix} Power"
|
||||
id: power
|
||||
@@ -223,27 +270,34 @@ sensor:
|
||||
# https://esphome.io/components/switch/
|
||||
#:########################################################################################:#
|
||||
switch:
|
||||
- platform: template
|
||||
name: "Relay"
|
||||
optimistic: true
|
||||
id: virtual_button
|
||||
turn_on_action:
|
||||
- switch.turn_on: relay
|
||||
- light.turn_on: led
|
||||
turn_off_action:
|
||||
- switch.turn_off: relay
|
||||
- light.turn_off: led
|
||||
|
||||
# The actual GPIO relay is exposed directly to Home Assistant.
|
||||
# This is the single authoritative relay state for:
|
||||
# - Home Assistant API control;
|
||||
# - MQTT control;
|
||||
# - physical button control;
|
||||
# - relay state restoration;
|
||||
# - MQTT status publishing;
|
||||
# - status LED synchronisation.
|
||||
- platform: gpio
|
||||
name: "Relay"
|
||||
id: relay
|
||||
pin: GPIO12
|
||||
|
||||
restore_mode: RESTORE_DEFAULT_ON
|
||||
|
||||
on_turn_on:
|
||||
then:
|
||||
- light.turn_on: led
|
||||
|
||||
- mqtt.publish:
|
||||
topic: "${mqtt_local_status_topic}"
|
||||
payload: "ON"
|
||||
retain: false
|
||||
|
||||
on_turn_off:
|
||||
then:
|
||||
- light.turn_off: led
|
||||
|
||||
- mqtt.publish:
|
||||
topic: "${mqtt_local_status_topic}"
|
||||
payload: "OFF"
|
||||
@@ -256,6 +310,7 @@ switch:
|
||||
output:
|
||||
- platform: esp8266_pwm
|
||||
id: pow_blue_led
|
||||
|
||||
pin:
|
||||
number: GPIO15
|
||||
inverted: true
|
||||
@@ -267,8 +322,8 @@ output:
|
||||
light:
|
||||
- platform: monochromatic
|
||||
name: "Status LED"
|
||||
output: pow_blue_led
|
||||
id: led
|
||||
output: pow_blue_led
|
||||
|
||||
#:########################################################################################:#
|
||||
# SCRIPT COMPONENT:
|
||||
@@ -277,13 +332,17 @@ light:
|
||||
script:
|
||||
- id: publish_state_burst
|
||||
mode: restart
|
||||
|
||||
then:
|
||||
- repeat:
|
||||
count: 5
|
||||
|
||||
then:
|
||||
- mqtt.publish:
|
||||
topic: "${mqtt_local_status_topic}"
|
||||
payload: !lambda 'return id(relay).state ? "ON" : "OFF";'
|
||||
payload: !lambda |-
|
||||
return id(relay).state ? "ON" : "OFF";
|
||||
retain: false
|
||||
qos: 1
|
||||
|
||||
- delay: 5s
|
||||
Reference in New Issue
Block a user