README
¶
zkteco
Package zkteco parses the XLS files outputted from zkteco device(KQ803) and update the employee attendance data in Redis.
Data in Redis
-
The attendance data of each emplyee are stored in a Redis Hash.
-
Key is
kaoqin:EmplyeeName. e.g.kaoqin:Jack.redis-cli --raw 127.0.0.1:6379> keys * kaoqin:Jack kaoqin:Bob kaoqin:Mary -
Field of the Redis Hash has two type.
-
date:inrepresents the clock in time of the date. Date format is YYYY-MM-DD. -
date:outrepresents the clock out time of the date.127.0.0.1:6379> HGETALL kaoqin:Jack 2017-07-01:in 18:02 2017-07-02:in 16:59 2017-07-03:in 18:17 2017-07-04:in 08:58 2017-07-07:in 11:56 2017-07-07:out 20:36 -
If there's only one clock time for a date, it will be recognized as clock in time.
-
-
Value of each field is the clock in / out time. Time format: HH:MM.
Examples
// Open a DB by given Redis address and password.
db := zkteco.Open(":6379", "")
// Get absolute path of example attendance xls file.
f := "/home/xx/campus-a.xls"
// Update attendance.
db.UpdateAttendance(f)
Documentation
Requirements
- zkteco requires libxls and xls2csv-go
- You may find installation guide in xls2csv-go.
- You may also find instructions in .travis.yml to build or test your apps.
License
Documentation
¶
Overview ¶
Package zkteco parses the XLS files outputted from zkteco device(KQ803) and update the employee attendance data in Redis.
Example ¶
package main
import (
"log"
"path"
"github.com/northbright/pathhelper"
"github.com/northbright/zkteco"
)
func main() {
// Set debug mode to true.
zkteco.SetDebugMode(true)
// Open a DB by given Redis address and password.
db := zkteco.Open(":6379", "")
// Get absolute path of example attendance xls file.
f, _ := pathhelper.GetCurrentExecDir()
f = path.Join(f, "files/campus-a.xls")
// Update attendance.
err := db.UpdateAttendance(f)
if err != nil {
log.Printf("db.UpdateAttendance() failed: %v", err)
return
}
log.Printf("db.UpdateAttendance ok")
}
Output:
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetRedisConn ¶
GetRedisConn gets the Redis connection.
Types ¶
type DB ¶
type DB struct {
// RedisAddr is Redis address. e.g. ":6379".
RedisAddr string
// RedisPassword is Redis password.
RedisPassword string
}
DB represents zkteco attendance database.
func (*DB) UpdateAttendance ¶
UpdateAttendance updates employees' attendance data by XLS file which is outputted by zkteco device.
Source Files