ESPHome 2026.3.0-dev
Loading...
Searching...
No Matches
esphome::sy6970::StatusBinarySensor< REG, SHIFT, MASK, TRUE_VALUE > Class Template Reference

#include <sy6970_binary_sensor.h>

Inheritance diagram for esphome::sy6970::StatusBinarySensor< REG, SHIFT, MASK, TRUE_VALUE >:
esphome::sy6970::SY6970Listener esphome::binary_sensor::BinarySensor esphome::StatefulEntityBase< bool > esphome::EntityBase_DeviceClass esphome::EntityBase

Public Member Functions

void on_data (const SY6970Data &data) override
 
- Public Member Functions inherited from esphome::sy6970::SY6970Listener
- Public Member Functions inherited from esphome::binary_sensor::BinarySensor
 BinarySensor ()
 
void publish_state (bool new_state)
 Publish a new state to the front-end.
 
void publish_initial_state (bool new_state)
 Publish the initial state, this will not make the callback manager send callbacks and is meant only for the initial state on boot.
 
void add_filter (Filter *filter)
 
void add_filters (std::initializer_list< Filter * > filters)
 
void send_state_internal (bool new_state)
 
virtual bool is_status_binary_sensor () const
 Return whether this binary sensor has outputted a state.
 
- Public Member Functions inherited from esphome::StatefulEntityBase< bool >
virtual bool has_state () const
 
virtual const bool & get_state () const
 
virtual bool get_state_default (bool default_value) const
 
void invalidate_state ()
 
void add_full_state_callback (std::function< void(optional< bool > previous, optional< bool > current)> &&callback)
 
void add_on_state_callback (std::function< void(bool)> &&callback)
 
void set_trigger_on_initial_state (bool trigger_on_initial_state)
 
- Public Member Functions inherited from esphome::EntityBase
const StringRefget_name () const
 
void set_name (const char *name)
 
void set_name (const char *name, uint32_t object_id_hash)
 Set name with pre-computed object_id hash (avoids runtime hash calculation) Use hash=0 for dynamic names that need runtime calculation.
 
bool has_own_name () const
 
ESPDEPRECATED("object_id mangles names and all object_id methods are planned for removal " "(see https://github.com/esphome/backlog/issues/76). " "Now is the time to stop using object_id. If still needed, use get_object_id_to() " "which will remain available longer. get_object_id() will be removed in 2026.7.0", "2025.12.0") std uint32_t get_object_id_hash ()
 
StringRef get_object_id_to (std::span< char, OBJECT_ID_MAX_LEN > buf) const
 Get object_id with zero heap allocation For static case: returns StringRef to internal storage (buffer unused) For dynamic case: formats into buffer and returns StringRef to buffer.
 
size_t write_object_id_to (char *buf, size_t buf_size) const
 Write object_id directly to buffer, returns length written (excluding null) Useful for building compound strings without intermediate buffer.
 
bool is_internal () const
 
void set_internal (bool internal)
 
bool is_disabled_by_default () const
 
void set_disabled_by_default (bool disabled_by_default)
 
EntityCategory get_entity_category () const
 
void set_entity_category (EntityCategory entity_category)
 
ESPDEPRECATED("Use get_icon_ref() instead for better performance (avoids string copy). Will be removed in ESPHome 2026.5.0", "2025.11.0") std void set_icon (const char *icon)
 
StringRef get_icon_ref () const
 
uint32_t get_device_id () const
 
void set_device (Device *device)
 
Deviceget_device () const
 
bool has_state () const
 
void set_has_state (bool state)
 
 ESPDEPRECATED ("Use make_entity_preference<T>() instead, or preferences won't be migrated. " "See https://github.com/esphome/backlog/issues/85. Will be removed in 2027.1.0.", "2026.7.0") uint32_t get_preference_hash()
 Get a unique hash for storing preferences/settings for this entity.
 
template<typename T >
ESPPreferenceObject make_entity_preference (uint32_t version=0)
 Create a preference object for storing this entity's state/settings.
 
- Public Member Functions inherited from esphome::EntityBase_DeviceClass
ESPDEPRECATED("Use get_device_class_ref() instead for better performance (avoids string copy). Will be removed in " "ESPHome 2026.5.0", "2025.11.0") std void set_device_class (const char *device_class)
 Get the device class, using the manual override if set.
 
StringRef get_device_class_ref () const
 Get the device class as StringRef.
 

Additional Inherited Members

- Data Fields inherited from esphome::binary_sensor::BinarySensor
bool state {}
 
- Protected Member Functions inherited from esphome::binary_sensor::BinarySensor
bool set_new_state (const optional< bool > &new_state) override
 
- Protected Member Functions inherited from esphome::StatefulEntityBase< bool >
- Protected Member Functions inherited from esphome::EntityBase
ESPPreferenceObject make_entity_preference_ (size_t size, uint32_t version)
 Non-template helper for make_entity_preference() to avoid code bloat.
 
void calc_object_id_ ()
 
- Protected Attributes inherited from esphome::binary_sensor::BinarySensor
Filterfilter_list_ {nullptr}
 
- Protected Attributes inherited from esphome::StatefulEntityBase< bool >
optional< bool > state_
 
bool trigger_on_initial_state_
 
CallbackManager< void(optional< bool > previous, optional< bool > current)> * full_state_callbacks_
 
CallbackManager< void(bool)> * state_callbacks_
 
- Protected Attributes inherited from esphome::EntityBase
StringRef name_
 
const char * icon_c_str_ {nullptr}
 
uint32_t object_id_hash_ {}
 
Devicedevice_ {}
 
struct esphome::EntityBase::EntityFlags flags_
 
- Protected Attributes inherited from esphome::EntityBase_DeviceClass
const char * device_class_ {nullptr}
 Device class override.
 

Detailed Description

template<uint8_t REG, uint8_t SHIFT, uint8_t MASK, uint8_t TRUE_VALUE>
class esphome::sy6970::StatusBinarySensor< REG, SHIFT, MASK, TRUE_VALUE >

Definition at line 9 of file sy6970_binary_sensor.h.

Member Function Documentation

◆ on_data()

template<uint8_t REG, uint8_t SHIFT, uint8_t MASK, uint8_t TRUE_VALUE>
void esphome::sy6970::StatusBinarySensor< REG, SHIFT, MASK, TRUE_VALUE >::on_data ( const SY6970Data & data)
inlineoverridevirtual

Implements esphome::sy6970::SY6970Listener.

Definition at line 11 of file sy6970_binary_sensor.h.


The documentation for this class was generated from the following file: