rfbeam 0.4.3 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cd82af6ee6d040de78fe19f179f643b0617c37b09a0f0f79ad952d05514b934
-  data.tar.gz: 4efe06f17ac00595fa1407212cc77f909bf3fcdcaacf190587daa73424132f41
+  metadata.gz: bf7e877bee6e38f770c7058a27e5c3b8240347699d7f5839dcb1785200288d33
+  data.tar.gz: f69fa55d36aa8c160329224f88cf8d9ed291ff107fce17a4d2915809237352e8
 SHA512:
-  metadata.gz: 07fac5306643bdac200b16c6aec4515602e6dcd42f96dc7198706d863fece4fc1b648accb1da80a48959826a50e9fcaaa6a4d7dbbc9f8775416c17faf3b49b35
-  data.tar.gz: 64e52d170ad21a8a6fb98006310b3e874f62300162c25bd3a3de5d6f158a55652add50c1646be4c3f8d597f580ebc4c7b3f7a848212f190cf6836508e1dcf494
+  metadata.gz: 5eee8481b7e290057353b9b5aca03ac22949824b1eefee979a26d36e34c46bbe029d893948af78df0c97354271adf14d495eae41491c3fd56afb3719e847012a
+  data.tar.gz: cacf5bc2b75eeb187ffaca4b2a9c28dad4f55d0a4f25492f163c1b9fe8cf0d9d7b27cb75c5c5d372f2618ed72d1923e091e93afdf6cfcb259b46cda182ea3f75

data/Gemfile.lock

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

data/README.md

@@ -27,7 +27,7 @@ The RfBeam class will return the path of any connected modules
 
 Simple pass the path and baude rate to initialise a new radar object
 
-    RfBeam::K_ld7.new("/dev/ttyUSB0", 115200) do |radar|
+    RfBeam::KLD7.new("/dev/ttyUSB0", 115200) do |radar|
         puts radar.config
     end
 
@@ -285,7 +285,7 @@ radar.micro_detection_sensitivty = 4
 
 ## CLI
 
-``` fish
+```fish
 ❯ bundle exec rfbeam list
 
 +--+------------+------------------+

data/lib/rfbeam/cli.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'thor'
 require 'rfbeam'
 require 'tty-table'
@@ -8,7 +10,7 @@ require 'unicode_plot'
 
 module RfBeam
   class CLI < Thor
-    attr_accessor :radar, :logger
+    attr_accessor :logger
 
     desc 'list', 'List available radar modules'
     def list
@@ -18,7 +20,7 @@ module RfBeam
 
       table = TTY::Table.new(header: %w[id Path Version])
 
-      devices.each.with_index { |path, index| table << ["#{index}", path, radar(index).sw_version] }
+      devices.each.with_index { |path, index| table << [index.to_s, path, radar(index).sw_version] }
       puts table.render(:ascii)
     end
 
@@ -44,13 +46,13 @@ module RfBeam
     desc 'ddat <radar_id>', 'stream any valid detections, stop stream with q and enter'
     option :stream, type: :boolean, aliases: '-s', desc: 'Stream the data from the device'
     def ddat(radar_id)
-      cli = RfBeam::KLD7::CliOutput.new(radar_id)
+      cli = RfBeam::Kld7::CliOutput.new(radar_id)
       cli.display(:ddat, stream: options[:stream])
     end
 
     desc 'pdat <radar_id>', 'Display Tracked Targets'
     def pdat(radar_id)
-      cli = RfBeam::KLD7::CliOutput.new(radar_id)
+      cli = RfBeam::Kld7::CliOutput.new(radar_id)
       cli.display(:pdat, stream: options[:stream])
     end
 
@@ -58,7 +60,7 @@ module RfBeam
     option :stream, type: :boolean, aliases: '-s', desc: 'Stream the data from the device'
     option :raw, type: :boolean, aliases: '-r', desc: 'Display raw data'
     def rfft(radar_id)
-      plotter = RfBeam::KLD7::CliOutput.new(radar_id)
+      plotter = RfBeam::Kld7::CliOutput.new(radar_id)
       if options[:raw]
         print radar(radar_id).rfft
       else
@@ -68,7 +70,7 @@ module RfBeam
 
     desc 'tdat <radar_id>', 'Display tracked target data'
     def tdat(radar_id)
-      cli = RfBeam::KLD7::CliOutput.new(radar_id)
+      cli = RfBeam::Kld7::CliOutput.new(radar_id)
       cli.display(:tdat, stream: options[:stream])
     end
 
@@ -79,7 +81,7 @@ module RfBeam
       @logger = TTY::Logger.new
       return @logger.warning 'No Radar modules found.' unless devices.count.positive?
 
-      RfBeam::K_ld7.new(devices[id.to_i])
+      RfBeam::KLD7.new(devices[id.to_i])
     end
   end
 end

data/lib/rfbeam/kld7/cli_formatter.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'tty-table'
 
 module RfBeam
-  module KLD7
+  module Kld7
     class CliFormatter
       def tdat(data)
         { dist: data[2], speed: data[3], angle: data[4], mag: data[5] }
@@ -11,7 +13,7 @@ module RfBeam
         table = TTY::Table.new header: ['index', 'dist (M)', 'speed (Km/h)', 'angle (°)', 'mag (db)']
         count = data[1] / 8
         data.shift(2)
-        count.times.with_index do |index|
+        count.times do |index|
           values = data.shift(4).map { |value| value.to_f / 100.0 }
           table << [index, values].flatten
         end

data/lib/rfbeam/kld7/cli_output.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'unicode_plot'
 require 'io/console'
 require 'stringio'
@@ -5,7 +7,7 @@ require 'tty-screen'
 require 'tty-logger'
 
 module RfBeam
-  module KLD7
+  module Kld7
     class CliOutput
       attr_reader :radar
 
@@ -13,7 +15,7 @@ module RfBeam
         devices = RfBeam.connected
         return TTY::Logger.new.warning 'No Radar modules found.' unless devices.count.positive?
 
-        @radar = RfBeam::K_ld7.new(devices[radar_id.to_i])
+        @radar = RfBeam::KLD7.new(devices[radar_id.to_i])
       end
 
       def display(type, stream: false)
@@ -39,10 +41,10 @@ module RfBeam
         $stdout.print "\e[0J"
         $stdout.flush
 
-        if @streaming
-          n = lines.count
-          $stdout.print "\e[#{n}F"
-        end
+        return unless @streaming
+
+        n = lines.count
+        $stdout.print "\e[#{n}F"
       end
 
       def stream_plot(type)
@@ -59,7 +61,7 @@ module RfBeam
 
       def monitor_keypress
         loop do
-          key = STDIN.getch
+          key = $stdin.getch
           if key.downcase == 'q'
             @streaming = false
             break
@@ -76,6 +78,7 @@ module RfBeam
       end
 
       def display_ddat(stream)
+        data = @radar.ddat
         if stream
           @streaming = true
           Thread.new { monitor_keypress }
@@ -83,28 +86,28 @@ module RfBeam
           logger = TTY::Logger.new
           loop do
             break unless @streaming
+
             spinner.spin
-            data = @radar.ddat
-            spinner.update title: "Searching... #{data[:detection_str]}"
-            logger.success "#{@radar.tdat}" if data[:detection]
+            spinner.update title: "Detection: #{DETECTION_FLAGS[data[2]]}"
+            logger.success @radar.tdat.to_s unless data[2].zero?
           end
         else
-          puts RfBeam::KLD7::CliFormatter.new.ddat(@radar.ddat)
+          puts RfBeam::Kld7::CliFormatter.new.ddat(data)
         end
       end
 
       def display_tdat(stream)
-        puts RfBeam::KLD7::CliFormatter.new.tdat(@radar.tdat)
+        puts RfBeam::Kld7::CliFormatter.new.tdat(@radar.tdat)
       end
 
       def display_pdat(stream)
-        table = RfBeam::KLD7::CliFormatter.new.pdat_table(@radar.pdat)
+        table = RfBeam::Kld7::CliFormatter.new.pdat_table(@radar.pdat)
         puts "\n   Detected Raw Targets"
         puts table.render(:unicode, alignment: :center)
       end
 
       def rfft_plot
-        width = TTY::Screen.width * 0.65
+        screen_width = TTY::Screen.width * 0.65
         data = rfft_plot_data(@radar.rfft)
         plot =
           UnicodePlot.lineplot(
@@ -113,7 +116,7 @@ module RfBeam
             name: 'IF1/2 Averaged',
             title: 'Raw FFT',
             height: 25,
-            width: width,
+            width: screen_width,
             xlabel: 'Speed (km/h)',
             ylabel: 'Signal (db)',
             xlim: [-128, 128],

data/lib/rfbeam/kld7/constants.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module RfBeam
-  module KLD7
+  module Kld7
     # All supported Serial port baude rates
     BAUDE_RATES = { 0 => 115_200, 1 => 460_800, 2 => 921_600, 3 => 2_000_000, 4 => 3_000_000 }.freeze
 
@@ -31,158 +33,231 @@ module RfBeam
       speed: %w[Low High]
     }.freeze
 
-    Param =
-      Struct.new(:name, :grps_index, :description, :default, :units, :values) do
-        def initialize(name:, grps_index:, description: nil, default: nil, units: nil, values: [])
-          super(name, grps_index, description, default, units, values)
-        end
+    class Param
+      attr_accessor :name, :grps_index, :description, :default, :units, :str_values
+
+      def initialize(name:, grps_index:, options: {})
+        @name = name
+        @grps_index = grps_index
+        @description = options.fetch(:description, nil)
+        @default = options.fetch(:default, nil)
+        @units = options.fetch(:units, nil)
+        @str_values = options.fetch(:str_values, [])
       end
+    end
 
     RADAR_PARAMETERS = {
-      sw_version: Param.new(name: 'Software Version', grps_index: 2, default: 'K-LD7_APP-RFB-XXXX'),
+      sw_version: Param.new(name: 'Software Version', grps_index: 2, options: { default: 'K-LD7_APP-RFB-XXXX' }),
       base_frequency:
         Param.new(
           name: 'Base Frequency',
           grps_index: 3,
-          description: '0 = Low, 1 = Middle, 2 = High',
-          default: 1,
-          values: %w[Low Middle High]
+          options: {
+            description: '0 = Low, 1 = Middle, 2 = High',
+            default: 1,
+            str_values: %w[Low Middle High]
+          }
         ),
       max_speed:
         Param.new(
           name: 'Maximum Speed',
           grps_index: 4,
-          description: '0 = 12km/h, 1 = 25km/h, 2 = 50km/h, 3 = 100km/h',
-          default: 1,
-          units: 'km/h',
-          values: %w[12.5 25 50 100]
+          options: {
+            description: '0 = 12km/h, 1 = 25km/h, 2 = 50km/h, 3 = 100km/h',
+            default: 1,
+            units: 'km/h',
+            str_values: %w[12.5 25 50 100]
+          }
         ),
       max_range:
         Param.new(
           name: 'Maximum Range',
           grps_index: 5,
-          description: '0 = 5m, 1 = 10m, 2 = 30m, 3 = 100m',
-          default: 1,
-          values: %w[5m 10m 30m 100m]
+          options: {
+            description: '0 = 5m, 1 = 10m, 2 = 30m, 3 = 100m',
+            default: 1,
+            str_values: %w[5m 10m 30m 100m]
+          }
         ),
       threshold_offset:
-        Param.new(name: 'Threshold Offset', grps_index: 6, description: '10db - 60db', default: 30, units: 'db'),
+        Param.new(
+          name: 'Threshold Offset',
+          grps_index: 6,
+          options: {
+            description: '10db - 60db',
+            default: 30,
+            units: 'db'
+          }
+        ),
       tracking_filter:
         Param.new(
           name: 'Tracking Filter Type',
           grps_index: 7,
-          description: '0 = Standard, 2 = Fast Detection, 3 = Long Visibility',
-          default: 0,
-          values: ['standard', 'Fast Detection', 'Long Visibility']
+          options: {
+            description: '0 = Standard, 2 = Fast Detection, 3 = Long Visibility',
+            default: 0,
+            str_values: ['standard', 'Fast Detection', 'Long Visibility']
+          }
         ),
       vibration_suppression:
         Param.new(
           name: 'Vibration Suppression',
           grps_index: 8,
-          description: '0-16, 0 = No Suppression, 16 = High Suppression',
-          default: 2
+          options: {
+            description: '0-16, 0 = No Suppression, 16 = High Suppression',
+            default: 2
+          }
         ),
       min_detection_distance:
         Param.new(
           name: 'Minimum Detection Distance',
           grps_index: 9,
-          description: '0 - 100% of range setting',
-          default: 0,
-          units: '%'
+          options: {
+            description: '0 - 100% of range setting',
+            default: 0,
+            units: '%'
+          }
         ),
       max_detection_distance:
         Param.new(
           name: 'Maximum Detection Distance',
           grps_index: 10,
-          description: '0 - 100% of range setting',
-          default: 50,
-          units: '%'
+          options: {
+            description: '0 - 100% of range setting',
+            default: 50,
+            units: '%'
+          }
         ),
       min_detection_angle:
-        Param.new(name: 'Minimum Detection Angle', grps_index: 11, description: '-90° - 90°', default: -90, units: '°'),
+        Param.new(
+          name: 'Minimum Detection Angle',
+          grps_index: 11,
+          options: {
+            description: '-90° - 90°',
+            default: -90,
+            units: '°'
+          }
+        ),
       max_detection_angle:
-        Param.new(name: 'Maximum Detection Angle', grps_index: 12, description: '-90° - 90°', default: 90, units: '°'),
+        Param.new(
+          name: 'Maximum Detection Angle',
+          grps_index: 12,
+          options: {
+            description: '-90° - 90°',
+            default: 90,
+            units: '°'
+          }
+        ),
       min_detection_speed:
         Param.new(
           name: 'Minimum Detection Speed',
           grps_index: 13,
-          description: '0 - 100% of speed setting',
-          default: 0,
-          units: '%'
+          options: {
+            description: '0 - 100% of speed setting',
+            default: 0,
+            units: '%'
+          }
         ),
       max_detection_speed:
         Param.new(
           name: 'Maximum Detection Speed',
           grps_index: 14,
-          description: '0 - 100% of speed setting',
-          default: 100,
-          units: '%'
+          options: {
+            description: '0 - 100% of speed setting',
+            default: 100,
+            units: '%'
+          }
         ),
       detection_direction:
         Param.new(
           name: 'Detection Direction',
           grps_index: 15,
-          description: '0 = Receding, 1 = Approaching, 2 = Both',
-          default: 2,
-          values: %w[Receding Approaching Both]
+          options: {
+            description: '0 = Receding, 1 = Approaching, 2 = Both',
+            default: 2,
+            str_values: %w[Receding Approaching Both]
+          }
         ),
       range_threshold:
         Param.new(
           name: 'Range Threshold',
           grps_index: 16,
-          description: '0 - 100% of range setting',
-          default: 10,
-          units: '%'
+          options: {
+            description: '0 - 100% of range setting',
+            default: 10,
+            units: '%'
+          }
         ),
       angle_threshold:
-        Param.new(name: 'Angle Threshold', grps_index: 17, description: '-90° - 90°', default: 0, units: '°'),
+        Param.new(
+          name: 'Angle Threshold',
+          grps_index: 17,
+          options: {
+            description: '-90° - 90°',
+            default: 0,
+            units: '°'
+          }
+        ),
       speed_threshold:
         Param.new(
           name: 'Speed Threshold',
           grps_index: 18,
-          description: '0 - 100% of speed setting',
-          default: 50,
-          units: '%'
+          options: {
+            description: '0 - 100% of speed setting',
+            default: 50,
+            units: '%'
+          }
         ),
       digital_output1:
         Param.new(
           name: '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]
+          options: {
+            description: '0 = Direction, 1 = Angle, 2 = Range, 3 = Speed, 4 = Micro Detection',
+            default: 0,
+            str_values: %w[Direction Angle Range Speed Micro]
+          }
         ),
       digital_output2:
         Param.new(
           name: '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]
+          options: {
+            description: '0 = Direction, 1 = Angle, 2 = Range, 3 = Speed, 4 = Micro Detection',
+            default: 1,
+            str_values: %w[Direction Angle Range Speed Micro]
+          }
         ),
       digital_output3:
         Param.new(
           name: '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]
+          options: {
+            description: '0 = Direction, 1 = Angle, 2 = Range, 3 = Speed, 4 = Micro Detection',
+            default: 2,
+            str_values: %w[Direction Angle Range Speed Micro]
+          }
         ),
-      hold_time: Param.new(name: 'Hold Time', grps_index: 22, description: '1 - 7200s', default: 1, units: 's'),
+      hold_time:
+        Param.new(name: 'Hold Time', grps_index: 22, options: { description: '1 - 7200s', default: 1, units: 's' }),
       micro_detection_retrigger:
         Param.new(
           name: 'Micro Detection Trigger',
           grps_index: 23,
-          description: '0 = Off, 1 = Retrigger',
-          default: 0,
-          values: %w[Off Retrigger]
+          options: {
+            description: '0 = Off, 1 = Retrigger',
+            default: 0,
+            str_values: %w[Off Retrigger]
+          }
         ),
       micro_detection_sensativity:
         Param.new(
           name: 'Micro Detection Sensativity',
           grps_index: 24,
-          description: '0 - 9, 0 = Min, 9 = Max',
-          default: 4
+          options: {
+            description: '0 - 9, 0 = Min, 9 = Max',
+            default: 4
+          }
         )
     }.freeze
   end

data/lib/rfbeam/kld7/radar_messages.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'csv'
 
 module RfBeam
-  module KLD7
+  module Kld7
     def detection?
       data = ddat
       (data[2] == 1)
@@ -33,7 +35,7 @@ module RfBeam
       return resp unless formatted
 
       target_count = resp[1].to_i / 8
-      return [] unless target_count > 0
+      return [] unless target_count.positive?
 
       resp.shift 2
       resp.compact
@@ -58,6 +60,7 @@ module RfBeam
 
       resp = read(14).unpack('a4LC6')
       raise Error, "DDAT response = #{resp[0]}" unless resp[0] == 'DDAT'
+
       resp
     end
 
@@ -71,8 +74,8 @@ module RfBeam
 
     def config
       data = grps
-      output = "\n"
-      RADAR_PARAMETERS.keys.each { |key| output << formatted_parameter(key, data[RADAR_PARAMETERS[key].grps_index]) }
+      output = []
+      RADAR_PARAMETERS.each_key { |key| output << formatted_parameter(key, data[RADAR_PARAMETERS[key].grps_index]) }
       output
     end
 
@@ -82,7 +85,7 @@ module RfBeam
         data = grps
         value = data[param.grps_index]
       end
-      param_str_value = param.values.empty? ? value.to_s : param.values[value]
+      param_str_value = param.str_values.empty? ? value.to_s : param.str_values[value]
       "#{param.name}: #{param_str_value}#{param.units}\n"
     end
 

data/lib/rfbeam/kld7/radar_parameters.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module RfBeam
-  module KLD7
+  module Kld7
     # -----------------
     # Software Version, 'K-LD7_APP-RFB-XXXX'
     # -----------------
@@ -386,8 +388,6 @@ module RfBeam
           'L'
         when :int32
           'l'
-        when :uint32
-          'S'
         else
           'L'
         end

data/lib/rfbeam/kld7/serial_connection.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module RfBeam
-  module KLD7
+  module Kld7
     require 'rubyserial'
     require 'timeout'
-    
+
     class Error < StandardError
     end
 
@@ -80,10 +82,10 @@ module RfBeam
       raise Error, 'No valid response from Serial Port' if resp[2].nil?
 
       response_key = resp[2]
-      return response_key.zero? # Everything OK
-
       error_string = RESP_CODES[response_key].nil? ? 'Response unknown' : RESP_CODES[response_key]
-      raise Error, "Radar response Error: #{error_string}"
+      raise Error, "Radar response Error: #{error_string}" unless response_key.zero?
+
+      response_key.zero? # Everything OK
     end
   end
 end

data/lib/rfbeam/version.rb

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

data/lib/rfbeam.rb

@@ -13,8 +13,8 @@ module RfBeam
   class Error < StandardError
   end
 
-  class K_ld7
-    include RfBeam::KLD7
+  class KLD7
+    include RfBeam::Kld7
   end
 
   def self.connected

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rfbeam
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.4.4
 platform: ruby
 authors:
 - Rob Carruthers