Click here to Skip to main content
15,397,981 members
Articles / Programming Languages / C#
Article
Posted 16 Jun 2016

Stats

404.6K views
102.3K downloads
58 bookmarked

C# ZKTeco Biometric Device Getting Started

Rate me:
Please Sign up or sign in to vote.
4.94/5 (51 votes)
7 Feb 2020CPOL5 min read
An implementation of a Zkteco (K14) Biometric Device using C#
This article is written as a getting started guide with a few pieces of source code such that it helps C# developers integrate a biometric device into their own application. The article and the source code provided will help you with the following things: Registering the SDK components, ping the device, connecting to the device, extracting data out of the device (Log Data, User Info, etc.), and how to register to device specific events.

Introduction

There are requirements where you have to integrate a biometric device into your own application or some part of it like fetching the attendance records, user information, backing up the fingerprint templates into your system database or export it somewhere remotely, etc.

For that very purpose, this article is written as a getting started guide with a few pieces of source code such that it helps C# developers to save some valuable time with all the troublesome work.

Note: Though the devices will be of various models, with a different set of sdk, the implementation procedure will be somewhat the same.

The following article contains some useful old pieces of code, if you ever get your hands on a biometric device (fingerprint reader for Time & Attendance) and want to extract gold(data) out of it.

Implemented Device Specification

Device Name : K14
Firmware Ver : ver. 4.0.1 ( build 39 )
Vendor : ZKTeco Inc.
FP : 500
Records : 50000
NOTE:
If you are working with a different model of the device like ZK4500, ZK9500, SLK20M or SLK20RHere is a good starting point for those device models.

If you are working with a different brand like the Realtime Biometric

Prior to going through the following article, it would be beneficial if you have some good understanding of the following things:

  • How a biometric device works, its features and functionalities
  • How to Register/ Unregister DLLs using the Regsvr32 utility
  • Knowledge about how the ref and out parameters work

The article and the source code provided will help you with the following things:

  • Registering the SDK components
  • Ping the device
  • Connecting to the device
  • Extracting some random data out of the device (Log Data, User Info, etc.)
  • Source code to upload data to the device
  • Restarting the device
  • How to register to device specific events [Not Implemented/ You will have to implement it yourself per your need]

Background

Biometric Devices are being used extensively in many corporations through out the world these days. Companies like ZKTeco manufacture biometric access control and Time and Attendance in various shapes and sizes with different set of features per model. They provide a better way of user authentication and security in organizations who implement it. It is a growing demand in today's world. Hence, developers are likely to come across its implementation at some point.

Using the Code

Note: The follow procedures are applicable for the K14 model devices. Other devices might have a different set of SDK, hence a slightly different set of procedures.

In order to implement any biometric device, you will have to register the related components in the system, which can be easily done by using the Regsvr32 utility. If you don't know how it works, please go through some blog posts in the related topic. We already have a batch file ready for that very purpose, Hence, we are cool here.

You can download the SDK from here. I have already attached an SDK sample along with this article. You can go through the source code inside the Register_SDK.bat to see the registration mechanism.

Registering the Components

  1. Fire up a Command Prompt with Administrator Privilege
  2. Navigate to the SDK location
  3. Execute the Register_SDK batch file

Image 1

On Successful Registration

Image 2

To implement the biometric device, you will have to use the zkemkeeper.dll.

Implementing the SDK

  1. Add Reference to the zkemkeeper.dll in a project. The DLL gives access to the following things:

    Image 3

  2. Create a class file and implement the IZKEM interface.
  3. Use the CZKEM class file to perform device related operations.

Let's say your Biometric device is connected in the local area network. To make a successful communication with the device, you need to know the IP address and the Port No.

IP address : Assign a static IP in the device itself
Default Port : 4370
Machine No : 1

Now we have a valid IP and Port, let's go through the source code used in a demo project entitled BioMetrix which I have attached along with this article. The application helps by showing some of the API implementations.

The ZKenClient.cs file implements the IZKEM interface which contains the following code.

Connecting to the Device

The following code helps connect to the device at the given IPAddress and Port and on successful connection, it registers some events.

(The events are not implemented though, you will have to implement it yourself as per your need.)

C++
public bool Connect_Net(string IPAdd, int Port)
{
    if (objCZKEM.Connect_Net(IPAdd, Port))
    {
        if (objCZKEM.RegEvent(1, 65535))
        {
            objCZKEM.OnConnected += ObjCZKEM_OnConnected;
            objCZKEM.OnDisConnected += objCZKEM_OnDisConnected; 
            objCZKEM.OnEnrollFinger += ObjCZKEM_OnEnrollFinger; 
            objCZKEM.OnFinger += ObjCZKEM_OnFinger; 
            objCZKEM.OnAttTransactionEx += 
               new _IZKEMEvents_OnAttTransactionExEventHandler(zkemClient_OnAttTransactionEx);
        }
        return true;
    }
    return false;
}

Registering Events

To fire any event when something occurs in the device, we need to register the event:

C++
 bool RegEvent(int dwMachineNumber, int EventMask); 
// Entering 65535 for the EventMast value registers for all events

The EventMask requires an integer value whose value varies based on the type of event. The complete list of EventMast values are given below:

1   OnAttTransaction, OnAttTransactionEx
2 (1<<1) OnFinger
4 (1<<2) OnNewUser
8 (1<<3) OnEnrollFinger
16 (1<<4) OnKeyPress
256 (1<<7) OnVerify
512 (1<<8) OnFingerFeature
1024 (1<<9) OnDoor, OnAlarm
2048 (1<<10) OnHIDNum
4096 (1<<11) OnWriteCard
8192 (1<<12) OnEmptyCard
16384 (1<<13) OnDeleteTemplate

To register for multiple-events, we can perform XOR operations between binary codes of related events.

To register all real-time events, the value of Eventmast can be set as 65535 which I have implemented in the above code.

Fetching User Info

The user information can be fetched by providing the machine number. The API implements the out parameter to give back the output. I had stored some random user data in the fingerprint device and used the following code to retrieve it back and display it. The TmpData is the users (fingerprint) template data.

C++
public ICollection<UserInfo> GetAllUserInfo(ZkemClient objZkeeper, int machineNumber)
{
    string sdwEnrollNumber = string.Empty, sName = string.Empty, 
                             sPassword = string.Empty, sTmpData = string.Empty;    
    int iPrivilege = 0, iTmpLength = 0, iFlag = 0, idwFingerIndex;
    bool bEnabled = false;

    ICollection<UserInfo> lstFPTemplates = new List<UserInfo>();
    objZkeeper.ReadAllUserID(machineNumber);
    objZkeeper.ReadAllTemplate(machineNumber);
    
    while (objZkeeper.SSR_GetAllUserInfo(machineNumber, out sdwEnrollNumber, 
                      out sName, out sPassword, out iPrivilege, out bEnabled))
    {
        for (idwFingerIndex = 0; idwFingerIndex < 10; idwFingerIndex++)
        {
            if (objZkeeper.GetUserTmpExStr(machineNumber, sdwEnrollNumber, 
                   idwFingerIndex, out iFlag, out sTmpData, out iTmpLength))
            {
                UserInfo fpInfo = new UserInfo();
                fpInfo.MachineNumber = machineNumber;
                fpInfo.EnrollNumber = sdwEnrollNumber;
                fpInfo.Name = sName;
                fpInfo.FingerIndex = idwFingerIndex;
                fpInfo.TmpData = sTmpData;
                fpInfo.Privelage = iPrivilege;
                fpInfo.Password = sPassword;
                fpInfo.Enabled = bEnabled;
                fpInfo.iFlag = iFlag.ToString();

                lstFPTemplates.Add(fpInfo);
            }
        }
    }
    return lstFPTemplates;
}

Result

Image 4

Conclusion

Well, that gives you the starting point for your project. With a biometric device in hand, you can now experiment with the source code yourself and play along.

There are numerous procedures and events to be implemented which you can use per you need. Also, you might want to take help from the SDK that I have attached along with this article. There are other SDK/manuals which you can find online for more detailed implementation.

Feel free for any queries and feedbacks.

Peace !!

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

Ozesh Thapa
Software Developer Assurance IQ
Nepal Nepal
I am a Software Engineer and a developer by profession.

The following things describes me:
1. I am a real time/run time developer : Basically learn and implement things on the fly.
2. Definitely not a technology racist : Love to work and explore any technology that i come across.
3. Prefer Beer over H2O : Code with passion and for fun

I am interested in Research & Development based tasks, exploring, experimenting and trying out new things.
Technologies i have been using up until now are C#, ASP.NET, Win Services, Web Services, Restful Web API, Windows Application, Windows Phone Application, Store Apps, couple of JavaScript frameworks, Xamarin Forms, NodeJS, React, ReactNative, AngularJS, SQL Server, MongoDB, Postgres etc.

Comments and Discussions

 
Questionget punch state Pin
ThrishikRam10-Jun-22 3:33
MemberThrishikRam10-Jun-22 3:33 
AnswerRe: get punch state Pin
Ali Muhammad Nizamani18-Jul-22 18:21
MemberAli Muhammad Nizamani18-Jul-22 18:21 
Questionget attendance log by time filter issue Pin
mazin_alyousef8-Jun-22 9:21
Membermazin_alyousef8-Jun-22 9:21 
AnswerRe: get attendance log by time filter issue Pin
Ali Muhammad Nizamani18-Jul-22 18:27
MemberAli Muhammad Nizamani18-Jul-22 18:27 
QuestionError to connect to device Pin
Oliver Alvarado9-May-22 19:01
MemberOliver Alvarado9-May-22 19:01 
Questionquestion Pin
Jerry Arg2-May-22 12:45
MemberJerry Arg2-May-22 12:45 
QuestionGet time in out on device Pin
Member 121978454-Apr-22 21:25
MemberMember 121978454-Apr-22 21:25 
Questionconnect Pin
Member 1552347621-Feb-22 11:10
MemberMember 1552347621-Feb-22 11:10 
QuestionThank you. Great !!!! Pin
Member 1547405722-Dec-21 15:40
MemberMember 1547405722-Dec-21 15:40 
QuestionHow to monitor multiple devices Pin
Gary Mohnsen 20211-Dec-21 9:18
MemberGary Mohnsen 20211-Dec-21 9:18 
Questionneed some help Pin
Akeel Shouket27-Oct-21 21:59
MemberAkeel Shouket27-Oct-21 21:59 
QuestionProblems uploading a ZK Face String Template to a device Pin
Denzel Ovando7-Oct-21 5:13
MemberDenzel Ovando7-Oct-21 5:13 
QuestionZKTEC Device F22 Pin
Member 1366070229-Sep-21 22:31
MemberMember 1366070229-Sep-21 22:31 
Questionfetch user photo Pin
Member 115595838-Sep-21 1:37
MemberMember 115595838-Sep-21 1:37 
Questionzk mb160 Pin
Nouri Abdelmoumene3-Jun-21 5:04
MemberNouri Abdelmoumene3-Jun-21 5:04 
QuestionSetCommPassword Pin
Member 1519733812-May-21 20:12
MemberMember 1519733812-May-21 20:12 
QuestionHow to bypass the device from Zkemkeeper.dll? Pin
Member 150948759-Mar-21 22:25
MemberMember 150948759-Mar-21 22:25 
Questioninject class library Pin
Member 150887794-Mar-21 4:33
MemberMember 150887794-Mar-21 4:33 
Questionfailed due to the following error: 80040154 Class not registered Pin
Nidhi Tank10-Feb-21 20:03
MemberNidhi Tank10-Feb-21 20:03 
QuestionZKTeco K40 Pin
Juan Miguel Pallo Andoy9-Feb-21 21:53
MemberJuan Miguel Pallo Andoy9-Feb-21 21:53 
QuestionRe: ZKTeco K40 Pin
Member 1327828115-Jun-21 16:16
MemberMember 1327828115-Jun-21 16:16 
AnswerRe: ZKTeco K40 Pin
Abdulmajeed Nomman20-Jul-22 2:03
MemberAbdulmajeed Nomman20-Jul-22 2:03 
Questioni want to pull data from the device between two dates is it possible? Pin
Member 1393039421-Dec-20 18:53
MemberMember 1393039421-Dec-20 18:53 
AnswerRe: i want to pull data from the device between two dates is it possible? Pin
Member 1270232626-Dec-20 6:27
MemberMember 1270232626-Dec-20 6:27 
GeneralRe: i want to pull data from the device between two dates is it possible? Pin
Eugene Busico (Bisayang Programmer)17-Feb-21 8:14
MemberEugene Busico (Bisayang Programmer)17-Feb-21 8:14 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.