rfbeam 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19f39170dee64099fe6806a345393beff434035df70fe525fa31b361468cac9e
-  data.tar.gz: 622aba1c5ab9f85fdb8cadf90f10339344306db39ab9299b2ef8b437d228d82d
+  metadata.gz: f97b41caa1ea2bb28202406b3c2ae9ab2cec96977f7238e3638407f7aa2e2fad
+  data.tar.gz: 12ecf75b483f934c2436a799405598ffd611d858acd15d099d00bcd73a4de30e
 SHA512:
-  metadata.gz: 57bd136ef560a32dab06e08c841b44e6e1b192525d9d3d44db1a88885c0b30b9b9b28ab28b1f408d628e191195373a012d31405ae24372fa4efd76ecbb3af46c
-  data.tar.gz: 5dc08c9c71c511e210a4c30599248bb5be53f1ccd7373af73edeb1ff35043dc76b90235bf46de93b9b755123af598225d6b96f06f6c0c5ab89bf4d1bc2e81d57
+  metadata.gz: e4a69f4f0501b19f05eb57887129089ac549a327f6fcb7ded1ffad3186f36260cb71ec766ef69916532447fd0138db5843111f4fad1b5b6c57c1d5c08466fb17
+  data.tar.gz: a7e7dc0c45b862dd2d37f28424e712236f4220bdef87ed4faccdb65b96f0e9cdf4984e3ff7c792940bb91b5896c32ac4f9cb678db45ba25a5f138bf6d475ecb1

data/.rubocop.yml

@@ -1,11 +1,9 @@
-inherit_from:
-  - node_modules/@prettier/plugin-ruby/rubocop.yml
-
 AllCops:
-  TargetRubyVersion: 3.2
+  TargetRubyVersion: 3.1
 
 Layout/LineLength:
   Max: 120
+  AutoCorrect: true
 
 Metrics/ModuleLength:
   Enabled: false
@@ -13,5 +11,8 @@ Metrics/ModuleLength:
 Metrics/MethodLength:
   Max: 20
 
+Metrics/ClassLength:
+  Enabled: false
+
 Documentation:
   Enabled: false

data/.streerc

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

data/.tool-versions

@@ -1 +1 @@
-ruby 3.2.1
+ruby 3.1.2

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [0.4.2] - 2023-4-4
+
+- Changed Data.define to Struct to support ruby 3.1.2
+
 ## [0.4.0] - 2023-4-4
 
 - rough CLI implementation

data/Gemfile

@@ -20,3 +20,7 @@ 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.4.0)
+    rfbeam (0.4.2)
       activesupport (~> 6.1.0)
       rubyserial (~> 0.6.0)
       thor (~> 1.2.1)
@@ -54,9 +54,12 @@ GEM
     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)
@@ -81,7 +84,9 @@ 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)

data/README.md

@@ -1,7 +1,7 @@
 # Rfbeam
 
 ![Gem](https://img.shields.io/gem/v/rfbeam?color=green&label=version)
-![Ruby](https://img.shields.io/static/v1?message=Ruby&color=red&logo=Ruby&logoColor=FFFFFF&label=v3.2.1)
+![Ruby](https://img.shields.io/static/v1?message=Ruby&color=red&logo=Ruby&logoColor=FFFFFF&label=v3.1.2)
 ![Ruby](https://img.shields.io/gitlab/license/robcarruthers/rfbeam?color=orange)
 
 RfBeam is a simple, high-level interface for the RFBeam radar modules.
@@ -67,12 +67,12 @@ Returns a formatted String of all parameter settings. The only way to read param
 
     radar.config
 
-    Software Version: K-LD7_APP-RFB-0103          
-    Base Frequency: Low                           
-    Maximum Speed: 100km/h                        
-    Maximum Range: 100m                           
-    Threshold Offset: 30db                        
-    Tracking Filter Type: Long Visibility         
+    Software Version: K-LD7_APP-RFB-0103
+    Base Frequency: Low
+    Maximum Speed: 100km/h
+    Maximum Range: 100m
+    Threshold Offset: 30db
+    Tracking Filter Type: Long Visibility
     Vibration Suppression: 16
     Minimum Detection Distance: 0%
     Maximum Detection Distance: 100%
@@ -91,7 +91,7 @@ Returns a formatted String of all parameter settings. The only way to read param
     Micro Detection Trigger: Off
     Micro Detection Sensativity: 4
 
-## Parameter setters
+## Parameter API
 
 ### Base Frequency
 
@@ -100,7 +100,7 @@ Returns a formatted String of all parameter settings. The only way to read param
 alias :rbfr
 
 ```ruby
-set_base_frequency(1)
+radar.radar.base_frequency = 1
 ```
 
 ### Maximum Speed
@@ -108,7 +108,7 @@ set_base_frequency(1)
 0 = 12.5km/h, 1 = 25km/h (default), 2 = 50km/h, 3 = 100km/h, alias :rspi
 
 ```ruby
-set_max_speed(1)
+radar.max_speed = 1
 ```
 
 ### Maximum Range
@@ -116,7 +116,7 @@ set_max_speed(1)
 0 = 5m, 1 = 10m (default), 2 = 30m, 3 = 100m, alias :rrai
 
 ```ruby
-set_max_range(1)
+radar.max_range = 1
 ```
 
 ### Threshold Offset
@@ -124,7 +124,7 @@ set_max_range(1)
 10 - 60db, (default = 30), alias :thof
 
 ```ruby
-set_threshold_offset(30)
+radar.threshold_offset = 30
 ```
 
 ### Tracking filter type
@@ -132,7 +132,7 @@ set_threshold_offset(30)
 0 = Standard (Default), 1 = Fast Tracking, 2 = Long visibility, alias :trtf
 
 ```ruby
-set_tracking_filter(0)
+radar.tracking_filter = 0
 ```
 
 ### Vibration suppression
@@ -140,7 +140,7 @@ set_tracking_filter(0)
 0 - 16, 0 = No Suppression, 16 = High Suppression, default = 2, alias :visu
 
 ```ruby
-set_vibration_suppression(2)
+radar.vibration_suppression = 2
 ```
 
 ### Minimum Detection distance
@@ -148,7 +148,7 @@ set_vibration_suppression(2)
 0 - 100% of Range setting, default = 0, alias :mira
 
 ```ruby
-set_min_detection_distance(0)
+radar.min_detection_distance = 0
 ```
 
 ### Maximum Detection distance
@@ -156,7 +156,7 @@ set_min_detection_distance(0)
 0 - 100% of Range setting, default = 50, alias :mara
 
 ```ruby
-set_max_detection_distance(50)
+radar.max_detection_distance = 50
 ```
 
 ### Minimum Detection Angle
@@ -164,7 +164,7 @@ set_max_detection_distance(50)
 -90° - 90°, default = -90, alias :mian
 
 ```ruby
-set_min_detection_angle(-90
+radar.min_detection_angle = -90
 ```
 
 ### Maximum Detection Angle
@@ -172,7 +172,7 @@ set_min_detection_angle(-90
 -90° - 90°, default = 90, alias :maan
 
 ```ruby
-set_min_detection_angle(90)
+radar.min_detection_angle = 90
 ```
 
 ### Minimum Detection Speed
@@ -180,7 +180,7 @@ set_min_detection_angle(90)
 0 - 100% of Speed setting, default = 0, alias :misp
 
 ```ruby
-set_min_detection_speed(0)
+radar.min_detection_speed = 0
 ```
 
 ### Maximum Detection Speed
@@ -188,7 +188,7 @@ set_min_detection_speed(0)
 0 - 100% of Speed setting, default = 100, alias :masp
 
 ```ruby
-set_max_detection_speed(100)
+radar.max_detection_speed = 100
 ```
 
 ### Detection Direction
@@ -196,7 +196,7 @@ set_max_detection_speed(100)
 0 = Receding, 1 = Approaching, 2 = Both (default), alias :dedi
 
 ```ruby
- set_detection_direction(2)
+radar. detection_direction = 2
 ```
 
 ### Range Threshold
@@ -204,7 +204,7 @@ set_max_detection_speed(100)
 0 - 100% of Range setting, default = 10, alias :rath
 
 ```ruby
- set_range_threshold(10)
+radar. range_threshold = 10
 ```
 
 ### Angle Threshold
@@ -212,7 +212,7 @@ set_max_detection_speed(100)
 -90° to 90°, default = 0, alias :anth
 
 ```ruby
- set_range_threshold(0)
+radar. range_threshold = 0
 ```
 
 ### Speed Threshold
@@ -220,37 +220,37 @@ set_max_detection_speed(100)
 0 - 100% of speed setting, default = 50, alias :spth
 
 ```ruby
- set_angle_threshold(50)
+radar. angle_threshold = 50
 ```
 
 ### Digital output 1
 
 0 = Direction, 1 = Angle, 2 = Range, 3 = Speed, 4 = Micro Detection, default = 0
 
-alias :dig1, :set_dio_1
+alias :dig1
 
 ```ruby
-set_dio_1(0)
+radar.digital_output1 = 0
 ```
 
 ### Digital output 2
 
 0 = Direction, 1 = Angle, 2 = Range, 3 = Speed, 4 = Micro Detection, default = 1
 
-alias :dig2, :set_dio_2
+alias :dig2
 
 ```ruby
-set_dio_2(1)
+radar.digital_output2 = 1
 ```
 
 ### Digital output 3
 
 0 = Direction, 1 = Angle, 2 = Range, 3 = Speed, 4 = Micro Detection, default = 2
 
-alias :dig3, :set_dio_3
+alias :dig3
 
 ```ruby
-set_dio_3(2)
+radar.digital_output3 = 2
 ```
 
 ### Hold Time
@@ -260,7 +260,7 @@ set_dio_3(2)
 alias :hold
 
 ```ruby
-set_hold_time(1)
+radar.hold_time = 1
 ```
 
 ### Micro Detection retrigger
@@ -270,7 +270,7 @@ set_hold_time(1)
 alias: :mide
 
 ```ruby
-set_micro_detection_retrigger(0)
+radar.micro_detection_retrigger = 0
 ```
 
 ### Micro Detection sensitivity
@@ -280,7 +280,31 @@ set_micro_detection_retrigger(0)
 alias: :mids
 
 ```ruby
-set_micro_detection_sensitivty(4)
+radar.micro_detection_sensitivty = 4
+```
+
+## CLI
+
+``` fish
+❯ bundle exec rfbeam list
+
++--+------------+------------------+
+|id|Path        |Version           |
++--+------------+------------------+
+|0 |/dev/ttyUSB0|K-LD7_APP-RFB-0103|
++--+------------+------------------+
+
+❯ bundle exec rfbeam help
+Commands:
+  rfbeam config <radar_id>                   # Shows the parameter setting for the Radar module
+  rfbeam ddat <radar_id>  -s, [--stream]     # stream any valid detections, stop stream with q and enter
+  rfbeam help [COMMAND]                      # Describe available commands or one specific command
+  rfbeam list                                # List available radar modules
+  rfbeam pdat <radar_id>                     # Display Tracked Targets
+  rfbeam reset <radar_id>                    # Shows the parameter setting for the Radar module
+  rfbeam rfft <radar_id>  -s, [--stream]     # Display the dopplar radar data as a plot
+  rfbeam set_param <radar_id> <key> <value>  # Set radar parameters, see readme for keys
+  rfbeam tdat <radar_id>                     # Display tracked target data
 ```
 
 ## Development

data/lib/rfbeam/cli.rb

@@ -1,4 +1,3 @@
-# rubocop:disable all
 require 'thor'
 require 'rfbeam'
 require 'tty-table'
@@ -9,122 +8,78 @@ 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?
+      logger.warning 'No Radar modules found.' unless devices.count.positive?
 
-      table = TTY::Table.new( header: ['id', 'Path', 'Version'])
+      table = TTY::Table.new(header: %w[id Path Version])
 
-      devices.each.with_index do |path, index|
-        table << ["R#{index}", path, @radar.sw_version]
-      end
+      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)
-      init_radar(radar_id)
-      puts @radar.config
+      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.warning("Invalid param: '#{param}'") unless RfBeam::K_ld7::RADAR_PARAMETERS.include?(param.to_sym)
+      return @logger.warn("Invalid param: '#{param}'") unless RfBeam::K_ld7::RADAR_PARAMETERS.include?(param.to_sym)
 
-      init_radar radar_id
-      @radar.send("#{param}=", value.to_i)
-      logger.success "Set #{@radar.formatted_parameter(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"
+    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}"
-            spinner.success @radar.tdat if data[2] == 1
-        end
-        spinner.stop
-        puts "\nTask Quit."
-      else
-          puts "\n#{@radar.ddat}"
-      end
-
+      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)
-      init_radar radar_id
-      puts @radar.pdat
+      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 :period, type: :numeric, aliases: '-p', default: 0.5, desc: "Update period (in seconds) for the streaming data"
+    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)
-      init_radar(radar_id)
-
-      if options[:stream]
-        streamer = RfBeam::KLD7::Streamer.new(@radar)
-        streamer.rfft
+      plotter = RfBeam::KLD7::CliOutput.new(radar_id)
+      if options[:raw]
+        print radar(radar_id).rfft
       else
-        plot = rfft_plot(@radar)
-        p plot.render
+        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 init_radar(id)
+    def radar(id)
       devices = RfBeam.connected
       @logger = TTY::Logger.new
       return @logger.warning 'No Radar modules found.' unless devices.count.positive?
 
-      @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
-      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
+      RfBeam::K_ld7.new(devices[id.to_i])
     end
   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