esphome sntp offline fixes

This commit is contained in:
root
2025-06-14 16:39:38 +12:00
parent 362b8119b4
commit 5ef9d0df7d
10 changed files with 611 additions and 858 deletions

View File

@@ -1,43 +1,47 @@
##########################################################################################
##########################################################################################
# POOL PUMP POWER AND tiMEr
# 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
#
# 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.0 2025-06-05 YAML Tidyups
#
# INSTRUCTIONS
# - It allows a device to work in a standalone operation
# - On startup, it will turn on for (startup_duration) hours then go into timer mode
# - The timer has a morning and evening time (but no weekday/weekend setting)
# - 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)
# - 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 4 on/off times via MQTT (See below commands)
# - You can set 4 modes ON/OFF/TIMER/STARTUP via MQTT. That way, you can set to STARTUP for a short boost
# - 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 a reboot, the device will always turn on for the Startup Duration (STARTUP mode, default 2 hours)
# - TIMER mode will always be switched on after startup mode is complete
# - 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
# 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/STARTUP : Turn on device for (startup_duration) hours then TIMER (also on startup)
# mqtt_timer_topic/operation/BOOST : Turn on for (boost_duration) minutes then BOOST (also on startup)
#
# operation_mode:
# 0 = OFF
# 1 = ON
# 2 = TIMER
# 3 = STARTUP
# 3 = BOOST
#
##########################################################################################
##########################################################################################
@@ -50,12 +54,12 @@ substitutions:
# Device Naming
device_name: "esp-poolpumppower"
friendly_name: "Pool Pump Power"
description_comment: "Pool Pump Power, Athom Smart Plug Power Monitor"
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.
# Project Naming
project_name: "Athom Technology.Smart Plug V3" # Project Details
project_version: "v1.0.7" # Project V denotes release of yaml file, allowing checking of deployed vs latest version
project_name: "Athom Technology.Smart Plug V3" # Project Details
project_version: "v2.2" # Project V denotes release of yaml file, allowing checking of deployed vs latest version
# Passwords
api_key: !secret esp-poolpumppower_api_key # unfortunately you can't use substitutions inside secrets names
@@ -64,17 +68,17 @@ substitutions:
# 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
update_interval: "20s" # update time for for general sensors etc
# Timer Settings
# Device 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
startup_duration: "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: "1320" # Default in minutes from midnight. Default 22:00 => 1320 => 1440 is midnight
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: "1320" # Default in minutes from midnight. Default 22:00 => 1320 => 1440 is midnight
##########################################################################################
# PACKAGES
@@ -90,10 +94,6 @@ packages:
file: common/api_common.yaml
vars:
local_api_key: "${api_key}"
# common_webportal: !include
# file: common/webportal_common.yaml
common_mqtt: !include
file: common/mqtt_common.yaml
common_sntp: !include
file: common/sntp_common.yaml
common_general_sensors: !include
@@ -102,6 +102,20 @@ packages:
local_friendly_name: "${friendly_name}"
local_update_interval: "${update_interval}"
# Web and MQTT Packages
#common_webportal: !include
# file: common/webportal_common.yaml
common_mqtt: !include
file: common/mqtt_common.yaml
# Device Specific included packages
common_athompowermonV3: !include
file: common/athompowermonv3_common.yaml
vars:
local_friendly_name: "${friendly_name}"
local_current_limit: "${current_limit}"
##########################################################################################
# ESPHome
# https://esphome.io/components/esphome.html
@@ -130,11 +144,11 @@ esp32:
flash_size: 4MB
variant: ESP32C3
framework:
type: arduino
version: recommended
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
preferences:
flash_write_interval: 5min
flash_write_interval: 10min
esp32_improv:
authorizer: none
@@ -191,12 +205,18 @@ globals:
restore_value: true
initial_value: "${evening_off_default}"
# Boost Duration (minutes),
- id: boost_duration
type: int
restore_value: true
initial_value: "${boost_duration_default}"
####################################################
# operation_mode:
# 0 = OFF
# 1 = ON
# 2 = TIMER
# 3 = STARTUP
# 3 = BOOST
####################################################
- id: operation_mode
type: int
@@ -214,44 +234,16 @@ globals:
restore_value: false
initial_value: "720" # 720 is 12:00 Noon
####################################################
# startup_timer: counts minutes in STARTUP mode
# After 'startup_duration' minutes, revert to TIMER.
####################################################
# boost_timer: counts minutes in BOOST mode
# After 'boost_duration' minutes, revert to TIMER.
# Not restored, so each boot starts fresh at 0.
####################################################
- id: startup_timer
- id: boost_timer
type: int
restore_value: false
initial_value: "0"
####################################################
# total_energy: cumulative power
# Not restored, so each boot starts fresh at 0.
####################################################
- id: total_energy
type: float
restore_value: yes
initial_value: '0.0'
##########################################################################################
# UART Bus
# https://esphome.io/components/uart.html
##########################################################################################
uart:
rx_pin: GPIO20
baud_rate: 4800
data_bits: 8
stop_bits: 1
parity: EVEN
##########################################################################################
# STATUS LED
# https://esphome.io/components/status_led.html
##########################################################################################
status_led:
pin:
number: GPIO06
inverted: False
##########################################################################################
# Text Sensors
@@ -343,15 +335,36 @@ 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
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 01439
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);
}
####################################################
# Subscribe to operation mode:
# OFF, ON, TIMER, STARTUP
# OFF, ON, TIMER, BOOST
# We do case-insensitive compare using strcasecmp
# (Requires <strings.h> typically included in ESPHome)
####################################################
- platform: mqtt_subscribe
name: "Operation Mode Setting"
id: timer_operation_mode_topic
topic: "${mqtt_timer_topic}/operation" # STARTUP,ON,OFF,TIMER
topic: "${mqtt_timer_topic}/operation" # BOOST,ON,OFF,TIMER
internal: True # No need to show this in Home Assistant as there is a sensor that shows the set value
on_value:
then:
@@ -370,29 +383,29 @@ text_sensor:
} else if (strcasecmp(x.c_str(), "OFF") == 0) {
id(operation_mode) = 0;
ESP_LOGI("timer","Operation mode set to OFF");
} else if (strcasecmp(x.c_str(), "STARTUP") == 0) {
} else if (strcasecmp(x.c_str(), "BOOST") == 0) {
id(operation_mode) = 3;
id(startup_timer) = 0; // Reset the startup timer to zero
ESP_LOGI("timer","Operation mode set to STARTUP");
id(boost_timer) = 0; // Reset the BOOST timer to zero
ESP_LOGI("timer","Operation mode set to BOOST");
} else {
ESP_LOGW("timer","Invalid operation mode: %s", x.c_str());
}
######################################################
# Expose the current operation mode (OFF, ON, TIMER, STARTUP)
# Expose the current operation mode (OFF, ON, TIMER, BOOST)
######################################################
- platform: template
name: "Operation Mode State"
lambda: |-
// 0=OFF, 1=ON, 2=TIMER, 3=STARTUP
// 0=OFF, 1=ON, 2=TIMER, 3=BOOST
switch (id(operation_mode)) {
case 0: return {"OFF"};
case 1: return {"ON"};
case 2: return {"TIMER"};
case 3: return {"STARTUP"};
case 3: return {"BOOST"};
default: return {"UNKNOWN"};
}
update_interval: "5s"
update_interval: 5s
######################################################
# Expose the "Morning On" time as a text (HH:MM)
@@ -473,11 +486,11 @@ binary_sensor:
then:
- lambda: |-
if (id(relay).state) {
// Relay is ON: turn it OFF and set mode to 0 (Timer)
// Relay is ON: turn it OFF and set mode to 0 (TIMER)
id(relay).turn_off();
id(operation_mode) = 2;
} else {
// Relay is OFF: turn it ON and set mode to 3 (Startup)
// Relay is OFF: turn it ON and set mode to 3 (BOOST)
id(relay).turn_on();
id(operation_mode) = 3;
}
@@ -501,24 +514,12 @@ sensor:
lambda: |-
return id(current_mins);
- platform: template
name: "Total Energy"
id: total_energy_sensor
unit_of_measurement: kWh
device_class: "energy"
state_class: "total_increasing"
icon: mdi:lightning-bolt
accuracy_decimals: 3
lambda: |-
return id(total_energy);
update_interval: "${update_interval}"
# A value in mins if a timer is running showing how many mins left
# 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"
update_interval: 10s
update_interval: 5s
accuracy_decimals: "0"
lambda: |-
// always zero if relay is off
@@ -526,7 +527,7 @@ sensor:
return 0;
}
int rem = 0;
// only calculate for mode 2 (scheduled) or mode 3 (startup)
// only calculate for mode 2 (scheduled) or mode 3 (BOOST)
if (id(operation_mode) == 2) {
int a = id(morning_off) - id(current_mins);
int b = id(evening_off) - id(current_mins);
@@ -534,86 +535,11 @@ sensor:
rem = (a < 0) ? b : (a < b ? a : b);
}
else if (id(operation_mode) == 3) {
rem = ${startup_duration} - id(startup_timer);
rem = id(boost_duration) - id(boost_timer);
}
// never return negative
return rem > 0 ? rem : 0;
#############################################
# CSE7766 POWER SENSOR
# https://esphome.io/components/sensor/cse7766.html
#############################################
- platform: cse7766
id: athom_cse7766
current:
name: "Current"
icon: mdi:current-ac
filters:
- throttle_average: "${update_interval}"
- lambda: if (x < 0.060) return 0.0; else return x; #For the chip will report less than 3w power when no load is connected
on_value_range:
- above: "${current_limit}"
then:
- switch.turn_off: relay
voltage:
name: "Voltage"
icon: mdi:sine-wave
filters:
- throttle_average: "${update_interval}"
power:
name: "Power"
id: power_sensor
icon: mdi:power
filters:
- throttle_average: "${update_interval}"
- lambda: if (x < 3.0) return 0.0; else return x; #For the chip will report less than 3w power when no load is connected
energy:
name: "Energy"
id: energy
icon: mdi:lightning-bolt
unit_of_measurement: kWh
filters:
- throttle: "${update_interval}"
# Multiplication factor from W to kW is 0.001
- multiply: 0.001
on_value:
then:
- lambda: |-
static float previous_energy_value = 0.0;
float current_energy_value = id(energy).state;
id(total_energy) += current_energy_value - previous_energy_value;
previous_energy_value = current_energy_value;
id(total_energy_sensor).update();
apparent_power:
name: "Apparent Power"
icon: mdi:power
filters:
- throttle_average: "${update_interval}"
reactive_power:
name: "Reactive Power"
icon: mdi:flash
filters:
- throttle_average: "${update_interval}"
power_factor:
name: "Power Factor"
icon: mdi:percent-outline
filters:
- throttle_average: "${update_interval}"
#############################################
# Total Daily Energy
# https://esphome.io/components/sensor/total_daily_energy.html
#############################################
- platform: total_daily_energy
name: "Total Daily Energy"
restore: true
power_id: power_sensor
unit_of_measurement: kWh
icon: mdi:hours-24
accuracy_decimals: 3
filters:
- multiply: 0.001
#################################################################################################
# SWITCH COMPONENT
# https://esphome.io/components/switch/
@@ -633,16 +559,16 @@ switch:
#################################################################################################
button:
- platform: template
name: "Startup: ${startup_duration} Minutes"
id: startup_button
name: "Boost now"
id: boost_button
icon: "mdi:play-circle-outline" # optional, pick any MaterialDesign icon you like
on_press:
then:
# 1) set the mode to STARTUP (3)
# 1) set the mode to BOOST (3)
- lambda: |-
id(startup_timer) = 0; // Reset the startup timer to zero
id(operation_mode) = 3; // Set to STARTUP
ESP_LOGD("main", "operation_mode set to %d via STARTUP button", id(operation_mode));
id(boost_timer) = 0; // Reset the BOOST timer to zero
id(operation_mode) = 3; // Set to BOOST
ESP_LOGD("main", "operation_mode set to %d via BOOST button", id(operation_mode));
# 2) turn on the relay switch
- switch.turn_on:
id: relay
@@ -660,14 +586,14 @@ select:
- "OFF"
- "ON"
- "TIMER"
- "STARTUP"
- "BOOST"
# Getter: maps your integer into one of the four strings
lambda: |-
switch (id(operation_mode)) {
case 1: return std::string("ON");
case 2: return std::string("TIMER");
case 3: return std::string("STARTUP");
case 3: return std::string("BOOST");
default: return std::string("OFF");
}
@@ -678,61 +604,51 @@ select:
else if (x == "ON") id(operation_mode) = 1;
else if (x == "TIMER") id(operation_mode) = 2;
else {
id(startup_timer) = 0; // Reset the startup timer to zero
id(operation_mode) = 3; /* STARTUP */
id(boost_timer) = 0; // Reset the BOOST timer to zero
id(operation_mode) = 3; /* BOOST */
}
ESP_LOGD("main", "operation_mode set to %d", id(operation_mode));
#################################################################################################
# INTERVAL COMPONENT
# https://esphome.io/components/interval.html
#################################################################################################
####################################################
# Check every minute to decide relay state
####################################################
interval:
- interval: "1min" # Must be 1min as this is used to calculate times
then:
- lambda: |-
// Do we have correct time from SNTP? If not...
if (!id(time_sync).has_state()) {
// Set minutes since midnight
id(current_mins) = id(current_mins) +1 ;
// wrap around at 1440 => next day
if (id(current_mins) >= 1440) {
id(current_mins) = 0;
}
// If we do have proper SNMP time...
if (!id(sntp_time).now().is_valid()) {
id(current_mins) += 1;
if (id(current_mins) >= 1440) id(current_mins) = 0;
} else {
// Use real time from SNTP
auto now = id(sntp_time).now();
id(current_mins) = now.hour * 60 + now.minute;
}
auto now = id(sntp_time).now();
id(current_mins) = now.hour * 60 + now.minute;
}
// operation_mode:
// 0 = OFF
// 1 = ON
// 2 = TIMER
// 3 = STARTUP
// 3 = BOOST
int mode = id(operation_mode);
//////////////////////////////////////////////////
// STARTUP MODE: Relay ON for 'startup_duration'
// BOOST MODE: Relay ON for 'boost_duration'
// minutes, then automatically revert to TIMER.
//////////////////////////////////////////////////
if (mode == 3) {
id(startup_timer) = id(startup_timer) + 1 ; // works as long as update_interval in seconds
// Compare with the substitution startup_duration
if (id(startup_timer) < (int) ${startup_duration}) {
// Still within the STARTUP period => turn relay on
id(boost_timer) = id(boost_timer) + 1 ; // works as long as update_interval in seconds
// Compare with the substitution boost_duration
if (id(boost_timer) < id(boost_duration)) {
// Still within the BOOST period => turn relay on
id(relay).turn_on();
} else {
// After 'startup_duration' minutes => switch to TIMER
// After 'boost_duration' minutes => switch to TIMER
id(operation_mode) = 2;
id(mqtt_client).publish("${mqtt_timer_topic}/operation", "TIMER");
}
// Skip the rest of the logic
ESP_LOGI("startup_timer", "startup_timer=%d", id(startup_timer));
ESP_LOGI("boost_timer", "boost_timer=%d", id(boost_timer));
return;
}