zk package¶
Submodules¶
zk.base module¶
-
class
zk.base.
ZK
(ip, port=4370, timeout=60, password=0, force_udp=False, ommit_ping=False, verbose=False, encoding='UTF-8')¶ Bases:
object
Clase ZK
-
cancel_capture
()¶ cancel capturing finger
-
clear_attendance
()¶ clear all attendance record
-
clear_data
(clear_type=5)¶ clear all data (include: user, attendance report, finger database ) 2 = FCT_FINGERTMP
-
connect
()¶ connect to the device
-
delete_user
(uid=0, user_id='')¶ delete specific user by uid
-
delete_user_template
(uid=0, temp_id=0, user_id='')¶ Delete specific template for tcp via user_id:
-
disable_device
()¶ disable (lock) device, ensure no activity when process run
-
disconnect
()¶ diconnect from the connected device
-
enable_device
()¶ re-enable the connected device
-
enroll_user
(uid=0, temp_id=0, user_id='')¶ start enroll user we need user_id (uid2)
-
free_data
()¶ clear buffer
-
get_attendance
()¶ return attendance record
-
get_compat_old_firmware
()¶ determine old firmware
-
get_device_name
()¶ return the device name
-
get_extend_fmt
()¶ determine extend fmt
-
get_face_fun_on
()¶ determine extend fmt
-
get_face_version
()¶ return the face version
-
get_firmware_version
()¶ return the firmware version
-
get_fp_version
()¶ return the fingerprint version
-
get_mac
()¶ return the mac
-
get_network_params
()¶
-
get_pin_width
()¶ return the serial number
-
get_platform
()¶ return the platform name
-
get_serialnumber
()¶ return the serial number
-
get_templates
()¶ return array of all fingers
-
get_time
()¶ get Device Time
-
get_user_extend_fmt
()¶ determine user extend fmt
-
get_user_template
(uid, temp_id=0, user_id='')¶ ZKFinger VX10.0 for tcp: command = const.CMD_USERTEMP_RRQ (doesn’t work always) command_string = pack(‘hb’, uid, temp_id)
-
get_users
()¶ return all user
-
live_capture
(new_timeout=10)¶ try live capture of events
-
poweroff
()¶ shutdown the device
-
read_sizes
()¶ read sizes
-
read_with_buffer
(command, fct=0, ext=0)¶ Test read info with buffered command (ZK6: 1503)
-
refresh_data
()¶ shutdown the device
-
reg_event
(flags)¶ reg events,
-
restart
()¶ restart the device
-
save_user_template
(user, fingers=[])¶ save user and template
-
set_sdk_build_1
()¶
-
set_time
(timestamp)¶ set Device time (pass datetime object)
-
set_user
(uid=None, name='', privilege=0, password='', group_id='', user_id='', card=0)¶ create or update user by uid
-
test_voice
(index=0)¶ - play test voice
- 0 acceso correcto / acceso correcto 1 password incorrecto / clave incorrecta 2 la memoria del terminal está llena / acceso denegado 3 usuario invalido /codigo no valido 4 intente de nuevo por favor / intente de nuevo por favor * 5 reintroduszca codigo de usuario /reintroduszca codigo 6 memoria del terminal llena /- 7 memoria de alm fich llena /- 8 huella duplicada / huella duplicada 9 acceso denegado / ya ha sido registrado 10 beep / beep kuko 11 el sistema vuelve al modo de verificacion / beep siren 12 por favor coloque su dedo o acerque tarjeta /- 13 acerca su tarjeta de nuevo /beep bell 14 excedido tiempo p esta operacion /- 15 coloque su dedo de nuevo /- 16 coloque su dedo por ultima vez /- 17 ATN numero de tarjeta está repetida /- 18 proceso de registro correcto * /- 19 borrado correcto /- 20 Numero de usuario / ponga la caja de ojos 21 ATN se ha llegado al max num usuarios /- 22 verificacion de usuarios /- 23 usuario no registrado /- 24 ATN se ha llegado al num max de registros /- 25 ATN la puerta no esta cerrada /- 26 registro de usuarios /- 27 borrado de usuarios /- 28 coloque su dedo /- 29 registre la tarjeta de administrador /- 30 0 /- 31 1 /- 32 2 /- 33 3 /- 34 4 /- 35 5 /- 36 6 /- 37 7 /- 38 8 /- 39 9 /- 40 PFV seleccione numero de usuario /- 41 registrar /- 42 operacion correcta /- 43 PFV acerque su tarjeta /- 43 la tarjeta ha sido registrada /- 45 error en operacion /- 46 PFV acerque tarjeta de administracion, p confirmacion /- 47 descarga de fichajes /- 48 descarga de usuarios /- 49 carga de usuarios /- 50 actualizan de firmware /- 51 ejeuctar ficheros de configuracion /- 52 confirmación de clave de acceso correcta /- 53 error en operacion de tclado /- 54 borrar todos los usuarios /- 55 restaurar terminal con configuracion por defecto /- 56 introduzca numero de usuario /- 57 teclado bloqueado /- 58 error en la gestión de la tarjeta /- 59 establezca una clave de acceso /- 60 pulse el teclado /- 61 zona de accceso invalida /- 62 acceso combinado invĺlido /- 63 verificación multiusuario /- 64 modo de verificación inválido /- 65 - /-
-
unlock
(time=3)¶ Parameters: time – define time in seconds Returns:
-
verify_user
()¶ start verify finger mode (after capture)
-
-
class
zk.base.
ZK_helper
(ip, port=4370)¶ Bases:
object
helper class
-
test_ping
()¶ Returns True if host responds to a ping request
-
test_tcp
()¶
-
test_udp
()¶
-
-
zk.base.
make_commkey
(key, session_id, ticks=50)¶ take a password and session_id and scramble them to send to the time clock. copied from commpro.c - MakeKey
-
zk.base.
safe_cast
(val, to_type, default=None)¶
zk.const module¶
zk.user module¶
Module contents¶
-
class
zk.
ZK
(ip, port=4370, timeout=60, password=0, force_udp=False, ommit_ping=False, verbose=False, encoding='UTF-8')¶ Bases:
object
Clase ZK
-
cancel_capture
()¶ cancel capturing finger
-
clear_attendance
()¶ clear all attendance record
-
clear_data
(clear_type=5)¶ clear all data (include: user, attendance report, finger database ) 2 = FCT_FINGERTMP
-
connect
()¶ connect to the device
-
delete_user
(uid=0, user_id='')¶ delete specific user by uid
-
delete_user_template
(uid=0, temp_id=0, user_id='')¶ Delete specific template for tcp via user_id:
-
disable_device
()¶ disable (lock) device, ensure no activity when process run
-
disconnect
()¶ diconnect from the connected device
-
enable_device
()¶ re-enable the connected device
-
enroll_user
(uid=0, temp_id=0, user_id='')¶ start enroll user we need user_id (uid2)
-
free_data
()¶ clear buffer
-
get_attendance
()¶ return attendance record
-
get_compat_old_firmware
()¶ determine old firmware
-
get_device_name
()¶ return the device name
-
get_extend_fmt
()¶ determine extend fmt
-
get_face_fun_on
()¶ determine extend fmt
-
get_face_version
()¶ return the face version
-
get_firmware_version
()¶ return the firmware version
-
get_fp_version
()¶ return the fingerprint version
-
get_mac
()¶ return the mac
-
get_network_params
()¶
-
get_pin_width
()¶ return the serial number
-
get_platform
()¶ return the platform name
-
get_serialnumber
()¶ return the serial number
-
get_templates
()¶ return array of all fingers
-
get_time
()¶ get Device Time
-
get_user_extend_fmt
()¶ determine user extend fmt
-
get_user_template
(uid, temp_id=0, user_id='')¶ ZKFinger VX10.0 for tcp: command = const.CMD_USERTEMP_RRQ (doesn’t work always) command_string = pack(‘hb’, uid, temp_id)
-
get_users
()¶ return all user
-
live_capture
(new_timeout=10)¶ try live capture of events
-
poweroff
()¶ shutdown the device
-
read_sizes
()¶ read sizes
-
read_with_buffer
(command, fct=0, ext=0)¶ Test read info with buffered command (ZK6: 1503)
-
refresh_data
()¶ shutdown the device
-
reg_event
(flags)¶ reg events,
-
restart
()¶ restart the device
-
save_user_template
(user, fingers=[])¶ save user and template
-
set_sdk_build_1
()¶
-
set_time
(timestamp)¶ set Device time (pass datetime object)
-
set_user
(uid=None, name='', privilege=0, password='', group_id='', user_id='', card=0)¶ create or update user by uid
-
test_voice
(index=0)¶ - play test voice
- 0 acceso correcto / acceso correcto 1 password incorrecto / clave incorrecta 2 la memoria del terminal está llena / acceso denegado 3 usuario invalido /codigo no valido 4 intente de nuevo por favor / intente de nuevo por favor * 5 reintroduszca codigo de usuario /reintroduszca codigo 6 memoria del terminal llena /- 7 memoria de alm fich llena /- 8 huella duplicada / huella duplicada 9 acceso denegado / ya ha sido registrado 10 beep / beep kuko 11 el sistema vuelve al modo de verificacion / beep siren 12 por favor coloque su dedo o acerque tarjeta /- 13 acerca su tarjeta de nuevo /beep bell 14 excedido tiempo p esta operacion /- 15 coloque su dedo de nuevo /- 16 coloque su dedo por ultima vez /- 17 ATN numero de tarjeta está repetida /- 18 proceso de registro correcto * /- 19 borrado correcto /- 20 Numero de usuario / ponga la caja de ojos 21 ATN se ha llegado al max num usuarios /- 22 verificacion de usuarios /- 23 usuario no registrado /- 24 ATN se ha llegado al num max de registros /- 25 ATN la puerta no esta cerrada /- 26 registro de usuarios /- 27 borrado de usuarios /- 28 coloque su dedo /- 29 registre la tarjeta de administrador /- 30 0 /- 31 1 /- 32 2 /- 33 3 /- 34 4 /- 35 5 /- 36 6 /- 37 7 /- 38 8 /- 39 9 /- 40 PFV seleccione numero de usuario /- 41 registrar /- 42 operacion correcta /- 43 PFV acerque su tarjeta /- 43 la tarjeta ha sido registrada /- 45 error en operacion /- 46 PFV acerque tarjeta de administracion, p confirmacion /- 47 descarga de fichajes /- 48 descarga de usuarios /- 49 carga de usuarios /- 50 actualizan de firmware /- 51 ejeuctar ficheros de configuracion /- 52 confirmación de clave de acceso correcta /- 53 error en operacion de tclado /- 54 borrar todos los usuarios /- 55 restaurar terminal con configuracion por defecto /- 56 introduzca numero de usuario /- 57 teclado bloqueado /- 58 error en la gestión de la tarjeta /- 59 establezca una clave de acceso /- 60 pulse el teclado /- 61 zona de accceso invalida /- 62 acceso combinado invĺlido /- 63 verificación multiusuario /- 64 modo de verificación inválido /- 65 - /-
-
unlock
(time=3)¶ Parameters: time – define time in seconds Returns:
-
verify_user
()¶ start verify finger mode (after capture)
-