ESPHome 2026.11.0b6
Loading...
Searching...
No Matches
hlk_fm22x.h
Go to the documentation of this file.
1#pragma once
2
9
10#include <array>
11#include <utility>
12
13namespace esphome::hlk_fm22x {
14
15static const uint16_t START_CODE = 0xEFAA;
16static constexpr size_t HLK_FM22X_NAME_SIZE = 32;
17// Maximum response payload: command(1) + result(1) + face_id(2) + name(32) = 36
18static constexpr size_t HLK_FM22X_MAX_RESPONSE_SIZE = 36;
20 NONE = 0x00,
21 RESET = 0x10,
22 GET_STATUS = 0x11,
23 VERIFY = 0x12,
24 ENROLL = 0x13,
30};
31
33 REPLY = 0x00,
34 NOTE = 0x01,
35 IMAGE = 0x02,
36};
37
39 READY = 0x00,
40 FACE_STATE = 0x01,
41};
42
64
73
75 SUB_SENSOR(face_count)
76 SUB_SENSOR(status)
77 SUB_SENSOR(last_face_id)
78 SUB_TEXT_SENSOR(last_face_name)
79 SUB_BINARY_SENSOR(enrolling)
80 SUB_TEXT_SENSOR(version)
81
82 public:
83 void setup() override;
84 void update() override;
85 void dump_config() override;
86
87 template<typename F> void add_on_face_scan_matched_callback(F &&callback) {
88 this->face_scan_matched_callback_.add(std::forward<F>(callback));
89 }
90 template<typename F> void add_on_face_scan_unmatched_callback(F &&callback) {
91 this->face_scan_unmatched_callback_.add(std::forward<F>(callback));
92 }
93 template<typename F> void add_on_face_scan_invalid_callback(F &&callback) {
94 this->face_scan_invalid_callback_.add(std::forward<F>(callback));
95 }
96 template<typename F> void add_on_face_info_callback(F &&callback) {
97 this->face_info_callback_.add(std::forward<F>(callback));
98 }
99 template<typename F> void add_on_enrollment_done_callback(F &&callback) {
100 this->enrollment_done_callback_.add(std::forward<F>(callback));
101 }
102 template<typename F> void add_on_enrollment_failed_callback(F &&callback) {
103 this->enrollment_failed_callback_.add(std::forward<F>(callback));
104 }
105
106 void enroll_face(const std::string &name, HlkFm22xFaceDirection direction);
107 void scan_face();
108 void delete_face(int16_t face_id);
109 void delete_all_faces();
110 void reset();
111
112 protected:
113 void get_face_count_();
114 void send_command_(HlkFm22xCommand command, const uint8_t *data = nullptr, size_t size = 0);
115 void recv_command_();
116 void handle_note_(const uint8_t *data, size_t length);
117 void handle_reply_(const uint8_t *data, size_t length);
118 void set_enrolling_(bool enrolling);
119
120 std::array<uint8_t, HLK_FM22X_MAX_RESPONSE_SIZE> recv_buf_;
122 uint16_t wait_cycles_ = 0;
124 CallbackManager<void(int16_t, std::string)> face_scan_matched_callback_;
126 CallbackManager<void(int16_t, int16_t, int16_t, int16_t, int16_t, int16_t, int16_t, int16_t)> face_info_callback_;
129};
130
131} // namespace esphome::hlk_fm22x
uint8_t status
Definition bl0942.h:8
virtual void setup()
Where the component's initialization should happen.
Definition component.cpp:84
This class simplifies creating components that periodically check a state.
Definition component.h:532
void handle_reply_(const uint8_t *data, size_t length)
CallbackManager< void(int16_t, int16_t, int16_t, int16_t, int16_t, int16_t, int16_t, int16_t)> face_info_callback_
Definition hlk_fm22x.h:126
void send_command_(HlkFm22xCommand command, const uint8_t *data=nullptr, size_t size=0)
Definition hlk_fm22x.cpp:78
CallbackManager< void(uint8_t)> face_scan_invalid_callback_
Definition hlk_fm22x.h:123
std::array< uint8_t, HLK_FM22X_MAX_RESPONSE_SIZE > recv_buf_
Definition hlk_fm22x.h:120
CallbackManager< void()> face_scan_unmatched_callback_
Definition hlk_fm22x.h:125
CallbackManager< void(int16_t, uint8_t)> enrollment_done_callback_
Definition hlk_fm22x.h:127
CallbackManager< void(uint8_t)> enrollment_failed_callback_
Definition hlk_fm22x.h:128
void handle_note_(const uint8_t *data, size_t length)
CallbackManager< void(int16_t, std::string)> face_scan_matched_callback_
Definition hlk_fm22x.h:124
FanDirection direction
Definition fan.h:5
uint16_t size
Definition helpers.cpp:34