ESPHome 2025.12.0-dev
Loading...
Searching...
No Matches
esphome::hlk_fm22x::HlkFm22xComponent Class Reference

#include <hlk_fm22x.h>

Inheritance diagram for esphome::hlk_fm22x::HlkFm22xComponent:
esphome::PollingComponent esphome::uart::UARTDevice esphome::Component

Public Member Functions

void setup () override
 
void update () override
 
void dump_config () override
 
void set_face_count_sensor (sensor::Sensor *face_count_sensor)
 
void set_status_sensor (sensor::Sensor *status_sensor)
 
void set_last_face_id_sensor (sensor::Sensor *last_face_id_sensor)
 
void set_last_face_name_text_sensor (text_sensor::TextSensor *last_face_name_text_sensor)
 
void set_enrolling_binary_sensor (binary_sensor::BinarySensor *enrolling_binary_sensor)
 
void set_version_text_sensor (text_sensor::TextSensor *version_text_sensor)
 
void add_on_face_scan_matched_callback (std::function< void(int16_t, std::string)> callback)
 
void add_on_face_scan_unmatched_callback (std::function< void()> callback)
 
void add_on_face_scan_invalid_callback (std::function< void(uint8_t)> callback)
 
void add_on_face_info_callback (std::function< void(int16_t, int16_t, int16_t, int16_t, int16_t, int16_t, int16_t, int16_t)> callback)
 
void add_on_enrollment_done_callback (std::function< void(int16_t, uint8_t)> callback)
 
void add_on_enrollment_failed_callback (std::function< void(uint8_t)> callback)
 
void enroll_face (const std::string &name, HlkFm22xFaceDirection direction)
 
void scan_face ()
 
void delete_face (int16_t face_id)
 
void delete_all_faces ()
 
void reset ()
 
- Public Member Functions inherited from esphome::PollingComponent
 PollingComponent ()
 
 PollingComponent (uint32_t update_interval)
 Initialize this polling component with the given update interval in ms.
 
virtual void set_update_interval (uint32_t update_interval)
 Manually set the update interval in ms for this polling object.
 
void call_setup () override
 
virtual uint32_t get_update_interval () const
 Get the update interval in ms of this sensor.
 
void start_poller ()
 
void stop_poller ()
 
- Public Member Functions inherited from esphome::Component
virtual void loop ()
 This method will be called repeatedly.
 
virtual float get_setup_priority () const
 priority of setup().
 
float get_actual_setup_priority () const
 
void set_setup_priority (float priority)
 
virtual float get_loop_priority () const
 priority of loop().
 
void call ()
 
virtual void on_shutdown ()
 
virtual void on_safe_shutdown ()
 
virtual bool teardown ()
 Called during teardown to allow component to gracefully finish operations.
 
virtual void on_powerdown ()
 Called after teardown is complete to power down hardware.
 
uint8_t get_component_state () const
 
void reset_to_construction_state ()
 Reset this component back to the construction state to allow setup to run again.
 
bool is_in_loop_state () const
 Check if this component has completed setup and is in the loop state.
 
bool is_idle () const
 Check if this component is idle.
 
virtual void mark_failed ()
 Mark this component as failed.
 
void mark_failed (const char *message)
 
void disable_loop ()
 Disable this component's loop.
 
void enable_loop ()
 Enable this component's loop.
 
void enable_loop_soon_any_context ()
 Thread and ISR-safe version of enable_loop() that can be called from any context.
 
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=nullptr)
 
void status_set_warning (const LogString *message)
 
void status_set_error (const char *message=nullptr)
 
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 LogString *source)
 Set where this component was loaded from for some debug messages.
 
const LogString * get_component_log_str () const
 Get the integration where this component was declared as a LogString for logging.
 
bool should_warn_of_blocking (uint32_t blocking_time)
 
- Public Member Functions inherited from esphome::uart::UARTDevice
 UARTDevice ()=default
 
 UARTDevice (UARTComponent *parent)
 
void set_uart_parent (UARTComponent *parent)
 
void write_byte (uint8_t data)
 
void set_rx_full_threshold (size_t rx_full_threshold)
 
void set_rx_full_threshold_ms (size_t time)
 
size_t get_rx_full_threshold ()
 
void set_rx_timeout (size_t rx_timeout)
 
size_t get_rx_timeout ()
 
void write_array (const uint8_t *data, size_t len)
 
void write_array (const std::vector< uint8_t > &data)
 
template<size_t N>
void write_array (const std::array< uint8_t, N > &data)
 
void write_str (const char *str)
 
bool read_byte (uint8_t *data)
 
bool peek_byte (uint8_t *data)
 
bool read_array (uint8_t *data, size_t len)
 
template<size_t N>
optional< std::array< uint8_t, N > > read_array ()
 
int available ()
 
void flush ()
 
int read ()
 
size_t write (uint8_t data)
 
int peek ()
 
void check_uart_settings (uint32_t baud_rate, uint8_t stop_bits=1, UARTParityOptions parity=UART_CONFIG_PARITY_NONE, uint8_t data_bits=8)
 Check that the configuration of the UART bus matches the provided values and otherwise print a warning.
 

Protected Member Functions

void get_face_count_ ()
 
void send_command_ (HlkFm22xCommand command, const uint8_t *data=nullptr, size_t size=0)
 
void recv_command_ ()
 
void handle_note_ (const std::vector< uint8_t > &data)
 
void handle_reply_ (const std::vector< uint8_t > &data)
 
void set_enrolling_ (bool enrolling)
 
- Protected Member Functions inherited from esphome::Component
virtual void call_loop ()
 
virtual void call_dump_config ()
 
void set_component_state_ (uint8_t state)
 Helper to set component state (clears state bits and sets new state)
 
void set_interval (const std::string &name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a unique name.
 
void set_interval (const char *name, uint32_t interval, std::function< void()> &&f)
 Set an interval function with a const char* name.
 
void set_interval (uint32_t interval, std::function< void()> &&f)
 
bool cancel_interval (const std::string &name)
 Cancel an interval function.
 
bool cancel_interval (const char *name)
 
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.
 
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.
 
void set_timeout (const std::string &name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a unique name.
 
void set_timeout (const char *name, uint32_t timeout, std::function< void()> &&f)
 Set a timeout function with a const char* name.
 
void set_timeout (uint32_t timeout, std::function< void()> &&f)
 
bool cancel_timeout (const std::string &name)
 Cancel a timeout function.
 
bool cancel_timeout (const char *name)
 
void defer (const std::string &name, std::function< void()> &&f)
 Defer a callback to the next loop() call.
 
void defer (const char *name, std::function< void()> &&f)
 Defer a callback to the next loop() call with a const char* name.
 
void defer (std::function< void()> &&f)
 Defer a callback to the next loop() call.
 
bool cancel_defer (const std::string &name)
 Cancel a defer callback using the specified name, name must not be empty.
 

Protected Attributes

HlkFm22xCommand active_command_ = HlkFm22xCommand::NONE
 
uint16_t wait_cycles_ = 0
 
sensor::Sensorface_count_sensor_ {nullptr}
 
sensor::Sensorstatus_sensor_ {nullptr}
 
sensor::Sensorlast_face_id_sensor_ {nullptr}
 
binary_sensor::BinarySensorenrolling_binary_sensor_ {nullptr}
 
text_sensor::TextSensorlast_face_name_text_sensor_ {nullptr}
 
text_sensor::TextSensorversion_text_sensor_ {nullptr}
 
CallbackManager< void(uint8_t)> face_scan_invalid_callback_
 
CallbackManager< void(int16_t, std::string)> face_scan_matched_callback_
 
CallbackManager< void()> face_scan_unmatched_callback_
 
CallbackManager< void(int16_t, int16_t, int16_t, int16_t, int16_t, int16_t, int16_t, int16_t)> face_info_callback_
 
CallbackManager< void(int16_t, uint8_t)> enrollment_done_callback_
 
CallbackManager< void(uint8_t)> enrollment_failed_callback_
 
- Protected Attributes inherited from esphome::PollingComponent
uint32_t update_interval_
 
- Protected Attributes inherited from esphome::Component
const LogString * component_source_ {nullptr}
 
uint16_t warn_if_blocking_over_ {WARN_IF_BLOCKING_OVER_MS}
 Warn if blocked for this many ms (max 65.5s)
 
uint8_t component_state_ {0x00}
 State of this component - each bit has a purpose: Bits 0-2: Component state (0x00=CONSTRUCTION, 0x01=SETUP, 0x02=LOOP, 0x03=FAILED, 0x04=LOOP_DONE) Bit 3: STATUS_LED_WARNING Bit 4: STATUS_LED_ERROR Bits 5-7: Unused - reserved for future expansion.
 
volatile bool pending_enable_loop_ {false}
 ISR-safe flag for enable_loop_soon_any_context.
 
- Protected Attributes inherited from esphome::uart::UARTDevice
UARTComponentparent_ {nullptr}
 

Detailed Description

Definition at line 71 of file hlk_fm22x.h.

Member Function Documentation

◆ add_on_enrollment_done_callback()

void esphome::hlk_fm22x::HlkFm22xComponent::add_on_enrollment_done_callback ( std::function< void(int16_t, uint8_t)> callback)
inline

Definition at line 104 of file hlk_fm22x.h.

◆ add_on_enrollment_failed_callback()

void esphome::hlk_fm22x::HlkFm22xComponent::add_on_enrollment_failed_callback ( std::function< void(uint8_t)> callback)
inline

Definition at line 107 of file hlk_fm22x.h.

◆ add_on_face_info_callback()

void esphome::hlk_fm22x::HlkFm22xComponent::add_on_face_info_callback ( std::function< void(int16_t, int16_t, int16_t, int16_t, int16_t, int16_t, int16_t, int16_t)> callback)
inline

Definition at line 100 of file hlk_fm22x.h.

◆ add_on_face_scan_invalid_callback()

void esphome::hlk_fm22x::HlkFm22xComponent::add_on_face_scan_invalid_callback ( std::function< void(uint8_t)> callback)
inline

Definition at line 97 of file hlk_fm22x.h.

◆ add_on_face_scan_matched_callback()

void esphome::hlk_fm22x::HlkFm22xComponent::add_on_face_scan_matched_callback ( std::function< void(int16_t, std::string)> callback)
inline

Definition at line 91 of file hlk_fm22x.h.

◆ add_on_face_scan_unmatched_callback()

void esphome::hlk_fm22x::HlkFm22xComponent::add_on_face_scan_unmatched_callback ( std::function< void()> callback)
inline

Definition at line 94 of file hlk_fm22x.h.

◆ delete_all_faces()

void esphome::hlk_fm22x::HlkFm22xComponent::delete_all_faces ( )

Definition at line 62 of file hlk_fm22x.cpp.

◆ delete_face()

void esphome::hlk_fm22x::HlkFm22xComponent::delete_face ( int16_t face_id)

Definition at line 56 of file hlk_fm22x.cpp.

◆ dump_config()

void esphome::hlk_fm22x::HlkFm22xComponent::dump_config ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 296 of file hlk_fm22x.cpp.

◆ enroll_face()

void esphome::hlk_fm22x::HlkFm22xComponent::enroll_face ( const std::string & name,
HlkFm22xFaceDirection direction )

Definition at line 34 of file hlk_fm22x.cpp.

◆ get_face_count_()

void esphome::hlk_fm22x::HlkFm22xComponent::get_face_count_ ( )
protected

Definition at line 67 of file hlk_fm22x.cpp.

◆ handle_note_()

void esphome::hlk_fm22x::HlkFm22xComponent::handle_note_ ( const std::vector< uint8_t > & data)
protected

Definition at line 165 of file hlk_fm22x.cpp.

◆ handle_reply_()

void esphome::hlk_fm22x::HlkFm22xComponent::handle_reply_ ( const std::vector< uint8_t > & data)
protected

Definition at line 206 of file hlk_fm22x.cpp.

◆ recv_command_()

void esphome::hlk_fm22x::HlkFm22xComponent::recv_command_ ( )
protected

Definition at line 111 of file hlk_fm22x.cpp.

◆ reset()

void esphome::hlk_fm22x::HlkFm22xComponent::reset ( )

Definition at line 72 of file hlk_fm22x.cpp.

◆ scan_face()

void esphome::hlk_fm22x::HlkFm22xComponent::scan_face ( )

Definition at line 50 of file hlk_fm22x.cpp.

◆ send_command_()

void esphome::hlk_fm22x::HlkFm22xComponent::send_command_ ( HlkFm22xCommand command,
const uint8_t * data = nullptr,
size_t size = 0 )
protected

Definition at line 80 of file hlk_fm22x.cpp.

◆ set_enrolling_()

void esphome::hlk_fm22x::HlkFm22xComponent::set_enrolling_ ( bool enrolling)
protected

Definition at line 290 of file hlk_fm22x.cpp.

◆ set_enrolling_binary_sensor()

void esphome::hlk_fm22x::HlkFm22xComponent::set_enrolling_binary_sensor ( binary_sensor::BinarySensor * enrolling_binary_sensor)
inline

Definition at line 85 of file hlk_fm22x.h.

◆ set_face_count_sensor()

void esphome::hlk_fm22x::HlkFm22xComponent::set_face_count_sensor ( sensor::Sensor * face_count_sensor)
inline

Definition at line 77 of file hlk_fm22x.h.

◆ set_last_face_id_sensor()

void esphome::hlk_fm22x::HlkFm22xComponent::set_last_face_id_sensor ( sensor::Sensor * last_face_id_sensor)
inline

Definition at line 79 of file hlk_fm22x.h.

◆ set_last_face_name_text_sensor()

void esphome::hlk_fm22x::HlkFm22xComponent::set_last_face_name_text_sensor ( text_sensor::TextSensor * last_face_name_text_sensor)
inline

Definition at line 82 of file hlk_fm22x.h.

◆ set_status_sensor()

void esphome::hlk_fm22x::HlkFm22xComponent::set_status_sensor ( sensor::Sensor * status_sensor)
inline

Definition at line 78 of file hlk_fm22x.h.

◆ set_version_text_sensor()

void esphome::hlk_fm22x::HlkFm22xComponent::set_version_text_sensor ( text_sensor::TextSensor * version_text_sensor)
inline

Definition at line 88 of file hlk_fm22x.h.

◆ setup()

void esphome::hlk_fm22x::HlkFm22xComponent::setup ( )
overridevirtual

Reimplemented from esphome::Component.

Definition at line 11 of file hlk_fm22x.cpp.

◆ update()

void esphome::hlk_fm22x::HlkFm22xComponent::update ( )
overridevirtual

Implements esphome::PollingComponent.

Definition at line 20 of file hlk_fm22x.cpp.

Field Documentation

◆ active_command_

HlkFm22xCommand esphome::hlk_fm22x::HlkFm22xComponent::active_command_ = HlkFm22xCommand::NONE
protected

Definition at line 125 of file hlk_fm22x.h.

◆ enrolling_binary_sensor_

binary_sensor::BinarySensor* esphome::hlk_fm22x::HlkFm22xComponent::enrolling_binary_sensor_ {nullptr}
protected

Definition at line 130 of file hlk_fm22x.h.

◆ enrollment_done_callback_

CallbackManager<void(int16_t, uint8_t)> esphome::hlk_fm22x::HlkFm22xComponent::enrollment_done_callback_
protected

Definition at line 137 of file hlk_fm22x.h.

◆ enrollment_failed_callback_

CallbackManager<void(uint8_t)> esphome::hlk_fm22x::HlkFm22xComponent::enrollment_failed_callback_
protected

Definition at line 138 of file hlk_fm22x.h.

◆ face_count_sensor_

sensor::Sensor* esphome::hlk_fm22x::HlkFm22xComponent::face_count_sensor_ {nullptr}
protected

Definition at line 127 of file hlk_fm22x.h.

◆ face_info_callback_

CallbackManager<void(int16_t, int16_t, int16_t, int16_t, int16_t, int16_t, int16_t, int16_t)> esphome::hlk_fm22x::HlkFm22xComponent::face_info_callback_
protected

Definition at line 136 of file hlk_fm22x.h.

◆ face_scan_invalid_callback_

CallbackManager<void(uint8_t)> esphome::hlk_fm22x::HlkFm22xComponent::face_scan_invalid_callback_
protected

Definition at line 133 of file hlk_fm22x.h.

◆ face_scan_matched_callback_

CallbackManager<void(int16_t, std::string)> esphome::hlk_fm22x::HlkFm22xComponent::face_scan_matched_callback_
protected

Definition at line 134 of file hlk_fm22x.h.

◆ face_scan_unmatched_callback_

CallbackManager<void()> esphome::hlk_fm22x::HlkFm22xComponent::face_scan_unmatched_callback_
protected

Definition at line 135 of file hlk_fm22x.h.

◆ last_face_id_sensor_

sensor::Sensor* esphome::hlk_fm22x::HlkFm22xComponent::last_face_id_sensor_ {nullptr}
protected

Definition at line 129 of file hlk_fm22x.h.

◆ last_face_name_text_sensor_

text_sensor::TextSensor* esphome::hlk_fm22x::HlkFm22xComponent::last_face_name_text_sensor_ {nullptr}
protected

Definition at line 131 of file hlk_fm22x.h.

◆ status_sensor_

sensor::Sensor* esphome::hlk_fm22x::HlkFm22xComponent::status_sensor_ {nullptr}
protected

Definition at line 128 of file hlk_fm22x.h.

◆ version_text_sensor_

text_sensor::TextSensor* esphome::hlk_fm22x::HlkFm22xComponent::version_text_sensor_ {nullptr}
protected

Definition at line 132 of file hlk_fm22x.h.

◆ wait_cycles_

uint16_t esphome::hlk_fm22x::HlkFm22xComponent::wait_cycles_ = 0
protected

Definition at line 126 of file hlk_fm22x.h.


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