ESPHome  2024.6.1
Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes
esphome::qwiic_pir::QwiicPIRComponent Class Reference

#include <qwiic_pir.h>

Inheritance diagram for esphome::qwiic_pir::QwiicPIRComponent:
esphome::Component esphome::i2c::I2CDevice esphome::binary_sensor::BinarySensor esphome::EntityBase esphome::EntityBase_DeviceClass

Public Member Functions

void setup () override
 
void loop () override
 
void dump_config () override
 
float get_setup_priority () const override
 
void set_debounce_time (uint16_t debounce_time)
 
void set_debounce_mode (DebounceMode mode)
 
- Public Member Functions inherited from esphome::Component
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
virtual float get_loop_priority () const
 priority of loop(). More...
 
void call ()
 
virtual void on_shutdown ()
 
virtual void on_safe_shutdown ()
 
uint32_t get_component_state () const
 
virtual void mark_failed ()
 Mark this component as failed. More...
 
bool is_failed () const
 
bool is_ready () const
 
virtual bool can_proceed ()
 
bool status_has_warning () const
 
bool status_has_error () const
 
void status_set_warning (const char *message="unspecified")
 
void status_set_error (const char *message="unspecified")
 
void status_clear_warning ()
 
void status_clear_error ()
 
void status_momentary_warning (const std::string &name, uint32_t length=5000)
 
void status_momentary_error (const std::string &name, uint32_t length=5000)
 
bool has_overridden_loop () const
 
void set_component_source (const char *source)
 Set where this component was loaded from for some debug messages. More...
 
const char * get_component_source () const
 Get the integration where this component was declared as a string. More...
 
- Public Member Functions inherited from esphome::i2c::I2CDevice
 I2CDevice ()=default
 we use the C++ default constructor More...
 
void set_i2c_address (uint8_t address)
 We store the address of the device on the bus. More...
 
void set_i2c_bus (I2CBus *bus)
 we store the pointer to the I2CBus to use More...
 
I2CRegister reg (uint8_t a_register)
 calls the I2CRegister constructor More...
 
I2CRegister16 reg16 (uint16_t a_register)
 calls the I2CRegister16 constructor More...
 
ErrorCode read (uint8_t *data, size_t len)
 reads an array of bytes from the device using an I2CBus More...
 
ErrorCode read_register (uint8_t a_register, uint8_t *data, size_t len, bool stop=true)
 reads an array of bytes from a specific register in the I²C device More...
 
ErrorCode read_register16 (uint16_t a_register, uint8_t *data, size_t len, bool stop=true)
 reads an array of bytes from a specific register in the I²C device More...
 
ErrorCode write (const uint8_t *data, size_t len, bool stop=true)
 writes an array of bytes to a device using an I2CBus More...
 
ErrorCode write_register (uint8_t a_register, const uint8_t *data, size_t len, bool stop=true)
 writes an array of bytes to a specific register in the I²C device More...
 
ErrorCode write_register16 (uint16_t a_register, const uint8_t *data, size_t len, bool stop=true)
 write an array of bytes to a specific register in the I²C device More...
 
bool read_bytes (uint8_t a_register, uint8_t *data, uint8_t len)
 Compat APIs All methods below have been added for compatibility reasons. More...
 
bool read_bytes_raw (uint8_t *data, uint8_t len)
 
template<size_t N>
optional< std::array< uint8_t, N > > read_bytes (uint8_t a_register)
 
template<size_t N>
optional< std::array< uint8_t, N > > read_bytes_raw ()
 
bool read_bytes_16 (uint8_t a_register, uint16_t *data, uint8_t len)
 
bool read_byte (uint8_t a_register, uint8_t *data, bool stop=true)
 
optional< uint8_t > read_byte (uint8_t a_register)
 
bool read_byte_16 (uint8_t a_register, uint16_t *data)
 
bool write_bytes (uint8_t a_register, const uint8_t *data, uint8_t len, bool stop=true)
 
bool write_bytes (uint8_t a_register, const std::vector< uint8_t > &data)
 
template<size_t N>
bool write_bytes (uint8_t a_register, const std::array< uint8_t, N > &data)
 
bool write_bytes_16 (uint8_t a_register, const uint16_t *data, uint8_t len)
 
bool write_byte (uint8_t a_register, uint8_t data, bool stop=true)
 
bool write_byte_16 (uint8_t a_register, uint16_t data)
 
- 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...
 

Protected Types

enum  ErrorCode { NONE = 0, ERROR_COMMUNICATION_FAILED, ERROR_WRONG_CHIP_ID }
 

Protected Member Functions

void clear_events_ ()
 
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
virtual void call_setup ()
 
virtual void call_dump_config ()
 
void set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a unique name. More...
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (const std::string &name)
 Cancel an interval function. More...
 
void set_retry (const std::string &name, uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
 Set an retry function with a unique name. More...
 
void set_retry (uint32_t initial_wait_time, uint8_t max_attempts, std::function< RetryResult(uint8_t)> &&f, float backoff_increase_factor=1.0f)
 
bool cancel_retry (const std::string &name)
 Cancel a retry function. More...
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name. More...
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (const std::string &name)
 Cancel a timeout function. More...
 
void defer (const std::string &name, std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call. More...
 
bool cancel_defer (const std::string &name)
 Cancel a defer callback using the specified name, name must not be empty. 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_ ()
 

Protected Attributes

uint16_t debounce_time_ {}
 
DebounceMode debounce_mode_ {}
 
enum esphome::qwiic_pir::QwiicPIRComponent::ErrorCode NONE
 
union {
   struct {
      bool   raw_reading: 1
 
      bool   event_available: 1
 
      bool   object_removed: 1
 
      bool   object_detected: 1
 
      bool   __pad0__: 4
 
   } 
 
   uint8_t   reg
 
event_register_ = {.reg = 0}
 
- Protected Attributes inherited from esphome::Component
uint32_t component_state_ {0x0000}
 State of this component. More...
 
float setup_priority_override_ {NAN}
 
const char * component_source_ {nullptr}
 
- Protected Attributes inherited from esphome::i2c::I2CDevice
uint8_t address_ {0x00}
 store the address of the device on the bus More...
 
I2CBusbus_ {nullptr}
 pointer to I2CBus instance More...
 
- 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...
 

Additional Inherited Members

- Data Fields inherited from esphome::binary_sensor::BinarySensor
bool state
 The current reported state of the binary sensor. More...
 

Detailed Description

Definition at line 33 of file qwiic_pir.h.

Member Enumeration Documentation

◆ ErrorCode

Enumerator
NONE 
ERROR_COMMUNICATION_FAILED 
ERROR_WRONG_CHIP_ID 

Definition at line 49 of file qwiic_pir.h.

Member Function Documentation

◆ clear_events_()

void esphome::qwiic_pir::QwiicPIRComponent::clear_events_ ( )
protected

Definition at line 130 of file qwiic_pir.cpp.

◆ dump_config()

void esphome::qwiic_pir::QwiicPIRComponent::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 100 of file qwiic_pir.cpp.

◆ get_setup_priority()

float esphome::qwiic_pir::QwiicPIRComponent::get_setup_priority ( ) const
inlineoverridevirtual

Reimplemented from esphome::Component.

Definition at line 39 of file qwiic_pir.h.

◆ loop()

void esphome::qwiic_pir::QwiicPIRComponent::loop ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 58 of file qwiic_pir.cpp.

◆ set_debounce_mode()

void esphome::qwiic_pir::QwiicPIRComponent::set_debounce_mode ( DebounceMode  mode)
inline

Definition at line 42 of file qwiic_pir.h.

◆ set_debounce_time()

void esphome::qwiic_pir::QwiicPIRComponent::set_debounce_time ( uint16_t  debounce_time)
inline

Definition at line 41 of file qwiic_pir.h.

◆ setup()

void esphome::qwiic_pir::QwiicPIRComponent::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 9 of file qwiic_pir.cpp.

Field Documentation

◆ __pad0__

bool esphome::qwiic_pir::QwiicPIRComponent::__pad0__

Definition at line 61 of file qwiic_pir.h.

◆ debounce_mode_

DebounceMode esphome::qwiic_pir::QwiicPIRComponent::debounce_mode_ {}
protected

Definition at line 47 of file qwiic_pir.h.

◆ debounce_time_

uint16_t esphome::qwiic_pir::QwiicPIRComponent::debounce_time_ {}
protected

Definition at line 45 of file qwiic_pir.h.

◆ event_available

bool esphome::qwiic_pir::QwiicPIRComponent::event_available

Definition at line 58 of file qwiic_pir.h.

◆ event_register_

union { ... } esphome::qwiic_pir::QwiicPIRComponent::event_register_

◆ NONE

enum esphome::qwiic_pir::QwiicPIRComponent::ErrorCode esphome::qwiic_pir::QwiicPIRComponent::NONE
protected

◆ object_detected

bool esphome::qwiic_pir::QwiicPIRComponent::object_detected

Definition at line 60 of file qwiic_pir.h.

◆ object_removed

bool esphome::qwiic_pir::QwiicPIRComponent::object_removed

Definition at line 59 of file qwiic_pir.h.

◆ raw_reading

bool esphome::qwiic_pir::QwiicPIRComponent::raw_reading

Definition at line 57 of file qwiic_pir.h.

◆ reg

uint8_t esphome::qwiic_pir::QwiicPIRComponent::reg

Definition at line 63 of file qwiic_pir.h.


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