zorruno/zorruno-homeassistant
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Files
5855dbb5a9a1da860ffbb574ea0a807cced59d29
zorruno-homeassistant/esphome/esp-3dprinterpow.yaml
T
ESPHome Device Builder 5c5256caa9 Edit esp-3dprinterpow.yaml
2026-07-12 13:05:32 +12:00

476 lines
16 KiB
YAML
Raw Blame History

#:########################################################################################:#
# 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.3 2026-07-12
# - Added cumulative Load Energy integration sensor for Home Assistant.
# - Added seven-day maximum power sensor.
# - Maximum power resets after 168 powered hours.
# - Added a single-process compile limit to reduce Builder memory use.
#
# 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 using the HLW8012.
# - Reports current, voltage, instantaneous power, and cumulative energy.
# - Load Energy integrates measured power over time and reports kWh.
# - Load Energy resets to zero if the ESPHome device reboots.
# - Home Assistant handles the reset because the sensor uses total_increasing.
# - Load Maximum Power 7 Days records the highest measured power.
# - Maximum power resets after 168 powered hours.
# - Maximum power and the elapsed-hour counter are retained across reboots.
# - The maximum value is checked for saving every five minutes.
# - The elapsed-hour counter is checked for saving every six hours.
# - An unexpected power loss may extend the peak reset period by up to about six hours.
# - 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:
# ${mqtt_local_command_topic}
#
# Payload "ON" -> relay ON
# Payload "OFF" -> relay OFF
#
# - Status topic:
# ${mqtt_local_status_topic}
#
# 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 through the MQTT local command topic.
# - Relay status changes continue to publish through MQTT.
# - Energy integration and maximum power monitoring continue locally.
# - 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.
# - Energy integration and maximum power monitoring continue locally.
# - MQTT status publishing resumes when MQTT reconnects.
#
# c) Entire WiFi/Network OFFLINE
# - 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.
# - Energy integration and maximum power monitoring continue locally.
# - Accurate time is not needed for the seven-day powered-time reset.
#:########################################################################################:#
#:########################################################################################:#
# SUBSTITUTIONS: Specific device variable substitutions
# 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"
# Project Naming
project_name: "Sonoff Technologies.POW R1"
project_version: "v1.3"
# Passwords and Secrets
api_key: !secret esp-api_key
ota_pass: !secret esp-ota_pass
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 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_device_name: "3dprinter-power"
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"
update_interval: "60s"
entity_prefix: "Load"
#:########################################################################################:#
# 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}"
area: "${device_area}"
# Restrict PlatformIO to one simultaneous compiler process to reduce host RAM use.
compile_process_limit: 1
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
#:########################################################################################:#
# ESP PLATFORM AND FRAMEWORK:
# https://esphome.io/components/esp8266/
#:########################################################################################:#
esp8266:
board: esp01_1m
# 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}"
# 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
# Adds local ON/OFF relay control to the common MQTT configuration.
#:########################################################################################:#
mqtt:
on_message:
- topic: "${mqtt_local_command_topic}"
payload: "ON"
then:
- switch.turn_on: relay
- topic: "${mqtt_local_command_topic}"
payload: "OFF"
then:
- switch.turn_off: relay
#:########################################################################################:#
# GLOBALS:
# Retained maximum power and elapsed-hour counter
# https://esphome.io/components/globals.html
#:########################################################################################:#
globals:
# Highest measured power during the current seven-day period.
# Changed values are checked for saving every five minutes.
- id: max_power_7d
type: float
restore_value: true
initial_value: '0.0'
update_interval: 5min
# Powered hours elapsed during the current seven-day period.
# Changed values are checked for saving every six hours to reduce flash writes.
- id: max_power_hours_elapsed
type: uint16_t
restore_value: true
initial_value: '0'
update_interval: 6h
#:########################################################################################:#
# 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
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 {};
}
return id(power).state > 4.0f;
#:########################################################################################:#
# SENSOR COMPONENT:
# https://esphome.io/components/sensor/
#:########################################################################################:#
sensor:
- platform: hlw8012
sel_pin: GPIO5
cf_pin: GPIO14
cf1_pin: GPIO13
update_interval: 2s
current:
name: "${entity_prefix} Current"
device_class: current
state_class: measurement
unit_of_measurement: "A"
accuracy_decimals: 2
voltage:
name: "${entity_prefix} Voltage"
device_class: voltage
state_class: measurement
unit_of_measurement: "V"
accuracy_decimals: 1
power:
name: "${entity_prefix} Power"
id: power
device_class: power
state_class: measurement
unit_of_measurement: "W"
accuracy_decimals: 1
# Update the seven-day maximum whenever a new peak is measured.
on_value:
then:
- lambda: |-
if (!isnan(x) && x > id(max_power_7d)) {
id(max_power_7d) = x;
id(max_power_7d_sensor).publish_state(x);
ESP_LOGI(
"max_power",
"New seven-day maximum power: %.1f W",
x
);
}
# Integrates instantaneous watts over time.
# Watts integrated over hours produces Wh; the filter converts Wh to kWh.
- platform: integration
name: "${entity_prefix} Energy"
id: energy
sensor: power
time_unit: h
integration_method: trapezoid
restore: false
unit_of_measurement: "kWh"
device_class: energy
state_class: total_increasing
accuracy_decimals: 3
filters:
- multiply: 0.001
# Highest power recorded during the current 168 powered-hour period.
- platform: template
name: "${entity_prefix} Maximum Power 7 Days"
id: max_power_7d_sensor
unit_of_measurement: "W"
device_class: power
state_class: measurement
accuracy_decimals: 1
update_interval: 60s
lambda: |-
return id(max_power_7d);
#:########################################################################################:#
# INTERVAL:
# Seven-day maximum power reset
# https://esphome.io/components/interval.html
#:########################################################################################:#
interval:
# Count one powered hour at a time.
# 168 hours equals seven days.
- interval: 1h
then:
- lambda: |-
id(max_power_hours_elapsed) += 1;
ESP_LOGD(
"max_power",
"Seven-day maximum power period: %u of 168 powered hours elapsed",
id(max_power_hours_elapsed)
);
if (id(max_power_hours_elapsed) >= 168) {
id(max_power_hours_elapsed) = 0;
id(max_power_7d) = 0.0f;
id(max_power_7d_sensor).publish_state(0.0f);
ESP_LOGI(
"max_power",
"Seven-day maximum power value has been reset"
);
}
#:########################################################################################:#
# SWITCH COMPONENT:
# https://esphome.io/components/switch/
#:########################################################################################:#
switch:
# 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"
retain: false
#:########################################################################################:#
# OUTPUT COMPONENT:
# https://esphome.io/components/output/
#:########################################################################################:#
output:
- platform: esp8266_pwm
id: pow_blue_led
pin:
number: GPIO15
inverted: true
#:########################################################################################:#
# LIGHT COMPONENT:
# https://esphome.io/components/light/
#:########################################################################################:#
light:
- platform: monochromatic
name: "Status LED"
id: led
output: pow_blue_led
#:########################################################################################:#
# SCRIPT COMPONENT:
# https://esphome.io/components/script.html
#:########################################################################################:#
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";
retain: false
qos: 1
- delay: 5s
Reference in New Issue View Git Blame Copy Permalink