rfbeam 0.4.10 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d9b598dd013b48a6c19e5755f4af6a687a1fd2b82ac2aaa3d38c3a8b98db2f8
-  data.tar.gz: d1bf6b228eb6c0cff37ae44a178c7eb9b1e80e033894d2ae2456e2882d6ac180
+  metadata.gz: a612ea7d8038a09e50462eca0c5acaeb6358992df63d0929e26024dbff5004a9
+  data.tar.gz: e3bbc877194756cd958d3616623fb46bc384ae7e73430a3e096a950efe6ae3c9
 SHA512:
-  metadata.gz: 277a4e68325e439d64db8ffc1af15b5b1aeae5be8b9f9718100d6fd9cdd7bb228274c51a856960d775f8f3ecf041616e59b039acf22b029b990d4b5488793053
-  data.tar.gz: 54b6209b877a2304139c8ea615d9fe0437b3393ee75385c00735ffe24279d0940d29b061cf28f6fbe47cdd7c5a2b208aecffe97a49b266f2aa8fad751cf52ae2
+  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.10)
+    rfbeam (0.5.0)
       activesupport (~> 6.1.0)
       rubyserial (~> 0.6.0)
       thor (~> 1.2.1)

data/lib/rfbeam/cli.rb

@@ -24,17 +24,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)
 
@@ -43,20 +43,28 @@ module RfBeam
       @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,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(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.10'
+  VERSION = '0.5.0'
 end

metadata

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