zklib-ts 1.0.6 → 1.0.7

package/dist/helper/command.d.ts

@@ -17,7 +17,7 @@ export declare enum COMMANDS {
     CMD_ATTLOG_RRQ = 13,
     /** [0x4E, 0x04] Request to begin session using commkey. */
     CMD_AUTH = 1102,
-    /** Disable normal authentication of users. */
+    /** [0x3e, 0x00] Disable normal authentication of users. */
     CMD_CANCELCAPTURE = 62,
     /** Capture fingerprint picture. */
     CMD_CAPTUREFINGER = 1009,
@@ -114,9 +114,9 @@ export declare enum COMMANDS {
     CMD_SMS_RRQ = 71,
     /** Upload short message. */
     CMD_SMS_WRQ = 70,
-    /** Start enroll procedure. */
+    /** [0x3d, 0x00] Start enroll procedure. */
     CMD_STARTENROLL = 61,
-    /** Set the machine to authentication state. */
+    /** [0x3c, 0x00] Set the machine to authentication state. */
     CMD_STARTVERIFY = 60,
     /** Query state. */
     CMD_STATE_RRQ = 64,
@@ -159,7 +159,9 @@ export declare enum COMMANDS {
     /** Prints chars to the device screen. */
     CMD_WRITE_LCD = 66,
     /** Write data to Mifare card. */
-    CMD_WRITE_MIFARE = 76,
+    CMD_WRITE_MIFARE = 76
+}
+export declare enum RTEvent {
     /** Triggered alarm. */
     EF_ALARM = 512,
     /** Attendance entry. */
@@ -180,8 +182,12 @@ export declare enum COMMANDS {
     EF_VERIFY = 128
 }
 export declare enum DISCOVERED_CMD {
+    /** [0x7f, 0x13] */
+    UNKNOWN = 4991,
     /** Returned when the Finger id not exists in the user uid, when attempting to download single finger template */
-    FID_NOT_FOUND = 4993
+    FID_NOT_FOUND = 4993,
+    /** [0x87, 0x13] i guess is an error reply code, is returned when attempint to read options ~isABCPinEnable and ~T9FunOn */
+    UNKNOWN_OR_NOT_SUPPORTED = 4999
 }
 export type CommandKeys = keyof typeof COMMANDS;
 export type CommandValues = typeof COMMANDS[CommandKeys];

package/dist/helper/terminal.d.ts

@@ -0,0 +1,541 @@
+/**
+ * SDK Parameters Enum
+ *
+ * Generated from SDK parameter table with the following structure:
+ * - Keys: Parameter names in uppercase without ~ prefix
+ * - Values: Original parameter names
+ * - JSDoc: Includes description, permissions, and notes
+ */
+export declare enum SdkParameter {
+    /**
+     * Device ID.
+     * Permissions: RW
+     * Notes: Value ranges from 1 to 254.
+     */
+    DEVICE_ID = "DeviceID",
+    /**
+     * Language.
+     * Permissions: RW
+     * Notes: For english it is 97.
+     */
+    NEW_LNG = "NewLng",
+    /**
+     * The machine will enter standby state or power off, after this time elapses.
+     * Permissions: RW
+     * Notes: Given in minutes.
+     */
+    IDLE_MINUTE = "IdleMinute",
+    /**
+     * Lock control time.
+     * Permissions: RW
+     * Notes: Given in seconds.
+     */
+    LOCK_ON = "LockOn",
+    /**
+     * Attendance record quantity alarm.
+     * Permissions: RW
+     * Notes:
+     */
+    ALARM_ATT_LOG = "AlarmAttLog",
+    /**
+     * Operation record quantity alarm.
+     * Permissions: RW
+     * Notes:
+     */
+    ALARM_OP_LOG = "AlarmOpLog",
+    /**
+     * Minimun time to record the same attendance state.
+     * Permissions: RW
+     * Notes: Units are unknown.
+     */
+    ALARM_RE_REC = "AlarmReRec",
+    /**
+     * Baud rate for RS232/485.
+     * Permissions: RW
+     * Notes: Valid values are 1200, 2400, 4800, 9600, 19200, 38400 57600, 115200.
+     */
+    RS232_BAUD_RATE = "RS232BaudRate",
+    /**
+     * Enable flag for network functions.
+     * Permissions: RW
+     * Notes:
+     */
+    NETWORK_ON = "NetworkOn",
+    /**
+     * Enable flag for RS232.
+     * Permissions: RW
+     * Notes:
+     */
+    RS232_ON = "RS232On",
+    /**
+     * Enable flag for RS485.
+     * Permissions: RW
+     * Notes:
+     */
+    RS485_ON = "RS485On",
+    /**
+     * Enable announcements(voice).
+     * Permissions: RW
+     * Notes:
+     */
+    VOICE_ON = "VoiceOn",
+    /**
+     * Perform high-speed comparison.
+     * Permissions: RW
+     * Notes: Value codification is unknown.
+     */
+    MSPEED = "MSpeed",
+    /**
+     * Idle mode.
+     * Permissions: RW
+     * Notes: 87 indicates shutdown and 88 indicates hibernation.
+     */
+    IDLE_POWER = "IdlePower",
+    /**
+     * Automatic shutdown time.
+     * Permissions: RW
+     * Notes: Value 255 indicates the machine to not shutdown automatically.
+     */
+    AUTO_POWER_OFF = "AutoPowerOff",
+    /**
+     * Automatic startup time.
+     * Permissions: RW
+     * Notes: Value 255 indicates the machine to not startup automatically.
+     */
+    AUTO_POWER_ON = "AutoPowerOn",
+    /**
+     * Automatic hibernation time.
+     * Permissions: RW
+     * Notes: Value 255 indicates the machine to not suspend automatically.
+     */
+    AUTO_POWER_SUSPEND = "AutoPowerSuspend",
+    /**
+     * Alarm 1 time.
+     * Permissions: RW
+     * Notes: Value 65535 disables the alarm(t).
+     */
+    AUTO_ALARM1 = "AutoAlarm1",
+    /**
+     * 1:N comparison threshold.
+     * Permissions: RW
+     * Notes: Integer.
+     */
+    MTHRESHOLD = "MThreshold",
+    /**
+     * Registration threshold.
+     * Permissions: RW
+     * Notes: Integer.
+     */
+    ETHRESHOLD = "EThreshold",
+    /**
+     * 1:1 comparison threshold.
+     * Permissions: RW
+     * Notes: Integer.
+     */
+    VTHRESHOLD = "VThreshold",
+    /**
+     * Display matching score during verification.
+     * Permissions: RW
+     * Notes: Bool.
+     */
+    SHOW_SCORE = "ShowScore",
+    /**
+     * Number of people that may unlock the door at the same time.
+     * Permissions: RW
+     * Notes: Integer.
+     */
+    UNLOCK_PERSON = "UnlockPerson",
+    /**
+     * Verify only the card number.
+     * Permissions: RW
+     * Notes: Bool.
+     */
+    ONLY_PIN_CARD = "OnlyPINCard",
+    /**
+     * Network speed.
+     * Permissions: RW
+     * Notes: Value correspondence: 1=100M-H, 4=10M-F, 5=100M-F, 8=Auto, others=10M-H.
+     */
+    HI_SPEED_NET = "HiSpeedNet",
+    /**
+     * Accept only registered cards.
+     * Permissions: RW
+     * Notes: Bool.
+     */
+    MUST_ENROLL = "MustEnroll",
+    /**
+     * Timeout to return to the initial state.
+     * Permissions: RW
+     * Notes: Given in seconds.
+     */
+    TO_STATE = "TOState",
+    /**
+     * Timeout to return to the initial state if there are no inputs after entering PIN.
+     * Permissions: RW
+     * Notes: Given in seconds.
+     */
+    TO_STATE_PIN = "TOState",
+    /**
+     * Timeout to return to the initial state if there are no inputs after entering menu.
+     * Permissions: RW
+     * Notes: Given in seconds.
+     */
+    TO_MENU = "TOMenu",
+    /**
+     * Time format.
+     * Permissions: NA
+     * Notes: Value codification is unknown.
+     */
+    DT_FMT = "DtFmt",
+    /**
+     * Flag for mandatory 1:1 comparison.
+     * Permissions: RW
+     * Notes: Bool.
+     */
+    MUST_1TO1 = "Must1To1",
+    /**
+     * Alarm 2 time.
+     * Permissions: RW
+     * Notes: Value 65535 disables the alarm(t).
+     */
+    AUTO_ALARM2 = "AutoAlarm2",
+    /**
+     * Alarm 3 time.
+     * Permissions: RW
+     * Notes: Value 65535 disables the alarm(t).
+     */
+    AUTO_ALARM3 = "AutoAlarm3",
+    /**
+     * Alarm 4 time.
+     * Permissions: RW
+     * Notes: Value 65535 disables the alarm(t).
+     */
+    AUTO_ALARM4 = "AutoAlarm4",
+    /**
+     * Alarm 5 time.
+     * Permissions: RW
+     * Notes: Value 65535 disables the alarm(t).
+     */
+    AUTO_ALARM5 = "AutoAlarm5",
+    /**
+     * Alarm 6 time.
+     * Permissions: RW
+     * Notes: Value 65535 disables the alarm(t).
+     */
+    AUTO_ALARM6 = "AutoAlarm6",
+    /**
+     * Automatic status changing times.
+     * Permissions: ?
+     * Notes: -1 value indicates that the status will not change automatically.
+     */
+    AS1 = "AS1",
+    /**
+     * Automatic status changing times.
+     * Permissions: ?
+     * Notes: -1 value indicates that the status will not change automatically.
+     */
+    AS2 = "AS2",
+    /**
+     * Automatic status changing times.
+     * Permissions: ?
+     * Notes: -1 value indicates that the status will not change automatically.
+     */
+    AS3 = "AS3",
+    /**
+     * Automatic status changing times.
+     * Permissions: ?
+     * Notes: -1 value indicates that the status will not change automatically.
+     */
+    AS4 = "AS4",
+    /**
+     * Automatic status changing times.
+     * Permissions: ?
+     * Notes: -1 value indicates that the status will not change automatically.
+     */
+    AS5 = "AS5",
+    /**
+     * Automatic status changing times.
+     * Permissions: ?
+     * Notes: -1 value indicates that the status will not change automatically.
+     */
+    AS6 = "AS6",
+    /**
+     * Automatic status changing times.
+     * Permissions: ?
+     * Notes: -1 value indicates that the status will not change automatically.
+     */
+    AS7 = "AS7",
+    /**
+     * Automatic status changing times.
+     * Permissions: ?
+     * Notes: -1 value indicates that the status will not change automatically.
+     */
+    AS8 = "AS8",
+    /**
+     * Automatic status changing times.
+     * Permissions: ?
+     * Notes: -1 value indicates that the status will not change automatically.
+     */
+    AS9 = "AS9",
+    /**
+     * Automatic status changing times.
+     * Permissions: ?
+     * Notes: -1 value indicates that the status will not change automatically.
+     */
+    AS10 = "AS10",
+    /**
+     * Automatic status changing times.
+     * Permissions: ?
+     * Notes: -1 value indicates that the status will not change automatically.
+     */
+    AS11 = "AS11",
+    /**
+     * Automatic status changing times.
+     * Permissions: ?
+     * Notes: -1 value indicates that the status will not change automatically.
+     */
+    AS12 = "AS12",
+    /**
+     * Automatic status changing times.
+     * Permissions: ?
+     * Notes: -1 value indicates that the status will not change automatically.
+     */
+    AS13 = "AS13",
+    /**
+     * Automatic status changing times.
+     * Permissions: ?
+     * Notes: -1 value indicates that the status will not change automatically.
+     */
+    AS14 = "AS14",
+    /**
+     * Automatic status changing times.
+     * Permissions: ?
+     * Notes: -1 value indicates that the status will not change automatically.
+     */
+    AS15 = "AS15",
+    /**
+     * Automatic status changing times.
+     * Permissions: ?
+     * Notes: -1 value indicates that the status will not change automatically.
+     */
+    AS16 = "AS16",
+    /**
+     * Wiegand failure ID.
+     * Permissions: ?
+     * Notes:
+     */
+    WG_FAILED_ID = "WGFailedID",
+    /**
+     * Wiegand duress ID.
+     * Permissions: ?
+     * Notes:
+     */
+    WG_DURESS_ID = "WGDuressID",
+    /**
+     * Wiegand zone bit.
+     * Permissions: ?
+     * Notes:
+     */
+    WG_SITE_CODE = "WGSiteCode",
+    /**
+     * Pulse width of Wiegand outputs.
+     * Permissions: ?
+     * Notes:
+     */
+    WG_PULSE_WIDTH = "WGPulseWidth",
+    /**
+     * Pulse interval for Wiegand outputs.
+     * Permissions: ?
+     * Notes:
+     */
+    WG_PULSE_INTERVAL = "WGPulseInterval",
+    /**
+     * ID of the start sector on the Mifare card where fingerprints are stored.
+     * Permissions: ?
+     * Notes:
+     */
+    RF_START = "RFSStart",
+    /**
+     * Total number of sectors on the Mifare card where fingerprints are stored.
+     * Permissions: ?
+     * Notes:
+     */
+    RF_LEN = "RFSLen",
+    /**
+     * Number of fingerprints stored on the Mifare card.
+     * Permissions: ?
+     * Notes:
+     */
+    RF_FPC = "RFFPC",
+    /**
+     * Forbidden.
+     * Permissions: NA
+     * Notes:
+     */
+    FORBIDDEN = "Forbidden",
+    /**
+     * Wheter to display the attendance status.
+     * Permissions: RW
+     * Notes:
+     */
+    SHOW_STATE = "~ShowState",
+    /**
+     * TCP Port.
+     * Permissions: ?
+     * Notes:
+     */
+    TCP_PORT = "TCPPort",
+    /**
+     * UDP Port.
+     * Permissions: ?
+     * Notes:
+     */
+    UDP_PORT = "UDPPort",
+    /**
+     * Fingerprint algorithm version.
+     * Permissions: R
+     * Notes:
+     */
+    ZK_FP_VERSION = "~ZKFPVersion",
+    /**
+     * Face algorithm version.
+     * Permissions: R
+     * Notes:
+     */
+    ZK_FACE_VERSION = "~ZKFaceVersion",
+    /**
+     * Finger vein version.
+     * Permissions: R
+     * Notes:
+     */
+    ZK_FV_VERSION = "~ZKFVVersion",
+    /**
+     * Face function.
+     * Permissions: R
+     * Notes:
+     */
+    FACE_FUN_ON = "~FaceFunOn",
+    /**
+     * User id max length.
+     * Permissions: R
+     * Notes:
+     */
+    PIN2_WIDTH = "~PIN2Width",
+    /**
+     * Does the user id support chars.
+     * Permissions: R
+     * Notes:
+     */
+    IS_SUPPORT_ABC_PIN = "IsSupportABCPin",
+    /**
+     * ?
+     * Permissions: ?
+     * Notes:
+     */
+    IME_FUN_ON = "IMEFunOn",
+    /**
+     * ?
+     * Permissions: ?
+     * Notes:
+     */
+    IS_SUPPORT_ALARM_EXT = "IsSupportAlarmExt",
+    /**
+     * ?
+     * Permissions: ?
+     * Notes:
+     */
+    DCTZ = "~DCTZ",
+    /**
+     * ?
+     * Permissions: ?
+     * Notes:
+     */
+    DOTZ = "~DOTZ",
+    /**
+   * -
+   * Permissions: ?
+   * Notes:
+   */
+    EXTEND_OP_LOG = "ExtendOPLog",
+    /**
+     * Bool
+     * Permissions: RW
+     * Notes:
+     */
+    WORK_CODE = "WorkCode",
+    /**
+     * Integer
+     * Permissions: RW
+     * Notes:
+     */
+    LANGUAGE = "Language",
+    /**
+     * -
+     * Permissions: ?
+     * Notes:
+     */
+    BIOMETRIC_TYPE = "BiometricType",
+    /**
+     * Bool
+     * Permissions: RW
+     * Notes:
+     */
+    FINGER_FUN_ON = "FingerFunOn",
+    /**
+     * Bool
+     * Permissions: ?
+     * Notes:
+     */
+    IS_ONLY_RF_MACHINE = "~IsOnlyRFMachine",
+    /**
+     * Vendor name
+     * Permissions: ?
+     * Notes:
+     */
+    OEM_VENDOR = "~OEMVendor",
+    /**
+     * Device name
+     * Permissions: ?
+     * Notes:
+     */
+    DEVICE_NAME = "~DeviceName",
+    /**
+     * MAC address
+     * Permissions: ?
+     * Notes:
+     */
+    MAC = "MAC",
+    /**
+     * Serial number
+     * Permissions: ?
+     * Notes:
+     */
+    SERIAL_NUMBER = "~SerialNumber",
+    /**
+     * Date string
+     * Permissions: ?
+     * Notes:
+     */
+    PRODUCT_TIME = "~ProductTime",
+    /**
+     * Bool
+     * Permissions: ?
+     * Notes:
+     */
+    IS_ABC_PIN_ENABLE = "~IsABCPinEnable",
+    /**
+     * Bool
+     * Permissions: ?
+     * Notes:
+     */
+    T9_FUN_ON = "~T9FunOn",
+    /**
+     * Date Time
+     * Permissions: RW
+     */
+    DATETIME = "DateTime",
+    /**
+     *
+     */
+    OS = "~OS"
+}

package/dist/helper/utils.d.ts

@@ -1,17 +1,45 @@
-import { User } from '../models/User';
+import { RTEvent } from "./command";
+import { User } from "../models/User";
 import { Attendance } from "../models/Attendance";
 export interface DeviceInfo {
     userCounts: number;
     logCounts: number;
     logCapacity: number;
 }
-export type UserData28 = Omit<User, 'password' | 'group_id' | 'card' | 'repack29' | 'repack73'>;
+export type UserData28 = Omit<User, "password" | "group_id" | "card" | "repack29" | "repack73">;
 export interface RecordData16 {
     record_time: Date;
     user_id: string;
     ip?: string;
 }
-export type RealTimeLog = RecordData16;
+export interface AlarmEvent {
+    /** Misoperation [0x3A], Tamper [0x37], Exit Button [0x35] */
+    alarm_type: any;
+    /** indicates cause, 20 = Duress, 22 = Passback */
+    alarm_cause: any;
+    /** user serial number */
+    user_uid: any;
+    /** matching way */
+    match_type: any;
+}
+export interface EnrolledFingerEvent {
+    /** Error code */
+    result: number;
+    /** finger size */
+    size: number;
+    /** user pin, storedAsString  */
+    pin: string;
+    /** finger index */
+    fid: number;
+}
+export interface FingerScoreEvent {
+    /** a number between 0 [0x00] and 100 [0x64] indicating the quality ofThe finger during enrolling process */
+    score: number;
+}
+export type RealTimeLog = {
+    event: RTEvent;
+    payload?: RecordData16 | EnrolledFingerEvent | AlarmEvent | FingerScoreEvent;
+};
 interface UDPHeader {
     commandId: number;
     checkSum: number;
@@ -59,12 +87,21 @@ export declare const decodeUserData28: (userData: Buffer) => UserData28;
 export declare const decodeUserData72: (userData: Buffer) => User;
 export declare const decodeRecordData40: (recordData: Buffer) => Attendance;
 export declare const decodeRecordData16: (recordData: Buffer) => RecordData16;
-export declare const decodeRecordRealTimeLog18: (recordData: Buffer) => RealTimeLog;
-export declare const decodeRecordRealTimeLog52: (recordData: Buffer) => RealTimeLog;
+export declare const decodeRecordRealTimeLog18: (recordData: Buffer) => RecordData16;
 export declare const decodeUDPHeader: (header: Buffer) => UDPHeader;
 export declare const decodeTCPHeader: (header: Buffer) => TCPHeader;
 export declare const exportErrorMessage: (commandValue: number) => string;
 export declare const checkNotEventTCP: (data: Buffer) => boolean;
 export declare const checkNotEventUDP: (data: Buffer) => boolean;
+export declare const decodeRTEvent: (data: Buffer) => {
+    event: RTEvent.EF_FINGER;
+    payload?: undefined;
+} | {
+    event: RTEvent.EF_FPFTR;
+    payload: FingerScoreEvent;
+};
+export declare const decodeRecordRealTimeLog52: (recordData: Buffer) => RecordData16;
 export declare const authKey: (comKey: number, sessionId: number) => number[];
+/** Some Tcp packets receibed by the socket client can be merged in one single data event by the OS, and we need to split to handle correctly */
+export declare const splitTcpPackets: (data: Buffer) => Buffer<ArrayBufferLike>[];
 export {};