rfbeam 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b79b7e0fa02dd099a126d18b8eb2de0d6d4c6bf3396891d42082851851160dd
-  data.tar.gz: 98bb8d9c52705fb542785adbbb798330af16fde06498acddbd12156c9eece97c
+  metadata.gz: 698385739f70574b698a117af8c749a21ebd75d9c3b0abaa39447ebd869324ef
+  data.tar.gz: 11f47d264d76f5a5b968c8f7cb49152602359383e8a0cf20a16564a2b2e808f3
 SHA512:
-  metadata.gz: 35619295790790e9d3ffb3d80dab111cae4650e083d227ec1787a96fc0c8741369463d1678ae2256413ecbf0dd104078328d32a1e76b6278fea817742cecefa3
-  data.tar.gz: 39ea4038c1175e9d4f598c1662c1f0152bee7d14fc6222fff29cf6e4b76af2886d57138003feb26d1e25ee45485972f600f7eb99c66e62770e2c7dcbfb4dded3
+  metadata.gz: 58b01ae8497458e6e4f238afcc64a38cd925312e7893b4e65a854407f34694493b002e5721a9980129d586370cc51abfca5e5cd238a51cf33dfb890f40992479
+  data.tar.gz: 48934f301cb4eb9ac2cdb695d08dfd544cc9e6ea16f130ab6b30b182c35ee1630d5ad2574c4bab081656f51ce4208857c92a2dfd6d2925639c303a3c66c0d1ae

data/.tool-versions

@@ -1 +1 @@
-ruby 2.7.6
+ruby 3.2.1

data/CHANGELOG.md

@@ -1,4 +1,8 @@
-## [0.3.1] - 2023-3-28
+## [0.3.4] - 2023-3-28
+
+ - Added a formatted option to pdat
+
+## [0.3.2] - 2023-3-28
 
 - Added setters for Parameter settings
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rfbeam (0.3.3)
+    rfbeam (0.3.4)
       activesupport (~> 6.1.0)
       rubyserial (~> 0.6.0)
       thor (~> 1.2.1)

data/lib/rfbeam/kld7/app_commands.rb

@@ -1,40 +1,40 @@
 module RfBeam
   module KLD7
-  
-    def detection?
-      data = ddat
-      (data[2] == 1)
-    end
-    
-    def config
-      puts formatted_grps(grps)
-    end
 
-    # Get the radar parameter structure
-    def grps
-      command = ['GRPS', 0]
-      write command.pack('a4L')
-      check_response
-      read(50).unpack('a4LA19C8c2C4cCCCCSCC')
+    # Base Frequency, 0 = low, 1 = middle (default), 2 = high
+    def base_frequency
+      data = grps
+      data[3]
     end
+    alias rbfr base_frequency
+    
     
-    # Base Frequency, 0 = low, 1 = middle (default), 2 = high
     def set_base_frequency(frequency = 1)
-      set_parameter(:rbfr, frequency, :uint8)
+      value = case frequency
+        when 0, :low, 'low'
+          0
+        when 1, :middle, 'middle'
+          1
+        when 2, :high, 'high'
+          2
+        else
+          raise ArgumentError, "Invalid arg: '#{frequency}'"
+        end
+      set_parameter(:rbfr, value, :uint8)
     end
-    alias_method :rbfr, :set_base_frequency
+    alias set_rbfr set_base_frequency
     
     # Maximum Speed, 0 = 12.5km/h, 1 = 25km/h (default), 2 = 50km/h, 3 = 100km/h
     def set_max_speed(speed = 1)
       set_parameter :rspi, speed, :uint8
     end
-    alias_method :rspi, :set_max_speed
+    alias rspi set_max_speed
     
     # Maximum Range, 0 = 5m, 1 = 10m (default), 2 = 30m, 3 = 100m
     def set_max_range(range = 1)
       set_parameter :rrai, range, :uint8
     end
-    alias_method :rrai, :set_max_range
+    alias rrai set_max_range
     
     # Threshold Offset, 10 - 60db, (default = 30)
     def set_threshold_offset(offset = 30)
@@ -43,61 +43,61 @@ module RfBeam
       
       set_parameter :thof, offset, :uint8
     end
-    alias_method :thof, :set_threshold_offset
+    alias thof set_threshold_offset
     
     # Tracking filter type, 0 = Standard (Default), 1 = Fast Tracking, 2 = Long visibility
     def set_tracking_filter(type = 0)
         set_parameter :trft, type, :uint8
     end
-    alias_method :trtf, :set_tracking_filter
+    alias trtf set_tracking_filter
     
     # Vibration suppression, 0 - 16, 0 = No Suppression, 16 = High Suppression, default = 2
     def set_vibration_suppression(value = 2)
       set_parameter :visu, value, :uint8  
     end
-    alias_method :visu, :set_vibration_suppression
+    alias visu set_vibration_suppression
     
     # Minimum Detection distance, 0 - 100% of Range setting, default = 0
     def set_min_detection_distance(value = 0)
       set_parameter :mira, value, :uint8
     end
-    alias_method :mira, :set_min_detection_distance
+    alias mira set_min_detection_distance
     
     # Maximum Detection distance, 0 - 100% of Range setting, default = 50
     def set_max_detection_distance(value = 50)
       set_parameter :mara, value, :uint8
     end
-    alias_method :mara, :set_max_detection_distance
+    alias mara set_max_detection_distance
     
     # Minimum Detection Angle, -90° - 90°, default = -90
     def set_min_detection_angle(angle = -90)
       set_parameter :mian, angle, :int8
     end
-    alias_method :mian, :set_min_detection_distance
+    alias mian set_min_detection_distance
     
     # Maximum Detection Angle, -90° - 90°, default = 90
-    def set_min_detection_angle(angle = 90)
+    def set_max_detection_angle(angle = 90)
       set_parameter :maan, angle, :int8
     end
-    alias_method :maan, :set_min_detection_angle
+    alias maan set_max_detection_angle
     
     # Minimum Detection Speed, 0 - 100% of Speed setting, default = 0
     def set_min_detection_speed(speed = 0)
       set_parameter :misp, speed, :uint8
     end
-    alias_method :misp, :set_min_detection_speed
+    alias misp set_min_detection_speed
     
     # Maximum Detection Speed, 0 - 100% of Speed setting, default = 100
     def set_max_detection_speed(speed = 100)
       set_parameter :masp, speed, :uint8
     end
-    alias_method :masp, :set_max_detection_speed
+    alias masp set_max_detection_speed
     
     # Detection Direction, 0 = Receding, 1 = Approaching, 2 = Both (default)
     def set_detection_direction(direction = 2)
       set_parameter :dedi, direction, :uint8
     end
-    alias_method :dedi, :set_detection_direction
+    alias dedi set_detection_direction
     
     # Range Threshold, 0 - 100% of Range setting, default = 10
     def set_range_threshold(value = 10)
@@ -106,7 +106,7 @@ module RfBeam
       
       set_parameter :rath, value, :uint8
     end
-    alias_method :rath, :set_range_threshold
+    alias rath set_range_threshold
     
     # Angle Threshold, -90° to 90°, default = 0
     def set_range_threshold(value = 0)
@@ -115,7 +115,7 @@ module RfBeam
       
       set_parameter :anth, value, :int8
     end
-    alias_method :anth, :set_range_threshold
+    alias anth set_range_threshold
     
     # Speed Threshold, 0 - 100% of speed setting, default = 50
     def set_angle_threshold(value = 50)
@@ -124,7 +124,7 @@ module RfBeam
       
       set_parameter :spth, value, :uint8
     end
-    alias_method :spth, :set_angle_threshold
+    alias spth set_angle_threshold
     
     # Digital output 1, 0 = Direction, 1 = Angle, 2 = Range, 3 = Speed, 4 = Micro Detection, default = 0
     def set_dio_1(value = 0)
@@ -133,7 +133,7 @@ module RfBeam
       
       set_parameter :dig1, value, :uint8
     end
-    alias_method :dig1, :set_dio_1
+    alias dig1 set_dio_1
     
     # Digital output 2, 0 = Direction, 1 = Angle, 2 = Range, 3 = Speed, 4 = Micro Detection, default = 1
     def set_dio_2(value = 1)
@@ -142,7 +142,7 @@ module RfBeam
       
       set_parameter :dig2, value, :uint8
     end
-    alias_method :dig2, :set_dio_2
+    alias dig2 set_dio_2
     
     # Digital output 3, 0 = Direction, 1 = Angle, 2 = Range, 3 = Speed, 4 = Micro Detection, default = 2
     def set_dio_3(value = 2)
@@ -151,7 +151,7 @@ module RfBeam
       
       set_parameter :dig3, value, :uint8
     end
-    alias_method :dig3, :set_dio_3
+    alias dig3 set_dio_3
     
     # Hold Time, 1 - 7200s, default = 1
     def set_hold_time(time = 1)
@@ -160,15 +160,15 @@ module RfBeam
       
       set_parameter :hold, time, :uint16
     end
-    alias_method :hold, :set_hold_time
+    alias hold set_hold_time
     
     # Micro Detection retrigger, 0 = Off (default), 1 = Retrigger
     def set_micro_detection_retrigger(value = 0)
-      return false unless (value == 0 || value == 1)
+      return false unless [0, 1].include?(value)
       
       set_parameter :mide, value, :uint8
     end
-    alias_method :mide, :set_micro_detection_retrigger
+    alias mide set_micro_detection_retrigger
     
     # Micro Detection sensitivity, 0 - 9, 0 = Min, 9 = Max, default = 4
     def set_micro_detection_sensitivty(value = 4)
@@ -177,7 +177,7 @@ module RfBeam
       
       set_parameter :mids, value, :uint8
     end
-    alias_method :mids, :set_micro_detection_sensitivty
+    alias mids set_micro_detection_sensitivty
 
     private
     
@@ -187,7 +187,7 @@ module RfBeam
           when :uint8
           'L'
           when :int8
-          'c'
+          'l'
           when :uint16
           'S'
           else
@@ -197,34 +197,5 @@ module RfBeam
       write command.pack("a4L#{return_type}")
       check_response
     end
-    
-    def formatted_grps(data)
-      output = "\n"
-      output << "Software Version: #{data[2]}\n"
-      output << "Base Frequency: #{PARAMETER_STRUCTURE[:base_frequency][data[3]]}\n"
-      output << "Max Speed: #{PARAMETER_STRUCTURE[:max_speed][data[4]]}\n"
-      output << "Max Range: #{PARAMETER_STRUCTURE[:max_range][data[5]]}\n"
-      output << "Threshold offset: #{data[6]}db\n"
-      output << "Tracking Filter Type: #{PARAMETER_STRUCTURE[:tracking_filter_type][data[7]]}\n"
-      output << "Vibration Suppression: #{data[8]} , (#{PARAMETER_STRUCTURE[:vibration_suppression]})\n"
-      output << "Minimum Detection Distance: #{data[9]} , (#{PARAMETER_STRUCTURE[:min_detection_distance]})\n"
-      output << "Maximum Detection Distance: #{data[10]} , (#{PARAMETER_STRUCTURE[:max_detection_distance]})\n"
-      output << "Minimum Detection Angle: #{data[11]}° , (#{PARAMETER_STRUCTURE[:min_detection_angle]})\n"
-      output << "Maximum Detection Angle: #{data[12]}° , (#{PARAMETER_STRUCTURE[:max_detection_angle]})\n"
-      output << "Minimum Detection Speed: #{data[13]} , (#{PARAMETER_STRUCTURE[:min_detection_speed]})\n"
-      output << "Maximum Detection Speed: #{data[14]} , (#{PARAMETER_STRUCTURE[:max_detection_speed]})\n"
-      output << "Detection Direction: #{PARAMETER_STRUCTURE[:detection_direction][data[15]]}\n"
-      output << "Range Threshold: #{data[16]}%, (#{PARAMETER_STRUCTURE[:range_threshold]})\n"
-      output << "Angle Threshold: #{data[17]}°, (#{PARAMETER_STRUCTURE[:angle_threshold]})\n"
-      output << "Speed Threshold: #{data[18]}%, (#{PARAMETER_STRUCTURE[:speed_threshold]})\n"
-      output << "Digital output 1: #{PARAMETER_STRUCTURE[:digital_output_1][data[19]]}\n"
-      output << "Digital output 2: #{PARAMETER_STRUCTURE[:digital_output_2][data[20]]}\n"
-      output << "Digital output 3: #{PARAMETER_STRUCTURE[:digital_output_3][data[21]]}\n"
-      output << "Hold time: #{data[22]}sec\n"
-      output << "Micro Detection Retrigger: #{PARAMETER_STRUCTURE[:micro_detection_trigger][data[23]]}\n"
-      output << "Micro Detection Sensitivity: #{data[24]} (#{PARAMETER_STRUCTURE[:micro_detection_sensitivity]})"
-      
-      output
-    end
   end
 end

data/lib/rfbeam/kld7/app_messages.rb

@@ -5,12 +5,19 @@ module RfBeam
       (data[2] == 1)
     end
     
-    def pdat
-      request_frame_data(:pdat)
-      sleep 0.1
-      
-      resp = read(102).unpack('a4LSssSSssS')
-      resp
+    def pdat(formatted: false)
+      request_frame_data(:pdat)      
+      resp = read(102).unpack('a4LSssSSssSSssSSssSSssSSssSSssSSssSSssSSssS')
+      return resp unless formatted
+
+      target_count = resp[1].to_i / 8
+      return [] unless target_count > 0
+
+      resp.shift 2
+      resp.compact
+      detected_raw_targets = []
+      target_count.times { detected_raw_targets << format_raw_target_data(resp.shift(4)) }
+      detected_raw_targets
     end
 
     def tdat
@@ -24,16 +31,70 @@ module RfBeam
     def ddat
       request_frame_data(:ddat)
 
-      resp = read(14).unpack('a4LC6')
-      return resp
+      read(14).unpack('a4LC6')
+    end
+    
+    def config
+      puts formatted_grps(grps)
+    end
+    
+    def formatted_parameter(param)
+      return unless PARAMETERS.include? param
+      
+      param_data = PARAMETERS[param]
+      grps_data = grps
+      index = grps_data[param_data[:grps_index]]
+      param_data[:values][index]
+    end
+
+    # Get the radar parameter structure
+    def grps
+      command = ['GRPS', 0]
+      write command.pack('a4L')
+      check_response
+      read(50).unpack('a4LA19C8c2C4cCCCCSCC')
     end
+    
 
     private
 
+    def format_raw_target_data(array)
+        { dist: array.shift, speed: array.shift, angle: array.shift, mag: array.shift }
+    end
+
     def request_frame_data(type)
       command = ['GNFD', 4, FRAME_DATA_TYPES[type]]
       write command.pack('a4LL')
       check_response
     end
+
+    def formatted_grps(data)
+      output = "\n"
+      output << "Software Version: #{data[2]}\n"
+      output << "Base Frequency: #{PARAMETER_STRUCTURE[:base_frequency][data[3]]}\n"
+      output << "Max Speed: #{PARAMETER_STRUCTURE[:max_speed][data[4]]}\n"
+      output << "Max Range: #{PARAMETER_STRUCTURE[:max_range][data[5]]}\n"
+      output << "Threshold offset: #{data[6]}db\n"
+      output << "Tracking Filter Type: #{PARAMETER_STRUCTURE[:tracking_filter_type][data[7]]}\n"
+      output << "Vibration Suppression: #{data[8]} , (#{PARAMETER_STRUCTURE[:vibration_suppression]})\n"
+      output << "Minimum Detection Distance: #{data[9]} , (#{PARAMETER_STRUCTURE[:min_detection_distance]})\n"
+      output << "Maximum Detection Distance: #{data[10]} , (#{PARAMETER_STRUCTURE[:max_detection_distance]})\n"
+      output << "Minimum Detection Angle: #{data[11]}° , (#{PARAMETER_STRUCTURE[:min_detection_angle]})\n"
+      output << "Maximum Detection Angle: #{data[12]}° , (#{PARAMETER_STRUCTURE[:max_detection_angle]})\n"
+      output << "Minimum Detection Speed: #{data[13]} , (#{PARAMETER_STRUCTURE[:min_detection_speed]})\n"
+      output << "Maximum Detection Speed: #{data[14]} , (#{PARAMETER_STRUCTURE[:max_detection_speed]})\n"
+      output << "Detection Direction: #{PARAMETER_STRUCTURE[:detection_direction][data[15]]}\n"
+      output << "Range Threshold: #{data[16]}%, (#{PARAMETER_STRUCTURE[:range_threshold]})\n"
+      output << "Angle Threshold: #{data[17]}°, (#{PARAMETER_STRUCTURE[:angle_threshold]})\n"
+      output << "Speed Threshold: #{data[18]}%, (#{PARAMETER_STRUCTURE[:speed_threshold]})\n"
+      output << "Digital output 1: #{PARAMETER_STRUCTURE[:digital_output_1][data[19]]}\n"
+      output << "Digital output 2: #{PARAMETER_STRUCTURE[:digital_output_2][data[20]]}\n"
+      output << "Digital output 3: #{PARAMETER_STRUCTURE[:digital_output_3][data[21]]}\n"
+      output << "Hold time: #{data[22]}sec\n"
+      output << "Micro Detection Retrigger: #{PARAMETER_STRUCTURE[:micro_detection_trigger][data[23]]}\n"
+      output << "Micro Detection Sensitivity: #{data[24]} (#{PARAMETER_STRUCTURE[:micro_detection_sensitivity]})"
+      
+      output
+    end
   end
 end

data/lib/rfbeam/kld7/connection.rb

@@ -3,6 +3,8 @@ module RfBeam
     require 'rubyserial'
     require 'timeout'
 
+
+    
     class Error < StandardError
     end
 

data/lib/rfbeam/kld7/constants.rb

@@ -28,9 +28,9 @@ module RfBeam
       direction: %w[Receding Approaching],
       range: %w[Far Near],
       speed: %w[Low High],
-    }
+  }.freeze
     
-    # GRPS - Parameter structture, used to map return values to readable strings
+    # GRPS - Parameter structure, used to map return values to readable strings
     PARAMETER_STRUCTURE = {
       base_frequency: ['Low', 'Middle', 'High'],
       max_speed: ['12.5km/h', '25km/h', '50km/h', '100km/h'],
@@ -54,6 +54,32 @@ module RfBeam
       hold_time: '1 - 7200s',
       micro_detection_trigger: %w[Off Retrigger],
       micro_detection_sensitivity: '0 - 9, 0 = Min, 9 = Max'
-    }
+  }.freeze
+    
+    # PARAMETERS = {
+    #   sw_version: { grps_index: 2, default: 'K-LD7_APP-RFB-XXXX' },
+    #   base_frequency: { grps_index: 3, description: '0 = Low, 1 = Middle, 2 = High', default: '1 - Middle', values: ['Low', 'Middle', 'High'] },
+    #   max_speed: { grps_index: 4, description: '0 = 12km/h, 1 = 25km/h, 2 = 50km/h, 3 = 100km/h, default: 1', values: ['12.5km/h', '25km/h', '50km/h', '100km/h'] },
+    #   max_range: { grps_index: 5, description: '0 = 5m, 1 = 10m, 2 = 30m, 3 = 100m, default: 1', values: %w[5m 10m 30m 100m] },
+    #   threshold_offset: { grps_index: 6, description: '10db - 60db, default: 30', values: '10db - 60db' },
+    #   tracking_filter_type: { grps_index: 7, description: '0 = Standard, 2 = Fast Detection, 3 = Long Visibility, default: 0', values: ['standard', 'Fast Detection', 'Long Visibility'] },
+    #   vibration_suppression: { grps_index: 8, description: '0-16, 0 = No Suppression, 16 = High Suppression, default: 2' },
+    #   min_detection_distance: { grps_index: 3, description: '0 - 100% of range setting, default: 0' },
+    #   max_detection_distance: { grps_index: 10, description: '0 - 100% of range setting, default: 50' },
+    #   min_detection_angle: { grps_index: 11, description: '-90° - 90°, default: -90' },
+    #   max_detection_angle: { grps_index: 12, description: '-90° - 90°, default: 90' },
+    #   min_detection_speed: { grps_index: 13, description: '0 - 100% of speed setting, default: 0' },
+    #   max_detection_speed: { grps_index: 14, description: '0 - 100% of speed setting, default: 100' },
+    #   detection_direction: { grps_index: 15, description: '0 = Receding, 1 = Approaching, 2 = Both, default: 2', values: %w[receding approaching both] },
+    #   range_threshold: { grps_index: 16, description: '0 - 100% of range setting, default: 10', values: '0 - 100% of range setting' },
+    #   angle_threshold: { grps_index: 17, description: '-90° - 90°, default: 0' },
+    #   speed_threshold: { grps_index: 18, description: '0 - 100% of speed setting, default: 50' },
+    #   digital_output_1: { grps_index: 19, description: '0 = Direction, 1 = Angle, 2 = Range, 3 = Speed, 4 = Micro Detection, default: 0', values: %w[Direction Angle Range Speed Micro] },
+    #   digital_output_2: { grps_index: 20, description: '0 = Direction, 1 = Angle, 2 = Range, 3 = Speed, 4 = Micro Detection, default: 1', values: %w[Direction Angle Range Speed Micro] },
+    #   digital_output_3: { grps_index: 21, description: '0 = Direction, 1 = Angle, 2 = Range, 3 = Speed, 4 = Micro Detection, default: 2', values: %w[Direction Angle Range Speed Micro] },
+    #   hold_time: { grps_index: 22, description: '1 - 7200s, default: 1', values: '1 - 7200s' },
+    #   micro_detection_trigger: { grps_index: 23, description: '0 = Off, 1 = Retrigger, default: 0' },
+    #   micro_detection_sensitivity: { grps_index: 24, description: '0 - 9, 0 = Min, 9 = Max, default: 4' }'
+    # }
   end
 end

data/lib/rfbeam/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RfBeam
-  VERSION = '0.3.3'
+  VERSION = '0.3.4'
 end

data/rfbeam.gemspec

@@ -8,11 +8,11 @@ Gem::Specification.new do |spec|
   spec.authors = ['Rob Carruthers']
   spec.email = ['robc@hey.com']
 
-  spec.summary = 'Ruby Serial interface and CLI for RFBeam doplar radar modules'
-  spec.description = 'Currently only works K-LD7 on Raspberry Pi (MacOS & Ubuntu 22.04 LTS)'
+  spec.summary = 'Ruby API and CLI for RFBeam doplar radar modules'
+  spec.description = 'Currently only tested with K-LD7 on MacOS & Raspian (bullseye)'
   spec.homepage = 'https://gitlab.com/robcarruthers/rfbeam'
   spec.license = 'MIT'
-  spec.required_ruby_version = '>= 2.7.6'
+  spec.required_ruby_version = '>= 3.2.1'
 
   # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rfbeam
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Rob Carruthers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-29 00:00:00.000000000 Z
+date: 2023-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -52,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.1
-description: Currently only works K-LD7 on Raspberry Pi (MacOS & Ubuntu 22.04 LTS)
+description: Currently only tested with K-LD7 on MacOS & Raspian (bullseye)
 email:
 - robc@hey.com
 executables: []
@@ -178,15 +178,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.6
+      version: 3.2.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.9
 signing_key: 
 specification_version: 4
-summary: Ruby Serial interface and CLI for RFBeam doplar radar modules
+summary: Ruby API and CLI for RFBeam doplar radar modules
 test_files: []