rfbeam 0.4.9 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3ca645044245d21d0248633dc68c5ac8608102c0fe4d8a93d825b7735bc225f
-  data.tar.gz: 5a443dad972d3c26d5e462597f166c7fa333bc2294ecd3b0529ad036fbe23375
+  metadata.gz: a612ea7d8038a09e50462eca0c5acaeb6358992df63d0929e26024dbff5004a9
+  data.tar.gz: e3bbc877194756cd958d3616623fb46bc384ae7e73430a3e096a950efe6ae3c9
 SHA512:
-  metadata.gz: 46e7f4cadd95cfabce4025d34e3cca666c655510b18e74edd451f3194ff70dfbd25bb116c88380873b34416c69f25274a2ee924ec45ac6913eb7cd76392d2c9d
-  data.tar.gz: f22887f60570dfa98d0430de0a6a487a3da566f1a9776058466015baa09b259026b4d064be99804669fddb9e1703ef8afc5892d5f42e22e6ecca8394278fdc28
+  metadata.gz: 4663603c15bb5423ee29710e0a743f9f979b7fd57185495062972189533e3c72f07712abb45ba77ea84dff55a6c2bcf72ef4142833195ca6d68f55632249c4a4
+  data.tar.gz: 4af5abb75a3fe9475ab0a4afd988b8fecc2323afc95d3f64f530f359b08ab0f390012a97272545d69d46da9e8051887a24a345b59434afcf90bc18b0312de2de

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## [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.9)
+    rfbeam (0.5.0)
       activesupport (~> 6.1.0)
       rubyserial (~> 0.6.0)
       thor (~> 1.2.1)

data/README.md

@@ -26,75 +26,90 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 The RfBeam class will return the path of any connected modules
 
-    RfBeam.connected
+```ruby
+RfBeam.connected
+=> ["/dev/ttyUSB0"]
+```
 
-Simple pass the path and baude rate to initialise a new radar object
+Simple pass the path and optional baude rate (default: 115200) to initialise a new radar object
 
-    RfBeam::KLD7.new("/dev/ttyUSB0", 115200) do |radar|
-        puts radar.config
-    end
+```ruby
+RfBeam::KLD7.new("/dev/ttyUSB0") do |radar|
+    puts radar.config
+end
+=>
+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%
+Minimum Detection Angle: -10°
+Maximum Detection Angle: 90°
+Minimum Detection Speed: 0%
+Maximum Detection Speed: 100%
+Detection Direction: Both
+Range Threshold: 10%
+Angle Threshold: 0°
+Speed Threshold: 50%
+Digital Output 1: Direction
+Digital Output 2: Angle
+Digital Output 3: Range
+Hold Time: 1s
+Micro Detection Trigger: Off
+Micro Detection Sensativity: 4
+```
 
-## RfBeam::K_ld7 API
+## RfBeam::KLD7 API
 
 ### detection?
 
 Returns true if the module has a valid detection.
 
-    radar.detection?
-    => true
+```ruby
+radar.detection?
+=> true
+```
 
 ### ddat
 
 Returns an array with the current detection values
 
-    radar.ddat
-    => ["DDAT", 6, 0, 0, 0, 0, 0, 0]
+```ruby
+radar.ddat
+=> ["DDAT", 6, 0, 0, 0, 0, 0, 0]
+```
 
 ### tdat
 
 Returns a hash with the current tracked object values
 
-    radar.tdat
-    => {:dist=>68, :speed=>196, :angle=>469, :mag=>6303}
+```ruby
+radar.tdat
+=> ["TDAT", 4, 68, 196, 469, 6303]
+```
 
 ### grps
 
 Returns the Parameter settings, values map to setting as detailed in the device datasheet.
 
-    radar.grps
-    => ["RPST", 42, "K-LD7_APP-RFB-0103", 1, 1, 1, 30, 0, 2, 0, 50, -90, 90, 0, 100, 2, 10, 0, 50, 0, 1, 2, 1, 0, 4]
+```ruby
+radar.grps
+=> ["RPST", 42, "K-LD7_APP-RFB-0103", 1, 1, 1, 30, 0, 2, 0, 50, -90, 90, 0, 100, 2, 10, 0, 50, 0, 1, 2, 1, 0, 4]
+```
 
 ### config
 
 Returns a formatted String of all parameter settings. The only way to read parameter settings is with config
 
-    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
-    Vibration Suppression: 16
-    Minimum Detection Distance: 0%
-    Maximum Detection Distance: 100%
-    Minimum Detection Angle: -10°
-    Maximum Detection Angle: 90°
-    Minimum Detection Speed: 0%
-    Maximum Detection Speed: 100%
-    Detection Direction: Both
-    Range Threshold: 10%
-    Angle Threshold: 0°
-    Speed Threshold: 50%
-    Digital Output 1: Direction
-    Digital Output 2: Angle
-    Digital Output 3: Range
-    Hold Time: 1s
-    Micro Detection Trigger: Off
-    Micro Detection Sensativity: 4
-
-## Parameter API
+```ruby
+radar.config
+```
+
+## Radar Parameters
 
 ### Base Frequency
 
@@ -318,7 +333,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rfbeam.
+Bug reports and pull requests are welcome on GitHub at https://github.com/robcarruthers/rfbeam.
 
 ## License
 

data/lib/rfbeam/cli.rb

@@ -24,39 +24,47 @@ 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 RfBeam::K_ld7::RADAR_PARAMETERS.include?(param.to_sym)
+      return @logger.warn("Invalid param: '#{param}'") unless Kld7::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'
+    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, press q to stop'
+    option :raw, type: :boolean, aliases: '-r', desc: 'Display raw data'
     def ddat(radar_id)
       cli = RfBeam::Kld7::CliOutput.new(radar_id)
-      cli.display(:ddat, stream: options[:stream])
+      cli.display(:ddat, options)
     end
 
-    desc 'pdat <radar_id>', 'Display Tracked Targets'
+    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(:tdat, options)
+    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])
+      cli.display(:pdat, options)
     end
 
-    desc 'rfft <radar_id>', 'Display the dopplar radar data as a plot'
+    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)
@@ -68,12 +76,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)

data/lib/rfbeam/kld7/cli_formatter.rb

@@ -5,46 +5,57 @@ 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
           tdat(data)
         when :pdat
-          pdat_table(data)
+          pdat(data)
         when :ddat
           ddat(data)
         end
       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
+        data.shift(2)
+        count.times do |index|
+          values = data.shift(4).map { |value| value.to_f / 100.0 }
+          table << [index, values].flatten
+        end
+        table
+      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 do |index|
-        values = data.shift(4).map { |value| value.to_f / 100.0 }
-        table << [index, values].flatten
+      private
+
+      def ddat(data)
+        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")
       end
-      table
-    end
 
-    private
+      def tdat(data)
+        return 'No target detected' unless data[1].positive?
 
-    def ddat(data)
-      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")
-    end
+        [
+          "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
+      def to_symbol(string)
+        modified_string = string.gsub(' ', '_').downcase
+        modified_string.to_sym
+      end
     end
   end
 end

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(options)
         table = RfBeam::Kld7::CliFormatter.new.pdat_table(@radar.pdat)
         puts "\n   Detected Raw Targets"
         puts table.render(:unicode, alignment: :center)

data/lib/rfbeam/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rfbeam
 version: !ruby/object:Gem::Version
-  version: 0.4.9
+  version: 0.5.0
 platform: ruby
 authors:
 - Rob Carruthers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-10 00:00:00.000000000 Z
+date: 2023-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport