ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
fingerprint_grow.h
Go to the documentation of this file.
1#pragma once
2
7
8#include <limits>
9#include <vector>
10
12
13static const uint16_t START_CODE = 0xEF01;
14
15static const uint16_t ENROLLMENT_SLOT_UNUSED = 0xFFFF;
16
17// The datasheet says a max wake up time of of 200ms.
18static const uint8_t WAIT_FOR_WAKE_UP_MS = 200;
19
20static const uint32_t DEFAULT_IDLE_PERIOD_TO_SLEEP_MS = 5000;
21
23 COMMAND = 0x01,
24 DATA = 0x02,
25 ACK = 0x07,
26 END_DATA = 0x08,
27};
28
30 GET_IMAGE = 0x01,
31 IMAGE_2_TZ = 0x02,
32 SEARCH = 0x04,
33 REG_MODEL = 0x05,
34 STORE = 0x06,
35 LOAD = 0x07,
36 UPLOAD = 0x08,
37 DELETE = 0x0C,
38 DELETE_ALL = 0x0D, // aka EMPTY
45 LED_ON = 0x50,
46 LED_OFF = 0x51,
47};
48
74
76 BREATHING = 0x01,
77 FLASHING = 0x02,
78 ALWAYS_ON = 0x03,
79 ALWAYS_OFF = 0x04,
80 GRADUAL_ON = 0x05,
82};
83
85 RED = 0x01,
86 BLUE = 0x02,
87 PURPLE = 0x03,
88 GREEN = 0x04,
89 YELLOW = 0x05,
90 CYAN = 0x06,
91 WHITE = 0x07,
92};
93
95 SUB_SENSOR(fingerprint_count)
96 SUB_SENSOR(status)
97 SUB_SENSOR(capacity)
98 SUB_SENSOR(security_level)
99 SUB_SENSOR(last_finger_id)
100 SUB_SENSOR(last_confidence)
101 SUB_BINARY_SENSOR(enrolling)
102
103 public:
104 void update() override;
105 void setup() override;
106 void dump_config() override;
107
108 void set_address(uint32_t address) {
109 this->address_[0] = (uint8_t) (address >> 24);
110 this->address_[1] = (uint8_t) (address >> 16);
111 this->address_[2] = (uint8_t) (address >> 8);
112 this->address_[3] = (uint8_t) (address & 0xFF);
113 }
114 void set_sensing_pin(GPIOPin *sensing_pin) { this->sensing_pin_ = sensing_pin; }
115 void set_sensor_power_pin(GPIOPin *sensor_power_pin) { this->sensor_power_pin_ = sensor_power_pin; }
116 void set_password(uint32_t password) { this->password_ = password; }
117 void set_new_password(uint32_t new_password) { this->new_password_ = new_password; }
118 void set_idle_period_to_sleep_ms(uint32_t period_ms) { this->idle_period_to_sleep_ms_ = period_ms; }
119 template<typename F> void add_on_finger_scan_start_callback(F &&callback) {
120 this->finger_scan_start_callback_.add(std::forward<F>(callback));
121 }
122 template<typename F> void add_on_finger_scan_matched_callback(F &&callback) {
123 this->finger_scan_matched_callback_.add(std::forward<F>(callback));
124 }
125 template<typename F> void add_on_finger_scan_unmatched_callback(F &&callback) {
126 this->finger_scan_unmatched_callback_.add(std::forward<F>(callback));
127 }
128 template<typename F> void add_on_finger_scan_misplaced_callback(F &&callback) {
129 this->finger_scan_misplaced_callback_.add(std::forward<F>(callback));
130 }
131 template<typename F> void add_on_finger_scan_invalid_callback(F &&callback) {
132 this->finger_scan_invalid_callback_.add(std::forward<F>(callback));
133 }
134 template<typename F> void add_on_enrollment_scan_callback(F &&callback) {
135 this->enrollment_scan_callback_.add(std::forward<F>(callback));
136 }
137 template<typename F> void add_on_enrollment_done_callback(F &&callback) {
138 this->enrollment_done_callback_.add(std::forward<F>(callback));
139 }
140
141 template<typename F> void add_on_enrollment_failed_callback(F &&callback) {
142 this->enrollment_failed_callback_.add(std::forward<F>(callback));
143 }
144
145 void enroll_fingerprint(uint16_t finger_id, uint8_t num_buffers);
146 void finish_enrollment(uint8_t result);
147 void delete_fingerprint(uint16_t finger_id);
148 void delete_all_fingerprints();
149
150 void led_control(bool state);
151 void aura_led_control(uint8_t state, uint8_t speed, uint8_t color, uint8_t count);
152
153 protected:
154 void scan_and_match_();
155 uint8_t scan_image_(uint8_t buffer);
156 uint8_t save_fingerprint_();
157 bool check_password_();
158 bool set_password_();
159 bool get_parameters_();
161 uint8_t transfer_(std::vector<uint8_t> &data_buffer);
162 uint8_t send_command_();
163 void sensor_wakeup_();
164 void sensor_sleep_();
165
166 std::vector<uint8_t> data_ = {};
167 uint8_t address_[4] = {0xFF, 0xFF, 0xFF, 0xFF};
168 uint16_t capacity_ = 64;
170 uint32_t new_password_ = std::numeric_limits<uint32_t>::max();
173 uint8_t enrollment_image_ = 0;
174 uint16_t enrollment_slot_ = ENROLLMENT_SLOT_UNUSED;
176 bool waiting_removal_ = false;
177 bool has_sensing_pin_ = false;
178 bool has_power_pin_ = false;
179 bool is_sensor_awake_ = false;
193};
194
195} // namespace esphome::fingerprint_grow
uint8_t status
Definition bl0942.h:8
This class simplifies creating components that periodically check a state.
Definition component.h:532
virtual void update()=0
CallbackManager< void(uint16_t, uint16_t)> finger_scan_matched_callback_
uint8_t transfer_(std::vector< uint8_t > &data_buffer)
CallbackManager< void(uint16_t)> enrollment_done_callback_
CallbackManager< void(uint16_t)> enrollment_failed_callback_
CallbackManager< void(uint8_t, uint16_t)> enrollment_scan_callback_
int speed
Definition fan.h:3
bool state
Definition fan.h:2
unsigned count
Definition gif.cpp:51
uint32_t buffer
Definition gif.cpp:50
uint16_t uint16_t & capacity
Definition helpers.cpp:34
static void uint32_t