ESPHome 2025.8.0b2
|
#include <fingerprint_grow.h>
Public Member Functions | |
void | update () override |
void | setup () override |
void | dump_config () override |
void | set_address (uint32_t address) |
void | set_sensing_pin (GPIOPin *sensing_pin) |
void | set_sensor_power_pin (GPIOPin *sensor_power_pin) |
void | set_password (uint32_t password) |
void | set_new_password (uint32_t new_password) |
void | set_idle_period_to_sleep_ms (uint32_t period_ms) |
void | set_fingerprint_count_sensor (sensor::Sensor *fingerprint_count_sensor) |
void | set_status_sensor (sensor::Sensor *status_sensor) |
void | set_capacity_sensor (sensor::Sensor *capacity_sensor) |
void | set_security_level_sensor (sensor::Sensor *security_level_sensor) |
void | set_last_finger_id_sensor (sensor::Sensor *last_finger_id_sensor) |
void | set_last_confidence_sensor (sensor::Sensor *last_confidence_sensor) |
void | set_enrolling_binary_sensor (binary_sensor::BinarySensor *enrolling_binary_sensor) |
void | add_on_finger_scan_start_callback (std::function< void()> callback) |
void | add_on_finger_scan_matched_callback (std::function< void(uint16_t, uint16_t)> callback) |
void | add_on_finger_scan_unmatched_callback (std::function< void()> callback) |
void | add_on_finger_scan_misplaced_callback (std::function< void()> callback) |
void | add_on_finger_scan_invalid_callback (std::function< void()> callback) |
void | add_on_enrollment_scan_callback (std::function< void(uint8_t, uint16_t)> callback) |
void | add_on_enrollment_done_callback (std::function< void(uint16_t)> callback) |
void | add_on_enrollment_failed_callback (std::function< void(uint16_t)> callback) |
void | enroll_fingerprint (uint16_t finger_id, uint8_t num_buffers) |
void | finish_enrollment (uint8_t result) |
void | delete_fingerprint (uint16_t finger_id) |
void | delete_all_fingerprints () |
void | led_control (bool state) |
void | aura_led_control (uint8_t state, uint8_t speed, uint8_t color, uint8_t count) |
![]() | |
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 () |
![]() | |
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. | |
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_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 char *source) |
Set where this component was loaded from for some debug messages. | |
const char * | get_component_source () const |
Get the integration where this component was declared as a string. | |
bool | should_warn_of_blocking (uint32_t blocking_time) |
![]() | |
UARTDevice ()=default | |
UARTDevice (UARTComponent *parent) | |
void | set_uart_parent (UARTComponent *parent) |
void | write_byte (uint8_t data) |
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 | scan_and_match_ () |
uint8_t | scan_image_ (uint8_t buffer) |
uint8_t | save_fingerprint_ () |
bool | check_password_ () |
bool | set_password_ () |
bool | get_parameters_ () |
void | get_fingerprint_count_ () |
uint8_t | transfer_ (std::vector< uint8_t > *p_data_buffer) |
uint8_t | send_command_ () |
void | sensor_wakeup_ () |
void | sensor_sleep_ () |
![]() | |
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 | |
std::vector< uint8_t > | data_ = {} |
uint8_t | address_ [4] = {0xFF, 0xFF, 0xFF, 0xFF} |
uint16_t | capacity_ = 64 |
uint32_t | password_ = 0x0 |
uint32_t | new_password_ = -1 |
GPIOPin * | sensing_pin_ {nullptr} |
GPIOPin * | sensor_power_pin_ {nullptr} |
uint8_t | enrollment_image_ = 0 |
uint16_t | enrollment_slot_ = ENROLLMENT_SLOT_UNUSED |
uint8_t | enrollment_buffers_ = 5 |
bool | waiting_removal_ = false |
bool | has_sensing_pin_ = false |
bool | has_power_pin_ = false |
bool | is_sensor_awake_ = false |
uint32_t | last_transfer_ms_ = 0 |
uint32_t | last_aura_led_control_ = 0 |
uint16_t | last_aura_led_duration_ = 0 |
uint16_t | system_identifier_code_ = 0 |
uint32_t | idle_period_to_sleep_ms_ = UINT32_MAX |
sensor::Sensor * | fingerprint_count_sensor_ {nullptr} |
sensor::Sensor * | status_sensor_ {nullptr} |
sensor::Sensor * | capacity_sensor_ {nullptr} |
sensor::Sensor * | security_level_sensor_ {nullptr} |
sensor::Sensor * | last_finger_id_sensor_ {nullptr} |
sensor::Sensor * | last_confidence_sensor_ {nullptr} |
binary_sensor::BinarySensor * | enrolling_binary_sensor_ {nullptr} |
CallbackManager< void()> | finger_scan_invalid_callback_ |
CallbackManager< void()> | finger_scan_start_callback_ |
CallbackManager< void(uint16_t, uint16_t)> | finger_scan_matched_callback_ |
CallbackManager< void()> | finger_scan_unmatched_callback_ |
CallbackManager< void()> | finger_scan_misplaced_callback_ |
CallbackManager< void(uint8_t, uint16_t)> | enrollment_scan_callback_ |
CallbackManager< void(uint16_t)> | enrollment_done_callback_ |
CallbackManager< void(uint16_t)> | enrollment_failed_callback_ |
![]() | |
uint32_t | update_interval_ |
![]() | |
const char * | 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. | |
![]() | |
UARTComponent * | parent_ {nullptr} |
Definition at line 95 of file fingerprint_grow.h.
|
inline |
Definition at line 147 of file fingerprint_grow.h.
|
inline |
Definition at line 151 of file fingerprint_grow.h.
|
inline |
Definition at line 144 of file fingerprint_grow.h.
|
inline |
Definition at line 141 of file fingerprint_grow.h.
|
inline |
Definition at line 132 of file fingerprint_grow.h.
|
inline |
Definition at line 138 of file fingerprint_grow.h.
|
inline |
Definition at line 129 of file fingerprint_grow.h.
|
inline |
Definition at line 135 of file fingerprint_grow.h.
void esphome::fingerprint_grow::FingerprintGrowComponent::aura_led_control | ( | uint8_t | state, |
uint8_t | speed, | ||
uint8_t | color, | ||
uint8_t | count ) |
Definition at line 340 of file fingerprint_grow.cpp.
|
protected |
Definition at line 229 of file fingerprint_grow.cpp.
void esphome::fingerprint_grow::FingerprintGrowComponent::delete_all_fingerprints | ( | ) |
Definition at line 306 of file fingerprint_grow.cpp.
void esphome::fingerprint_grow::FingerprintGrowComponent::delete_fingerprint | ( | uint16_t | finger_id | ) |
Definition at line 292 of file fingerprint_grow.cpp.
|
overridevirtual |
Reimplemented from esphome::Component.
Definition at line 534 of file fingerprint_grow.cpp.
void esphome::fingerprint_grow::FingerprintGrowComponent::enroll_fingerprint | ( | uint16_t | finger_id, |
uint8_t | num_buffers ) |
Definition at line 94 of file fingerprint_grow.cpp.
void esphome::fingerprint_grow::FingerprintGrowComponent::finish_enrollment | ( | uint8_t | result | ) |
Definition at line 104 of file fingerprint_grow.cpp.
|
protected |
Definition at line 282 of file fingerprint_grow.cpp.
|
protected |
Definition at line 257 of file fingerprint_grow.cpp.
void esphome::fingerprint_grow::FingerprintGrowComponent::led_control | ( | bool | state | ) |
Definition at line 320 of file fingerprint_grow.cpp.
|
protected |
Definition at line 201 of file fingerprint_grow.cpp.
|
protected |
Definition at line 121 of file fingerprint_grow.cpp.
|
protected |
Definition at line 152 of file fingerprint_grow.cpp.
|
protected |
Definition at line 471 of file fingerprint_grow.cpp.
|
protected |
Definition at line 524 of file fingerprint_grow.cpp.
|
protected |
Definition at line 476 of file fingerprint_grow.cpp.
|
inline |
Definition at line 101 of file fingerprint_grow.h.
|
inline |
Definition at line 116 of file fingerprint_grow.h.
|
inline |
Definition at line 126 of file fingerprint_grow.h.
|
inline |
Definition at line 112 of file fingerprint_grow.h.
|
inline |
Definition at line 111 of file fingerprint_grow.h.
|
inline |
Definition at line 123 of file fingerprint_grow.h.
|
inline |
Definition at line 120 of file fingerprint_grow.h.
|
inline |
Definition at line 110 of file fingerprint_grow.h.
|
inline |
Definition at line 109 of file fingerprint_grow.h.
|
protected |
Definition at line 244 of file fingerprint_grow.cpp.
|
inline |
Definition at line 117 of file fingerprint_grow.h.
|
inline |
Definition at line 107 of file fingerprint_grow.h.
|
inline |
Definition at line 108 of file fingerprint_grow.h.
|
inline |
Definition at line 115 of file fingerprint_grow.h.
|
overridevirtual |
Reimplemented from esphome::Component.
Definition at line 59 of file fingerprint_grow.cpp.
|
protected |
Definition at line 363 of file fingerprint_grow.cpp.
|
overridevirtual |
Implements esphome::PollingComponent.
Definition at line 12 of file fingerprint_grow.cpp.
|
protected |
Definition at line 177 of file fingerprint_grow.h.
|
protected |
Definition at line 178 of file fingerprint_grow.h.
|
protected |
Definition at line 197 of file fingerprint_grow.h.
|
protected |
Definition at line 176 of file fingerprint_grow.h.
|
protected |
Definition at line 201 of file fingerprint_grow.h.
|
protected |
Definition at line 185 of file fingerprint_grow.h.
|
protected |
Definition at line 208 of file fingerprint_grow.h.
|
protected |
Definition at line 209 of file fingerprint_grow.h.
|
protected |
Definition at line 183 of file fingerprint_grow.h.
|
protected |
Definition at line 207 of file fingerprint_grow.h.
|
protected |
Definition at line 184 of file fingerprint_grow.h.
|
protected |
Definition at line 202 of file fingerprint_grow.h.
|
protected |
Definition at line 204 of file fingerprint_grow.h.
|
protected |
Definition at line 206 of file fingerprint_grow.h.
|
protected |
Definition at line 203 of file fingerprint_grow.h.
|
protected |
Definition at line 205 of file fingerprint_grow.h.
|
protected |
Definition at line 195 of file fingerprint_grow.h.
|
protected |
Definition at line 188 of file fingerprint_grow.h.
|
protected |
Definition at line 187 of file fingerprint_grow.h.
|
protected |
Definition at line 194 of file fingerprint_grow.h.
|
protected |
Definition at line 189 of file fingerprint_grow.h.
|
protected |
Definition at line 191 of file fingerprint_grow.h.
|
protected |
Definition at line 192 of file fingerprint_grow.h.
|
protected |
Definition at line 200 of file fingerprint_grow.h.
|
protected |
Definition at line 199 of file fingerprint_grow.h.
|
protected |
Definition at line 190 of file fingerprint_grow.h.
|
protected |
Definition at line 180 of file fingerprint_grow.h.
|
protected |
Definition at line 179 of file fingerprint_grow.h.
|
protected |
Definition at line 198 of file fingerprint_grow.h.
|
protected |
Definition at line 181 of file fingerprint_grow.h.
|
protected |
Definition at line 182 of file fingerprint_grow.h.
|
protected |
Definition at line 196 of file fingerprint_grow.h.
|
protected |
Definition at line 193 of file fingerprint_grow.h.
|
protected |
Definition at line 186 of file fingerprint_grow.h.