ESPHome  2024.11.1
Public Member Functions | Protected Attributes
esphome::mpr121::MPR121BinarySensor Class Reference

#include <mpr121_binary_sensor.h>

Inheritance diagram for esphome::mpr121::MPR121BinarySensor:
esphome::binary_sensor::BinarySensor esphome::mpr121::MPR121Channel esphome::Parented< MPR121Component > esphome::EntityBase esphome::EntityBase_DeviceClass

Public Member Functions

void set_channel (uint8_t channel)
 
void set_touch_threshold (uint8_t touch_threshold)
 
void set_release_threshold (uint8_t release_threshold)
 
void setup () override
 
void process (uint16_t data) override
 
- Public Member Functions inherited from esphome::binary_sensor::BinarySensor
 BinarySensor ()
 
void add_on_state_callback (std::function< void(bool)> &&callback)
 Add a callback to be notified of state changes. More...
 
void publish_state (bool state)
 Publish a new state to the front-end. More...
 
void publish_initial_state (bool state)
 Publish the initial state, this will not make the callback manager send callbacks and is meant only for the initial state on boot. More...
 
void add_filter (Filter *filter)
 
void add_filters (const std::vector< Filter *> &filters)
 
void set_publish_initial_state (bool publish_initial_state)
 
void send_state_internal (bool state, bool is_initial)
 
virtual bool has_state () const
 Return whether this binary sensor has outputted a state. More...
 
virtual bool is_status_binary_sensor () const
 
- Public Member Functions inherited from esphome::EntityBase
const StringRefget_name () const
 
void set_name (const char *name)
 
bool has_own_name () const
 
std::string get_object_id () const
 
void set_object_id (const char *object_id)
 
uint32_t get_object_id_hash ()
 
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)
 
std::string get_icon () const
 
void set_icon (const char *icon)
 
- Public Member Functions inherited from esphome::EntityBase_DeviceClass
std::string get_device_class ()
 Get the device class, using the manual override if set. More...
 
void set_device_class (const char *device_class)
 Manually set the device class. More...
 
- Public Member Functions inherited from esphome::Parented< MPR121Component >
 Parented ()
 
 Parented (MPR121Component *parent)
 
MPR121Component * get_parent () const
 Get the parent of this object. More...
 
void set_parent (MPR121Component *parent)
 Set the parent of this object. More...
 

Protected Attributes

uint8_t channel_ {0}
 
optional< uint8_t > touch_threshold_ {}
 
optional< uint8_t > release_threshold_ {}
 
- Protected Attributes inherited from esphome::binary_sensor::BinarySensor
CallbackManager< void(bool)> state_callback_ {}
 
Filterfilter_list_ {nullptr}
 
bool has_state_ {false}
 
bool publish_initial_state_ {false}
 
Deduplicator< bool > publish_dedup_
 
- Protected Attributes inherited from esphome::EntityBase
StringRef name_
 
const char * object_id_c_str_ {nullptr}
 
const char * icon_c_str_ {nullptr}
 
uint32_t object_id_hash_
 
bool has_own_name_ {false}
 
bool internal_ {false}
 
bool disabled_by_default_ {false}
 
EntityCategory entity_category_ {ENTITY_CATEGORY_NONE}
 
- Protected Attributes inherited from esphome::EntityBase_DeviceClass
const char * device_class_ {nullptr}
 Device class override. More...
 
- Protected Attributes inherited from esphome::Parented< MPR121Component >
MPR121Component * parent_
 

Additional Inherited Members

- Data Fields inherited from esphome::binary_sensor::BinarySensor
bool state
 The current reported state of the binary sensor. More...
 
- Protected Member Functions inherited from esphome::EntityBase
virtual uint32_t hash_base ()
 The hash_base() function has been deprecated. More...
 
void calc_object_id_ ()
 

Detailed Description

Definition at line 10 of file mpr121_binary_sensor.h.

Member Function Documentation

◆ process()

void esphome::mpr121::MPR121BinarySensor::process ( uint16_t  data)
overridevirtual

Implements esphome::mpr121::MPR121Channel.

Definition at line 14 of file mpr121_binary_sensor.cpp.

◆ set_channel()

void esphome::mpr121::MPR121BinarySensor::set_channel ( uint8_t  channel)
inline

Definition at line 12 of file mpr121_binary_sensor.h.

◆ set_release_threshold()

void esphome::mpr121::MPR121BinarySensor::set_release_threshold ( uint8_t  release_threshold)
inline

Definition at line 14 of file mpr121_binary_sensor.h.

◆ set_touch_threshold()

void esphome::mpr121::MPR121BinarySensor::set_touch_threshold ( uint8_t  touch_threshold)
inline

Definition at line 13 of file mpr121_binary_sensor.h.

◆ setup()

void esphome::mpr121::MPR121BinarySensor::setup ( )
overridevirtual

Implements esphome::mpr121::MPR121Channel.

Definition at line 6 of file mpr121_binary_sensor.cpp.

Field Documentation

◆ channel_

uint8_t esphome::mpr121::MPR121BinarySensor::channel_ {0}
protected

Definition at line 20 of file mpr121_binary_sensor.h.

◆ release_threshold_

optional<uint8_t> esphome::mpr121::MPR121BinarySensor::release_threshold_ {}
protected

Definition at line 22 of file mpr121_binary_sensor.h.

◆ touch_threshold_

optional<uint8_t> esphome::mpr121::MPR121BinarySensor::touch_threshold_ {}
protected

Definition at line 21 of file mpr121_binary_sensor.h.


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