samples: sensor: Modified Readme for grow_r502a

Modified readme for grow_r502a sample w.r.t
latest changes on driver like attributes and
LED controlling via zephyr LED subsystem APIs.

Signed-off-by: Dinesh Kumar K <dinesh@linumiz.com>
This commit is contained in:
Dinesh Kumar K 2024-05-01 16:09:56 +05:30 committed by Anas Nashif
commit 5e60656aeb

View file

@ -8,18 +8,15 @@ Overview
This sample has the below functionalities: This sample has the below functionalities:
#. Sensor LED is controlled using led APIs from zephyr subsystem.
#. Shows the number of fingerprints stored in the sensor. #. Shows the number of fingerprints stored in the sensor.
#. Shows the sensor device's configurations like baud rate, library size, address and data packet size in UART frame.
#. When SENSOR_ATTR_RECORD_FREE_IDX is set then it search for free index in sensor library. #. When SENSOR_ATTR_RECORD_FREE_IDX is set then it search for free index in sensor library.
#. When SENSOR_ATTR_RECORD_ADD is set then it adds a new fingerprint to the sensor. #. When SENSOR_ATTR_RECORD_ADD is set then it adds a new fingerprint to the sensor.
#. When SENSOR_ATTR_RECORD_FIND is set then it tries to find a match for the input fingerprint. On finding a match it returns ID and confidence. #. When SENSOR_ATTR_RECORD_FIND is set then it tries to find a match for the input fingerprint. On finding a match it returns ID and confidence.
#. When SENSOR_ATTR_RECORD_DEL is set then it deletes a fingerprint from the sensor. #. When SENSOR_ATTR_RECORD_DEL is set then it deletes a fingerprint from the sensor.
Note: Fingerprint add & delete functionalities work only when SENSOR_TRIG_TOUCH is set. Note: Fingerprint add functionality work only when SENSOR_TRIG_TOUCH is set.
Tricolored LED in the sensor hardware will, flash on the below conditions:
#. On successful addition or deletion of fingerprint it will flash in blue three times.
#. On finding a match for the input fingerprint it will flash in purple.
#. In all other cases it will flash in red.
Wiring Wiring
******* *******
@ -42,7 +39,7 @@ build this sample app using:
.. zephyr-app-commands:: .. zephyr-app-commands::
:zephyr-app: samples/sensor/grow_r502a :zephyr-app: samples/sensor/grow_r502a
:board: nrf52840dk/nrf52840 :board: esp32_devkitc_wroom/esp32/procpu
:goals: build flash :goals: build flash
Sample Output Sample Output
@ -50,20 +47,18 @@ Sample Output
.. code-block:: console .. code-block:: console
*** Booting Zephyr OS build zephyr-v3.1.0-2640-g328bb73113d4 *** *** Booting Zephyr OS build v3.6.0-3147-g8ae1a2e2718e ***
template count : 0 template count : 4
baud 57600
addr 0xffffffff
lib_size 200
data_pkt_size 128
Fingerprint Deleted at ID #3 Fingerprint Deleted at ID #3
Fingerprint template free idx at ID #0 Fingerprint template free idx at ID #3
Waiting for valid finger to enroll as ID #0 Waiting for valid finger to enroll as ID #3
Place your finger Place your finger
Fingerprint successfully stored at #0 Fingerprint successfully stored at #3
template count : 1 template count : 4
Matched ID : 0 Matched ID : 2
confidence : 170 confidence : 110
template count : 1
Matched ID : 0
confidence : 136
template count : 1
Matched ID : 0
confidence : 318
<repeats endlessly> <repeats endlessly>