🚘 Garage Fingerprint Sensor

RomanFdez · August 16, 2023, 8:37am

Writing just to say you @parrel thank you. I have created my very first ESPhome project with your info. In my case was for disarm the alarmo entity. Now waiting for a DIN rail case to finish the enclosure.

RomanFdez · August 17, 2023, 7:56am

Just in case is useful for anyone:

1.- I’ve added “aura_led_control” also in services section, for “enroll”, just looking for turn on light when the enroll starts.

...
api:
  password: !secret api_password
  encryption:
    key: "*******************"
  services:
  - service: enroll
    variables:
      finger_id: int
      num_scans: int
    then:
      - text_sensor.template.publish:
          id: enrolling_state
          state: "Registra tu huella"
      - fingerprint_grow.aura_led_control:
          state: ALWAYS_ON
          speed: 0
          color: BLUE
          count: 0
      - fingerprint_grow.enroll:
          finger_id: !lambda 'return finger_id;'
          num_scans: !lambda 'return num_scans;'
          ...

2.- Also added one more text_sensor to separate fingerprint_state and enrolling_state.
fingerprint_state is updated when match or unmatch, and enrolling_state when enrollment done, scan or fail.

fingerprint_grow:
  sensing_pin: GPIO21 
  on_finger_scan_matched:
    - text_sensor.template.publish:
        id: fingerprint_state
        state: "Autorizado"
    - fingerprint_grow.aura_led_control:
        state: BREATHING
        speed: 100
        color: GREEN
        count: 2
    - delay: 3s
    - text_sensor.template.publish:
        id: fingerprint_state
        state: "Escanea tu huella"
  on_finger_scan_unmatched:
    - text_sensor.template.publish:
        id: fingerprint_state
        state: "No reconocida"
    - fingerprint_grow.aura_led_control:
        state: FLASHING
        speed: 25
        color: RED
        count: 4
    - delay: 3s
    - text_sensor.template.publish:
        id: fingerprint_state
        state: "Escanea tu huella"
  on_enrollment_scan:
    - fingerprint_grow.aura_led_control:
        state: BREATHING
        speed: 50
        color: PURPLE
        count: 1
    - fingerprint_grow.aura_led_control:
        state: ALWAYS_ON
        speed: 0
        color: BLUE
        count: 0
    - text_sensor.template.publish:
        id: enrolling_state
        state: "Registrando huella"
  on_enrollment_done:
    - fingerprint_grow.aura_led_control:
        state: BREATHING
        speed: 200
        color: YELLOW
        count: 2
    - fingerprint_grow.aura_led_control:
        state: FLASHING
        speed: 25
        color: WHITE
        count: 4
    - text_sensor.template.publish:
        id: enrolling_state
        state: "Huella registrada"
    - delay: 5s
    - text_sensor.template.publish:
        id: enrolling_state
        state: "Off"
  on_enrollment_failed:
    - fingerprint_grow.aura_led_control:
        state: FLASHING
        speed: 25
        color: RED
        count: 4
    - text_sensor.template.publish:
        id: enrolling_state
        state: "Fallo al registrar huella"
    - delay: 5s
    - text_sensor.template.publish:
        id: enrolling_state
        state: "Off"

epictechlab · August 17, 2023, 8:44pm

thanks man for the nice Guide. But I have several questions. I#ve set up an Wemos D1 mini and its working as it should I think. The main problem I have that is that I have 8 people an 2 doors which i wont to control via the scanner and i have no idea which trigger is needed in the automations for this different scenarios. is it the “fingerprint last ID” sensor? And the second question is, when i Called the Service to enroll new Fingerprints I cant find a solution for an Visual indikator for the enrol Action.neither it shows “Place your Finger” or the scanner lights up. Where do i configure this stuff?

Simonthorsted · August 21, 2023, 3:23pm

In : Developer Tools ,Services , esphome.finger_print_enroll , set id no. and number of scan

Simonthorsted · August 21, 2023, 3:29pm

 is it the “fingerprint last ID”


alias: Open door with finger id 6
description: ''
mode: single
trigger:
  - platform: state
    entity_id: sensor.fingerprint_last_finger_id  #difrent sensor name for the 2 doors (2 readers)
    to: '6' # replace with your id
condition: []
action: # add actions
  - device_id: ''
    domain: ''
    entity_id: ''

Simonthorsted · August 21, 2023, 3:55pm

Hello all

Does anyone know why i cant make this work on a D1 mini v4.0.0 (usb-c) it does work fine on a nodemcu ,im sure that i use the right gpios but i cant make
it work ?? anyone else have a problem whit the “new” D1 mini ?

solved : it was the password for the sensor that was the problem
i deleted the password line and it worked, then i added it agin
whit “new_” in front ,and then agin whit out the “new_” then
it worked fine ???

epictechlab · August 22, 2023, 5:48am

Yeah, thats the thing i know. I Mean, is it Possible to create an input Helper where i Can input a Slot Number and Assign it to a Name?

UndIch · August 27, 2023, 8:24am

I stumbled across this project - great work everyone - maybe somebody already asked for it and I missed it scrolling through …

Would it be an option to add a function “if the fingerprint doesn’t match, just ring the bell”? - I would use it for my apartment door and trigger my Nuki to open the door.
But I only have a single “cavity wall box” where I could build it in (replace the switch for the bell with the sensor) - so the idea was to combine the sensor and the bell - so if someone touches the sensor and it doesn’t match a print - it should ring the bell (it’s a ring bell so it can be set up in automations …).

Thanks in advance!

parrel · August 27, 2023, 8:42am

Yes it’s possible, you can use on_finger_scan_unmatched: to automate something if the finger does not match. You will also need to connect the door bell to a relay, which you can then control using the ESP

sreknob · September 16, 2023, 4:21pm

@epictechlab - if you want, you can create a template sensor in HA that references the last finger ID.

Helpers → Template Sensor

{% if is_state('sensor.garage_fingerprint_last_finger_id', '1') %}
  Tom
{% elif is_state('sensor.garage_fingerprint_last_finger_id', '2') %}
  Dick
{% elif is_state('sensor.garage_fingerprint_last_finger_id', '3') %}
  Harry
{% elif is_state('sensor.garage_fingerprint_last_finger_id', '4') %}
  Violet
{% elif is_state('sensor.garage_fingerprint_last_finger_id', '5') %}
  Rose
{% else %}
  Unknown
{% endif %}

or in configuration.yaml

template:
    # Fingerprint Sensor
  - sensor:
      - name: "Garage Door Last User"
        state: >
            {% if is_state('sensor.garage_fingerprint_last_finger_id', '1') %}
                Tom
            {% elif is_state('sensor.garage_fingerprint_last_finger_id', '2') %}
                Dick
            {% elif is_state('sensor.garage_fingerprint_last_finger_id', '3') %}
                Harry
            {% elif is_state('sensor.garage_fingerprint_last_finger_id', '4') %}
                Violet
            {% elif is_state('sensor.garage_fingerprint_last_finger_id', '5') %}
                Rose
            {% else %}
                Unknown
            {% endif %}

digaus · September 20, 2023, 12:23pm

I want to try to buy another 25mm button and modify it with the sensor so I have push function for ringing.

Otherwise it would suck if it cannot match your finger and you accidentally ring the bell when someone is sleeping.

Maybe someone else tried this already?

parrel · September 20, 2023, 3:40pm

You could disable the door bell altogether at night…?

digaus · October 5, 2023, 10:54am

True but still not optimal

So I am now integrating a the sensor into a button. Currently waiting for the smaller 22mm version of the fingerprint.

guegiurm · October 18, 2023, 11:54am

Hi, but how did you solve it, I wouldn’t want to have the same problem because I have the same components. could you tell me how you did it??? A thousand thanks

parrel · October 18, 2023, 2:48pm

Try different pins for TX and RX? Which pins are you using and which board?

guegiurm · October 18, 2023, 10:22pm

i’m going out of my mind, because it doesn’t work. the configuration is correct. the logs show that eroll starts but the sensor doesn’t switch on. i have two of them but nothing, tried both. is it me or do the sensors suck?
I’m use the platform: ESP8266 board: d1_mini
the fingerprint is a GROW R503

what do you think it could be ? i don’t see the light coming on at all, shouldn’t it come on already by connecting to 3.3 and gnd ? can anyone help me ? this is the third sensor i’ve tried, could it be that they are all not working ?

this is my configuration:

uart:

tx_pin: D0

rx_pin: D1

baud_rate: 57600

fingerprint_grow:

sensing_pin: D2

on_finger_scan_matched:

- fingerprint_grow.aura_led_control:

    state: BREATHING

    speed: 200

    color: BLUE

    count: 1

- text_sensor.template.publish:

    id: fingerprint_state

    state: "Authorized finger"

on_finger_scan_unmatched:

- fingerprint_grow.aura_led_control:

    state: FLASHING

    speed: 25

    color: RED

    count: 2

- text_sensor.template.publish:

    id: fingerprint_state

    state: "Unauthorized finger"

on_enrollment_scan:

- fingerprint_grow.aura_led_control:

    state: FLASHING

    speed: 25

    color: BLUE

    count: 2

- fingerprint_grow.aura_led_control:

    state: ALWAYS_ON

    speed: 0

    color: PURPLE

    count: 0

- text_sensor.template.publish:

    id: fingerprint_state

    state: "Finger scanned"

on_enrollment_done:

- fingerprint_grow.aura_led_control:

    state: BREATHING

    speed: 100

    color: BLUE

    count: 2

- text_sensor.template.publish:

    id: fingerprint_state

    state: "Enrolled fingerprint"

on_enrollment_failed:

- fingerprint_grow.aura_led_control:

    state: FLASHING

    speed: 25

    color: RED

    count: 4

- text_sensor.template.publish:

    id: fingerprint_state

    state: "Failed to enroll fingerprint"

text_sensor:

platform: template

id: fingerprint_state

name: “Garage Fingerprint State”

sensor:

platform: fingerprint_grow

fingerprint_count:

name: “Garage Fingerprint Count”

id: fingerprint_count

last_finger_id:

name: “Garage Fingerprint Last Finger ID”

last_confidence:

name: “Garage Fingerprint Last Confidence”

status:

name: “Garage Fingerprint Status”

capacity:

name: “Garage Fingerprint Capacity”

security_level:

name: “Garage Fingerprint Security Level”

services:

service: enroll

variables:

finger_id: int

num_scans: int

then:
- fingerprint_grow.enroll:
  
  finger_id: !lambda ‘return finger_id;’
  
  num_scans: !lambda ‘return num_scans;’
service: enroll_next # Idea by Ralf Klüber (thanks!)

variables:

num_scans: int

then:
- fingerprint_grow.enroll:
  
  finger_id: !lambda ‘return id(fingerprint_count).state;’
  
  num_scans: !lambda ‘return num_scans;’
service: cancel_enroll

then:
- fingerprint_grow.cancel_enroll:
service: delete

variables:

finger_id: int

then:
- fingerprint_grow.delete:
  
  finger_id: !lambda ‘return finger_id;’
service: delete_all

then:
- fingerprint_grow.delete_all:

this a log:
00:20:13][C][logger:361]: Logger:
[00:20:13][C][logger:362]: Level: DEBUG
[00:20:13][C][logger:363]: Log Baud Rate: 115200
[00:20:13][C][logger:365]: Hardware UART: UART0
[00:20:13][C][uart.arduino_esp8266:102]: UART Bus:
[00:20:13][C][uart.arduino_esp8266:103]: TX Pin: GPIO16
[00:20:13][C][uart.arduino_esp8266:104]: RX Pin: GPIO5
[00:20:13][C][uart.arduino_esp8266:106]: RX Buffer Size: 256
[00:20:13][C][uart.arduino_esp8266:108]: Baud Rate: 57600 baud
[00:20:13][C][uart.arduino_esp8266:109]: Data Bits: 8
[00:20:13][C][uart.arduino_esp8266:110]: Parity: NONE
[00:20:13][C][uart.arduino_esp8266:111]: Stop bits: 1
[00:20:13][C][uart.arduino_esp8266:115]: Using software serial
[00:20:13][C][template.text_sensor:020]: Template Sensor ‘Garage Fingerprint State’
[00:20:13][C][fingerprint_grow:427]: GROW_FINGERPRINT_READER:
[00:20:13][C][fingerprint_grow:428]: Update Interval: 0.5s
[00:20:13][C][fingerprint_grow:429]: Fingerprint Count ‘Garage Fingerprint Count’
[00:20:13][C][fingerprint_grow:429]: State Class: ‘’
[00:20:13][C][fingerprint_grow:429]: Unit of Measurement: ‘’
[00:20:13][C][fingerprint_grow:429]: Accuracy Decimals: 0
[00:20:13][C][fingerprint_grow:429]: Icon: ‘mdi:fingerprint’
[00:20:13][C][fingerprint_grow:430]: Status ‘Garage Fingerprint Status’
[00:20:13][C][fingerprint_grow:430]: State Class: ‘’
[00:20:13][C][fingerprint_grow:430]: Unit of Measurement: ‘’
[00:20:13][C][fingerprint_grow:430]: Accuracy Decimals: 0
[00:20:13][C][fingerprint_grow:431]: Capacity ‘Garage Fingerprint Capacity’
[00:20:13][C][fingerprint_grow:431]: State Class: ‘’
[00:20:13][C][fingerprint_grow:431]: Unit of Measurement: ‘’
[00:20:13][C][fingerprint_grow:431]: Accuracy Decimals: 0
[00:20:13][C][fingerprint_grow:431]: Icon: ‘mdi:database’
[00:20:13][C][fingerprint_grow:432]: Security Level ‘Garage Fingerprint Security Level’
[00:20:13][C][fingerprint_grow:432]: State Class: ‘’
[00:20:13][C][fingerprint_grow:432]: Unit of Measurement: ‘’
[00:20:13][C][fingerprint_grow:432]: Accuracy Decimals: 0
[00:20:13][C][fingerprint_grow:432]: Icon: ‘mdi:security’
[00:20:13][C][fingerprint_grow:433]: Last Finger ID ‘Garage Fingerprint Last Finger ID’
[00:20:13][C][fingerprint_grow:433]: State Class: ‘’
[00:20:13][C][fingerprint_grow:433]: Unit of Measurement: ‘’
[00:20:13][C][fingerprint_grow:433]: Accuracy Decimals: 0
[00:20:13][C][fingerprint_grow:433]: Icon: ‘mdi:account’
[00:20:13][C][fingerprint_grow:434]: Last Confidence ‘Garage Fingerprint Last Confidence’
[00:20:13][C][fingerprint_grow:434]: State Class: ‘’
[00:20:13][C][fingerprint_grow:434]: Unit of Measurement: ‘’
[00:20:13][C][fingerprint_grow:434]: Accuracy Decimals: 0
[00:20:13][C][fingerprint_grow:434]: Icon: ‘mdi:account-check’
[00:20:13][C][captive_portal:088]: Captive Portal:
[00:20:13][C][mdns:115]: mDNS:
[00:20:13][C][mdns:116]: Hostname: fingerprint
[00:20:13][C][ota:097]: Over-The-Air Updates:
[00:20:13][C][ota:098]: Address: fingerprint.local:8266
[00:20:13][C][ota:101]: Using Password.
[00:20:13][C][api:138]: API Server:
[00:20:13][C][api:139]: Address: fingerprint.local:6053
[00:20:13][C][api:141]: Using noise encryption: YES

parrel · October 19, 2023, 5:06am

Do you have a picture of your wiring from the board to the sensor?

guegiurm · October 19, 2023, 7:44am

consider that the wire you see is gray and connected to the red and white for 3.3V the black to G. I put the rest, yellow on D0, brown (formerly green) on D1 and blue on D2 (sensing pin)

into log:
[10:29:50][C][logger:361]: Logger:
[10:29:50][C][logger:362]: Level: DEBUG
[10:29:50][C][logger:363]: Log Baud Rate: 115200
[10:29:50][C][logger:365]: Hardware UART: UART0
[10:29:50][C][uart.arduino_esp8266:102]: UART Bus:
[10:29:50][C][uart.arduino_esp8266:103]: TX Pin: GPIO16
[10:29:50][C][uart.arduino_esp8266:104]: RX Pin: GPIO5
[10:29:50][C][uart.arduino_esp8266:106]: RX Buffer Size: 256
[10:29:50][C][uart.arduino_esp8266:108]: Baud Rate: 57600 baud
[10:29:50][C][uart.arduino_esp8266:109]: Data Bits: 8
[10:29:50][C][uart.arduino_esp8266:110]: Parity: NONE
[10:29:50][C][uart.arduino_esp8266:111]: Stop bits: 1
[10:29:50][C][uart.arduino_esp8266:115]: Using software serial
[10:29:50][C][template.text_sensor:020]: Template Sensor ‘Fingerprint State’
[10:29:50][C][fingerprint_grow:427]: GROW_FINGERPRINT_READER:
[10:29:50][C][fingerprint_grow:428]: Update Interval: 0.5s
[10:29:50][C][fingerprint_grow:429]: Fingerprint Count ‘Fingerprint Count’
[10:29:50][C][fingerprint_grow:429]: State Class: ‘’
[10:29:50][C][fingerprint_grow:429]: Unit of Measurement: ‘’
[10:29:50][C][fingerprint_grow:429]: Accuracy Decimals: 0
[10:29:50][C][fingerprint_grow:429]: Icon: ‘mdi:fingerprint’
[10:29:50][C][fingerprint_grow:430]: Status ‘Fingerprint Status’
[10:29:50][C][fingerprint_grow:430]: State Class: ‘’
[10:29:50][C][fingerprint_grow:430]: Unit of Measurement: ‘’
[10:29:50][C][fingerprint_grow:430]: Accuracy Decimals: 0
[10:29:50][C][fingerprint_grow:431]: Capacity ‘Fingerprint Capacity’
[10:29:50][C][fingerprint_grow:431]: State Class: ‘’
[10:29:50][C][fingerprint_grow:431]: Unit of Measurement: ‘’
[10:29:50][C][fingerprint_grow:431]: Accuracy Decimals: 0
[10:29:50][C][fingerprint_grow:431]: Icon: ‘mdi:database’
[10:29:50][C][fingerprint_grow:432]: Security Level ‘Fingerprint Security Level’
[10:29:50][C][fingerprint_grow:432]: State Class: ‘’
[10:29:50][C][fingerprint_grow:432]: Unit of Measurement: ‘’
[10:29:50][C][fingerprint_grow:432]: Accuracy Decimals: 0
[10:29:50][C][fingerprint_grow:432]: Icon: ‘mdi:security’
[10:29:50][C][fingerprint_grow:433]: Last Finger ID ‘Fingerprint Last Finger ID’
[10:29:50][C][fingerprint_grow:433]: State Class: ‘’
[10:29:50][C][fingerprint_grow:433]: Unit of Measurement: ‘’
[10:29:50][C][fingerprint_grow:433]: Accuracy Decimals: 0
[10:29:50][C][fingerprint_grow:433]: Icon: ‘mdi:account’
[10:29:50][C][fingerprint_grow:434]: Last Confidence ‘Fingerprint Last Confidence’
[10:29:50][C][fingerprint_grow:434]: State Class: ‘’
[10:29:50][C][fingerprint_grow:434]: Unit of Measurement: ‘’
[10:29:50][C][fingerprint_grow:434]: Accuracy Decimals: 0
[10:29:50][C][fingerprint_grow:434]: Icon: ‘mdi:account-check’
[10:29:51][C][captive_portal:088]: Captive Portal:
[10:29:51][C][mdns:115]: mDNS:
[10:29:51][C][mdns:116]: Hostname: fingerprint
[10:29:51][C][ota:097]: Over-The-Air Updates:
[10:29:51][C][ota:098]: Address: fingerprint.local:8266
[10:29:51][C][ota:101]: Using Password.
[10:29:51][C][api:138]: API Server:
[10:29:51][C][api:139]: Address: fingerprint.local:6053
[10:29:51][C][api:141]: Using noise encryption: YES
[10:32:14][I][fingerprint_grow:066]: Starting enrollment in slot 10
[10:32:21][D][fingerprint_grow:307]: Setting Aura LED ->> no led on!
[10:32:22][E][fingerprint_grow:421]: No response received from reader
[10:32:22][D][text_sensor:064]: ‘Fingerprint State’: Sending state ‘Failed to enroll fingerprint’
[10:32:22][I][fingerprint_grow:089]: Finished enrollment
[10:32:22][W][component:214]: Component api took a long time for an operation (1.05 s).
[10:32:22][W][component:215]: Components should block for at most 20-30ms.

parrel · October 19, 2023, 2:21pm

You switched the RX and TX pins. Yellow should be on D1

guegiurm · October 19, 2023, 3:37pm

yes I just tried but the reader does not respond.
yet they confirm to me that it has been tested and is working.
uart:
tx_pin: D0 → on esp at D1
rx_pin: D1 → on the esp at D0
baud_rate: 57600

fingerprint_grow:
sensing_pin: D2

can you think of what it could be? i am now sending the photo of the esp because it also has tx and rx pins