github/esphome
2
0
Fork 0
mirror of https://github.com/esphome/esphome.git synced 2026-09-02 02:56:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

[binary_sensor] Move trigger_on_initial_state out of EntityBase flags into BinarySensor

Browse Source 
Use pure virtual get/set methods on StatefulEntityBase instead of
storing the flag in EntityBase::flags_. This keeps EntityBase clean
and avoids mixing binary_sensor-specific state into the base entity.
This commit is contained in:
J. Nick Koston
2026-03-22 16:01:39 -10:00
parent 98b0aea6bf
commit e406fb25cb
2 changed files with 12 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
esphome/components/binary_sensor/binary_sensor.h
+4 -1
View File
@@ -32,9 +32,10 @@ void log_binary_sensor(const char *tag, const char *prefix, const char *type, Bi
*/
class BinarySensor : public StatefulEntityBase<bool> {
public:
explicit BinarySensor() { this->flags_.trigger_on_initial_state = true; }
explicit BinarySensor() = default;
const bool &get_state() const override { return this->state; }
void set_trigger_on_initial_state(bool value) override { this->trigger_on_initial_state_ = value; }
/** Publish a new state to the front-end.
*
@@ -65,8 +66,10 @@ class BinarySensor : public StatefulEntityBase<bool> {
bool state{};
protected:
bool get_trigger_on_initial_state() const override { return this->trigger_on_initial_state_; }
void set_state_value_(const bool &value) override { this->state = value; }
bool trigger_on_initial_state_{true};
#ifdef USE_BINARY_SENSOR_FILTER
Filter *filter_list_{nullptr};
#endif
esphome/core/entity_base.h
+8 -7
View File
@@ -266,9 +266,8 @@ class EntityBase {
uint8_t internal : 1;
uint8_t disabled_by_default : 1;
uint8_t has_state : 1;
uint8_t entity_category : 2; // Supports up to 4 categories
uint8_t trigger_on_initial_state : 1; // Whether callbacks fire on first state (StatefulEntityBase)
uint8_t reserved : 1; // Reserved for future use
uint8_t entity_category : 2; // Supports up to 4 categories
uint8_t reserved : 2; // Reserved for future use
} flags_{};
// String table indices — packed into the 3 padding bytes after flags_
#ifdef USE_ENTITY_DEVICE_CLASS
@@ -330,11 +329,13 @@ template<typename T> class StatefulEntityBase : public EntityBase {
}
/// Control whether state_callbacks_ fire on the very first state (before any previous state exists).
void set_trigger_on_initial_state(bool trigger_on_initial_state) {
this->flags_.trigger_on_initial_state = trigger_on_initial_state;
}
/// Subclasses must implement set_trigger_on_initial_state() to store this value.
virtual void set_trigger_on_initial_state(bool value) = 0;
protected:
/// Subclasses return whether callbacks should fire on the very first state.
virtual bool get_trigger_on_initial_state() const = 0;
/** Apply a new state, de-duplicating and firing callbacks as needed.
*
* Pass nullopt to invalidate (clear) the state. Pass a value to set it.
@@ -348,7 +349,7 @@ template<typename T> class StatefulEntityBase : public EntityBase {
this->set_has_state(new_state.has_value());
if (new_state.has_value()) {
this->set_state_value_(new_state.value());
if (this->flags_.trigger_on_initial_state || had_state)
if (this->get_trigger_on_initial_state() || had_state)
this->state_callbacks_.call(new_state.value());
}
return true;