Download the PHP package nazamey/zktecodevices without Composer
On this page you can find all versions of the php package nazamey/zktecodevices. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download nazamey/zktecodevices
More information about nazamey/zktecodevices
Files in nazamey/zktecodevices
Package zktecodevices
Short Description Nazamey abstraction layer for ZKTeco attendance devices.
License MIT
Informations about the package zktecodevices
Nazamey ZKTECO Devices
A comprehensive PHP library for connecting to and extracting data from ZKTeco fingerprint attendance devices. This library provides a complete implementation of the ZKTeco protocol, enabling you to retrieve user data, attendance records, and device information.
✨ Features
- 🔌 Full Protocol Support - Complete ZKTeco TCP/UDP communication protocol
- 👥 User Management - Extract user information, privileges, and access cards
- 📊 Attendance Records - Retrieve detailed attendance logs with timestamps
- 🔐 Authentication - Support for password-protected devices
- 📁 Multiple Export Formats - CSV, JSON export capabilities
- 🌐 Cross-Platform - Works on Windows, Linux, and macOS
- 🚀 Production Ready - Tested with real ZKTeco devices
📋 Requirements
- PHP >= 7.0
- PHP Sockets extension (
ext-sockets) - Network access to ZKTeco device
📦 Installation
Via Composer (Recommended)
After Package Installed Add The Below line on the Composer.json
ON This Part
🚀 Quick Start
Basic Usage
Complete Data Extraction
Set Users
� API Documentation
Class Methods
Connection Methods
connect()/testConnection()- Establish or verify connection to the devicedisconnect()- Close the connectionisConnected()- Check connection status
Data Extraction Methods
getUsers()- Retrieve all user recordsgetAttendance()/getAttendanceLogs()- Retrieve attendance recordsgetDeviceInfo()- Get device information and status
Device Control Methods
enableDevice()- Enable the devicedisableDevice()- Disable the devicegetDeviceTime()- Get device current timesetDeviceTime()- Set device time
Data Structures
User Record
Attendance Record
🔧 Configuration
Device Settings
Multiple Password Attempts
� Export Formats
You can design your own export layer on top of this abstraction. A common pattern is:
CSV Files
attendance_DEVICE_TIMESTAMP.csv- Attendance recordsusers_DEVICE_TIMESTAMP.csv- User information
JSON Files
attendance_DEVICE_TIMESTAMP.json- Attendance datausers_DEVICE_TIMESTAMP.json- User data
Summary Report
summary_DEVICE_TIMESTAMP.txt- Complete extraction statistics
🔍 Tested Devices
This library is intended to work with common ZKTeco TCP/IP devices such as:
- ZKTeco K Series (Various firmware versions)
- ZKTeco F18
- ZKTeco MA300
- ZKTeco UFace 800
- ZKTeco IFace 990 Plus
- Various TCP/IP models
�️ Troubleshooting
Common Issues
Connection Failed
- Verify device IP address and network connectivity
- Check if device is powered on and network-enabled
- Ensure PHP sockets extension is enabled:
php -m | grep sockets
Authentication Failed
- Try different passwords:
0,123456,88888 - Check if device requires specific authentication method
No Data Retrieved
- Verify device has users/attendance records
- Some devices may need specific timing between operations
- Try different connection methods (TCP/UDP)
🤝 Contributing
Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
Development Setup
- Clone the repository
- Install dependencies:
composer install - Run tests:
composer test - Check code style:
composer analyse
📄 License
This project is licensed under the MIT License - see the LICENSE file for details.
All versions of zktecodevices with dependencies
ext-sockets Version *