rfbeam 0.4.9 → 0.4.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3ca645044245d21d0248633dc68c5ac8608102c0fe4d8a93d825b7735bc225f
-  data.tar.gz: 5a443dad972d3c26d5e462597f166c7fa333bc2294ecd3b0529ad036fbe23375
+  metadata.gz: 1d9b598dd013b48a6c19e5755f4af6a687a1fd2b82ac2aaa3d38c3a8b98db2f8
+  data.tar.gz: d1bf6b228eb6c0cff37ae44a178c7eb9b1e80e033894d2ae2456e2882d6ac180
 SHA512:
-  metadata.gz: 46e7f4cadd95cfabce4025d34e3cca666c655510b18e74edd451f3194ff70dfbd25bb116c88380873b34416c69f25274a2ee924ec45ac6913eb7cd76392d2c9d
-  data.tar.gz: f22887f60570dfa98d0430de0a6a487a3da566f1a9776058466015baa09b259026b4d064be99804669fddb9e1703ef8afc5892d5f42e22e6ecca8394278fdc28
+  metadata.gz: 277a4e68325e439d64db8ffc1af15b5b1aeae5be8b9f9718100d6fd9cdd7bb228274c51a856960d775f8f3ecf041616e59b039acf22b029b990d4b5488793053
+  data.tar.gz: 54b6209b877a2304139c8ea615d9fe0437b3393ee75385c00735ffe24279d0940d29b061cf28f6fbe47cdd7c5a2b208aecffe97a49b266f2aa8fad751cf52ae2

data/Gemfile.lock

@@ -9,7 +9,7 @@ GIT
 PATH
   remote: .
   specs:
-    rfbeam (0.4.9)
+    rfbeam (0.4.10)
       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

@@ -36,7 +36,7 @@ module RfBeam
 
     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)

data/lib/rfbeam/kld7/cli_formatter.rb

@@ -10,41 +10,41 @@ module RfBeam
         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 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
+      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
-      table
-    end
 
-    private
+      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
+      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
 
-    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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rfbeam
 version: !ruby/object:Gem::Version
-  version: 0.4.9
+  version: 0.4.10
 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