rbzk 0.1.3 → 0.1.6

data/lib/rbzk/cli/commands.rb

@@ -5,6 +5,7 @@ require 'thor'
 require 'yaml'
 require 'fileutils'
 require 'date'
+require 'time'
 require 'rbzk'
 require 'rbzk/cli/config'
 require 'terminal-table'
@@ -75,6 +76,19 @@ module RBZK
         end
       end
 
+      desc "refresh [IP]", "Refresh device data"
+
+      def refresh(ip = nil)
+        # Use IP from options if not provided as argument
+        ip ||= options[:ip] || @config['ip']
+
+        with_connection(ip, options) do |conn|
+          puts "Refreshing device data..."
+          result = conn.refresh_data
+          puts "✓ Device data refreshed successfully!" if result
+        end
+      end
+
       desc "users [IP]", "Get users from the device"
 
       def users(ip = nil)
@@ -87,43 +101,33 @@ module RBZK
         end
       end
 
-      desc "logs [IP]", "Get attendance logs"
-      method_option :today, type: :boolean, desc: "Get only today's logs"
-      method_option :yesterday, type: :boolean, desc: "Get only yesterday's logs"
-      method_option :week, type: :boolean, desc: "Get this week's logs"
-      method_option :month, type: :boolean, desc: "Get this month's logs"
-      method_option :start_date, type: :string, desc: "Start date for custom range (YYYY-MM-DD)"
-      method_option :end_date, type: :string, desc: "End date for custom range (YYYY-MM-DD)"
-      method_option :limit, type: :numeric, default: 25, desc: "Limit the number of logs displayed (default: 25, use 0 for all)"
-
       # Add aliases for common log commands
       desc "logs-today [IP]", "Get today's attendance logs"
       map "logs-today" => "logs"
 
       def logs_today(ip = nil)
-
-        invoke :logs, [ ip ], today: true
+        invoke :logs, [ ip ], { today: true }.merge(options)
       end
 
       desc "logs-yesterday [IP]", "Get yesterday's attendance logs"
       map "logs-yesterday" => "logs"
 
       def logs_yesterday(ip = nil)
-        invoke :logs, [ ip ], yesterday: true
+        invoke :logs, [ ip ], { yesterday: true }.merge(options)
       end
 
       desc "logs-week [IP]", "Get this week's attendance logs"
       map "logs-week" => "logs"
 
       def logs_week(ip = nil)
-        invoke :logs, [ ip ], week: true
+        invoke :logs, [ ip ], { week: true }.merge(options)
       end
 
       desc "logs-month [IP]", "Get this month's attendance logs"
       map "logs-month" => "logs"
 
       def logs_month(ip = nil)
-        invoke :logs, [ ip ], month: true
+        invoke :logs, [ ip ], { month: true }.merge(options)
       end
 
       desc "logs-all [IP]", "Get all attendance logs without limit"
@@ -177,10 +181,19 @@ module RBZK
       def logs_custom(start_date, end_date, ip = nil)
         # Use IP from options if not provided as argument
         ip ||= options[:ip] || @config['ip']
-        invoke :logs, [ ip ], start_date: start_date, end_date: end_date
+        invoke :logs, [ ip ], { start_date: start_date, end_date: end_date }.merge(options)
       end
 
-      desc "logs [IP]", "Get all attendance logs"
+      desc "logs [IP]", "Get attendance logs"
+      method_option :today, type: :boolean, desc: "Get only today's logs"
+      method_option :yesterday, type: :boolean, desc: "Get only yesterday's logs"
+      method_option :week, type: :boolean, desc: "Get this week's logs"
+      method_option :month, type: :boolean, desc: "Get this month's logs"
+      method_option :start_date, type: :string, desc: "Start date for custom range (YYYY-MM-DD)"
+      method_option :end_date, type: :string, desc: "End date for custom range (YYYY-MM-DD)"
+      method_option :start_time, type: :string, desc: "Start time for custom range (HH:MM)"
+      method_option :end_time, type: :string, desc: "End time for custom range (HH:MM)"
+      method_option :limit, type: :numeric, default: 25, desc: "Limit the number of logs displayed (default: 25, use 0 for all)"
 
       def logs(ip = nil)
         # Use IP from options if not provided as argument
@@ -195,21 +208,21 @@ module RBZK
           # Filter logs based on options
           title = if options[:today]
                     today = Date.today
-                    logs = filter_logs_by_date(logs, today, today)
+                    logs = filter_logs_by_datetime(logs, today, today, options[:start_time], options[:end_time])
                     "Today's Attendance Logs (#{today})"
                   elsif options[:yesterday]
                     yesterday = Date.today - 1
-                    logs = filter_logs_by_date(logs, yesterday, yesterday)
+                    logs = filter_logs_by_datetime(logs, yesterday, yesterday, options[:start_time], options[:end_time])
                     "Yesterday's Attendance Logs (#{yesterday})"
                   elsif options[:week]
                     today = Date.today
                     start_of_week = today - today.wday
-                    logs = filter_logs_by_date(logs, start_of_week, today)
+                    logs = filter_logs_by_datetime(logs, start_of_week, today, options[:start_time], options[:end_time])
                     "This Week's Attendance Logs (#{start_of_week} to #{today})"
                   elsif options[:month]
                     today = Date.today
                     start_of_month = Date.new(today.year, today.month, 1)
-                    logs = filter_logs_by_date(logs, start_of_month, today)
+                    logs = filter_logs_by_datetime(logs, start_of_month, today, options[:start_time], options[:end_time])
                     "This Month's Attendance Logs (#{start_of_month} to #{today})"
                   elsif options[:start_date] && options[:end_date]
                     begin
@@ -219,8 +232,8 @@ module RBZK
                       # Print debug info
                       puts "Filtering logs from #{start_date} to #{end_date}..." if options[:verbose]
 
-                      # Use the filter_logs_by_date method
-                      logs = filter_logs_by_date(logs, start_date, end_date)
+                      # Use the filter_logs_by_datetime method
+                      logs = filter_logs_by_datetime(logs, start_date, end_date, options[:start_time], options[:end_time])
 
                       "Attendance Logs (#{start_date} to #{end_date})"
                     rescue ArgumentError
@@ -235,8 +248,8 @@ module RBZK
                       # Print debug info
                       puts "Filtering logs from #{start_date} onwards..." if options[:verbose]
 
-                      # Use the filter_logs_by_date method
-                      logs = filter_logs_by_date(logs, start_date, end_date)
+                      # Use the filter_logs_by_datetime method
+                      logs = filter_logs_by_datetime(logs, start_date, end_date, options[:start_time], options[:end_time])
 
                       "Attendance Logs (#{start_date} to #{end_date})"
                     rescue ArgumentError
@@ -252,8 +265,8 @@ module RBZK
                       # Print debug info
                       puts "Filtering logs from #{start_date} to #{end_date}..." if options[:verbose]
 
-                      # Use the filter_logs_by_date method
-                      logs = filter_logs_by_date(logs, start_date, end_date)
+                      # Use the filter_logs_by_datetime method
+                      logs = filter_logs_by_datetime(logs, start_date, end_date, options[:start_time], options[:end_time])
 
                       "Attendance Logs (#{start_date} to #{end_date})"
                     rescue ArgumentError
@@ -327,6 +340,236 @@ module RBZK
         end
       end
 
+      desc "unlock [IP]", "Unlock the door"
+      method_option :time, type: :numeric, default: 3, desc: "Unlock time in seconds (default: 3)"
+      map "unlock" => :unlock_door
+
+      def unlock_door(ip = nil)
+        # Use IP from options if not provided as argument
+        ip ||= options[:ip] || @config['ip']
+
+        # Get the unlock time
+        time = options[:time] || 3
+
+        with_connection(ip, options) do |conn|
+          puts "Unlocking door for #{time} seconds..."
+          result = conn.unlock(time)
+          puts "✓ Door unlocked successfully!" if result
+        end
+      end
+
+      desc "door-state [IP]", "Get the door lock state"
+      map "door-state" => :door_state
+
+      def door_state(ip = nil)
+        # Use IP from options if not provided as argument
+        ip ||= options[:ip] || @config['ip']
+
+        with_connection(ip, options) do |conn|
+          state = conn.get_lock_state
+          puts "Door state: #{state ? 'Open' : 'Closed'}"
+        end
+      end
+
+      desc "write-lcd [IP] LINE_NUMBER TEXT", "Write text to LCD display"
+      map "write-lcd" => :write_lcd
+
+      def write_lcd(line_number, text, ip = nil)
+        # Use IP from options if not provided as argument
+        ip ||= options[:ip] || @config['ip']
+
+        # Convert line_number to integer
+        line_number = line_number.to_i
+
+        with_connection(ip, options) do |conn|
+          puts "Writing text to LCD line #{line_number}..."
+          result = conn.write_lcd(line_number, text)
+          puts "✓ Text written to LCD successfully!" if result
+        end
+      end
+
+      desc "clear-lcd [IP]", "Clear the LCD display"
+      map "clear-lcd" => :clear_lcd
+
+      def clear_lcd(ip = nil)
+        # Use IP from options if not provided as argument
+        ip ||= options[:ip] || @config['ip']
+
+        with_connection(ip, options) do |conn|
+          puts "Clearing LCD display..."
+          result = conn.clear_lcd
+          puts "✓ LCD cleared successfully!" if result
+        end
+      end
+
+      desc "add-user [IP]", "Add or update a user"
+      method_option :uid, type: :numeric, desc: "User ID (generated by device if not provided)"
+      method_option :name, type: :string, default: "", desc: "User name"
+      method_option :privilege, type: :numeric, default: 0, desc: "User privilege (0=User, 14=Admin)"
+      method_option :password, type: :string, default: "", desc: "User password"
+      method_option :group_id, type: :string, default: "", desc: "Group ID"
+      method_option :user_id, type: :string, default: "", desc: "Custom user ID"
+      method_option :card, type: :numeric, default: 0, desc: "Card number"
+      map "add-user" => :add_user
+
+      def add_user(ip = nil)
+        # Use IP from options if not provided as argument
+        ip ||= options[:ip] || @config['ip']
+
+        with_connection(ip, options) do |conn|
+          puts "Adding/updating user..."
+
+          result = conn.set_user(
+            uid: options[:uid],
+            name: options[:name] || "",
+            privilege: options[:privilege] || 0,
+            password: options[:password] || "",
+            group_id: options[:group_id] || "",
+            user_id: options[:user_id] || "",
+            card: options[:card] || 0
+          )
+
+          puts "✓ User added/updated successfully!" if result
+        end
+      end
+
+      desc "delete-user [IP]", "Delete a user"
+      method_option :uid, type: :numeric, desc: "User ID (generated by device)"
+      method_option :user_id, type: :string, desc: "Custom user ID"
+      map "delete-user" => :delete_user
+
+      def delete_user(ip = nil)
+        # Use IP from options if not provided as argument
+        ip ||= options[:ip] || @config['ip']
+
+        # Ensure at least one of uid or user_id is provided
+        if options[:uid].nil? && (options[:user_id].nil? || options[:user_id].empty?)
+          puts "Error: You must provide either --uid"
+          return
+        end
+
+        with_connection(ip, options) do |conn|
+          puts "Deleting user..."
+
+          # Use the User object with delete_user
+          result = conn.delete_user(uid: options[:uid])
+
+          if result
+            puts "✓ User deleted successfully!"
+          else
+            puts "✗ User not found or could not be deleted."
+          end
+        end
+      end
+
+      desc "get-templates [IP]", "Get all fingerprint templates"
+      map "get-templates" => :get_templates
+
+      def get_templates(ip = nil)
+        # Use IP from options if not provided as argument
+        ip ||= options[:ip] || @config['ip']
+
+        with_connection(ip, options) do |conn|
+          puts "Getting fingerprint templates..."
+          templates = conn.get_templates
+
+          if templates && !templates.empty?
+            puts "✓ Found #{templates.size} fingerprint templates:"
+
+            # Use Terminal::Table for pretty output
+            table = ::Terminal::Table.new do |t|
+              t.title = "Fingerprint Templates"
+              t.headings = [ 'UID', 'Finger ID', 'Valid', 'Size' ]
+
+              templates.each do |template|
+                t << [
+                  template.uid,
+                  template.fid,
+                  template.valid == 1 ? 'Yes' : 'No',
+                  template.size
+                ]
+              end
+            end
+
+            puts table
+          else
+            puts "✓ No fingerprint templates found"
+          end
+        end
+      end
+
+      desc "get-user-template [IP]", "Get a specific user's fingerprint template"
+      method_option :uid, type: :numeric, desc: "User ID (generated by device)"
+      method_option :user_id, type: :string, desc: "Custom user ID"
+      method_option :finger_id, type: :numeric, default: 0, desc: "Finger ID (0-9)"
+      map "get-user-template" => :get_user_template
+
+      def get_user_template(ip = nil)
+        # Use IP from options if not provided as argument
+        ip ||= options[:ip] || @config['ip']
+
+        # Ensure at least one of uid or user_id is provided
+        if options[:uid].nil? && (options[:user_id].nil? || options[:user_id].empty?)
+          puts "Error: You must provide either --uid or --user-id"
+          return
+        end
+
+        with_connection(ip, options) do |conn|
+          puts "Getting user fingerprint template..."
+
+          # Extract parameters from options
+          uid = options[:uid] || 0
+          user_id = options[:user_id] || ""
+          finger_id = options[:finger_id] || 0
+
+          template = conn.get_user_template(uid: uid, temp_id: finger_id, user_id: user_id)
+
+          if template
+            puts "✓ Found fingerprint template:"
+            puts "  User ID: #{template.uid}"
+            puts "  Finger ID: #{template.fid}"
+            puts "  Valid: #{template.valid == 1 ? 'Yes' : 'No'}"
+            puts "  Size: #{template.size} bytes"
+          else
+            puts "✗ Fingerprint template not found"
+          end
+        end
+      end
+
+      desc "delete-template [IP]", "Delete a specific fingerprint template"
+      method_option :uid, type: :numeric, desc: "User ID (generated by device)"
+      method_option :user_id, type: :string, desc: "Custom user ID"
+      method_option :finger_id, type: :numeric, default: 0, desc: "Finger ID (0-9)"
+      map "delete-template" => :delete_template
+
+      def delete_template(ip = nil)
+        # Use IP from options if not provided as argument
+        ip ||= options[:ip] || @config['ip']
+
+        # Ensure at least one of uid or user_id is provided
+        if options[:uid].nil? && (options[:user_id].nil? || options[:user_id].empty?)
+          puts "Error: You must provide either --uid or --user-id"
+          return
+        end
+
+        with_connection(ip, options) do |conn|
+          puts "Deleting fingerprint template..."
+
+          # Extract parameters from options
+          uid = options[:uid] || 0
+          user_id = options[:user_id] || ""
+          finger_id = options[:finger_id] || 0
+
+          result = conn.delete_user_template(uid: uid, temp_id: finger_id, user_id: user_id)
+
+          if result
+            puts "✓ Fingerprint template deleted successfully!"
+          else
+            puts "✗ Fingerprint template not found or could not be deleted"
+          end
+        end
+      end
+
       desc "test-voice [IP]", "Test the device voice"
       method_option :index, type: :numeric, desc: "Sound index to play (0-35, default: 0)"
       map "test-voice" => :test_voice
@@ -376,6 +619,42 @@ module RBZK
         end
       end
 
+      desc "restart [IP]", "Restart the device"
+
+      def restart(ip = nil)
+        # Use IP from options if not provided as argument
+        ip ||= options[:ip] || @config['ip']
+
+        if yes?("Are you sure you want to restart the device? (y/N)")
+          with_connection(ip, options.merge(skip_disconnect_after_yield: true)) do |conn|
+            puts "Restarting device..."
+            result = conn.restart
+            puts "✓ Device restart command sent successfully!" if result
+            puts "The device will restart now. You may need to wait a few moments before reconnecting."
+          end
+        else
+          puts "Operation cancelled."
+        end
+      end
+
+      desc "poweroff [IP]", "Power off the device"
+
+      def poweroff(ip = nil)
+        # Use IP from options if not provided as argument
+        ip ||= options[:ip] || @config['ip']
+
+        if yes?("Are you sure you want to power off the device? (y/N)")
+          with_connection(ip, options.merge(skip_disconnect_after_yield: true)) do |conn|
+            puts "Powering off device..."
+            result = conn.poweroff
+            puts "✓ Device poweroff command sent successfully!" if result
+            puts "The device will power off now. You will need to manually power it back on."
+          end
+        else
+          puts "Operation cancelled."
+        end
+      end
+
       desc "config", "Show current configuration"
 
       def config
@@ -425,26 +704,30 @@ module RBZK
       end
 
       def with_connection(ip, options = {})
-        puts "Connecting to ZKTeco device at #{ip}:#{options[:port] || @config['port'] || 4370}..."
+        local_opts = options.dup # Use a copy for local modifications and access
+        skip_disconnect = local_opts.delete(:skip_disconnect_after_yield) || false
+
+        puts "Connecting to ZKTeco device at #{ip}:#{local_opts[:port] || @config['port'] || 4370}..." # Use local_opts
         puts "Please ensure the device is powered on and connected to the network."
 
+        conn = nil # Initialize conn for safety in ensure block
         begin
           # Create ZK instance with options from config and command line
           zk_options = {
-            port: options[:port] || @config['port'] || 4370,
-            timeout: options[:timeout] || @config['timeout'] || 30,
-            password: options[:password] || @config['password'] || 0,
-            verbose: options[:verbose] || @config['verbose'] || false,
-            force_udp: options[:force_udp] || @config['force_udp'] || false,
-            omit_ping: options[:no_ping] || @config['no_ping'] || false,
-            encoding: options[:encoding] || @config['encoding'] || 'UTF-8'
+            port: local_opts[:port] || @config['port'] || 4370, # Use local_opts
+            timeout: local_opts[:timeout] || @config['timeout'] || 30, # Use local_opts
+            password: local_opts[:password] || @config['password'] || 0, # Use local_opts
+            verbose: local_opts[:verbose] || @config['verbose'] || false, # Use local_opts
+            force_udp: local_opts[:force_udp] || @config['force_udp'] || false, # Use local_opts
+            omit_ping: local_opts[:no_ping] || @config['no_ping'] || false, # Use local_opts
+            encoding: local_opts[:encoding] || @config['encoding'] || 'UTF-8' # Use local_opts
           }
 
           zk = RBZK::ZK.new(ip, **zk_options)
           conn = zk.connect
 
           if conn.connected?
-            puts "✓ Connected successfully!" unless options[:quiet]
+            puts "✓ Connected successfully!" unless local_opts[:quiet] # Use local_opts
             yield conn if block_given?
           else
             puts "✗ Failed to connect to device."
@@ -458,12 +741,16 @@ module RBZK
         rescue => e
           puts "✗ Unexpected Error: #{e.message}"
           puts "An unexpected error occurred while communicating with the device."
-          puts e.backtrace.join("\n") if options[:verbose]
+          puts e.backtrace.join("\n") if local_opts[:verbose] # Use local_opts
         ensure
           if conn && conn.connected?
-            puts "Disconnecting from device..." unless options[:quiet]
-            conn.disconnect
-            puts "✓ Disconnected" unless options[:quiet]
+            if skip_disconnect
+              puts "Skipping disconnect as device is undergoing restart/poweroff." unless local_opts[:quiet] # Use local_opts
+            else
+              puts "Disconnecting from device..." unless local_opts[:quiet] # Use local_opts
+              conn.disconnect
+              puts "✓ Disconnected" unless local_opts[:quiet] # Use local_opts
+            end
           end
         end
       end
@@ -496,31 +783,26 @@ module RBZK
         end
       end
 
-      def filter_logs_by_date(logs, start_date, end_date)
-        # Convert Date objects to strings for comparison
-        total_logs = logs.size
-        start_date_str = start_date.strftime('%Y-%m-%d')
-        end_date_str = end_date.strftime('%Y-%m-%d')
+      def filter_logs_by_datetime(logs, start_date, end_date, start_time = nil, end_time = nil)
+        start_datetime_str = "#{start_date.strftime('%Y-%m-%d')} #{start_time || '00:00:00'}"
+        end_datetime_str = "#{end_date.strftime('%Y-%m-%d')} #{end_time || '23:59:59'}"
+
+        start_datetime = Time.parse(start_datetime_str)
+        end_datetime = Time.parse(end_datetime_str)
 
         if options[:verbose]
-          puts "Filtering logs from #{start_date_str} to #{end_date_str}..."
-          puts "Total logs before filtering: #{total_logs}"
+          puts "Filtering logs from #{start_datetime} to #{end_datetime}..."
+          puts "Total logs before filtering: #{logs.size}"
         end
 
-        # Filter logs by date range using string comparison
-        filtered_logs = []
-        logs.each do |log|
-          log_date_str = log.timestamp.strftime('%Y-%m-%d')
-          if log_date_str >= start_date_str && log_date_str <= end_date_str
-            filtered_logs << log
-          end
+        filtered_logs = logs.select do |log|
+          log.timestamp >= start_datetime && log.timestamp <= end_datetime
         end
 
         if options[:verbose]
-          puts "Filtered logs: #{filtered_logs.size} of #{total_logs}"
+          puts "Filtered logs: #{filtered_logs.size} of #{logs.size}"
         end
 
-        # Return the filtered logs
         filtered_logs
       end
 

data/lib/rbzk/finger.rb

@@ -2,13 +2,24 @@
 
 module RBZK
   class Finger
-    attr_accessor :uid, :fid, :valid, :template
+    attr_accessor :uid, :fid, :valid, :template, :size
 
     def initialize(uid, fid, valid, template = "")
       @uid = uid
       @fid = fid
       @valid = valid
       @template = template
+      @size = template.length
+    end
+
+    # Pack the finger data into a binary string (full data)
+    def repack
+      [@size + 6, @uid, @fid, @valid].pack('S<S<CC') + @template
+    end
+
+    # Pack only the template data into a binary string
+    def repack_only
+      [@size].pack('S<') + @template
     end
 
     def to_s

data/lib/rbzk/user.rb

@@ -27,6 +27,40 @@ module RBZK
       @card = card
     end
 
+    # Pack the user data into a binary string for ZK6 devices (size 29)
+    def repack29
+      [2, @uid, @privilege].pack('CS<C') +
+      @password.encode(@@encoding, invalid: :replace, undef: :replace).ljust(5, "\x00")[0...5] +
+      @name.encode(@@encoding, invalid: :replace, undef: :replace).ljust(8, "\x00")[0...8] +
+      [@card, 0, @group_id.to_i, 0, @user_id.to_i].pack('L<CS<S<L<')
+    end
+
+    # Pack the user data into a binary string for ZK8 devices (size 73)
+    def repack73
+      [2, @uid, @privilege].pack('CS<C') +
+      @password.encode(@@encoding, invalid: :replace, undef: :replace).ljust(8, "\x00")[0...8] +
+      @name.encode(@@encoding, invalid: :replace, undef: :replace).ljust(24, "\x00")[0...24] +
+      [@card, 1].pack('L<C') +
+      @group_id.to_s.encode(@@encoding, invalid: :replace, undef: :replace).ljust(7, "\x00")[0...7] +
+      "\x00" +
+      @user_id.to_s.encode(@@encoding, invalid: :replace, undef: :replace).ljust(24, "\x00")[0...24]
+    end
+
+    # Check if the user is disabled
+    def is_disabled?
+      (@privilege & 1) != 0
+    end
+
+    # Check if the user is enabled
+    def is_enabled?
+      !is_disabled?
+    end
+
+    # Get the user type
+    def usertype
+      @privilege & 0xE
+    end
+
     def to_s
       "#{@uid} #{@user_id} #{@name} #{@privilege} #{@password} #{@group_id} #{@card}"
     end

data/lib/rbzk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RBZK
-  VERSION = "0.1.3"
+  VERSION = '0.1.6'
 end