Biometric Device Integration

v 17.0 Third Party 17081

Availability	Odoo Online Odoo.sh On Premise
Odoo Apps Dependencies	• Attendances (hr_attendance) • Employees (hr) • Discuss (mail)
Lines of code	386
Technical Name	`hr_zk_attendance`
License	AGPL-3
Website	https://www.cybrosys.com
Versions	10.0 11.0 12.0 13.0 14.0 15.0 16.0 17.0 18.0

You bought this module and need support? Click here!

Availability	Odoo Online Odoo.sh On Premise
Odoo Apps Dependencies	• Attendances (hr_attendance) • Employees (hr) • Discuss (mail)
Lines of code	386
Technical Name	`hr_zk_attendance`
License	AGPL-3
Website	https://www.cybrosys.com
Versions	10.0 11.0 12.0 13.0 14.0 15.0 16.0 17.0 18.0

Community

Biometric Device Integration

This Module Integrates Biometric Device With HR Attendance.

Key Highlights

(Face+Thumb) with HR Attendance.

Integrates Biometric Device (Face+Thumb) with HR Attendance.

Simultaneous Employee in Odoo.

If you create an Employee in Device simultaneously create that Employee in Odoo also. For adding the existing employee of Odoo to Device, create the employee in Device with the same Biometric Device id from Odoo.

Attendance log in Odoo.

Option to keep the Device Attendance log in Odoo.

Clear Attendance.

Option to clear the Device Attendance log from both Device and Odoo.

Restart and set Time of Device.

We can set the timezone of the device and also restart the device.

Supporting Models

This module support with the following machines :
* uFace202 (ZKteco)
* iFace990 (ZKteco)
-Clients have reported that the module works well with the following machine :
* K40 Pro (ZKteco)
* SFace900 (ZKteco)
* FR1500 (ZKteco)
* UA760 (ZKteco)
* MB10 (ZKteco)

From the Biometric Device menu, you can configure your all devices with its IP address and port number.

Test Connection - Click on the Test connection for connecting with the Device.

Clear Data - This Button will clear all Attendance data from the Device and Odoo.

Restart - This Button will Restart the Biometric Device.

Click on the Test connection for connecting with the Device.

After configuration, you can download your Device Attendance log into Odoo through 'Download Data' button.If the Device is connected, then the Odoo will download all Device Attendance log. Otherwise, the Odoo will display you a warning message.

Here you can see all Device Attendance log.

Here you can set the Time zone for Device .

Here, Odoo automatically generates HR Attendance log while downloading the Device Attendance.

You can update existing employees with the 'Device Id' which are the id in the Biometric Device. If there is no match with the "Biometric Device id" then system will automatically create corresponding employee.

Note:- This integration is only applicable for the Device ZKteco model 'uFace 202' Please install zklib library (sudo pip install zklib)

Can Download Attendance
Clear Attendance
Can Restart Device from odoo
Can set timezone of Device.

Version 17.0.1.0.0|Released on:16th November 2023

Initial Commit for Biometric Device Integration.

Version 17.0.1.0.0|Released on:31st July 2024

Added a feature to set the time in Biometric Device Integration.

Please log in to comment on this module

The author can leave a single reply to each comment.
This section is meant to ask simple questions or leave a rating. Every report of a problem experienced while using the module should be addressed to the author directly (refer to the following point).
If you want to start a discussion with the author, please use the developer contact information. They can usually be found in the description.

Ratings
Discuss

hope you can make thsi compatible to v18

Joel Huerta

on 4/11/25, 1:45 AM

thank you

automatically generate HR

alireza riazi

on 2/11/25, 6:46 AM

HI
i use your module for 1 months it s ok
but recently HR generated is not working
all attendance was show in

Attendance Analysis but in Attendances is not added

Re: automatically generate HR

Cybrosys Technologies

on 4/15/25, 10:51 PM Author

Could you please write an email to odoo@cybrosys.com with more details?

instalasi gagal

Dinasrul

on 11/29/24, 3:52 AM

Hola funciona con Odoo.sh?

Leidy Montoya

on 11/26/24, 5:51 PM

EPcia

on 10/8/24, 3:20 AM

Error while importing module 'hr_zk_attendance'. Module loading hr_zk_attendance failed: file C:\Windows\SERVIC~1\LOCALS~1\AppData\Local\Temp\tmphq7p5jk5\hr_zk_attendance\security/ir.model.access.csv could not be processed: No matching record found for external id 'model_biometric_device_details' in field 'Model' No matching record found for external id 'model_daily_attendance' in field 'Model' No matching record found for external id 'model_zk_machine_attendance' in field 'Model' Missing required value for the field 'Model' (model_id) Missing required value for the field 'Model' (model_id) Missing required value for the field 'Model' (model_id)

Re:

Cybrosys Technologies

on 10/10/24, 1:17 AM Author

Please note that custom modules with Python or JS files cannot be imported directly via the Odoo Apps interface, which only supports modules with XML files. If you're on Odoo Online, custom module installation is not supported.

If you're using Odoo on-premise, you can manually add the module to your 'custom_addon' folder. After that, make sure to update the 'custom_addons' path in your Odoo config file. For detailed steps, refer to this guide: How to Install a Custom Module in Odoo 16.

IN reply

alireza riazi

on 9/9/24, 5:12 AM

in reply of your message
you mean selecting the checkedin / checked out option is necessary in punching time?

Good use

by alireza riazi on 9/5/24, 12:55 PM Report

I use this module and I can connect to the device but one isuee I have

we we punching on device (uface) we did not select Check-in / check-out

so all punching entered as check-in

in this situation, when we download data from machine, attendance is not complited

what should I have to do?

Re: Good use

by Cybrosys Technologies on 9/9/24, 1:05 PM Author Report

Please verify the configuration of the device's punch state mode, where you can adjust the setting to fixed, auto, manual, etc. Additionally, review the working time and shift time configured in each employee's details under their working information in the employee module.

Re: IN reply

Cybrosys Technologies

on 9/10/24, 2:33 AM Author

Yes, If you are using the device for attendance purposes, selecting the punching type at the time of punching is essential. If you are using a single device for both check-in and check-out, you will need to set the punching types to either manual or automatic.

In your biometric device, you can set the punching modes as follows:

Navigate to Device Configuration.
Go to Personalize.
Select Punch State Options.

Here, you can choose the appropriate mode according to your needs.

For more detailed instructions, please refer to the device user manual

Good use

alireza riazi

on 9/5/24, 3:55 AM

I use this module and I can connect to the device but one isuee I have
we we punching on device (uface) we did not select Check-in / check-out

so all punching entered as check-in

in this situation, when we download data from machine, attendance is not complited
what should I have to do?

Re: Good use

Cybrosys Technologies

on 9/9/24, 4:05 AM Author

nithish

on 8/3/24, 1:09 AM

Hello Team,
Will this work for uFace800???

Re:

Cybrosys Technologies

on 8/6/24, 1:44 AM Author

Currently, we have successfully tested only ZKteco model 'uFace 202' & ZKteco model 'iFace990' devices in our apps.

Other devices are not tested from our side. Perhaps it will be compatible with other device models.

Our clients have reported that the following devices work well:

K40 Pro (ZKTeco)

SFace900 (ZKTeco)

FR1500 (ZKTeco)

UA760 (ZKTeco)

MB10 (ZKTeco)

biomitric device connection

h.mohamed25@hotmail.fr

on 8/2/24, 6:30 PM

hello;

can i use url to connect to the biomitric device instead of the IP address?

Re: biomitric device connection

Cybrosys Technologies

on 8/3/24, 1:34 AM Author

Yes, you can

cemara

on 7/26/24, 1:36 PM

Hi, i managed to install it, but after few records, i got this when trying to download data

Validation Error

Cannot create new attendance record for John, the employee was already checked in on 07/26/2024

Re:

Cybrosys Technologies

on 8/30/24, 6:01 AM Author

The issue occurred due to a time difference between your device and the system.

We've updated our app with a new feature that sets the device time from Odoo.

deny winarto

on 7/19/24, 4:41 AM

Unable to install module "hr_zk_attendance" because an external dependency is not met: Python library not installed: pyzk

Hi, i got this error at first.

Then i installed in the debian 12 container like this :

root@odoo16:~# sudo mv /usr/lib/python3.11/EXTERNALLY-MANAGED /usr/lib/python3.11/EXTERNALLY-MANAGED.old

root@odoo16:~# pip3 install zklib

Collecting zklib

Using cached zklib-0.1.1-py3-none-any.whl

Installing collected packages: zklib

Successfully installed zklib-0.1.1

WARNING: Running pip as the 'root' user can result in broken permissions and conflicting behaviour with the system package manager. It is recommended to use a virtual environment instead: https://pip.pypa.io/warnings/venv

But even with that i still get same error. Can you help?

Re:

Cybrosys Technologies

on 7/26/24, 12:46 AM Author

This could be due to the library not being installed in the correct Python environment Odoo uses. We recommend ensuring the library is installed in the same environment where Odoo is running. You can achieve this by activating the virtual environment (if you're using one) before installing the library. Here's how you can do it:

source /path/to/your/virtualenv/bin/activate
pip3 install zklib

deny winarto

on 7/19/24, 3:39 AM

Copied into addons directory, enable debug, update addons list, but the module wont appear.

Import module and it gives me this error

Module loading hr_zk_attendance failed: file /tmp/tmpgk2jsnha/hr_zk_attendance/security/ir.model.access.csv could not be processed: No matching record found for external id 'model_biometric_device_details' in field 'Model' No matching record found for external id 'model_daily_attendance' in field 'Model' No matching record found for external id 'model_zk_machine_attendance' in field 'Model' Missing required value for the field 'Model' (model_id) Missing required value for the field 'Model' (model_id) Missing required value for the field 'Model' (model_id)

Odoo 17.0-20240711 (Community Edition), please fix thanks.

Re:

Cybrosys Technologies

on 7/26/24, 12:46 AM Author

This can occur if there are missing dependencies or misconfigurations in the module. So ensure all necessary dependencies for the hr_zk_attendance module are installed and properly configured.

Aswathy p

on 7/16/24, 12:20 AM

Traceback (most recent call last):
  File "/opt/aswathyp_140/odoo17_enterprise/odoo/http.py", line 1765, in _serve_db
    return service_model.retrying(self._serve_ir_http, self.env)
  File "/opt/aswathyp_140/odoo17_enterprise/odoo/service/model.py", line 133, in retrying
    result = func()
  File "/opt/aswathyp_140/odoo17_enterprise/odoo/http.py", line 1792, in _serve_ir_http
    response = self.dispatcher.dispatch(rule.endpoint, args)
  File "/opt/aswathyp_140/odoo17_enterprise/odoo/http.py", line 1996, in dispatch
    result = self.request.registry['ir.http']._dispatch(endpoint)
  File "/opt/aswathyp_140/odoo17_enterprise/odoo/addons/base/models/ir_http.py", line 222, in _dispatch
    result = endpoint(**request.params)
  File "/opt/aswathyp_140/odoo17_enterprise/odoo/http.py", line 722, in route_wrapper
    result = endpoint(self, *args, **params_ok)
  File "/opt/aswathyp_140/odoo17_enterprise/odoo/addons/web/controllers/dataset.py", line 28, in call_button
    action = self._call_kw(model, method, args, kwargs)
  File "/opt/aswathyp_140/odoo17_enterprise/odoo/addons/web/controllers/dataset.py", line 20, in _call_kw
    return call_kw(request.env[model], method, args, kwargs)
  File "/opt/aswathyp_140/odoo17_enterprise/odoo/api.py", line 468, in call_kw
    result = _call_kw_multi(method, model, args, kwargs)
  File "/opt/aswathyp_140/odoo17_enterprise/odoo/api.py", line 453, in _call_kw_multi
    result = method(recs, *args, **kwargs)
  File "/opt/aswathyp_140/odoo17_enterprise/custom_addons/hr_zk_attendance/models/biometric_device_details.py", line 165, in action_download_attendance
    zk_attendance.create({
  File "", line 2, in create
  File "/opt/aswathyp_140/odoo17_enterprise/odoo/api.py", line 414, in _model_create_multi
    return create(self, [arg])
  File "/opt/aswathyp_140/odoo17_enterprise/odoo/addons/hr_attendance/models/hr_attendance.py", line 393, in create
    res = super().create(vals_list)
  File "", line 2, in create
  File "/opt/aswathyp_140/odoo17_enterprise/odoo/api.py", line 415, in _model_create_multi
    return create(self, arg)
  File "/opt/aswathyp_140/odoo17_enterprise/odoo/addons/mail/models/mail_thread.py", line 259, in create
    threads = super(MailThread, self).create(vals_list)
  File "", line 2, in create
  File "/opt/aswathyp_140/odoo17_enterprise/odoo/api.py", line 415, in _model_create_multi
    return create(self, arg)
  File "/opt/aswathyp_140/odoo17_enterprise/odoo/models.py", line 4603, in create
    records = self._create(data_list)
  File "/opt/aswathyp_140/odoo17_enterprise/odoo/models.py", line 4770, in _create
    colval = field.convert_to_column(stored[fname], self, stored)
  File "/opt/aswathyp_140/odoo17_enterprise/odoo/fields.py", line 2816, in convert_to_column
    value = self.convert_to_cache(value, record)
  File "/opt/aswathyp_140/odoo17_enterprise/odoo/fields.py", line 2826, in convert_to_cache
    raise ValueError("Wrong value for %s: %r" % (self, value))
ValueError: Wrong value for zk.machine.attendance.attendance_type: '101'

The above server error caused the following client error:
RPC_ERROR: Odoo Server Error
    RPCError@http://odootestserver1:1140/web/assets/c4566ad/web.assets_web.min.js:2873:319
    makeErrorFromResponse@http://odootestserver1:1140/web/assets/c4566ad/web.assets_web.min.js:2876:163
    jsonrpc/promiseWhat is the error mean? and need solution

AITLAMSALI Alaa

on 7/8/24, 7:42 AM

- Does we need to buy the Biotime Software with the Devices ??

- Are you using SQL to connect or API ? because with the API supplier told me I need to buy the Biotime native software with it which is expensive .

- If we have Odoo on cloud and the device in local network how we can connect ?

Thanks for your answer

Sincerely

Re:

Cybrosys Technologies

on 7/11/24, 12:38 AM Author

Sorry, It wont work with Biotime

zk = ZK(self.device_ip, port=self.port_number, timeout=30, NameError: name 'ZK' is not defined

Ajmal C

on 5/20/24, 3:38 AM

    zk = ZK(self.device_ip, port=self.port_number, timeout=30,
NameError: name 'ZK' is not defined

Biometric Device Integration

Biometric Device Integration

Click on the Test connection for connecting with the Device.

After configuration, you can download your Device Attendance log into Odoo through 'Download Data' button.If the Device is connected, then the Odoo will download all Device Attendance log. Otherwise, the Odoo will display you a warning message.

Here you can see all Device Attendance log.

Here you can set the Time zone for Device .

Here, Odoo automatically generates HR Attendance log while downloading the Device Attendance.

You can update existing employees with the 'Device Id' which are the id in the Biometric Device. If there is no match with the "Biometric Device id" then system will automatically create corresponding employee.

Please log in to comment on this module

hope you can make thsi compatible to v18

automatically generate HR

HIi use your module for 1 months it s ok but recently HR generated is not workingall attendance was show in

Re: automatically generate HR

instalasi gagal

Hola funciona con Odoo.sh?

Re:

IN reply

in reply of your messageyou mean selecting the checkedin / checked out option is necessary in punching time?

Good use

Re: Good use

Re: IN reply

Good use

Re: Good use

Re:

biomitric device connection

Re: biomitric device connection

Validation Error

Re:

Re:

Re:

Re:

zk = ZK(self.device_ip, port=self.port_number, timeout=30, NameError: name 'ZK' is not defined

HI
i use your module for 1 months it s ok
but recently HR generated is not working
all attendance was show in

in reply of your message
you mean selecting the checkedin / checked out option is necessary in punching time?