gozk

package module
v0.0.0-...-a631ea7 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 21, 2025 License: MIT Imports: 10 Imported by: 1

README

GOZK

Get inspired from this project

GOZK is a library to help gopher interact with ZK fingerprint machine

Features:

  • Get all check-in list in a ZK fingerprint machine
  • Get all users
  • Reatime capturing events

Getting started

Get source: go get github.com/canhlinh/gozk

Sample:

package main

import (
	"log"
	"os"
	"os/signal"
	"syscall"
	"time"

	"github.com/canhlinh/gozk"
)

func main() {
	zkSocket := gozk.NewZK("192.168.0.201", 4370, 0, gozk.DefaultTimezone)
	if err := zkSocket.Connect(); err != nil {
		panic(err)
	}

	c, err := zkSocket.LiveCapture()
	if err != nil {
		panic(err)
	}

	go func() {
		for event := range c {
			log.Println(event)
		}
	}()

	gracefulQuit(zkSocket.StopCapture)
}

func gracefulQuit(f func()) {
	sigChan := make(chan os.Signal)
	signal.Notify(sigChan, os.Interrupt, syscall.SIGTERM)
	go func() {
		<-sigChan

		log.Println("Stopping...")
		f()

		time.Sleep(time.Second * 1)
		os.Exit(1)
	}()

	for {
		time.Sleep(10 * time.Second) // or runtime.Gosched() or similar per @misterbee
	}
}

Documentation

Index

Constants

View Source 
const (
	USHRT_MAX      = 65535
	MAX_TCP_CHUNK  = 0xFFc0
	MAX_UDP_CHUNK  = 16 * 1024
	UDP_CHUNK_SIZE = 1024 + 8

	CMD_DB_RRQ          = 7  // Read in some kind of data from the machine
	CMD_USER_WRQ        = 8  // Upload the user information (from PC to terminal).
	CMD_USERTEMP_RRQ    = 9  // Read some fingerprint template or some kind of data entirely
	CMD_USERTEMP_WRQ    = 10 // Upload some fingerprint template
	CMD_OPTIONS_RRQ     = 11 // Read in the machine some configuration parameter
	CMD_OPTIONS_WRQ     = 12 // Set machines configuration parameter
	CMD_ATTLOG_RRQ      = 13 // Read all attendance record
	CMD_CLEAR_DATA      = 14 // clear Data
	CMD_CLEAR_ATTLOG    = 15 // Clear attendance records
	CMD_DELETE_USER     = 18 // Delete some user
	CMD_DELETE_USERTEMP = 19 // Delete some fingerprint template
	CMD_CLEAR_ADMIN     = 20 // Cancel the manager
	CMD_USERGRP_RRQ     = 21 // Read the user grouping
	CMD_USERGRP_WRQ     = 22 // Set users grouping
	CMD_USERTZ_RRQ      = 23 // Read the user Time Zone set
	CMD_USERTZ_WRQ      = 24 // Write the user Time Zone set
	CMD_GRPTZ_RRQ       = 25 // Read the group Time Zone set
	CMD_GRPTZ_WRQ       = 26 // Write the group Time Zone set
	CMD_TZ_RRQ          = 27 // Read Time Zone set
	CMD_TZ_WRQ          = 28 // Write the Time Zone
	CMD_ULG_RRQ         = 29 // Read unlocks combination
	CMD_ULG_WRQ         = 30 // write unlocks combination
	CMD_UNLOCK          = 31 // unlock
	CMD_CLEAR_ACC       = 32 // Restores Access Control set to the default condition.
	CMD_CLEAR_OPLOG     = 33 // Delete attendance machines all attendance record.
	CMD_OPLOG_RRQ       = 34 // Read manages the record
	CMD_GET_FREE_SIZES  = 50 // Obtain machines condition, like user recording number and so on
	CMD_ENABLE_CLOCK    = 57 // Ensure the machine to be at the normal work condition
	CMD_STARTVERIFY     = 60 // Ensure the machine to be at the authentication condition
	CMD_STARTENROLL     = 61 // Start to enroll some user, ensure the machine to be at the registration user condition
	CMD_CANCELCAPTURE   = 62 // Make the machine to be at the waiting order status, please refers to the CMD_STARTENROLL description.
	CMD_STATE_RRQ       = 64 // Gain the machine the condition
	CMD_WRITE_LCD       = 66 // Write LCD
	CMD_CLEAR_LCD       = 67 // Clear the LCD captions (clear screen).
	CMD_GET_PINWIDTH    = 69 // Obtain the length of user’s serial number
	CMD_SMS_WRQ         = 70 // Upload the short message.
	CMD_SMS_RRQ         = 71 // Download the short message
	CMD_DELETE_SMS      = 72 // Delete the short message
	CMD_UDATA_WRQ       = 73 // Set user’s short message
	CMD_DELETE_UDATA    = 74 // Delete user’s short message
	CMD_DOORSTATE_RRQ   = 75 // Obtain the door condition
	CMD_WRITE_MIFARE    = 76 // Write the Mifare card
	CMD_EMPTY_MIFARE    = 78 // Clear the Mifare card

	CMD_GET_TIME  = 201 // Obtain the machine time
	CMD_SET_TIME  = 202 // Set machines time
	CMD_REG_EVENT = 500 // Register the event

	CMD_CONNECT        = 1000 // Connections requests
	CMD_EXIT           = 1001 // Disconnection requests
	CMD_ENABLEDEVICE   = 1002 // Ensure the machine to be at the normal work condition
	CMD_DISABLEDEVICE  = 1003 // Make the machine to be at the shut-down condition, generally demonstrates ‘in the work ...’on LCD
	CMD_RESTART        = 1004 // Restart the machine.
	CMD_POWEROFF       = 1005 // Shut-down power source
	CMD_SLEEP          = 1006 // Ensure the machine to be at the idle state.
	CMD_RESUME         = 1007 // Awakens the sleep machine (temporarily not to support)
	CMD_CAPTUREFINGER  = 1009 // Captures fingerprints picture
	CMD_TEST_TEMP      = 1011 // Test some fingerprint exists or does not
	CMD_CAPTUREIMAGE   = 1012 // Capture the entire image
	CMD_REFRESHDATA    = 1013 // Refresh the machine interior data
	CMD_REFRESHOPTION  = 1014 // Refresh the configuration parameter
	CMD_TESTVOICE      = 1017 // Play voice
	CMD_GET_VERSION    = 1100 // Obtain the firmware edition
	CMD_CHANGE_SPEED   = 1101 // Change transmission speed
	CMD_AUTH           = 1102 // Connections authorizations
	CMD_PREPARE_DATA   = 1500 // Prepares to transmit the data
	CMD_DATA           = 1501 // Transmit a data packet
	CMD_FREE_DATA      = 1502 // Clear machines opened buffer
	CMD_PREPARE_BUFFER = 1503 // initialize buffer for partial reads!
	CMD_READ_BUFFER    = 1504 // Read buffer

	CMD_ACK_OK     = 2000 // Return value for order perform successfully
	CMD_ACK_ERROR  = 2001 // Return value for order perform failed
	CMD_ACK_DATA   = 2002 // Return data
	CMD_ACK_RETRY  = 2003 // * Regstered event occorred */
	CMD_ACK_REPEAT = 2004 // Not available
	CMD_ACK_UNAUTH = 2005 // Connection unauthorized

	CMD_ACK_UNKNOWN    = 0xffff // Unkown order
	CMD_ACK_ERROR_CMD  = 0xfffd // Order false
	CMD_ACK_ERROR_INIT = 0xfffc //* Not Initializated */
	CMD_ACK_ERROR_DATA = 0xfffb // Not available

	EF_ATTLOG       = 1        // Be real-time to verify successfully
	EF_FINGER       = (1 << 1) // be real–time to press fingerprint (be real time to return data type sign)
	EF_ENROLLUSER   = (1 << 2) // Be real-time to enroll user
	EF_ENROLLFINGER = (1 << 3) // be real-time to enroll fingerprint
	EF_BUTTON       = (1 << 4) // be real-time to press button
	EF_UNLOCK       = (1 << 5) // be real-time to unlock
	EF_VERIFY       = (1 << 7) // be real-time to verify fingerprint
	EF_FPFTR        = (1 << 8) // be real-time capture fingerprint minutia
	EF_ALARM        = (1 << 9) // Alarm signal

	USER_DEFAULT  = 0
	USER_ENROLLER = 2
	USER_MANAGER  = 6
	USER_ADMIN    = 14

	FCT_ATTLOG    = 1
	FCT_WORKCODE  = 8
	FCT_FINGERTMP = 2
	FCT_OPLOG     = 4
	FCT_USER      = 5
	FCT_SMS       = 6
	FCT_UDATA     = 7

	MACHINE_PREPARE_DATA_1 = 20560 // 0x5050
	MACHINE_PREPARE_DATA_2 = 32130 // 0x7282
)
View Source 
const (
	DefaultTimezone = "Asia/Ho_Chi_Minh"
)

Variables

View Source 
var (
	KeepAlivePeriod   = time.Minute
	ReadSocketTimeout = 3 * time.Second
)

Functions

func LoadLocation 

func LoadLocation(timezone string) *time.Location

func PrintlHex 

func PrintlHex(title string, buf []byte)

PrintlHex printls bytes to console as HEX encoding

Types

type Option 

type Option interface {
	// Type describes the type of the option.
	Type() OptionType

	// Value returns a value used to create this option.
	Value() interface{}
}

Option specifies the task processing behavior.

func WithDeviceID 

func WithDeviceID(deviceID string) Option

func WithPin 

func WithPin(pin int) Option

func WithPort 

func WithPort(port int) Option

func WithTCP 

func WithTCP(useTCP bool) Option

func WithTimezone 

func WithTimezone(tz string) Option

type OptionType 

type OptionType int
const (
	OptionPort OptionType = iota
	OptionPin
	OptionTimezone
	OptionUseTCP
	OptionDeviceID
)

type Response 

type Response struct {
	Status    bool
	Code      int
	TCPLength int
	CommandID int
	Data      []byte
	ReplyID   int
}

func (Response) String 

func (r Response) String() string

type ScanEvent 

type ScanEvent struct {
	DeviceID  string    // An unique identifier for the device
	UserID    int64     // An unique identifier for the user
	Timestamp time.Time // The time when the event was scanned
	Error     error     // An error if the event is invalid
}

func (ScanEvent) String 

func (event ScanEvent) String() string

type User 

type User struct {
}

type ZK 

type ZK struct {
	// contains filtered or unexported fields
}

func NewZK 

func NewZK(host string, opts ...Option) *ZK

func (ZK) Clone 

func (zk ZK) Clone() *ZK

func (*ZK) Connect 

func (zk *ZK) Connect() error

func (*ZK) DisableDevice 

func (zk *ZK) DisableDevice() error

DisableDevice disable the connected device

func (*ZK) Disconnect 

func (zk *ZK) Disconnect() error

Disconnect disconnects out of the machine fingerprint

func (*ZK) EnableDevice 

func (zk *ZK) EnableDevice() error

EnableDevice enables the connected device

func (*ZK) GetAllScannedEvents 

func (zk *ZK) GetAllScannedEvents() ([]*ScanEvent, error)

GetAllScannedEvents returns total attendances from the connected device

func (*ZK) GetFirmwareVersion 

func (zk *ZK) GetFirmwareVersion() (string, error)

func (*ZK) GetProperties 

func (zk *ZK) GetProperties() (*ZKProperties, error)

func (*ZK) GetTime 

func (zk *ZK) GetTime() (time.Time, error)

func (*ZK) GetUsers 

func (zk *ZK) GetUsers() error

GetUsers returns a list of users For now, just run this func. I'll implement this function later on.

func (*ZK) SetTime 

func (zk *ZK) SetTime(t time.Time) error

func (*ZK) StartCapturing 

func (zk *ZK) StartCapturing(outerChan chan<- *ScanEvent) error

func (*ZK) StopCapturing 

func (zk *ZK) StopCapturing()

func (*ZK) UnlockTheDoor 

func (zk *ZK) UnlockTheDoor(delayInSeconds int) error

func (*ZK) WriteLCD 

func (zk *ZK) WriteLCD(text string) error

type ZKProperties 

type ZKProperties struct {
	ID           string
	TCP          bool
	Clock        time.Time
	Version      string
	RecordCap    int
	TotalRecords int
	UserCap      int
	TotalUsers   int
	FingerCap    int
	TotalFingers int
}

func (ZKProperties) Println 

func (properties ZKProperties) Println()

Source Files

View all Source files

Directories

Path Synopsis
examples
GetAllRecords command
LiveCapture command

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.