yaml layout updates to v1.x
This commit is contained in:
+171
-235
@@ -1,92 +1,102 @@
|
||||
##########################################################################################
|
||||
##########################################################################################
|
||||
# POOL PUMP POWER AND TIMER
|
||||
# Controlled by a Athom Smart Plug V3
|
||||
#
|
||||
# dashboard_import:
|
||||
# package_import_url: github://athom-tech/esp32-configs/athom-smart-plug.yaml
|
||||
#
|
||||
#:########################################################################################:#
|
||||
# TITLE: POOL PUMP POWER AND TIMER
|
||||
# zorruno.com layout v1.1 2026
|
||||
#:########################################################################################:#
|
||||
# REPO:
|
||||
# https://home.fox.co.nz/gitea/zorruno/zorruno-homeassistant/src/branch/master/esphome/esp-poolpumppower.yaml
|
||||
#:########################################################################################:#
|
||||
# VERSIONS:
|
||||
# V2.5 2026-02-25 Updated yaml to zorruno layout V1.1
|
||||
# V2.4 2026-01-31 Added Morning/Evening Timer Enable switches (gate timer windows)
|
||||
# V2.3 2025-06-19 Minor changes to remember mode in reboot and to ensure offline functionality
|
||||
# V2.2 2025-06-14 Fixes to offline time when sntp/network unavailable
|
||||
# V2.1 2025-06-12 Added select and button to chose modes, added countdown & startup to boost
|
||||
# V2.1 2025-06-12 Added select and button to chose modes, added countdown and startup to boost
|
||||
# V2.0 2025-06-05 YAML Tidyups
|
||||
#
|
||||
# INSTRUCTIONS
|
||||
# - It allows the device to work in a standalone timer style operation
|
||||
# - The timer has a morning and evening time (but no weekday/weekend settings)
|
||||
# - Morning Timer Enable / Evening Timer Enable switches gate their timer windows (default ON and restored on reboot)
|
||||
# - Default values are set, but changed values are remembered in flash
|
||||
# - It uses SNTP for time setting (but obviously only if wifi & networking are working)
|
||||
# - It will default to an internal timer if no wifi. To reset internal timer, reboot the device at 12pm (noon)
|
||||
# - If on a network and there is a MQTT server, you can set the on/off times via MQTT (See below commands)
|
||||
# - You can set 4 modes ON/OFF/TIMER/BOOST via MQTT. Setting BOOST gives you a oneshot operation
|
||||
# - Any new timer times set via MQTT will be remembered though a reboot
|
||||
# - On startup, or a reboot, the device will always turn on for the BOOST Duration (BOOST mode, default 2 hours)
|
||||
# - TIMER mode will always be switched on after BOOST mode is complete
|
||||
# - Home Assistant entities are set so that BOOST mode can be pressed with a button and other modes selectable with a dropdown
|
||||
# - If you need it ON continuously with no MQTT, toggle power ON/OFF 4 times within 30 seconds (with ~2 secs in between to allow it to boot)
|
||||
#
|
||||
# MQTT Commands
|
||||
# Values will be set in place on the update_interval time, not immediately
|
||||
# Use 00:00 in 24hr format for time setting. (Note there is no weekday/weekend setting)
|
||||
# mqtt_timer_topic/morning-on/06:00 : Time device will go on
|
||||
# mqtt_timer_topic/morning-off/08:00 : Time device will go off
|
||||
# mqtt_timer_topic/evening-on/09:00 : Time device will go on
|
||||
# mqtt_timer_topic/evening-off/00:00 : Time device will go off
|
||||
# mqtt_timer_topic/boost-time/0000 : Time in minutes device will temporarily go on for (1-1439)
|
||||
# mqtt_timer_topic/operation/ON : Device permanently on
|
||||
# mqtt_timer_topic/operation/OFF : Device permanently off
|
||||
# mqtt_timer_topic/operation/TIMER : Device will obey timer settings
|
||||
# mqtt_timer_topic/operation/BOOST : Turn on for (boost_duration) minutes then BOOST (also on startup)
|
||||
#:########################################################################################:#
|
||||
# HARDWARE:
|
||||
# - Athom Smart Plug V3 (ESP32-C3) controlling pool pump relay + power monitoring
|
||||
# - dashboard_import: github://athom-tech/esp32-configs/athom-smart-plug.yaml
|
||||
#:########################################################################################:#
|
||||
# OPERATION NOTES:
|
||||
# - Standalone timer style operation (morning and evening windows, no weekday/weekend).
|
||||
# - Morning Timer Enable / Evening Timer Enable switches gate their timer windows (default ON).
|
||||
# - Default values are set, but changed values are remembered in flash.
|
||||
# - Uses SNTP for accurate time when WiFi/networking is available.
|
||||
# - If on a network and MQTT is available, you can set on/off times and operation mode via MQTT.
|
||||
# - Operation modes: OFF / ON / TIMER / BOOST. BOOST is a oneshot that reverts back to TIMER.
|
||||
# - On startup or reboot, the device enters BOOST for the configured BOOST duration, then returns to TIMER.
|
||||
#:########################################################################################:#
|
||||
# MQTT COMMANDS:
|
||||
# Values are applied on the update_interval, not instantly.
|
||||
# Use 00:00 in 24hr format for time settings.
|
||||
# ${mqtt_timer_topic}/morning-on payload "HH:MM"
|
||||
# ${mqtt_timer_topic}/morning-off payload "HH:MM"
|
||||
# ${mqtt_timer_topic}/evening-on payload "HH:MM"
|
||||
# ${mqtt_timer_topic}/evening-off payload "HH:MM"
|
||||
# ${mqtt_timer_topic}/boost-time payload "0".."1439" (minutes)
|
||||
# ${mqtt_timer_topic}/operation payload "ON","OFF","TIMER","BOOST"
|
||||
#
|
||||
# operation_mode:
|
||||
# 0 = OFF
|
||||
# 1 = ON
|
||||
# 2 = TIMER
|
||||
# 3 = BOOST
|
||||
#
|
||||
##########################################################################################
|
||||
##########################################################################################
|
||||
#:########################################################################################:#
|
||||
# OFFLINE NOTES:
|
||||
# a) Home Assistant OFFLINE, but Network and MQTT ONLINE
|
||||
# - Timer logic continues to run on the device.
|
||||
# - MQTT commands for schedule/mode updates still work.
|
||||
# b) MQTT OFFLINE (or HA/MQTT OFFLINE)
|
||||
# - If HA API is available, device can still be controlled from HA.
|
||||
# - Without MQTT, schedule/mode changes via MQTT will not work.
|
||||
# c) Entire WiFi/Network OFFLINE
|
||||
# - No HA API and no MQTT control available.
|
||||
# - Timer mode continues using the fallback clock.
|
||||
# - Loss of network will drift the timeclocks; time of day can be reset by powering off then on again at 12pm (midday).
|
||||
#:########################################################################################:#
|
||||
|
||||
##########################################################################################
|
||||
# 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-poolpumppower"
|
||||
friendly_name: "Pool Pump Power"
|
||||
description_comment: "Pool Pump Power :: Athom Smart Plug Power V3"
|
||||
device_area: "Outside" # Allows ESP device to be automatically linked to an 'Area' in Home Assistant.
|
||||
description_comment: "Pool Pump Power :: Athom Smart Plug Power V3 (Layout V1.1)"
|
||||
device_area: "Outside" # Allows ESP device to be automatically linked to an 'Area' in Home Assistant.
|
||||
|
||||
# Project Naming
|
||||
project_name: "Athom Technology.Smart Plug V3" # Project Details
|
||||
project_version: "v2.4" # Project V denotes release of yaml file, allowing checking of deployed vs latest version
|
||||
project_name: "Athom Technology.Smart Plug V3"
|
||||
project_version: "v2.5" # Updated yaml to zorruno layout V1.1
|
||||
|
||||
# Passwords
|
||||
api_key: !secret esp-poolpumppower_api_key # unfortunately you can't use substitutions inside secrets names
|
||||
ota_pass: !secret esp-poolpumppower_ota_pass # unfortunately you can't use substitutions inside secrets names
|
||||
static_ip_address: !secret esp-poolpumppower_ip
|
||||
|
||||
# Device Settings
|
||||
log_level: "INFO" # Define logging level: NONE, ERROR, WARN, INFO, DEBUG (Default), VERBOSE, VERY_VERBOSE
|
||||
update_interval: "20s" # update time for for general sensors etc
|
||||
# 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" # NONE, ERROR, WARN, INFO, DEBUG (Default), VERBOSE, VERY_VERBOSE
|
||||
update_interval: "20s" # update time for general sensors etc
|
||||
|
||||
# Timer Settings
|
||||
relay_icon: "mdi:pool"
|
||||
current_limit: "10" # Current Limit in Amps. AU Plug = 10. IL, BR, EU, UK, US Plug = 16.
|
||||
mqtt_timer_topic: "viewroad-commands/poolpump-timer" # Topics you will use to change stuff
|
||||
boost_duration_default: "60" # Minutes to stay ON in STARTUP mode before reverting to TIMER
|
||||
morning_on_default: "450" # Default in minutes from midnight. Default 07:30 => 450
|
||||
morning_off_default: "450" # Default in minutes from midnight. Default 07:30 => 450 (same as ON as no need for morning schedule)
|
||||
evening_on_default: "1260" # Default in minutes from midnight. Default 21:00 => 1260
|
||||
evening_off_default: "1350" # Default in minutes from midnight. Default 22:30 => 1350 => 1440 is midnight
|
||||
current_limit: "10" # Current limit in amps. AU plug = 10. IL, BR, EU, UK, US plug = 16.
|
||||
mqtt_timer_topic: "viewroad-commands/poolpump-timer"
|
||||
boost_duration_default: "60" # minutes to stay ON in BOOST mode before reverting to TIMER
|
||||
morning_on_default: "450" # 07:30 => 450
|
||||
morning_off_default: "450" # 07:30 => 450 (same as ON, no morning schedule)
|
||||
evening_on_default: "1260" # 21:00 => 1260
|
||||
evening_off_default: "1350" # 22:30 => 1350
|
||||
|
||||
##########################################################################################
|
||||
#:########################################################################################:#
|
||||
# PACKAGES: Included Common Packages
|
||||
# https://esphome.io/components/packages.html
|
||||
##########################################################################################
|
||||
#:########################################################################################:#
|
||||
packages:
|
||||
#### WIFI, Network (Static/DHCP/IPV6 etc), Fallback AP, Safemode ####
|
||||
common_wifi: !include
|
||||
@@ -95,6 +105,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
|
||||
@@ -111,6 +122,7 @@ packages:
|
||||
|
||||
#### 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
|
||||
|
||||
@@ -120,20 +132,20 @@ packages:
|
||||
diag_debug: !include common/include_debug_diag_sensors.yaml
|
||||
diag_resetcount: !include common/include_resetcount_diag_sensors.yaml
|
||||
|
||||
# Device Specific included packages
|
||||
#### Device Specific included packages ####
|
||||
common_athompowermonV3: !include
|
||||
file: common/athompowermonv3_common.yaml
|
||||
vars:
|
||||
local_current_limit: "${current_limit}"
|
||||
|
||||
##########################################################################################
|
||||
# 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
|
||||
comment: "${description_comment}" # Appears on the esphome page in HA
|
||||
area: "${device_area}"
|
||||
name_add_mac_suffix: false
|
||||
min_version: 2024.6.0
|
||||
@@ -148,17 +160,17 @@ esphome:
|
||||
then:
|
||||
- script.execute: evaluate_relay_state
|
||||
|
||||
##########################################################################################
|
||||
# ESP Platform and Framework
|
||||
# https://esphome.io/components/esp32.html
|
||||
##########################################################################################
|
||||
#:########################################################################################:#
|
||||
# ESP PLATFORM AND FRAMEWORK:
|
||||
# https://esphome.io/components/esp32/
|
||||
#:########################################################################################:#
|
||||
esp32:
|
||||
board: esp32-c3-devkitm-1
|
||||
flash_size: 4MB
|
||||
variant: ESP32C3
|
||||
framework:
|
||||
type: esp-idf # "esp-idf" OR "arduino". Suggested ESP-IDF Framework, or Plug Out the UART Cable Might Cause ESP32 Hang.
|
||||
version: recommended # recommended, latest or dev
|
||||
type: esp-idf
|
||||
version: recommended
|
||||
|
||||
preferences:
|
||||
flash_write_interval: 5min
|
||||
@@ -166,22 +178,19 @@ preferences:
|
||||
esp32_improv:
|
||||
authorizer: none
|
||||
|
||||
##########################################################################################
|
||||
# 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)
|
||||
#esp8266_store_log_strings_in_flash: false
|
||||
#tx_buffer_size: 64
|
||||
level: "${log_level}"
|
||||
baud_rate: 0
|
||||
|
||||
##########################################################################################
|
||||
# Global Variables for use in automations etc
|
||||
# https://esphome.io/guides/automations.html?highlight=globals#global-variables
|
||||
##########################################################################################
|
||||
#:########################################################################################:#
|
||||
# GLOBAL VARIABLES:
|
||||
# https://esphome.io/guides/automations.html#global-variables
|
||||
#:########################################################################################:#
|
||||
globals:
|
||||
|
||||
# Tracks the time (in seconds from midnight) at the previous boot
|
||||
- id: last_boot_time_s
|
||||
type: int
|
||||
@@ -194,31 +203,31 @@ globals:
|
||||
restore_value: true
|
||||
initial_value: "0"
|
||||
|
||||
# Morning On time (minutes from midnight),
|
||||
# Morning On time (minutes from midnight)
|
||||
- id: morning_on
|
||||
type: int
|
||||
restore_value: true
|
||||
initial_value: "${morning_on_default}"
|
||||
|
||||
# Morning Off time (minutes from midnight),
|
||||
# Morning Off time (minutes from midnight)
|
||||
- id: morning_off
|
||||
type: int
|
||||
restore_value: true
|
||||
initial_value: "${morning_off_default}"
|
||||
|
||||
# Evening On time (minutes from midnight),
|
||||
# Evening On time (minutes from midnight)
|
||||
- id: evening_on
|
||||
type: int
|
||||
restore_value: true
|
||||
initial_value: "${evening_on_default}"
|
||||
|
||||
# Evening Off time (minutes from midnight),
|
||||
# Evening Off time (minutes from midnight)
|
||||
- id: evening_off
|
||||
type: int
|
||||
restore_value: true
|
||||
initial_value: "${evening_off_default}"
|
||||
|
||||
# Boost Duration (minutes),
|
||||
# Boost Duration (minutes)
|
||||
- id: boost_duration
|
||||
type: int
|
||||
restore_value: true
|
||||
@@ -226,10 +235,10 @@ globals:
|
||||
|
||||
####################################################
|
||||
# operation_mode:
|
||||
# 0 = OFF
|
||||
# 1 = ON
|
||||
# 2 = TIMER
|
||||
# 3 = BOOST
|
||||
# 0 = OFF
|
||||
# 1 = ON
|
||||
# 2 = TIMER
|
||||
# 3 = BOOST
|
||||
####################################################
|
||||
- id: operation_mode
|
||||
type: int
|
||||
@@ -245,52 +254,41 @@ globals:
|
||||
restore_value: true
|
||||
initial_value: "0"
|
||||
|
||||
##########################################################################################
|
||||
# Text Sensors
|
||||
#:########################################################################################:#
|
||||
# TEXT SENSOR:
|
||||
# https://esphome.io/components/text_sensor/index.html
|
||||
##########################################################################################
|
||||
#:########################################################################################:#
|
||||
text_sensor:
|
||||
|
||||
############################
|
||||
# MQTT Subscriptions
|
||||
############################
|
||||
####################################################
|
||||
# Subscribe to the Morning On time, format "HH:MM"
|
||||
# We check x.size() == 5 and x[2] == ':',
|
||||
# then parse x.substr(0,2) and x.substr(3,2)
|
||||
# std::string uses 'substr', not 'substring'.
|
||||
####################################################
|
||||
############################
|
||||
# MQTT Subscriptions
|
||||
############################
|
||||
- platform: mqtt_subscribe
|
||||
name: "Morning On Time Setting"
|
||||
id: morning_on_topic
|
||||
topic: "${mqtt_timer_topic}/morning-on" # Stored in the format HH:MM
|
||||
topic: "${mqtt_timer_topic}/morning-on"
|
||||
internal: true
|
||||
on_value:
|
||||
then:
|
||||
- lambda: |-
|
||||
// Expect "HH:MM" => total length = 5, with ':'
|
||||
if (x.size() == 5 && x[2] == ':') {
|
||||
int hour = atoi(x.substr(0, 2).c_str()); // "HH"
|
||||
int minute = atoi(x.substr(3, 2).c_str()); // "MM"
|
||||
int hour = atoi(x.substr(0, 2).c_str());
|
||||
int minute = atoi(x.substr(3, 2).c_str());
|
||||
id(morning_on) = hour * 60 + minute;
|
||||
ESP_LOGI("timer","Received new Morning On: %02d:%02d", hour, minute);
|
||||
} else {
|
||||
ESP_LOGW("timer","Invalid Morning On format: %s", x.c_str());
|
||||
}
|
||||
|
||||
####################################################
|
||||
# Morning Off time => "HH:MM"
|
||||
####################################################
|
||||
- platform: mqtt_subscribe
|
||||
name: "Morning Off Time Setting"
|
||||
id: morning_off_topic
|
||||
topic: "${mqtt_timer_topic}/morning-off" # Stored in the format HH:MM
|
||||
internal: true # No need to show this in Home Assistant as there is a sensor that shows the set value
|
||||
topic: "${mqtt_timer_topic}/morning-off"
|
||||
internal: true
|
||||
on_value:
|
||||
then:
|
||||
- lambda: |-
|
||||
if (x.size() == 5 && x[2] == ':') {
|
||||
int hour = atoi(x.substr(0, 2).c_str());
|
||||
int hour = atoi(x.substr(0, 2).c_str());
|
||||
int minute = atoi(x.substr(3, 2).c_str());
|
||||
id(morning_off) = hour * 60 + minute;
|
||||
ESP_LOGI("timer","Received new Morning Off: %02d:%02d", hour, minute);
|
||||
@@ -298,19 +296,16 @@ text_sensor:
|
||||
ESP_LOGW("timer","Invalid Morning Off format: %s", x.c_str());
|
||||
}
|
||||
|
||||
####################################################
|
||||
# Evening On time => "HH:MM"
|
||||
####################################################
|
||||
- platform: mqtt_subscribe
|
||||
name: "Evening On Time Setting"
|
||||
id: evening_on_topic
|
||||
topic: "${mqtt_timer_topic}/evening-on" # Stored in the format HH:MM
|
||||
internal: true # No need to show this in Home Assistant as there is a sensor that shows the set value
|
||||
topic: "${mqtt_timer_topic}/evening-on"
|
||||
internal: true
|
||||
on_value:
|
||||
then:
|
||||
- lambda: |-
|
||||
if (x.size() == 5 && x[2] == ':') {
|
||||
int hour = atoi(x.substr(0, 2).c_str());
|
||||
int hour = atoi(x.substr(0, 2).c_str());
|
||||
int minute = atoi(x.substr(3, 2).c_str());
|
||||
id(evening_on) = hour * 60 + minute;
|
||||
ESP_LOGI("timer","Received new Evening On: %02d:%02d", hour, minute);
|
||||
@@ -318,19 +313,16 @@ text_sensor:
|
||||
ESP_LOGW("timer","Invalid Evening On format: %s", x.c_str());
|
||||
}
|
||||
|
||||
####################################################
|
||||
# Evening Off time => "HH:MM"
|
||||
####################################################
|
||||
- platform: mqtt_subscribe
|
||||
name: "Evening Off Time Setting"
|
||||
id: evening_off_topic
|
||||
topic: "${mqtt_timer_topic}/evening-off" # Stored in the format HH:MM
|
||||
internal: true # No need to show this in Home Assistant as there is a sensor that shows the set value
|
||||
topic: "${mqtt_timer_topic}/evening-off"
|
||||
internal: true
|
||||
on_value:
|
||||
then:
|
||||
- lambda: |-
|
||||
if (x.size() == 5 && x[2] == ':') {
|
||||
int hour = atoi(x.substr(0, 2).c_str());
|
||||
int hour = atoi(x.substr(0, 2).c_str());
|
||||
int minute = atoi(x.substr(3, 2).c_str());
|
||||
id(evening_off) = hour * 60 + minute;
|
||||
ESP_LOGI("timer","Received new Evening Off: %02d:%02d", hour, minute);
|
||||
@@ -338,37 +330,26 @@ text_sensor:
|
||||
ESP_LOGW("timer","Invalid Evening Off format: %s", x.c_str());
|
||||
}
|
||||
|
||||
####################################################
|
||||
# Boost duration => 1 - 1439
|
||||
####################################################
|
||||
- platform: mqtt_subscribe
|
||||
name: "Boost Duration"
|
||||
id: boost_time_topic
|
||||
topic: "${mqtt_timer_topic}/boost-time" # Stored as an integer from 1-1439
|
||||
internal: true # No need to show this in Home Assistant as there is a sensor that shows the set value
|
||||
topic: "${mqtt_timer_topic}/boost-time"
|
||||
internal: true
|
||||
on_value:
|
||||
then:
|
||||
- lambda: |-
|
||||
// parse as integer
|
||||
char *endptr;
|
||||
long v = strtol(x.c_str(), &endptr, 10);
|
||||
|
||||
// invalid if nothing parsed, trailing chars, or out of 0-1439
|
||||
if (endptr == x.c_str() || *endptr != '\0' || v < 0 || v > 1439) {
|
||||
ESP_LOGE("boost_time", "Invalid boost_time '%s'", x.c_str());
|
||||
} else {
|
||||
id(boost_duration) = static_cast<int>(v);
|
||||
id(boost_duration) = (int) v;
|
||||
}
|
||||
|
||||
####################################################
|
||||
# Subscribe to operation mode:
|
||||
# OFF, ON, TIMER, BOOST
|
||||
# We do case-insensitive compare using strcasecmp
|
||||
####################################################
|
||||
- platform: mqtt_subscribe
|
||||
id: timer_operation_mode_topic
|
||||
topic: "${mqtt_timer_topic}/operation"
|
||||
internal: true # No need to show this in Home Assistant as there is a sensor that shows the set value
|
||||
internal: true
|
||||
on_value:
|
||||
then:
|
||||
- lambda: |-
|
||||
@@ -390,13 +371,9 @@ text_sensor:
|
||||
}
|
||||
- script.execute: evaluate_relay_state
|
||||
|
||||
######################################################
|
||||
# Expose the current operation mode (OFF, ON, TIMER, BOOST)
|
||||
######################################################
|
||||
- platform: template
|
||||
name: "Operation Mode State"
|
||||
lambda: |-
|
||||
// 0=OFF, 1=ON, 2=TIMER, 3=BOOST
|
||||
switch (id(operation_mode)) {
|
||||
case 0: return {"OFF"};
|
||||
case 1: return {"ON"};
|
||||
@@ -406,9 +383,6 @@ text_sensor:
|
||||
}
|
||||
update_interval: 5s
|
||||
|
||||
######################################################
|
||||
# Expose the "Morning On" time as a text (HH:MM)
|
||||
######################################################
|
||||
- platform: template
|
||||
name: "Timeclock: Morning On Time"
|
||||
lambda: |-
|
||||
@@ -419,9 +393,6 @@ text_sensor:
|
||||
return { std::string(buff) };
|
||||
update_interval: "${update_interval}"
|
||||
|
||||
######################################################
|
||||
# Expose the "Morning Off" time as a text (HH:MM)
|
||||
######################################################
|
||||
- platform: template
|
||||
name: "Timeclock: Morning Off Time"
|
||||
lambda: |-
|
||||
@@ -432,9 +403,6 @@ text_sensor:
|
||||
return { std::string(buff) };
|
||||
update_interval: "${update_interval}"
|
||||
|
||||
######################################################
|
||||
# Expose the "Evening On" time as a text (HH:MM)
|
||||
######################################################
|
||||
- platform: template
|
||||
name: "Timeclock: Evening On Time"
|
||||
lambda: |-
|
||||
@@ -445,9 +413,6 @@ text_sensor:
|
||||
return { std::string(buff) };
|
||||
update_interval: "${update_interval}"
|
||||
|
||||
######################################################
|
||||
# Expose the "Evening Off" time as a text (HH:MM)
|
||||
######################################################
|
||||
- platform: template
|
||||
name: "Timeclock: Evening Off Time"
|
||||
lambda: |-
|
||||
@@ -458,10 +423,10 @@ text_sensor:
|
||||
return { std::string(buff) };
|
||||
update_interval: "${update_interval}"
|
||||
|
||||
##########################################################################################
|
||||
# BINARY SENSORS
|
||||
#:########################################################################################:#
|
||||
# BINARY SENSORS:
|
||||
# https://esphome.io/components/binary_sensor/
|
||||
##########################################################################################
|
||||
#:########################################################################################:#
|
||||
binary_sensor:
|
||||
- platform: gpio
|
||||
pin:
|
||||
@@ -478,11 +443,9 @@ binary_sensor:
|
||||
then:
|
||||
- lambda: |-
|
||||
if (id(relay).state) {
|
||||
// Relay is ON: turn it OFF and set mode to 2 (TIMER)
|
||||
id(relay).turn_off();
|
||||
id(operation_mode) = 2;
|
||||
} else {
|
||||
// Relay is OFF: turn it ON and set mode to 3 (BOOST)
|
||||
id(relay).turn_on();
|
||||
id(operation_mode) = 3;
|
||||
}
|
||||
@@ -492,16 +455,16 @@ binary_sensor:
|
||||
lambda: |-
|
||||
return id(relay).state;
|
||||
|
||||
##########################################################################################
|
||||
# Sensors
|
||||
# https://esphome.io/components/text_sensor/index.html
|
||||
##########################################################################################
|
||||
#:########################################################################################:#
|
||||
# SENSORS:
|
||||
# https://esphome.io/components/sensor/
|
||||
#:########################################################################################:#
|
||||
sensor:
|
||||
- platform: template
|
||||
name: "Timeclock: Boost Duration"
|
||||
id: boost_duration_time
|
||||
unit_of_measurement: "mins"
|
||||
accuracy_decimals: "0"
|
||||
accuracy_decimals: 0
|
||||
update_interval: "${update_interval}"
|
||||
lambda: |-
|
||||
return id(boost_duration);
|
||||
@@ -510,30 +473,24 @@ sensor:
|
||||
name: "Mins from Midnight"
|
||||
id: mins_from_midnight
|
||||
unit_of_measurement: "mins"
|
||||
accuracy_decimals: "0"
|
||||
accuracy_decimals: 0
|
||||
update_interval: "${update_interval}"
|
||||
internal: true # No need to show this in Home Assistant
|
||||
internal: true
|
||||
lambda: |-
|
||||
return id(current_mins);
|
||||
|
||||
# A value in mins if a timer is running showing how many mins left
|
||||
- platform: template
|
||||
name: "Timer Minutes Remaining"
|
||||
id: timer_minutes_remaining
|
||||
unit_of_measurement: "Mins"
|
||||
unit_of_measurement: "mins"
|
||||
update_interval: 5s
|
||||
accuracy_decimals: "0"
|
||||
accuracy_decimals: 0
|
||||
lambda: |-
|
||||
// always zero if relay is off
|
||||
if (!id(relay).state) {
|
||||
return 0;
|
||||
}
|
||||
if (!id(relay).state) return 0;
|
||||
|
||||
int rem = 0;
|
||||
|
||||
// only calculate for mode 2 (scheduled) or mode 3 (BOOST)
|
||||
if (id(operation_mode) == 2) {
|
||||
// Only report remaining time for the currently-active enabled window
|
||||
if (id(morning_timer_enable).state &&
|
||||
id(current_mins) >= id(morning_on) && id(current_mins) < id(morning_off)) {
|
||||
rem = id(morning_off) - id(current_mins);
|
||||
@@ -547,26 +504,21 @@ sensor:
|
||||
rem = id(boost_duration) - id(boost_timer);
|
||||
}
|
||||
|
||||
// never return negative
|
||||
return rem > 0 ? rem : 0;
|
||||
|
||||
#################################################################################################
|
||||
# SWITCH COMPONENT
|
||||
#:########################################################################################:#
|
||||
# SWITCH COMPONENT:
|
||||
# https://esphome.io/components/switch/
|
||||
#################################################################################################
|
||||
#:########################################################################################:#
|
||||
switch:
|
||||
- platform: gpio
|
||||
name: "Power Output"
|
||||
pin: GPIO5
|
||||
id: relay
|
||||
restore_mode: RESTORE_DEFAULT_OFF # Ensures the relay is restored (or off) at boot
|
||||
#internal: true # Hides the switch from Home Assistant
|
||||
restore_mode: RESTORE_DEFAULT_OFF
|
||||
icon: "${relay_icon}"
|
||||
|
||||
#################################################################################################
|
||||
# TIMER ENABLE SWITCHES (gate the schedule windows)
|
||||
# These default ON, and restore as ON at reboot (unless changed).
|
||||
#################################################################################################
|
||||
# Timer Enable Switches (gate schedule windows)
|
||||
- platform: template
|
||||
name: "Morning Timer Enable"
|
||||
id: morning_timer_enable
|
||||
@@ -591,21 +543,19 @@ switch:
|
||||
on_turn_off:
|
||||
- script.execute: evaluate_relay_state
|
||||
|
||||
#################################################################################################
|
||||
# BUTTON COMPONENT
|
||||
#:########################################################################################:#
|
||||
# BUTTON COMPONENT:
|
||||
# https://esphome.io/components/button/index.html
|
||||
#################################################################################################
|
||||
#:########################################################################################:#
|
||||
button:
|
||||
- platform: template
|
||||
name: "Boost now"
|
||||
id: boost_button
|
||||
icon: "mdi:play-circle-outline"
|
||||
on_press:
|
||||
# 1) reset BOOST timer and set mode
|
||||
- lambda: |-
|
||||
id(boost_timer) = 0;
|
||||
id(operation_mode) = 3;
|
||||
# 2) immediately re-evaluate relay state
|
||||
- script.execute: evaluate_relay_state
|
||||
|
||||
- platform: template
|
||||
@@ -614,23 +564,23 @@ button:
|
||||
icon: "mdi:restore"
|
||||
on_press:
|
||||
- lambda: |-
|
||||
// Restore all timing globals to their YAML defaults
|
||||
id(morning_on) = ${morning_on_default};
|
||||
id(morning_off) = ${morning_off_default};
|
||||
id(evening_on) = ${evening_on_default};
|
||||
id(evening_off) = ${evening_off_default};
|
||||
id(boost_duration) = ${boost_duration_default};
|
||||
|
||||
// Reset mode to TIMER and clear any running boost
|
||||
id(operation_mode) = 2;
|
||||
id(boost_timer) = 0;
|
||||
ESP_LOGI("timer","Default timer settings applied");
|
||||
- switch.turn_on: morning_timer_enable
|
||||
- switch.turn_on: evening_timer_enable
|
||||
- script.execute: evaluate_relay_state
|
||||
|
||||
#################################################################################################
|
||||
# SELECT COMPONENT
|
||||
#:########################################################################################:#
|
||||
# SELECT COMPONENT:
|
||||
# https://esphome.io/components/select/index.html
|
||||
#################################################################################################
|
||||
#:########################################################################################:#
|
||||
select:
|
||||
- platform: template
|
||||
name: "Operation Mode"
|
||||
@@ -641,8 +591,6 @@ select:
|
||||
- "ON"
|
||||
- "TIMER"
|
||||
- "BOOST"
|
||||
|
||||
# show the current mode
|
||||
lambda: |-
|
||||
switch (id(operation_mode)) {
|
||||
case 1: return std::string("ON");
|
||||
@@ -650,80 +598,69 @@ select:
|
||||
case 3: return std::string("BOOST");
|
||||
default: return std::string("OFF");
|
||||
}
|
||||
|
||||
# when changed in HA, set mode & re-evaluate
|
||||
set_action:
|
||||
- lambda: |-
|
||||
if (x == "OFF") { id(operation_mode) = 0; }
|
||||
else if (x == "ON") { id(operation_mode) = 1; }
|
||||
else if (x == "TIMER") { id(operation_mode) = 2; }
|
||||
else { // BOOST
|
||||
else {
|
||||
id(boost_timer) = 0;
|
||||
id(operation_mode) = 3;
|
||||
}
|
||||
- script.execute: evaluate_relay_state
|
||||
|
||||
#################################################################################################
|
||||
# SCRIPT COMPONENT
|
||||
#:########################################################################################:#
|
||||
# SCRIPT COMPONENT:
|
||||
# https://esphome.io/components/script.html
|
||||
#################################################################################################
|
||||
# Script: evaluate and drive the relay
|
||||
#:########################################################################################:#
|
||||
script:
|
||||
- id: evaluate_relay_state
|
||||
then:
|
||||
- lambda: |-
|
||||
int mode = id(operation_mode);
|
||||
|
||||
// BOOST just forces the relay on
|
||||
if (mode == 3) {
|
||||
id(relay).turn_on();
|
||||
return;
|
||||
}
|
||||
|
||||
// OFF -> always off
|
||||
if (mode == 0) {
|
||||
id(relay).turn_off();
|
||||
return;
|
||||
}
|
||||
|
||||
// ON -> always on
|
||||
if (mode == 1) {
|
||||
id(relay).turn_on();
|
||||
return;
|
||||
}
|
||||
|
||||
// TIMER -> follow schedule windows (gated by enable switches)
|
||||
{
|
||||
bool should_on = false;
|
||||
bool should_on = false;
|
||||
|
||||
// Morning window only applies if Morning Timer Enable is ON
|
||||
if (id(morning_timer_enable).state) {
|
||||
if (id(current_mins) >= id(morning_on) && id(current_mins) < id(morning_off)) {
|
||||
should_on = true;
|
||||
}
|
||||
if (id(morning_timer_enable).state) {
|
||||
if (id(current_mins) >= id(morning_on) && id(current_mins) < id(morning_off)) {
|
||||
should_on = true;
|
||||
}
|
||||
|
||||
// Evening window only applies if Evening Timer Enable is ON
|
||||
if (id(evening_timer_enable).state) {
|
||||
if (id(current_mins) >= id(evening_on) && id(current_mins) < id(evening_off)) {
|
||||
should_on = true;
|
||||
}
|
||||
}
|
||||
|
||||
if (should_on) id(relay).turn_on();
|
||||
else id(relay).turn_off();
|
||||
}
|
||||
|
||||
#################################################################################################
|
||||
# INTERVAL COMPONENT
|
||||
if (id(evening_timer_enable).state) {
|
||||
if (id(current_mins) >= id(evening_on) && id(current_mins) < id(evening_off)) {
|
||||
should_on = true;
|
||||
}
|
||||
}
|
||||
|
||||
if (should_on) id(relay).turn_on();
|
||||
else id(relay).turn_off();
|
||||
|
||||
#:########################################################################################:#
|
||||
# INTERVAL COMPONENT:
|
||||
# https://esphome.io/components/interval.html
|
||||
#################################################################################################
|
||||
# Interval: bumps time (even if no SNTP), then calls the script to evaluate relay state
|
||||
#:########################################################################################:#
|
||||
interval:
|
||||
- interval: "1min"
|
||||
then:
|
||||
- lambda: |-
|
||||
// - update current_mins via SNTP or fallback
|
||||
// update current_mins via SNTP or fallback
|
||||
if (!id(sntp_time).now().is_valid()) {
|
||||
id(current_mins)++;
|
||||
if (id(current_mins) >= 1440) id(current_mins) = 0;
|
||||
@@ -732,12 +669,11 @@ interval:
|
||||
id(current_mins) = now.hour * 60 + now.minute;
|
||||
}
|
||||
|
||||
// - if in BOOST, advance boost_timer and expire when done
|
||||
// BOOST timer handling
|
||||
if (id(operation_mode) == 3) {
|
||||
id(boost_timer)++;
|
||||
if (id(boost_timer) >= id(boost_duration)) {
|
||||
id(operation_mode) = 2;
|
||||
//id(mqtt_client).publish("${mqtt_timer_topic}/operation", "TIMER");
|
||||
}
|
||||
}
|
||||
- script.execute: evaluate_relay_state
|
||||
- script.execute: evaluate_relay_state
|
||||
Reference in New Issue
Block a user