Screl.ZKemKeeper 1.1.0

Screl.ZKemKeeper

.NET 8.0 interop package for ZKTeco / ESSL biometric attendance devices. Bundles the managed COM interop assembly and all native DLLs so you don't need a separate SDK install.

Installation

dotnet add package Screl.ZKemKeeper

Or via the NuGet Package Manager in Visual Studio:

Install-Package Screl.ZKemKeeper

What's Included

All native DLLs are automatically copied to your output directory via MSBuild targets — no manual setup needed in your project.

Requirements

• Windows (x86 native DLLs, runs on x64 via WoW64)
• .NET 8.0 or later
• COM Registration — zkemkeeper.dll must be registered once per machine (see below)

COM Registration

The native zkemkeeper.dll is a COM server and must be registered on each target machine. Run as Administrator:

regsvr32 zkemkeeper.dll

The DLL will be in your build output directory after compilation. This is a one-time setup per machine.

Quick Start

Connect to a Device

using zkemkeeper;

CZKEM zk = new CZKEM();
bool connected = zk.Connect_Net("192.168.1.201", 4370);

if (connected)
{
    Console.WriteLine("Connected!");
    zk.Disconnect();
}

Get Device Info

string firmware = "", vendor = "", serialNo = "", mac = "", sdk = "";

zk.GetFirmwareVersion(1, ref firmware);
zk.GetVendor(ref vendor);
zk.GetSDKVersion(ref sdk);
zk.GetSerialNumber(1, out serialNo);
zk.GetDeviceMAC(1, ref mac);

Console.WriteLine($"Firmware: {firmware}");
Console.WriteLine($"Vendor: {vendor}");
Console.WriteLine($"Serial: {serialNo}");

Download Attendance Logs

int machineNumber = 1;

if (zk.ReadGeneralLogData(machineNumber))
{
    string enrollNumber;
    int verifyMode, inOutMode, year, month, day, hour, minute, second, workCode = 0;

    while (zk.SSR_GetGeneralLogData(machineNumber,
        out enrollNumber, out verifyMode, out inOutMode,
        out year, out month, out day, out hour, out minute, out second,
        ref workCode))
    {
        var timestamp = new DateTime(year, month, day, hour, minute, second);
        string direction = inOutMode == 0 ? "IN" : "OUT";
        Console.WriteLine($"User {enrollNumber} — {direction} at {timestamp}");
    }
}

Get All Enrolled Users

int machineNumber = 1;
zk.ReadAllUserID(machineNumber);

string enrollNo, name, password;
int privilege;
bool enabled;

while (zk.SSR_GetAllUserInfo(machineNumber,
    out enrollNo, out name, out password, out privilege, out enabled))
{
    Console.WriteLine($"ID: {enrollNo}, Name: {name}, Enabled: {enabled}");
}

Enroll / Update a User on Device

bool success = zk.SSR_SetUserInfo(1, "101", "John Doe", "", 0, true);

Delete a User from Device

bool success = zk.DeleteUserInfoEx(1, 101);

Real-Time Events (Live Attendance)

int machineNumber = 1;

if (zk.RegEvent(machineNumber, 65535))
{
    zk.OnAttTransactionEx += (enrollNumber, isInValid, attState, verifyMethod,
        year, month, day, hour, minute, second, workCode) =>
    {
        var timestamp = new DateTime(year, month, day, hour, minute, second);
        string direction = attState == 0 ? "IN" : "OUT";
        Console.WriteLine($"[LIVE] {enrollNumber} punched {direction} at {timestamp}");
    };
}

Device Control

int machineNumber = 1;

// Beep the device
zk.Beep(100);

// Open door / relay
zk.ACUnlock(machineNumber, 5000);

// Sync device clock
var now = DateTime.Now;
zk.SetDeviceTime2(machineNumber, now.Year, now.Month, now.Day,
    now.Hour, now.Minute, now.Second);

// Restart device
zk.RestartDevice(machineNumber);

// Clear attendance logs from device
zk.ClearGLog(machineNumber);

Common Methods Reference

Supported Devices

Works with ZKTeco / ESSL biometric devices that use the ZKem SDK, including:

• ZKTeco K-series (K40, K60, K80)
• ZKTeco UA-series (UA100, UA200, UA300, UA400, UA760)
• ZKTeco MB-series (MB160, MB360, MB460)
• ZKTeco uFace series
• ZKTeco SpeedFace series
• ESSL X-series (X990, X7)
• ESSL iFace series
• Other ZKTeco-compatible devices supporting the PULL SDK protocol

Troubleshooting

License

MIT

Author

SCREL INFO PVT LTD