Skip to content

Commit 1914289

Browse files
hlym123lbuque
hlym123
authored and
lbuque
committed
libs/unit: Add support for Fingerprint2Unit.
Signed-off-by: hlym123 <[email protected]>
1 parent b501499 commit 1914289

13 files changed

+3251
-0
lines changed

‎docs/en/refs/unit.fingerprint2.ref‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
.. |Unit Fingerprint2| image:: https://m5stack-doc.oss-cn-shenzhen.aliyuncs.com/1186/U203_01.webp
2+
:target: https://docs.m5stack.com/en/products/sku/U203
3+
:height: 200px
4+
:width: 200px
5+
6+
.. |init.png| image:: https://static-cdn.m5stack.com/mpy_docs/unit/fingerprint2/init.png
7+
.. |get_verify_image.png| image:: https://static-cdn.m5stack.com/mpy_docs/unit/fingerprint2/get_verify_image.png
8+
.. |get_enroll_image.png| image:: https://static-cdn.m5stack.com/mpy_docs/unit/fingerprint2/get_enroll_image.png
9+
.. |gen_feature.png| image:: https://static-cdn.m5stack.com/mpy_docs/unit/fingerprint2/gen_feature.png
10+
.. |gen_template.png| image:: https://static-cdn.m5stack.com/mpy_docs/unit/fingerprint2/gen_template.png
11+
.. |store_template.png| image:: https://static-cdn.m5stack.com/mpy_docs/unit/fingerprint2/store_template.png
12+
.. |load_template.png| image:: https://static-cdn.m5stack.com/mpy_docs/unit/fingerprint2/load_template.png
13+
.. |delete_template.png| image:: https://static-cdn.m5stack.com/mpy_docs/unit/fingerprint2/delete_template.png
14+
.. |delete_all_template.png| image:: https://static-cdn.m5stack.com/mpy_docs/unit/fingerprint2/delete_all_template.png
15+
.. |upload_template.png| image:: https://static-cdn.m5stack.com/mpy_docs/unit/fingerprint2/upload_template.png
16+
.. |download_template.png| image:: https://static-cdn.m5stack.com/mpy_docs/unit/fingerprint2/download_template.png
17+
.. |upload_image.png| image:: https://static-cdn.m5stack.com/mpy_docs/unit/fingerprint2/upload_image.png
18+
.. |get_valid_template_num.png| image:: https://static-cdn.m5stack.com/mpy_docs/unit/fingerprint2/get_valid_template_num.png
19+
.. |get_stored_template_id.png| image:: https://static-cdn.m5stack.com/mpy_docs/unit/fingerprint2/get_stored_template_id.png
20+
.. |find_match.png| image:: https://static-cdn.m5stack.com/mpy_docs/unit/fingerprint2/find_match.png
21+
.. |match.png| image:: https://static-cdn.m5stack.com/mpy_docs/unit/fingerprint2/match.png
22+
.. |is_connected.png| image:: https://static-cdn.m5stack.com/mpy_docs/unit/fingerprint2/is_connected.png
23+
.. |activate_module.png| image:: https://static-cdn.m5stack.com/mpy_docs/unit/fingerprint2/activate_module.png
24+
.. |set_work_mode.png| image:: https://static-cdn.m5stack.com/mpy_docs/unit/fingerprint2/set_work_mode.png
25+
.. |get_work_mode.png| image:: https://static-cdn.m5stack.com/mpy_docs/unit/fingerprint2/get_work_mode.png
26+
.. |set_auto_sleep_time.png| image:: https://static-cdn.m5stack.com/mpy_docs/unit/fingerprint2/set_auto_sleep_time.png
27+
.. |get_auto_sleep_time.png| image:: https://static-cdn.m5stack.com/mpy_docs/unit/fingerprint2/get_auto_sleep_time.png
28+
.. |get_work_status.png| image:: https://static-cdn.m5stack.com/mpy_docs/unit/fingerprint2/get_work_status.png
29+
.. |get_firmware_version.png| image:: https://static-cdn.m5stack.com/mpy_docs/unit/fingerprint2/get_firmware_version.png
30+
.. |set_led_breath.png| image:: https://static-cdn.m5stack.com/mpy_docs/unit/fingerprint2/set_led_breath.png
31+
.. |set_led_color.png| image:: https://static-cdn.m5stack.com/mpy_docs/unit/fingerprint2/set_led_color.png
32+
33+
34+
.. |m5cores3_fp2_basic_example.png| image:: https://static-cdn.m5stack.com/mpy_docs/unit/fingerprint2/basic_example.png
35+
36+
.. |m5cores3_fp2_basic_example.m5f2| raw:: html
37+
38+
<a
39+
href="https://uiflow2.m5stack.com/?example=https://raw.githubusercontent.com/m5stack/uiflow-micropython/develop/examples/unit/fingerprint2/m5cores3_fp2_basic_example.m5f2"
40+
target="_blank"
41+
>
42+
m5cores3_fp2_basic_example.m5f2
43+
</a>
44+
45+
.. |m5cores3_fp2_template_upload_download_example.png| image:: https://static-cdn.m5stack.com/mpy_docs/unit/fingerprint2/template_upload_download_example.png
46+
47+
.. |m5cores3_fp2_template_upload_download_example.m5f2| raw:: html
48+
49+
<a
50+
href="https://uiflow2.m5stack.com/?example=https://raw.githubusercontent.com/m5stack/uiflow-micropython/develop/examples/unit/fingerprint2/m5cores3_fp2_template_upload_download_example.m5f2"
51+
target="_blank"
52+
>
53+
m5cores3_fp2_template_upload_download_example.m5f2
54+
</a>
55+
56+
.. |m5cores3_fp2_upload_image_example.png| image:: https://static-cdn.m5stack.com/mpy_docs/unit/fingerprint2/upload_image_example.png
57+
58+
.. |m5cores3_fp2_upload_image_example.m5f2| raw:: html
59+
60+
<a
61+
href="https://uiflow2.m5stack.com/?example=https://raw.githubusercontent.com/m5stack/uiflow-micropython/develop/examples/unit/fingerprint2/m5cores3_fp2_upload_image_example.m5f2"
62+
target="_blank"
63+
>
64+
m5cores3_fp2_upload_image_example.m5f2
65+
</a>
66+

‎docs/en/units/fingerprint2.rst‎

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
Fingerprint2 Unit
2+
=================
3+
4+
.. sku: U203
5+
6+
.. include:: ../refs/unit.fingerprint2.ref
7+
8+
This library is the driver for Unit Fingerprint2.
9+
10+
Support the following products:
11+
12+
|Unit Fingerprint2|
13+
14+
UiFlow2 Example
15+
---------------
16+
17+
Enroll and recognize
18+
^^^^^^^^^^^^^^^^^^^^
19+
20+
Open the |m5cores3_fp2_basic_example.m5f2| project in UiFlow2.
21+
22+
This example demonstrates how to use a fingerprint recognition module to perform
23+
the complete process of fingerprint enrollment, identification, and deletion.
24+
25+
UiFlow2 Code Block:
26+
27+
|m5cores3_fp2_basic_example.png|
28+
29+
Example output:
30+
31+
None
32+
33+
Upload and download template
34+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
35+
36+
Open the |m5cores3_fp2_template_upload_download_example.m5f2| project in UiFlow2.
37+
38+
This example demonstrates how to use a fingerprint recognition module to perform the complete process of fingerprint enrollment, identification, deletion,
39+
and template upload/download.(The upload and download functions enable cross-device fingerprint recognition — a fingerprint enrolled on one module can be verified on another.
40+
The fingerprint template transfer method can be customized according to user requirements, such as via serial communication, network, or cloud synchronization.)
41+
42+
UiFlow2 Code Block:
43+
44+
|m5cores3_fp2_template_upload_download_example.png|
45+
46+
Example output:
47+
48+
None
49+
50+
Upload adn display fingerprint image
51+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
52+
53+
Open the |m5cores3_fp2_upload_image_example.m5f2| project in UiFlow2.
54+
55+
This example demonstrates how to upload and display the fingerprint image.
56+
57+
UiFlow2 Code Block:
58+
59+
|m5cores3_fp2_upload_image_example.png|
60+
61+
Example output:
62+
63+
None
64+
65+
MicroPython Example
66+
-------------------
67+
68+
Enroll and recognize
69+
^^^^^^^^^^^^^^^^^^^^
70+
71+
This example demonstrates how to use a fingerprint recognition module to perform
72+
the complete process of fingerprint enrollment, identification, and deletion.
73+
74+
MicroPython Code Block:
75+
76+
.. literalinclude:: ../../../examples/unit/fingerprint2/m5cores3_fp2_basic_example.py
77+
:language: python
78+
:linenos:
79+
80+
Example output:
81+
82+
None
83+
84+
Upload and download template
85+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
86+
87+
This example demonstrates how to use a fingerprint recognition module to perform the complete process of fingerprint enrollment, identification, deletion,
88+
and template upload/download.(The upload and download functions enable cross-device fingerprint recognition — a fingerprint enrolled on one module can be verified on another.
89+
The fingerprint template transfer method can be customized according to user requirements, such as via serial communication, network, or cloud synchronization.)
90+
91+
MicroPython Code Block:
92+
93+
.. literalinclude:: ../../../examples/unit/fingerprint2/m5cores3_fp2_template_upload_download_example.py
94+
:language: python
95+
:linenos:
96+
97+
Example output:
98+
99+
None
100+
101+
Upload adn display fingerprint image
102+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
103+
104+
This example demonstrates how to upload and display the fingerprint image.
105+
106+
MicroPython Code Block:
107+
108+
.. literalinclude:: ../../../examples/unit/fingerprint2/m5cores3_fp2_upload_image_example.py
109+
:language: python
110+
:linenos:
111+
112+
Example output:
113+
114+
None
115+
116+
**API**
117+
-------
118+
119+
Fingerprint2Unit
120+
^^^^^^^^^^^^^^^^
121+
122+
.. autoclass:: unit.fingerprint2.Fingerprint2Unit
123+
:members:

‎docs/en/units/index.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ Unit
4444
extio2.rst
4545
fader.rst
4646
finger.rst
47+
fingerprint2.rst
4748
flash_light.rst
4849
gateway_h2.rst
4950
glass.rst

0 commit comments

Comments
 (0)