rfbeam 0.4.10 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d9b598dd013b48a6c19e5755f4af6a687a1fd2b82ac2aaa3d38c3a8b98db2f8
-  data.tar.gz: d1bf6b228eb6c0cff37ae44a178c7eb9b1e80e033894d2ae2456e2882d6ac180
+  metadata.gz: 641d32533a354fa54db2906e234d7243899286dd85ab72a51d8a477b27f327cd
+  data.tar.gz: a1d94a25fee763ada51a4dc5fd6687f7bb4e1bc67a56adae257dd67efa6ded79
 SHA512:
-  metadata.gz: 277a4e68325e439d64db8ffc1af15b5b1aeae5be8b9f9718100d6fd9cdd7bb228274c51a856960d775f8f3ecf041616e59b039acf22b029b990d4b5488793053
-  data.tar.gz: 54b6209b877a2304139c8ea615d9fe0437b3393ee75385c00735ffe24279d0940d29b061cf28f6fbe47cdd7c5a2b208aecffe97a49b266f2aa8fad751cf52ae2
+  metadata.gz: 66d1d5f9e22d1adce03395cb153cebbc5eff4336b3cf3ade2a73d77548a7ff233ebe7d45b9ce09a23479c9c60382b0e81052c7da20f584792c8eb642b758a317
+  data.tar.gz: '094f688f3e86604632a1fa5fd05c3ff377e9b848deb6ed56eb024991e7ad8288641d3d29dc16f538cd4b1d564e5ac6f6b6dcaf77862048f3ffa9de351eab7932'

data/.streerc

@@ -0,0 +1 @@
+/Users/rob/.streerc

data/.streerc~1f4cd14e3c0a9afdf972aa5f3982d36a89869b72

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

data/.tool-versions

@@ -1 +1 @@
-ruby 3.1.2
+ruby 3.1.3

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+- - -
+## [v0.5.1](https://github.com/robcarruthers/rfbeam/compare/v0.5.0..v0.5.1) - 2023-05-09
+#### Documentation
+- **(cog)** Setup changelog generator - ([23dd6d8](https://github.com/robcarruthers/rfbeam/commit/23dd6d8407edaf6d4c29472fa60775a5aea87daa)) - [@robcarruthers](https://github.com/robcarruthers)
+- **(readme)** Updated - ([14bb58e](https://github.com/robcarruthers/rfbeam/commit/14bb58ecaa6f55166532151425fa24269b515937)) - [@robcarruthers](https://github.com/robcarruthers)
+
+- - -
+
+## [0.5.0] - 2023-11-4
+
+- Refactored CLI, refined help and options
+
 ## [0.4.2] - 2023-4-4
 
 - Changed Data.define to Struct to support ruby 3.1.2

data/Gemfile.lock

@@ -9,7 +9,7 @@ GIT
 PATH
   remote: .
   specs:
-    rfbeam (0.4.10)
+    rfbeam (0.5.1)
       activesupport (~> 6.1.0)
       rubyserial (~> 0.6.0)
       thor (~> 1.2.1)
@@ -89,6 +89,7 @@ GEM
 PLATFORMS
   aarch64-linux
   arm64-darwin-21
+  arm64-darwin-22
 
 DEPENDENCIES
   minitest (~> 5.0)

data/Rakefile

@@ -2,14 +2,19 @@
 
 require 'bundler/gem_tasks'
 require 'rake/testtask'
+require 'rubocop/rake_task'
 
-Rake::TestTask.new(:test) do |t|
+Rake::TestTask.new(:local_test) do |t|
   t.libs << 'test'
   t.libs << 'lib'
-  t.test_files = FileList['test/**/test_*.rb']
+  t.test_files = FileList['test/local_tests/test_*.rb']
 end
 
-require 'rubocop/rake_task'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/test_*.rb'].exclude('test/local_tests/**/*')
+end
 
 RuboCop::RakeTask.new
 

data/cog.toml

@@ -0,0 +1,24 @@
+from_latest_tag = false
+ignore_merge_commits = false
+branch_whitelist = []
+pre_bump_hooks = [ "bump set {{version}} -p 'chore(version):' -m 'v{{version}}'" ]
+post_bump_hooks = [ "rake release" ]
+pre_package_bump_hooks = []
+post_package_bump_hooks = []
+tag_prefix = "v"
+
+[commit_types]
+
+[changelog]
+path = "CHANGELOG.md"
+template = "remote"
+remote = "github.com"
+repository = "rfbeam"
+owner = "robcarruthers"
+authors = [
+  { signature = "Rob Carruthers", username = "robcarruthers" }
+]
+
+[bump_profiles]
+
+[packages]

data/lib/rfbeam/cli.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'thor'
-require 'rfbeam'
 require 'tty-table'
 require 'tty-logger'
 require 'tty-spinner'
@@ -10,7 +9,7 @@ require 'unicode_plot'
 
 module RfBeam
   class CLI < Thor
-    attr_accessor :logger
+    attr_accessor :radar, :logger
 
     desc 'list', 'List available radar modules'
     def list
@@ -24,17 +23,17 @@ module RfBeam
       puts table.render(:ascii)
     end
 
-    desc 'config <radar_id>', 'Shows the parameter setting for the Radar module'
+    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'
+    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'
+    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 Kld7::RADAR_PARAMETERS.include?(param.to_sym)
 
@@ -46,14 +45,35 @@ 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)
+      init_radar radar_id
+
+      if options[:stream]
+        Thread.new { monitor_keypress }
+        spinner = TTY::Spinner.new('[:spinner] :title ', format: :bouncing_ball)
+        loop do
+          break if @stop_streaming
+          spinner.spin
+          data = @radar.ddat
+          spinner.update title: "Searching... #{data[:detection_str]}"
+          @logger.success "#{@radar.tdat}" if data[:detection]
+        end
+        puts "\nTask Quit."
+      else
+        puts "\n#{@radar.ddat}"
+      end
+    end
+
+    desc 'tdat [RADAR_ID]', 'Display tracked target data'
+    option :raw, type: :boolean, aliases: '-r', desc: 'Display raw data'
+    def tdat(radar_id)
       cli = RfBeam::Kld7::CliOutput.new(radar_id)
-      cli.display(:ddat, stream: options[:stream])
+      cli.display(:tdat, options)
     end
 
-    desc 'pdat <radar_id>', 'Display Tracked Targets'
+    desc 'pdat [RADAR_ID]', 'Display Tracked Targets'
     def pdat(radar_id)
       cli = RfBeam::Kld7::CliOutput.new(radar_id)
-      cli.display(:pdat, stream: options[:stream])
+      cli.display(:pdat, options)
     end
 
     desc 'rfft <radar_id>', 'Display the dopplar radar data as a plot'
@@ -68,12 +88,6 @@ module RfBeam
       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)
@@ -81,7 +95,44 @@ module RfBeam
       @logger = TTY::Logger.new
       return @logger.warning 'No Radar modules found.' unless devices.count.positive?
 
-      RfBeam::KLD7.new(devices[id.to_i])
+      @radar = RfBeam::K_ld7.new(devices[id.to_i])
+    end
+
+    def 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 monitor_keypress
+      @stop_streaming = false
+      loop do
+        key = STDIN.getch
+        if key.downcase == 'q'
+          @stop_streaming = true
+          break
+        end
+      end
+    end
+
+    def rfft_plot(radar)
+      speed = radar.max_speed
+      speed_label = radar.formatted_parameter(:max_speed)
+      xlim = [speed - speed * 2, speed]
+      data = plot_data(radar.rfft)
+      plot =
+        UnicodePlot.lineplot(
+          data[:x],
+          data[:series1],
+          name: 'IF1/2 Averaged',
+          title: 'Raw FFT',
+          height: 25,
+          width: 120,
+          xlabel: "Speed (km/h), #{speed_label}",
+          ylabel: 'Signal (db)',
+          xlim: [-128, 128],
+          ylim: [0, 100]
+        )
+      UnicodePlot.lineplot!(plot, data[:x], data[:series2], name: 'Threshold')
+      plot
     end
   end
 end

data/lib/rfbeam/kld7/cli_formatter.rb

@@ -5,6 +5,10 @@ require 'tty-table'
 module RfBeam
   module Kld7
     class CliFormatter
+      def self.format(type, data)
+        new.format(type, data)
+      end
+
       def format(type, data)
         case type
         when :tdat
@@ -16,10 +20,6 @@ module RfBeam
         end
       end
 
-      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
@@ -41,6 +41,17 @@ module RfBeam
           .join("\n")
       end
 
+      def tdat(data)
+        return 'No target detected' unless data[1].positive?
+
+        [
+          "Distance: #{data[2].to_f / 100.0} m",
+          "Speed: #{data[3].to_f / 100.0} km/h",
+          "Angle: #{data[4].to_f / 100.0}°",
+          "Mag: #{data[5].to_f / 100.0} db"
+        ].join("\n")
+      end
+
       def to_symbol(string)
         modified_string = string.gsub(' ', '_').downcase
         modified_string.to_sym

data/lib/rfbeam/kld7/cli_output.rb

@@ -20,8 +20,9 @@ module RfBeam
         end
       end
 
-      def display(type, stream: false)
-        stream ? send("stream_#{type}") : send("display_#{type}")
+      def display(type, options)
+        display_method = options[:stream].nil? ? 'display' : 'stream'
+        send("#{display_method}_#{type}", options)
       end
 
       def plot(type, stream: false)
@@ -79,8 +80,12 @@ module RfBeam
         }
       end
 
-      def display_ddat
-        puts RfBeam::Kld7::CliFormatter.new.format(:ddat, @radar.ddat)
+      def display_ddat(options)
+        if options[:raw].nil?
+          puts RfBeam::Kld7::CliFormatter.format(:ddat, @radar.ddat)
+        else
+          puts @radar.ddat.inspect
+        end
       end
 
       def stream_ddat
@@ -98,11 +103,15 @@ module RfBeam
         end
       end
 
-      def display_tdat
-        puts RfBeam::Kld7::CliFormatter.new.tdat(@radar.tdat)
+      def display_tdat(options)
+        if options[:raw].nil?
+          puts RfBeam::Kld7::CliFormatter.format(:tdat, @radar.tdat)
+        else
+          puts @radar.tdat.inspect
+        end
       end
 
-      def display_pdat
+      def display_pdat(*)
         table = RfBeam::Kld7::CliFormatter.new.pdat_table(@radar.pdat)
         puts "\n   Detected Raw Targets"
         puts table.render(:unicode, alignment: :center)

data/lib/rfbeam/kld7/constants.rb

@@ -33,231 +33,158 @@ module RfBeam
       speed: %w[Low High]
     }.freeze
 
-    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, [])
+    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, options: { default: 'K-LD7_APP-RFB-XXXX' }),
+      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,
-          options: {
-            description: '0 = Low, 1 = Middle, 2 = High',
-            default: 1,
-            str_values: %w[Low Middle High]
-          }
+          description: '0 = Low, 1 = Middle, 2 = High',
+          default: 1,
+          values: %w[Low Middle High]
         ),
       max_speed:
         Param.new(
           name: 'Maximum Speed',
           grps_index: 4,
-          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]
-          }
+          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,
-          options: {
-            description: '0 = 5m, 1 = 10m, 2 = 30m, 3 = 100m',
-            default: 1,
-            str_values: %w[5m 10m 30m 100m]
-          }
+          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,
-          options: {
-            description: '10db - 60db',
-            default: 30,
-            units: 'db'
-          }
-        ),
+        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,
-          options: {
-            description: '0 = Standard, 2 = Fast Detection, 3 = Long Visibility',
-            default: 0,
-            str_values: ['standard', 'Fast Detection', 'Long Visibility']
-          }
+          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,
-          options: {
-            description: '0-16, 0 = No Suppression, 16 = High Suppression',
-            default: 2
-          }
+          description: '0-16, 0 = No Suppression, 16 = High Suppression',
+          default: 2
         ),
       min_detection_distance:
         Param.new(
           name: 'Minimum Detection Distance',
           grps_index: 9,
-          options: {
-            description: '0 - 100% of range setting',
-            default: 0,
-            units: '%'
-          }
+          description: '0 - 100% of range setting',
+          default: 0,
+          units: '%'
         ),
       max_detection_distance:
         Param.new(
           name: 'Maximum Detection Distance',
           grps_index: 10,
-          options: {
-            description: '0 - 100% of range setting',
-            default: 50,
-            units: '%'
-          }
+          description: '0 - 100% of range setting',
+          default: 50,
+          units: '%'
         ),
       min_detection_angle:
-        Param.new(
-          name: 'Minimum Detection Angle',
-          grps_index: 11,
-          options: {
-            description: '-90° - 90°',
-            default: -90,
-            units: '°'
-          }
-        ),
+        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,
-          options: {
-            description: '-90° - 90°',
-            default: 90,
-            units: '°'
-          }
-        ),
+        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,
-          options: {
-            description: '0 - 100% of speed setting',
-            default: 0,
-            units: '%'
-          }
+          description: '0 - 100% of speed setting',
+          default: 0,
+          units: '%'
         ),
       max_detection_speed:
         Param.new(
           name: 'Maximum Detection Speed',
           grps_index: 14,
-          options: {
-            description: '0 - 100% of speed setting',
-            default: 100,
-            units: '%'
-          }
+          description: '0 - 100% of speed setting',
+          default: 100,
+          units: '%'
         ),
       detection_direction:
         Param.new(
           name: 'Detection Direction',
           grps_index: 15,
-          options: {
-            description: '0 = Receding, 1 = Approaching, 2 = Both',
-            default: 2,
-            str_values: %w[Receding Approaching Both]
-          }
+          description: '0 = Receding, 1 = Approaching, 2 = Both',
+          default: 2,
+          values: %w[Receding Approaching Both]
         ),
       range_threshold:
         Param.new(
           name: 'Range Threshold',
           grps_index: 16,
-          options: {
-            description: '0 - 100% of range setting',
-            default: 10,
-            units: '%'
-          }
+          description: '0 - 100% of range setting',
+          default: 10,
+          units: '%'
         ),
       angle_threshold:
-        Param.new(
-          name: 'Angle Threshold',
-          grps_index: 17,
-          options: {
-            description: '-90° - 90°',
-            default: 0,
-            units: '°'
-          }
-        ),
+        Param.new(name: 'Angle Threshold', grps_index: 17, description: '-90° - 90°', default: 0, units: '°'),
       speed_threshold:
         Param.new(
           name: 'Speed Threshold',
           grps_index: 18,
-          options: {
-            description: '0 - 100% of speed setting',
-            default: 50,
-            units: '%'
-          }
+          description: '0 - 100% of speed setting',
+          default: 50,
+          units: '%'
         ),
       digital_output1:
         Param.new(
           name: 'Digital Output 1',
           grps_index: 19,
-          options: {
-            description: '0 = Direction, 1 = Angle, 2 = Range, 3 = Speed, 4 = Micro Detection',
-            default: 0,
-            str_values: %w[Direction Angle Range Speed Micro]
-          }
+          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,
-          options: {
-            description: '0 = Direction, 1 = Angle, 2 = Range, 3 = Speed, 4 = Micro Detection',
-            default: 1,
-            str_values: %w[Direction Angle Range Speed Micro]
-          }
+          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,
-          options: {
-            description: '0 = Direction, 1 = Angle, 2 = Range, 3 = Speed, 4 = Micro Detection',
-            default: 2,
-            str_values: %w[Direction Angle Range Speed Micro]
-          }
+          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, options: { description: '1 - 7200s', default: 1, units: 's' }),
+      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,
-          options: {
-            description: '0 = Off, 1 = Retrigger',
-            default: 0,
-            str_values: %w[Off Retrigger]
-          }
+          description: '0 = Off, 1 = Retrigger',
+          default: 0,
+          values: %w[Off Retrigger]
         ),
       micro_detection_sensativity:
         Param.new(
           name: 'Micro Detection Sensativity',
           grps_index: 24,
-          options: {
-            description: '0 - 9, 0 = Min, 9 = Max',
-            default: 4
-          }
+          description: '0 - 9, 0 = Min, 9 = Max',
+          default: 4
         )
     }.freeze
   end