rfbeam 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3701d190afa17ff597b95c3828f53ced876634450c2a8185ef6204e003de988
-  data.tar.gz: ad3393070257497505ece77149306e91e2cf42bbdbce896912c03d78ff230a3e
+  metadata.gz: daed0b3716d78b7783768008f4fb69a0b1dd790fe23aaaceb4682b8c68982341
+  data.tar.gz: 74b70ca29f4065966a59ab2801e0d1eaefbf7fab45f67a8b70062fd8cf944cff
 SHA512:
-  metadata.gz: 1e3e93de85a88b87f113f58f28d8ec43378b12576f0ce4676cbe62713d718dd4f690c7e9070619801417b60fcd36afe58d229f31f72a652f95515df43b16248e
-  data.tar.gz: 968916b79ace6eb9fe531c0d3386fec3ea27725d87cc2fa0f74a893f2a0829e2ac296aee418e5bfaf37d47f7b4680ba4d3d227a70002220899547647b296eabc
+  metadata.gz: f4c29ec4115d65fb0fd8dd565c070d3124cf8ef32e863fd236346faac28265960c7e872ba166463180c84f20cc7db04b184551cfbda804bbcf98cb7d7de5e81f
+  data.tar.gz: 9e5763c1acbd1c4f4f45bdd481d4efc4fa66cff721f8ebfda263d89548110fe538bdbd8b4b36ad65f08f523fb3256a8052c275c039ba4e01b3394baaadfc689b

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## [0.3.1] - 2023-3-28
+
+- Added setters for Parameter settings
+
+## [0.3.1] - 2023-3-28
+
+- Added setter for Max Distance
+- Added setter for Max Speed
+- Added setter for Threshold offset
+
 ## [0.2.2] - 2023-3-28
 
 - Refinements to ddat

data/Gemfile.lock

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

data/README.md

@@ -59,7 +59,7 @@ Returns the Parameter settings, values map to setting as detailed in the device
 
 ### config
 
-Returns a formatted String of all parameter settings
+Returns a formatted String of all parameter settings. The only way to read parameter settings is with config
 
     radar.config
 
@@ -86,6 +86,198 @@ Returns a formatted String of all parameter settings
     Micro Detection Retrigger: Off
     Micro Detection Sensitivity: 4 (0 - 9, 0 = Min, 9 = Max)
 
+## Parameter setters
+
+### Base Frequency
+
+0 = low, 1 = middle (default), 2 = high
+
+alias :rbfr
+
+```ruby
+set_base_frequency(1)
+```
+
+### Maximum Speed
+
+0 = 12.5km/h, 1 = 25km/h (default), 2 = 50km/h, 3 = 100km/h, alias :rspi
+
+```ruby
+set_max_speed(1)
+```
+
+### Maximum Range
+
+0 = 5m, 1 = 10m (default), 2 = 30m, 3 = 100m, alias :rrai
+
+```ruby
+set_max_range(1)
+```
+
+### Threshold Offset
+
+10 - 60db, (default = 30), alias :thof
+
+```ruby
+set_threshold_offset(30)
+```
+
+### Tracking filter type
+
+0 = Standard (Default), 1 = Fast Tracking, 2 = Long visibility, alias :trtf
+
+```ruby
+set_tracking_filter(0)
+```
+
+### Vibration suppression
+
+0 - 16, 0 = No Suppression, 16 = High Suppression, default = 2, alias :visu
+
+```ruby
+set_vibration_suppression(2)
+```
+
+### Minimum Detection distance
+
+0 - 100% of Range setting, default = 0, alias :mira
+
+```ruby
+set_min_detection_distance(0)
+```
+
+### Maximum Detection distance
+
+0 - 100% of Range setting, default = 50, alias :mara
+
+```ruby
+set_max_detection_distance(50)
+```
+
+### Minimum Detection Angle
+
+-90° - 90°, default = -90, alias :mian
+
+```ruby
+set_min_detection_angle(-90
+```
+
+### Maximum Detection Angle
+
+-90° - 90°, default = 90, alias :maan
+
+```ruby
+set_min_detection_angle(90)
+```
+
+### Minimum Detection Speed
+
+0 - 100% of Speed setting, default = 0, alias :misp
+
+```ruby
+set_min_detection_speed(0)
+```
+
+### Maximum Detection Speed
+
+0 - 100% of Speed setting, default = 100, alias :masp
+
+```ruby
+set_max_detection_speed(100)
+```
+
+### Detection Direction
+
+0 = Receding, 1 = Approaching, 2 = Both (default), alias :dedi
+
+```ruby
+ set_detection_direction(2)
+```
+
+### Range Threshold
+
+0 - 100% of Range setting, default = 10, alias :rath
+
+```ruby
+ set_range_threshold(10)
+```
+
+### Angle Threshold
+
+-90° to 90°, default = 0, alias :anth
+
+```ruby
+ set_range_threshold(0)
+```
+
+### Speed Threshold
+
+0 - 100% of speed setting, default = 50, alias :spth
+
+```ruby
+ set_angle_threshold(50)
+```
+
+### Digital output 1
+
+0 = Direction, 1 = Angle, 2 = Range, 3 = Speed, 4 = Micro Detection, default = 0
+
+alias :dig1, :set_dio_1
+
+```ruby
+set_dio_1(0)
+```
+
+### Digital output 2
+
+0 = Direction, 1 = Angle, 2 = Range, 3 = Speed, 4 = Micro Detection, default = 1
+
+alias :dig2, :set_dio_2
+
+```ruby
+set_dio_2(1)
+```
+
+### Digital output 3
+
+0 = Direction, 1 = Angle, 2 = Range, 3 = Speed, 4 = Micro Detection, default = 2
+
+alias :dig3, :set_dio_3
+
+```ruby
+set_dio_3(2)
+```
+
+### Hold Time
+
+1 - 7200s, default = 1
+
+alias :hold
+
+```ruby
+set_hold_time(1)
+```
+
+### Micro Detection retrigger
+
+0 = Off (default), 1 = Retrigger
+
+alias: :mide
+
+```ruby
+set_micro_detection_retrigger(0)
+```
+
+### Micro Detection sensitivity
+
+0 - 9, 0 = Min, 9 = Max, default = 4
+
+alias: :mids
+
+```ruby
+set_micro_detection_sensitivty(4)
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/rfbeam/kld7/commands.rb

@@ -80,10 +80,10 @@ module RfBeam
       raise Error, 'No valid response from Serial Port' if resp[2].nil?
 
       response_key = resp[2]
-      return if response_key.zero? # Everything OK
+      return response_key.zero? # Everything OK
 
       error_string = RESP_CODES[response_key].nil? ? 'Response unknown' : RESP_CODES[response_key]
-      raise Error, "Initialisation Error: #{error_string}"
+      raise Error, "Radar response Error: #{error_string}"
     end
   end
 end

data/lib/rfbeam/kld7/parameters.rb

@@ -1,24 +1,203 @@
 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
-      resp = read(50).unpack('a4LA19C8c2C4cCCCCSCC')
-      resp
+      read(50).unpack('a4LA19C8c2C4cCCCCSCC')
     end
     
-    def config
-      puts formatted_grps(grps)
+    # Base Frequency, 0 = low, 1 = middle (default), 2 = high
+    def set_base_frequency(frequency = 1)
+      set_parameter(:rbfr, frequency, :uint8)
+    end
+    alias_method :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
+    
+    # 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
+    
+    # Threshold Offset, 10 - 60db, (default = 30)
+    def set_threshold_offset(offset = 30)
+      range = 10..60
+      return false unless range.include?(offset)
+      
+      set_parameter :thof, offset, :uint8
+    end
+    alias_method :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
+    
+    # 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
+    
+    # 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
+    
+    # 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
+    
+    # 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
+    
+    # Maximum Detection Angle, -90° - 90°, default = 90
+    def set_min_detection_angle(angle = 90)
+      set_parameter :maan, angle, :int8
+    end
+    alias_method :maan, :set_min_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
+    
+    # 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
+    
+    # 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
+    
+    # Range Threshold, 0 - 100% of Range setting, default = 10
+    def set_range_threshold(value = 10)
+      range = 0..100
+      return false unless range.include?(value)
+      
+      set_parameter :rath, value, :uint8
     end
+    alias_method :rath, :set_range_threshold
+    
+    # Angle Threshold, -90° to 90°, default = 0
+    def set_range_threshold(value = 0)
+      range = -90..90
+      return false unless range.include?(value)
+      
+      set_parameter :anth, value, :int8
+    end
+    alias_method :anth, :set_range_threshold
+    
+    # Speed Threshold, 0 - 100% of speed setting, default = 50
+    def set_angle_threshold(value = 50)
+      range = 0..100
+      return false unless range.include?(value)
+      
+      set_parameter :spth, value, :uint8
+    end
+    alias_method :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)
+      range = 0..4
+      return false unless range.include?(value)
+      
+      set_parameter :dig1, value, :uint8
+    end
+    alias_method :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)
+      range = 0..4
+      return false unless range.include?(value)
+      
+      set_parameter :dig2, value, :uint8
+    end
+    alias_method :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)
+      range = 0..4
+      return false unless range.include?(value)
+      
+      set_parameter :dig3, value, :uint8
+    end
+    alias_method :dig3, :set_dio_3
+    
+    # Hold Time, 1 - 7200s, default = 1
+    def set_hold_time(time = 1)
+      range = 1..7200
+      return false unless range.include?(time)
+      
+      set_parameter :hold, time, :uint16
+    end
+    alias_method :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)
+      
+      set_parameter :mide, value, :uint8
+    end
+    alias_method :mide, :set_micro_detection_retrigger
+    
+    # Micro Detection sensitivity, 0 - 9, 0 = Min, 9 = Max, default = 4
+    def set_micro_detection_sensitivty(value = 4)
+      range = 0..9
+      return false unless range.include?(value)
+      
+      set_parameter :mids, value, :uint8
+    end
+    alias_method :mids, :set_micro_detection_sensitivty
 
     private
     
+    def set_parameter(header, value, return_type = :uint8)
+      return_type =
+        case return_type
+          when :uint8
+          'L'
+          when :int8
+          'c'
+          when :uint16
+          'S'
+          else
+          'L'
+        end
+      command = [header.upcase.to_s, 4, value]
+      write command.pack("a4L#{return_type}")
+      check_response
+    end
+    
     def formatted_grps(data)
       output = "\n"
       output << "Software Version: #{data[2]}\n"
@@ -31,10 +210,10 @@ module RfBeam
       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_distance]})\n"
-      output << "Maximum Detection Speed: #{data[13]} , (#{PARAMETER_STRUCTURE[:min_detection_speed]})\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: #{data[15]}"
+      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"
@@ -47,11 +226,5 @@ module RfBeam
       
       output
     end
-
-    def request_parameter_data
-      command = ['GRPS', 0]
-      write command.pack('a4L')
-      check_response
-    end
   end
 end

data/lib/rfbeam/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rfbeam
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Rob Carruthers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-28 00:00:00.000000000 Z
+date: 2023-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport