rfbeam 0.3.5 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 139acc0d00964189f2eadbba6ed9c7b0e3f4b6c5104a757b2c1ab335d0e30c22
-  data.tar.gz: 86370312525afb17e493aa4b561a68b0f57dc48122f3ecd5f389c421c512cbe8
+  metadata.gz: 7edface1b941c801c5842d40d396f8343461271f10a7c381346338e415b074e9
+  data.tar.gz: 02bf778dc66bb874da0323867beeb350d5a69e8bb8aa3986c140a88370ae4d94
 SHA512:
-  metadata.gz: 76e49986de83640754506d935a5a46b0c74548fe96ac7fec03bff66efe048937eaf1dd1175ea25658e3cbdc3705f6f4744df56c969f584e9f3763629d37fbe0e
-  data.tar.gz: 0d032f953bca0658fb4edec3544925bd1fe675b759b1a9759a8cfbffea0abd76f7e1690bb9ae87df5d700a102d4c713f5bb858ca7a8b855d039c3ea448e94428
+  metadata.gz: 0d4cac38cff0bcc30df6501bc42c2cfcc054df8df5d94b486489d1b123d44afce4d5fc49f42e14efbb66813caa12aca4e6d7c67dcdd4c6c9438dfaf698591a51
+  data.tar.gz: ee253b692da85a7504a0de62353fca8d060d1618d9b265f0afd28b32416892fc5754eb57db09af996d8b2fe766a96b84fa6b49d8d7cd4f3675d8ec338cc1e9d0

data/.rubocop.yml

@@ -1,17 +1,18 @@
-inherit_from:
-  - node_modules/@prettier/plugin-ruby/rubocop.yml
-
 AllCops:
   TargetRubyVersion: 3.2
 
 Layout/LineLength:
   Max: 120
+  AutoCorrect: true
 
 Metrics/ModuleLength:
   Enabled: false
 
 Metrics/MethodLength:
-  Max: 15
+  Max: 20
+
+Metrics/ClassLength:
+  Enabled: false
 
 Documentation:
   Enabled: false

data/.streerc

@@ -0,0 +1,2 @@
+--print-width=120
+--plugins=plugin/single_quotes

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [0.4.0] - 2023-4-4
+
+- rough CLI implementation
+- Streaming rfft data, with plot output
+
 ## [0.3.5] - 2023-4-1
 
 - Updated Radar parameter accessors

data/Gemfile

@@ -10,3 +10,17 @@ gem "rake", "~> 13.0"
 gem "minitest", "~> 5.0"
 
 gem "rubocop", "~> 1.21"
+
+gem "tty-table", "~> 0.12.0"
+
+gem "tty-spinner", "~> 0.9.3"
+
+gem "unicode_plot", "~> 0.0.5"
+
+gem "tty-logger", "~> 0.6.0"
+
+gem "tty-screen", "~> 0.8.1"
+
+gem "tty-option", "~> 0.2.0"
+
+gem "tty-command", "~> 0.10.1"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rfbeam (0.3.5)
+    rfbeam (0.4.1)
       activesupport (~> 6.1.0)
       rubyserial (~> 0.6.0)
       thor (~> 1.2.1)
@@ -17,6 +17,7 @@ GEM
       zeitwerk (~> 2.3)
     ast (2.4.2)
     concurrent-ruby (1.1.10)
+    enumerable-statistics (2.0.7)
     ffi (1.15.5)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
@@ -25,6 +26,8 @@ GEM
     parallel (1.22.1)
     parser (3.1.3.0)
       ast (~> 2.4.1)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
     rainbow (3.1.1)
     rake (13.0.6)
     regexp_parser (2.6.1)
@@ -44,10 +47,32 @@ GEM
     ruby-progressbar (1.11.0)
     rubyserial (0.6.0)
       ffi (~> 1.9, >= 1.9.3)
+    strings (0.2.1)
+      strings-ansi (~> 0.2)
+      unicode-display_width (>= 1.5, < 3.0)
+      unicode_utils (~> 1.4)
+    strings-ansi (0.2.0)
     thor (1.2.1)
+    tty-color (0.6.0)
+    tty-command (0.10.1)
+      pastel (~> 0.8)
+    tty-cursor (0.7.1)
+    tty-logger (0.6.0)
+      pastel (~> 0.8)
+    tty-option (0.2.0)
+    tty-screen (0.8.1)
+    tty-spinner (0.9.3)
+      tty-cursor (~> 0.7)
+    tty-table (0.12.0)
+      pastel (~> 0.8)
+      strings (~> 0.2.0)
+      tty-screen (~> 0.8)
     tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.3.0)
+    unicode_plot (0.0.5)
+      enumerable-statistics (>= 2.0.1)
+    unicode_utils (1.4.0)
     zeitwerk (2.6.6)
 
 PLATFORMS
@@ -59,6 +84,13 @@ DEPENDENCIES
   rake (~> 13.0)
   rfbeam!
   rubocop (~> 1.21)
+  tty-command (~> 0.10.1)
+  tty-logger (~> 0.6.0)
+  tty-option (~> 0.2.0)
+  tty-screen (~> 0.8.1)
+  tty-spinner (~> 0.9.3)
+  tty-table (~> 0.12.0)
+  unicode_plot (~> 0.0.5)
 
 BUNDLED WITH
    2.4.10

data/exe/rfbeam

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'rfbeam'
+
+RfBeam::CLI.start(ARGV)

data/lib/rfbeam/cli.rb

@@ -0,0 +1,85 @@
+require 'thor'
+require 'rfbeam'
+require 'tty-table'
+require 'tty-logger'
+require 'tty-spinner'
+require 'io/console'
+require 'unicode_plot'
+
+module RfBeam
+  class CLI < Thor
+    attr_accessor :radar, :logger
+
+    desc 'list', 'List available radar modules'
+    def list
+      logger = TTY::Logger.new
+      devices = RfBeam.connected
+      logger.warning 'No Radar modules found.' unless devices.count.positive?
+
+      table = TTY::Table.new(header: %w[id Path Version])
+
+      devices.each.with_index { |path, index| table << ["#{index}", path, radar(index).sw_version] }
+      puts table.render(:ascii)
+    end
+
+    desc 'config <radar_id>', 'Shows the parameter setting for the Radar module'
+    def config(radar_id)
+      puts radar(radar_id).config
+    end
+
+    desc 'reset <radar_id>', 'Shows the parameter setting for the Radar module'
+    def reset(radar_id)
+      @logger.success 'Radar reset to factory defaults' if radar(radar_id).reset
+    end
+
+    desc 'set_param <radar_id> <key> <value>', 'Set radar parameters, see readme for keys'
+    def set_param(radar_id, param, value)
+      return @logger.warn("Invalid param: '#{param}'") unless RfBeam::K_ld7::RADAR_PARAMETERS.include?(param.to_sym)
+
+      r = radar(radar_id)
+      r.send("#{param}=", value.to_i)
+      @logger.success r.formatted_parameter(param.to_sym)
+    end
+
+    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.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.display(:pdat, stream: options[:stream])
+    end
+
+    desc 'rfft <radar_id>', 'Display the dopplar radar data as a plot'
+    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)
+      if options[:raw]
+        print radar(radar_id).rfft
+      else
+        plotter.plot(:rfft, stream: options[:stream])
+      end
+    end
+
+    desc 'tdat <radar_id>', 'Display tracked target data'
+    def tdat(radar_id)
+      cli = RfBeam::KLD7::CliOutput.new(radar_id)
+      cli.display(:tdat, stream: options[:stream])
+    end
+
+    private
+
+    def radar(id)
+      devices = RfBeam.connected
+      @logger = TTY::Logger.new
+      return @logger.warning 'No Radar modules found.' unless devices.count.positive?
+
+      RfBeam::K_ld7.new(devices[id.to_i])
+    end
+  end
+end

data/lib/rfbeam/kld7/cli_formatter.rb

@@ -0,0 +1,41 @@
+require 'tty-table'
+
+module RfBeam
+  module KLD7
+    class CliFormatter
+      def tdat(data)
+        { dist: data[2], speed: data[3], angle: data[4], mag: data[5] }
+      end
+
+      def pdat_table(data)
+        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|
+          values = data.shift(4).map { |value| value.to_f / 100.0 }
+          table << [index, values].flatten
+        end
+        table
+      end
+
+      def ddat(data)
+        if data[2] == 1
+          labels = ['Detection', 'Micro Detection', 'Angle', 'Direction', 'Range', 'Speed']
+          labels
+            .map
+            .with_index { |label, index| "#{label}: #{DETECTION_FLAGS[to_symbol(label)][data[index + 2]]}" }
+            .join("\n")
+        else
+          'DDAT: No Detection'
+        end
+      end
+
+      private
+
+      def to_symbol(string)
+        modified_string = string.gsub(' ', '_').downcase
+        modified_string.to_sym
+      end
+    end
+  end
+end

data/lib/rfbeam/kld7/cli_output.rb

@@ -0,0 +1,127 @@
+require 'unicode_plot'
+require 'io/console'
+require 'stringio'
+require 'tty-screen'
+require 'tty-logger'
+
+module RfBeam
+  module KLD7
+    class CliOutput
+      attr_reader :radar
+
+      def initialize(radar_id)
+        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])
+      end
+
+      def display(type, stream: false)
+        send("display_#{type}", stream)
+      end
+
+      def plot(type, stream: false)
+        stream ? stream_plot(type) : display_plot(type)
+      end
+
+      def display_plot(type)
+        out = StringIO.new
+        def out.tty?
+          true
+        end
+        out.truncate(0)
+
+        plot = send("#{type}_plot")
+        plot.render(out)
+
+        lines = out.string.lines
+        lines.each { |line| $stdout.print "\r#{line}" }
+        $stdout.print "\e[0J"
+        $stdout.flush
+
+        if @streaming
+          n = lines.count
+          $stdout.print "\e[#{n}F"
+        end
+      end
+
+      def stream_plot(type)
+        @streaming = true
+        Thread.new { monitor_keypress }
+
+        loop do
+          display_plot(type)
+          break unless @streaming
+        end
+      end
+
+      private
+
+      def monitor_keypress
+        loop do
+          key = STDIN.getch
+          if key.downcase == 'q'
+            @streaming = false
+            break
+          end
+        end
+      end
+
+      def rfft_plot_data(data)
+        {
+          x: Array(-128...128),
+          series1: data.shift(256).map { |value| value / 100 },
+          series2: data.shift(256).map { |value| value.to_i / 100 }
+        }
+      end
+
+      def display_ddat(stream)
+        if stream
+          @streaming = true
+          Thread.new { monitor_keypress }
+          spinner = TTY::Spinner.new('[:spinner] :title ', format: :bouncing_ball)
+          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]
+          end
+        else
+          puts RfBeam::KLD7::CliFormatter.new.ddat(@radar.ddat)
+        end
+      end
+
+      def display_tdat(stream)
+        puts RfBeam::KLD7::CliFormatter.new.tdat(@radar.tdat)
+      end
+
+      def display_pdat(stream)
+        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
+        data = rfft_plot_data(@radar.rfft)
+        plot =
+          UnicodePlot.lineplot(
+            data[:x],
+            data[:series1],
+            name: 'IF1/2 Averaged',
+            title: 'Raw FFT',
+            height: 25,
+            width: width,
+            xlabel: 'Speed (km/h)',
+            ylabel: 'Signal (db)',
+            xlim: [-128, 128],
+            ylim: [0, 100]
+          )
+        UnicodePlot.lineplot!(plot, data[:x], data[:series2], name: 'Threshold')
+        plot
+      end
+    end
+  end
+end

data/lib/rfbeam/kld7/constants.rb

@@ -14,52 +14,176 @@ module RfBeam
       6 => 'Timeout error'
     }.freeze
 
-    # The response delay was determined empirically and may need adjusting with baude rate
-    RESP_DELAY = 0.1
+    # Delays are determined empirically and may need adjusting with baude rate
+    RESPONSE_DELAY = 0.05
+    MEASUREMENT_DELAY = 0.15
 
     # 'GNFD' command types
     FRAME_DATA_TYPES = { disabled: 0x00, radc: 0x01, rfft: 0x02, pdat: 0x04, tdat: 0x08, ddat: 0x10, done: 0x20 }.freeze
 
     # The angle, direction, range and speed flags are only valid if the detection flag is 1.
     DETECTION_FLAGS = {
-      detection: ['No Detection', 'Detection'],
-      micro_detection: ['No Detection', 'Detection'],
+      detection: ['No', 'Yes'],
+      micro_detection: ['No', 'Yes'],
       angle: %w[Left Right],
       direction: %w[Receding Approaching],
       range: %w[Far Near],
       speed: %w[Low High]
     }.freeze
-    
-    Param = Data.define(:name, :grps_index, :description, :default, :units, :values) do |_param|
-      def initialize(name:, grps_index:, description: nil, default: nil, units: nil, values: [])
-        super(name:, grps_index:, description:, default:, units:, values:)
+
+    Param =
+      Data.define(:name, :grps_index, :description, :default, :units, :values) do |_param|
+        def initialize(name:, grps_index:, description: nil, default: nil, units: nil, values: [])
+          super(name:, grps_index:, description:, default:, units:, values:)
+        end
       end
-    end
 
     RADAR_PARAMETERS = {
       sw_version: Param.new(name: 'Software Version', grps_index: 2, 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: ['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: ['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] ),
-      threshhold_offset: Param.new( name: 'Threshold Offset', grps_index: 6, 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'] ),
-      vibration_suppression: Param.new( name: 'Vibration Suppression', grps_index: 8, 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: '%' ),
-      max_detection_distance: Param.new( name: 'Maximum Detection Distance', grps_index: 10, 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: '°' ),
-      max_detection_angle: Param.new( name: 'Maximum Detection Angle', grps_index: 12, 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: '%' ),
-      max_detection_speed: Param.new( name: 'Maximum Detection Speed', grps_index: 14, 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] ),
-      range_threshold: Param.new( name: 'Range Threshold', grps_index: 16, 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: '°' ),
-      speed_threshold: Param.new( name: 'Speed Threshold', grps_index: 18, 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] ),
-      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] ),
-      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] ),
-      hold_time: Param.new( name: 'Hold Time', grps_index: 22, 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] ),
-      micro_detection_sensativity: Param.new( name: 'Micro Detection Sensativity', grps_index: 24, description: '0 - 9, 0 = Min, 9 = Max', default: 4 )
-  }.freeze
+      base_frequency:
+        Param.new(
+          name: 'Base Frequency',
+          grps_index: 3,
+          description: '0 = Low, 1 = Middle, 2 = High',
+          default: 1,
+          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]
+        ),
+      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]
+        ),
+      threshold_offset:
+        Param.new(name: 'Threshold Offset', grps_index: 6, 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']
+        ),
+      vibration_suppression:
+        Param.new(
+          name: 'Vibration Suppression',
+          grps_index: 8,
+          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: '%'
+        ),
+      max_detection_distance:
+        Param.new(
+          name: 'Maximum Detection Distance',
+          grps_index: 10,
+          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: '°'),
+      max_detection_angle:
+        Param.new(name: 'Maximum Detection Angle', grps_index: 12, 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: '%'
+        ),
+      max_detection_speed:
+        Param.new(
+          name: 'Maximum Detection Speed',
+          grps_index: 14,
+          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]
+        ),
+      range_threshold:
+        Param.new(
+          name: 'Range Threshold',
+          grps_index: 16,
+          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: '°'),
+      speed_threshold:
+        Param.new(
+          name: 'Speed Threshold',
+          grps_index: 18,
+          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]
+        ),
+      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]
+        ),
+      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]
+        ),
+      hold_time: Param.new(name: 'Hold Time', grps_index: 22, 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]
+        ),
+      micro_detection_sensativity:
+        Param.new(
+          name: 'Micro Detection Sensativity',
+          grps_index: 24,
+          description: '0 - 9, 0 = Min, 9 = Max',
+          default: 4
+        )
+    }.freeze
   end
 end

data/lib/rfbeam/kld7/radar_messages.rb

@@ -1,13 +1,35 @@
+require 'csv'
+
 module RfBeam
   module KLD7
     def detection?
       data = ddat
       (data[2] == 1)
     end
-    
+
+    def rfft
+      request_frame_data(:rfft)
+      sleep MEASUREMENT_DELAY
+      data = read(1032).unpack('a4LS256S256')
+      header, length = data.shift(2)
+      raise Error, "RFFT header response, header=#{header}" unless header == 'RFFT'
+      raise Error, "RFFT payload length, length=#{length}" unless length == 1024
+
+      data
+    end
+
+    def reset
+      command = ['RFSE', 0]
+      write command.pack('a4L')
+      check_response
+    end
+    alias rfse reset
+
     def pdat(formatted: false)
-      request_frame_data(:pdat)      
+      request_frame_data(:pdat)
       resp = read(102).unpack('a4LSssSSssSSssSSssSSssSSssSSssSSssSSssSSssS')
+      raise Error, "PDAT response = #{resp[0]}" unless resp[0] == 'PDAT'
+
       return resp unless formatted
 
       target_count = resp[1].to_i / 8
@@ -22,29 +44,21 @@ module RfBeam
 
     def tdat
       request_frame_data(:tdat)
+      sleep MEASUREMENT_DELAY
 
-      sleep 0.1
       resp = read(16).unpack('a4LSssS')
-      return { dist: resp[2], speed: resp[3], angle: resp[4], mag: resp[5] } unless resp[1].zero?
+      raise Error, "TDAT response = #{resp[0]}" unless resp[0] == 'TDAT'
+
+      resp
     end
 
     def ddat
       request_frame_data(:ddat)
+      sleep MEASUREMENT_DELAY
 
-      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]
+      resp = read(14).unpack('a4LC6')
+      raise Error, "DDAT response = #{resp[0]}" unless resp[0] == 'DDAT'
+      resp
     end
 
     # Get the radar parameter structure
@@ -54,12 +68,28 @@ module RfBeam
       check_response
       read(50).unpack('a4LA19C8c2C4cCCCCSCC')
     end
-    
+
+    def config
+      data = grps
+      output = "\n"
+      RADAR_PARAMETERS.keys.each { |key| output << formatted_parameter(key, data[RADAR_PARAMETERS[key].grps_index]) }
+      output
+    end
+
+    def formatted_parameter(param, value = nil)
+      param = RADAR_PARAMETERS[param]
+      if value.nil?
+        data = grps
+        value = data[param.grps_index]
+      end
+      param_str_value = param.values.empty? ? value.to_s : param.values[value]
+      "#{param.name}: #{param_str_value}#{param.units}\n"
+    end
 
     private
 
     def format_raw_target_data(array)
-        { dist: array.shift, speed: array.shift, angle: array.shift, mag: array.shift }
+      { dist: array.shift, speed: array.shift, angle: array.shift, mag: array.shift }
     end
 
     def request_frame_data(type)
@@ -67,15 +97,5 @@ module RfBeam
       write command.pack('a4LL')
       check_response
     end
-
-    def formatted_grps(data)
-      output = "\n"
-      RADAR_PARAMETERS.each do |param|
-        param = param[1]
-        value = param.values.empty? ? data[param.grps_index] : param.values[data[param.grps_index].to_i]
-        output << "#{param.name}: #{value}#{param.units}\n"
-      end
-      output
-    end
   end
 end

data/lib/rfbeam/kld7/radar_parameters.rb

@@ -1,6 +1,13 @@
 module RfBeam
   module KLD7
 
+    # -----------------
+    # Software Version, 'K-LD7_APP-RFB-XXXX'
+    # -----------------
+    def sw_version
+      query_parameter RADAR_PARAMETERS[:sw_version].grps_index
+    end
+
     # -----------------
     # Base Frequency, 0 = low, 1 = middle (default), 2 = high
     # -----------------
@@ -52,6 +59,7 @@ module RfBeam
     
     def max_range=(range = 1)
       raise ArgumentError, "Invalid arg: '#{range}'" unless (0..3).include?(range)
+      raise ArgumentError, "Expected an Integer" unless range.is_a?(Integer)
       
       set_parameter :rrai, range, :uint32
     end
@@ -68,7 +76,7 @@ module RfBeam
     
     def threshold_offset=(offset = 30)
       raise ArgumentError, "Invalid arg: '#{offset}'" unless (10..60).include?(offset)
-      raise ArgumentError, "Expected an Integer" unless range.is_a?(Integer)
+      raise ArgumentError, "Expected an Integer" unless offset.is_a?(Integer)
       
       set_parameter :thof, offset, :uint32
     end
@@ -83,13 +91,14 @@ module RfBeam
       query_parameter RADAR_PARAMETERS[:tracking_filter].grps_index
     end
     
-    def set_tracking_filter(type = 0)
+    def tracking_filter=(type = 0)
       raise ArgumentError, "Invalid arg: '#{type}'" unless (0..2).include?(type)
       raise ArgumentError, "Expected an Integer" unless type.is_a?(Integer)
       
       set_parameter :trft, type, :uint32
     end
-    alias trtf set_tracking_filter
+    alias trtf= tracking_filter=
+    alias set_tracking_filter tracking_filter=
     
     # -----------------
     # Vibration suppression, 0 - 16, 0 = No Suppression, 16 = High Suppression, default = 2
@@ -271,7 +280,7 @@ module RfBeam
     # Digital output 1, 0 = Direction, 1 = Angle, 2 = Range, 3 = Speed, 4 = Micro Detection, default = 0
     # -----------------
     def digital_output1
-      query_parameter RADAR_PARAMETERS[:digital_output1]grps_index
+      query_parameter RADAR_PARAMETERS[:digital_output1].grps_index
     end
     
     def digital_output1=(value = 0)      
@@ -287,7 +296,7 @@ module RfBeam
     # Digital output 2, 0 = Direction, 1 = Angle, 2 = Range, 3 = Speed, 4 = Micro Detection, default = 1
     # -----------------
     def digital_output2
-      query_parameter RADAR_PARAMETERS[:digital_output2]grps_index
+      query_parameter RADAR_PARAMETERS[:digital_output2].grps_index
     end
     
     def digital_output2=(value = 1)
@@ -296,7 +305,7 @@ module RfBeam
       
       set_parameter :dig2, value, :uint32
     end
-    alias dig2= set_digital_output2=
+    alias dig2= digital_output2=
     alias set_digital_output2 digital_output2=
     
     # -----------------
@@ -360,8 +369,8 @@ module RfBeam
       
       set_parameter :mids, value, :uint32
     end
-    alias mids= micro_detection_sensitivty=
-    alias set_micro_detection_sensitivity micro_detection_sensitivty=
+    alias mids= micro_detection_sensitivity=
+    alias set_micro_detection_sensitivity micro_detection_sensitivity=
 
     private
 

data/lib/rfbeam/kld7/serial_connection.rb

@@ -75,7 +75,7 @@ module RfBeam
     end
 
     def check_response
-      sleep RESP_DELAY
+      sleep RESPONSE_DELAY
       resp = @serial_port.read(9).unpack('a4LC') # 4 ASCII bytes, UINT32, UINT8
       raise Error, 'No valid response from Serial Port' if resp[2].nil?
 

data/lib/rfbeam/version.rb

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

data/lib/rfbeam.rb

@@ -4,7 +4,10 @@ require 'rfbeam/kld7/radar_parameters'
 require 'rfbeam/kld7/radar_messages'
 require 'rfbeam/kld7/serial_connection'
 require 'rfbeam/kld7/constants'
-require_relative 'rfbeam/version'
+require 'rfbeam/kld7/cli_output'
+require 'rfbeam/kld7/cli_formatter'
+require 'rfbeam/version'
+require 'rfbeam/cli'
 
 module RfBeam
   class Error < StandardError

data/output.csv

@@ -0,0 +1,257 @@
+0,2105,2105
+1,3070,2915
+2,2915,805
+3,2325,2830
+4,805,3420
+5,1000,1340
+6,2830,1555
+7,3810,2645
+8,3420,1270
+9,1645,1400
+10,1340,1130
+11,1285,1350
+12,1555,1085
+13,1500,910
+14,2645,1400
+15,2785,1435
+16,1270,1150
+17,500,1545
+18,1400,1270
+19,615,1285
+20,1130,1435
+21,1000,785
+22,1350,710
+23,1565,955
+24,1085,1165
+25,1420,1645
+26,910,1595
+27,1265,455
+28,1400,805
+29,1015,1050
+30,1435,560
+31,1060,1530
+32,1150,3275
+33,305,3510
+34,1545,650
+35,765,1415
+36,1270,1760
+37,785,650
+38,1285,830
+39,980,560
+40,1435,850
+41,1085,0
+42,785,480
+43,1340,1150
+44,710,910
+45,1210,1050
+46,955,500
+47,1000,1230
+48,1165,1040
+49,1060,955
+50,1645,910
+51,2200,150
+52,1595,455
+53,1085,150
+54,455,830
+55,1400,455
+56,805,500
+57,1490,850
+58,1050,0
+59,560,980
+60,560,1040
+61,800,500
+62,1530,800
+63,0,1410
+64,3275,305
+65,3990,1570
+66,3510,1255
+67,1105,955
+68,650,150
+69,700,655
+70,1415,1245
+71,1295,455
+72,1760,710
+73,1235,560
+74,650,650
+75,500,1000
+76,830,760
+77,650,760
+78,560,350
+79,1240,305
+80,850,150
+81,1400,910
+82,0,650
+83,805,500
+84,480,1180
+85,150,1435
+86,1150,850
+87,1360,800
+88,910,1305
+89,1190,910
+90,1050,1260
+91,1115,455
+92,500,1000
+93,800,615
+94,1230,1265
+95,980,3955
+96,1040,3675
+97,500,615
+98,955,300
+99,1285,1825
+100,910,760
+101,980,1315
+102,150,1435
+103,1200,1260
+104,455,850
+105,480,1260
+106,150,1970
+107,500,1015
+108,830,350
+109,700,735
+110,455,1680
+111,150,350
+112,500,1135
+113,605,865
+114,850,1735
+115,805,850
+116,0,1165
+117,710,1965
+118,980,810
+119,305,1005
+120,1040,1200
+121,150,2885
+122,500,1095
+123,710,1060
+124,800,2455
+125,1265,2145
+126,1410,1665
+127,1175,3230
+128,305,4328
+129,1255,4228
+130,1570,4069
+131,980,3995
+132,1255,3946
+133,1480,3910
+134,955,3881
+135,455,3857
+136,150,3836
+137,910,3818
+138,655,3802
+139,350,3788
+140,1245,3774
+141,1150,3762
+142,455,3751
+143,560,3741
+144,710,3731
+145,150,3722
+146,560,3714
+147,830,3706
+148,650,3698
+149,655,3691
+150,1000,3684
+151,350,3677
+152,760,3671
+153,455,3665
+154,760,3659
+155,560,3654
+156,350,3648
+157,655,3643
+158,305,3638
+159,150,3633
+160,150,3629
+161,910,3624
+162,910,3620
+163,1190,3616
+164,650,3612
+165,455,3608
+166,500,3604
+167,500,3600
+168,1180,3596
+169,1500,3592
+170,1435,3589
+171,1265,3586
+172,850,3582
+173,650,3579
+174,800,3576
+175,1350,3573
+176,1305,3569
+177,1260,3566
+178,910,3563
+179,805,3561
+180,1260,3558
+181,1175,3555
+182,455,3552
+183,965,3550
+184,1000,3547
+185,755,3544
+186,615,3542
+187,350,3539
+188,1265,3537
+189,935,3534
+190,3955,3532
+191,4445,3530
+192,3675,3528
+193,1365,3530
+194,615,3532
+195,605,3534
+196,300,3537
+197,1135,3539
+198,1825,3542
+199,895,3544
+200,760,3547
+201,500,3550
+202,1315,3552
+203,1330,3555
+204,1435,3558
+205,1385,3561
+206,1260,3563
+207,920,3566
+208,850,3569
+209,615,3573
+210,1260,3576
+211,1545,3579
+212,1970,3582
+213,1605,3586
+214,1015,3589
+215,955,3592
+216,350,3596
+217,1270,3600
+218,735,3604
+219,1330,3608
+220,1680,3612
+221,630,3616
+222,350,3620
+223,1200,3624
+224,1135,3629
+225,850,3633
+226,865,3638
+227,1540,3643
+228,1735,3648
+229,500,3654
+230,850,3659
+231,150,3665
+232,1165,3671
+233,1345,3677
+234,1965,3684
+235,1630,3691
+236,810,3698
+237,1175,3706
+238,1005,3714
+239,500,3722
+240,1200,3731
+241,2830,3741
+242,2885,3751
+243,1630,3762
+244,1095,3774
+245,980,3788
+246,1060,3802
+247,1190,3818
+248,2455,3836
+249,3045,3857
+250,2145,3881
+251,1500,3910
+252,1665,3946
+253,1975,3995
+254,3230,
+255,3470,
+256,4328,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rfbeam
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.4.1
 platform: ruby
 authors:
 - Rob Carruthers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-01 00:00:00.000000000 Z
+date: 2023-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -55,12 +55,14 @@ dependencies:
 description: Currently only tested with K-LD7 on MacOS & Raspian (bullseye)
 email:
 - robc@hey.com
-executables: []
+executables:
+- rfbeam
 extensions: []
 extra_rdoc_files: []
 files:
 - ".DS_Store"
 - ".rubocop.yml"
+- ".streerc"
 - ".tool-versions"
 - CHANGELOG.md
 - Gemfile
@@ -68,7 +70,11 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- exe/rfbeam
 - lib/rfbeam.rb
+- lib/rfbeam/cli.rb
+- lib/rfbeam/kld7/cli_formatter.rb
+- lib/rfbeam/kld7/cli_output.rb
 - lib/rfbeam/kld7/constants.rb
 - lib/rfbeam/kld7/radar_messages.rb
 - lib/rfbeam/kld7/radar_parameters.rb
@@ -159,6 +165,7 @@ files:
 - node_modules/prettier/parser-yaml.js
 - node_modules/prettier/standalone.js
 - node_modules/prettier/third-party.js
+- output.csv
 - package.json
 - rfbeam.gemspec
 - sig/rfbeam.rbs