Files
esphome-yambms/packages/base/device_base.yaml
T
Sleeper85 c3affb8a10 Add a Board name text sensor and show it in the HA dashboards
The board_name substitution of each board_*.yaml only reached the
telemetry POST. Home Assistant had no way to read it: the device model is
replaced by the project name, and a sub-device carries no model.

device_base.yaml declares a "Board name" diagnostic text sensor on the
board sub-device. Its value is a constant, so it is published once from
the existing on_boot at priority 600, and update_interval is never: the
API resends the stored state on every connection.

The Diagnostic card of the HA dashboards shows it in a Board row, under
Chip.

The RPi Pico board does not include device_base.yaml and has no such
sensor.
2026-11-14 16:00:27 +01:00

179 lines
6.3 KiB
YAML

# Updated : 2026.11.14
# Version : 1.3.0
# GitHub : https://github.com/Sleeper85/esphome-yambms
# YamBMS ( Yet another multi-BMS Merging Solution )
# This YAML is free software: you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation, either version 3
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
# See the GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/gpl.html>.
packages:
device_base_esphome: !include device_base_esphome.yaml
sub_device: !include device_base_sub_device.yaml
fault_registry: !include device_base_fault_registry.yaml
substitutions:
# +----------------------------------------------------------------------+
# | Rate-limit filter - NaN-safe replacement for `or: throttle + delta` |
# +----------------------------------------------------------------------+
# ESPHome's `delta` filter rejects a NaN without updating its internal
# reference, so a sensor that publishes NaN stays frozen on its previous
# value until `throttle` fires (up to 10s). YamBMS publishes NaN on purpose
# to mean "no data", so the NaN <-> value transition must count as a change,
# in both directions - including a return to the very same value.
# Defined here (rather than in yambms_core.yaml) so it is reachable from a
# node that only loads BMS/Shunt packages, without the YamBMS engine (e.g.
# a multi-node Modbus server) - every node loads a board_*.yaml, which
# always includes this file.
# Usage: declare `const float delta` (delta threshold) then expand it.
# filters:
# - lambda: |-
# const float delta = 1.0f; # delta: 1
# ${rate_limit_filter} # improved `throttle: 10s`
# Must stay capture-free: a filter lambda is compiled to a plain function
# pointer (StatelessLambdaFilter), so no id() reference is allowed here.
rate_limit_filter_ms: '10000' # 10s
rate_limit_filter: |-
static float last = NAN;
static uint32_t last_ms = 0;
const uint32_t now = millis();
if ((std::isnan(x) != std::isnan(last)) ||
(!std::isnan(x) && fabsf(x - last) >= delta) ||
((now - last_ms) >= ${rate_limit_filter_ms}))
{
last = x;
last_ms = now;
return x;
}
return {};
# The ID of the LED on your board used for this component
board_status_led_id: "esp_light"
# ID for this component instance for fault registry
board_fault_device_id: "1"
esphome:
on_boot:
- priority: 600.0
then:
- lambda: |-
// Register System
id(global_register_led)(${CAT_SYSTEM}, ${board_fault_device_id}, id(${board_status_led_id}));
// Constant, so published once: the API resends the stored state on every connection
id(esp32_board_name).publish_state("${board_name}");
time:
# https://esphome.io/components/time/homeassistant
# https://esphome.io/components/time/sntp
- platform: sntp # homeassistant
id: my_time
button:
# https://esphome.io/components/button/restart
- platform: restart
name: Restart
id: esp32_restart_button
device_id: ${board_id}
entity_category: config
# https://esphome.io/components/button/factory_reset
- platform: factory_reset
name: Factory reset
id: esp32_factory_reset_button
device_id: ${board_id}
entity_category: config
binary_sensor:
# https://esphome.io/components/binary_sensor/status
- platform: status
name: Online status
id: esp32_online_status
device_id: ${board_id}
entity_category: diagnostic
trigger_on_initial_state: true
on_state:
then:
- lambda: |-
// Pass the current state to the update function
id(global_update_fault)(${CAT_SYSTEM}, ${board_fault_device_id}, !x);
sensor:
# https://esphome.io/components/sensor/uptime
- platform: uptime
id: esp32_uptime_sec
device_id: ${board_id}
update_interval: 10s
# Drives the human-readable text sensor. Publishing from the source's own
# value makes it structurally impossible to format a state that has not
# been published yet — see Design_decisions.md.
on_value:
then:
- text_sensor.template.publish:
id: esp32_uptime
state: !lambda |-
int uptime_sec = x;
int days = uptime_sec / 86400;
int hours = (uptime_sec % 86400) / 3600;
int minutes = (uptime_sec % 3600) / 60;
int seconds = uptime_sec % 60;
return (
(days ? std::to_string(days) +"d " : "") +
(hours ? std::to_string(hours) +"h " : "") +
(minutes ? std::to_string(minutes) +"m " : "") +
(std::to_string(seconds) +"s")
);
# https://esphome.io/components/sensor/internal_temperature
- platform: internal_temperature
name: Internal temperature
id: esp32_internal_temperature
device_id: ${board_id}
update_interval: 10s
entity_category: diagnostic
text_sensor:
# Uptime Human Readable
- platform: template
name: Uptime
id: esp32_uptime
device_id: ${board_id}
update_interval: never # published by esp32_uptime_sec's on_value
icon: mdi:clock-start
entity_category: diagnostic
# Now date and time
- platform: template
id: esp32_date_time_now
device_id: ${board_id}
update_interval: 10s
icon: mdi:clock-start
entity_category: diagnostic
lambda: |-
auto t = id(my_time).now();
if (!t.is_valid()) return {};
return t.strftime("%Y-%m-%d %H:%M:%S");
# Board name, from the board_name substitution of the board_*.yaml
- platform: template
name: Board name
id: esp32_board_name
device_id: ${board_id}
update_interval: never # published once by on_boot
icon: mdi:developer-board
entity_category: diagnostic
# https://esphome.io/components/text_sensor/version
- platform: version
name: ESPHome version
id: esp32_esphome_version
device_id: ${board_id}
hide_timestamp: false #true
entity_category: diagnostic