rfbeam 0.2.2 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77d2b1df756f691df7c78412d41e8a30fbeb8d1571dc575c1cfbe88ac3af4cbb
-  data.tar.gz: 5848e309860476a13a1ff8f202170e42e3e91ab991e9d1aaa290df163c6f629c
+  metadata.gz: 8b330fbbd75049114a6b8be3c4870ac68723bb2a25fd0870e40e81304f215cc7
+  data.tar.gz: f740ced4593c75173d216527ab4f0afcaf85cb323097a8b7a86f9c3ad7717a74
 SHA512:
-  metadata.gz: 16ccd6c1b11bd7272131c1e6d113878657ea4d1606d43da331cd1ad0c54296103db0de43b790e8145f679c5d49346b54cee948a8981a34e4e3340da7bf9bb34a
-  data.tar.gz: 1a7d155f0c2c628d3f6ccd16c68fc39e61ece8e047a0a6f06b0f43034190b9a8c8b0dd57e4a32185fef8e7c4fb84e07b7a1cb0b6908c0afa89ca9ab596f97d00
+  metadata.gz: 5c6e265438debcac0e7a3cae53cbe68a589e9eca2529f57ca49179b70aa7ded7e8d0dab2052a748319fe6d02fe4b74640907c3909603e58b13f0b632cb5bbed5
+  data.tar.gz: eb1d53dea2e385a06c8729657f3a9283c2da19120ce122c5b763ba83dc980235ae543bf31fc53e2b27338b43eeed760e2cf7fef407e8e9ac34f866916bc60bd5

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [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.2.0)
+    rfbeam (0.3.0)
       activesupport (~> 6.1.0)
       rubyserial (~> 0.6.0)
       thor (~> 1.2.1)
@@ -51,6 +51,7 @@ GEM
     zeitwerk (2.6.6)
 
 PLATFORMS
+  aarch64-linux
   arm64-darwin-21
 
 DEPENDENCIES
@@ -60,4 +61,4 @@ DEPENDENCIES
   rubocop (~> 1.21)
 
 BUNDLED WITH
-   2.3.26
+   2.4.10

data/README.md

@@ -1,8 +1,9 @@
 # Rfbeam
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rfbeam`. To experiment with that code, run `bin/console` for an interactive prompt.
+RfBeam is a simple, high-level interface to the RFBeam radar modules.
+The user can read and set the radar parameters and fetch raw or processed data frames from the sensor.
 
-TODO: Delete this and the text above, and describe your gem
+At this stage it only works on Linux and Mac with the K-LD7 module.
 
 ## Installation
 
@@ -16,19 +17,74 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-```ruby
-❯ bin/console
-irb(main):001:0> RfBeam.connected
-=> ["/dev/tty.usbserial-FTBX7TKD"]
-irb(main):002:0> r = RfBeam::K_ld7.new("/dev/tty.usbserial-FTBX7TKD", 115200)
-=> #<RfBeam::K_ld7:0x0000000146bb2ff0 @serial_port=#<Serial:0x0000000146bb2f28 @fd=9, @open=true, @config=#<RubySerial::Posix::Termios:0x0000000146bb2cf8>>>
-irb(main):003:0> r.detection?
-=> false
-irb(main):004:0> r.detection?
-=> true
-irb(main):005:0> r.tdat
-=> {:dist=>68, :speed=>196, :angle=>469, :mag=>6303}
-```
+The RfBeam class will return the path of any connected modules
+
+    RfBeam.connected
+
+Simple pass the path and baude rate to initialise a new radar object
+
+    RfBeam::K_ld7.new("/dev/ttyUSB0", 115200) do |radar|
+        puts radar.config
+    end
+
+## RfBeam::K_ld7 API
+
+### detection?
+
+Returns true if the module has a valid detection.
+
+    radar.detection?
+    => true
+
+### ddat
+
+Returns an array with the current detection values
+
+    radar.ddat
+    => ["DDAT", 6, 0, 0, 0, 0, 0, 0]
+
+### tdat
+
+Returns a hash with the current tracked object values
+
+    radar.tdat
+    => {:dist=>68, :speed=>196, :angle=>469, :mag=>6303}
+
+### grps
+
+Returns the Parameter settings, values map to setting as detailed in the device datasheet.
+
+    radar.grps
+    => ["RPST", 42, "K-LD7_APP-RFB-0103", 1, 1, 1, 30, 0, 2, 0, 50, -90, 90, 0, 100, 2, 10, 0, 50, 0, 1, 2, 1, 0, 4]
+
+### config
+
+Returns a formatted String of all parameter settings
+
+    radar.config
+
+    Software Version: K-LD7_APP-RFB-0103
+    Base Frequency: Middle
+    Max Speed: 25km/h
+    Max Range: 10m
+    Threshold offset: 30db
+    Tracking Filter Type: standard
+    Vibration Suppression: 2 , (0-16, 0 = No Suppression, 16 = High Suppression)
+    Minimum Detection Distance: 0 , (0 - 100% of range setting)
+    Maximum Detection Distance: 50 , (0 - 100% of range setting)
+    Minimum Detection Angle: -90° , (-90° - 90°)
+    Maximum Detection Angle: 90° , (0 - 100% of range setting)
+    Maximum Detection Speed: 0 , (0 - 100% of speed setting)
+    Maximum Detection Speed: 100 , (0 - 100% of speed setting)
+    Detection Direction: 2Range Threshold: 10%, (0 - 100% of range setting)
+    Angle Threshold: 0°, (-90° - 90°)
+    Speed Threshold: 50%, (0 - 100% of speed setting)
+    Digital output 1: Direction
+    Digital output 2: Angle
+    Digital output 3: Range
+    Hold time: 1sec
+    Micro Detection Retrigger: Off
+    Micro Detection Sensitivity: 4 (0 - 9, 0 = Min, 9 = Max)
 
 ## Development
 

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/device_data.rb

@@ -29,5 +29,31 @@ module RfBeam
       range: %w[Far Near],
       speed: %w[Low High],
     }
+    
+    # GRPS - Parameter structture, 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'],
+      max_range: %w[5m 10m 30m 100m],
+      threshold_offset: '10db - 60db',
+      tracking_filter_type: ['standard', 'Fast Detection', 'Long Visibility'],
+      vibration_suppression: '0-16, 0 = No Suppression, 16 = High Suppression',
+      min_detection_distance: '0 - 100% of range setting',      
+      max_detection_distance: '0 - 100% of range setting',
+      min_detection_angle: '-90° - 90°',
+      max_detection_angle: '-90° - 90°',
+      min_detection_speed: '0 - 100% of speed setting',
+      max_detection_speed: '0 - 100% of speed setting',
+      detection_direction: %w[receding approaching both],
+      range_threshold: '0 - 100% of range setting',
+      angle_threshold: '-90° - 90°',
+      speed_threshold: '0 - 100% of speed setting',
+      digital_output_1: %w[Direction Angle Range Speed Micro],
+      digital_output_2: %w[Direction Angle Range Speed Micro],
+      digital_output_3: %w[Direction Angle Range Speed Micro],
+      hold_time: '1 - 7200s',
+      micro_detection_trigger: %w[Off Retrigger],
+      micro_detection_sensitivity: '0 - 9, 0 = Min, 9 = Max'
+    }
   end
 end

data/lib/rfbeam/kld7/parameters.rb

@@ -0,0 +1,96 @@
+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')
+    end
+    
+    # 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, :unit8
+    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, range, :unit8
+    end
+    alias_method :thof, :set_threshold_offset
+
+    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"
+      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_distance]})\n"
+      output << "Maximum 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 << "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/version.rb

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

data/lib/rfbeam.rb

@@ -2,6 +2,7 @@
 
 require 'rfbeam/kld7/commands'
 require 'rfbeam/kld7/detection'
+require 'rfbeam/kld7/parameters'
 require 'rfbeam/kld7/device_data'
 require_relative 'rfbeam/version'
 
@@ -13,16 +14,16 @@ module RfBeam
     include RfBeam::KLD7
   end
 
-  def self.connected
-    path_str, dir =
-      if RubySerial::ON_LINUX
-        %w[ttyUSB /dev/]
-      elsif RubySerial::ON_WINDOWS
-        ['TODO: Implement find device for Windows', 'You lazy bugger']
-      else
-        %w[tty.usbserial /dev/]
-      end
-
-    Dir.glob("#{dir}#{path_str}*")
+          def self.connected
+            path_str, dir =
+              if RubySerial::ON_LINUX
+                %w[ttyUSB /dev/]
+              elsif RubySerial::ON_WINDOWS
+                ['TODO: Implement find device for Windows', 'You lazy bugger']
+              else
+                %w[tty.usbserial /dev/]
+              end
+        
+            Dir.glob("#{dir}#{path_str}*")
   end
 end

data/node_modules/.yarn-integrity

@@ -1,5 +1,5 @@
 {
-  "systemParams": "darwin-arm64-108",
+  "systemParams": "linux-arm64-108",
   "modulesFolders": [
     "node_modules"
   ],
@@ -7,12 +7,12 @@
   "linkedModules": [],
   "topLevelPatterns": [
     "@prettier/plugin-ruby@^3.2.2",
-    "prettier@^2.8.0"
+    "prettier@^2.8.7"
   ],
   "lockfileEntries": {
     "@prettier/plugin-ruby@^3.2.2": "https://registry.yarnpkg.com/@prettier/plugin-ruby/-/plugin-ruby-3.2.2.tgz#43c9d85349032f74d34c4f57e6a77487d5c5bdc1",
     "prettier@>=2.3.0": "https://registry.yarnpkg.com/prettier/-/prettier-2.8.0.tgz#c7df58393c9ba77d6fba3921ae01faf994fb9dc9",
-    "prettier@^2.8.0": "https://registry.yarnpkg.com/prettier/-/prettier-2.8.0.tgz#c7df58393c9ba77d6fba3921ae01faf994fb9dc9"
+    "prettier@^2.8.7": "https://registry.yarnpkg.com/prettier/-/prettier-2.8.7.tgz#bb79fc8729308549d28fe3a98fce73d2c0656450"
   },
   "files": [],
   "artifacts": {}

data/node_modules/@prettier/plugin-ruby/node_modules/.bin/prettier

@@ -1 +1 @@
-../../../../prettier/bin-prettier.js
+../prettier/bin-prettier.js