technophilic/zkteco-laravel-sdk

The technophilic/zkteco-laravel-sdk package provides easy to use functions to ZKTeco Device activities.

v1.1.10 2025-08-19 04:21 UTC

Requires

• php: ^8.0
• laravel/framework: ^9.0|^10.0|^11.0|^12.0

MIT

• Ravi Arya
• Technophilic

README

The technophilic/zkteco-laravel-sdk package provides easy to use functions to ZKTeco Device activities.

Requires: Laravel >= 11.0

License: MIT or later

Installation:

You can install the package via composer:

composer require technophilic/zkteco-laravel-sdk

php artisan zkteco:install

The package will automatically register itself.

You have to enable your php socket if it is not enabled.

Usage

1. Configuration

   Setup these two parameters in you .env file

    ZKTECO_IP = Your Device IP

    ZKTECO_PORT = Device Port (default: 4370)

1. Create a object of ZKTeco class.

    use Technophilic\ZKTecoLaravelSDK\ZKTeco;
  
    $zk = new ZKTeco();

1. Call ZKTeco methods

• Connect

    $zk->connect();   // returns bool

• Disconnect

    $zk->disconnect();   // returns bool

• Device Version

    $zk->version(); 

• Device Os Version

    $zk->osVersion(); 

• Power Off

    $zk->shutdown(); 

• Restart

    $zk->restart(); 

• Sleep

    $zk->sleep(); 

• Resume

    $zk->resume(); 

• Voice Test

    $zk->testVoice(); 

• Platform

    $zk->platform(); 

• Serial Number

    $zk->serialNumber(); 

• Device Name

    $zk->deviceName(); 

• Get Device Time

    $zk->getTime(); 
    
    // returns bool/mixed bool|mixed Format: "Y-m-d H:i:s"

• Set Device Time

    $zk->setTime(); 

    // parameter string $t Format: "Y-m-d H:i:s"

• Get Users

    $zk->getUser(); 

• Set Users

    $zk->setUser(); 

    //    set user

    //    1 s't parameter int $uid Unique ID (max 65535)
    //    2 nd parameter int|string $userid ID in DB (same like $uid, max length = 9, only numbers - depends device setting)
    //    3 rd parameter string $name (max length = 24)
    //    4 th parameter int|string $password (max length = 8, only numbers - depends device setting)
    //    5 th parameter int $role Default Util::LEVEL_USER
    //    6 th parameter int $cardno Default 0 (max length = 10, only numbers

    //    returns bool|mixed

• Clear All Admin

    $zk->clearAdmin(); 

• Clear All Users

    $zk->clearAdmin(); 

• Remove A User

    $zk->removeUser($uid); 

    //  remove a user by $uid
    //  parameter integer $uid
    //  return bool|mixed

• Get Attendance Log

    $zk->getAttendance();   // returns array[]

• Clear Attendance Log

    $zk->clearAttendance(); 

end