rfbeam 0.4.8 → 0.4.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0b3dc099fbf26e535ffa58dad9e643a2556168528d206d8f0fb7d73507cba3e
-  data.tar.gz: f75cfd53fe0bc32e982dd75e53af8a9e7c976f64abc3eca43ea1a31549ba6bd8
+  metadata.gz: 1d9b598dd013b48a6c19e5755f4af6a687a1fd2b82ac2aaa3d38c3a8b98db2f8
+  data.tar.gz: d1bf6b228eb6c0cff37ae44a178c7eb9b1e80e033894d2ae2456e2882d6ac180
 SHA512:
-  metadata.gz: 6f00551148744f9d8f214ebef729fa5f26e84c8403f88ce1cd6534c407a577fc439f284c20899d08d861252f269c007126a06501a4175d0c802c0581c0030861
-  data.tar.gz: cf59d75f0b12ea6bfa7b6d0dd519da5f8ef5c700c5cdf66d177e8e6bcea59911550aa7c7215049deebc7e13c0c9430ae8b6d6c5ba44c57ad9db6a1155e2c7f86
+  metadata.gz: 277a4e68325e439d64db8ffc1af15b5b1aeae5be8b9f9718100d6fd9cdd7bb228274c51a856960d775f8f3ecf041616e59b039acf22b029b990d4b5488793053
+  data.tar.gz: 54b6209b877a2304139c8ea615d9fe0437b3393ee75385c00735ffe24279d0940d29b061cf28f6fbe47cdd7c5a2b208aecffe97a49b266f2aa8fad751cf52ae2

data/Gemfile.lock

@@ -9,7 +9,7 @@ GIT
 PATH
   remote: .
   specs:
-    rfbeam (0.4.8)
+    rfbeam (0.4.10)
       activesupport (~> 6.1.0)
       rubyserial (~> 0.6.0)
       thor (~> 1.2.1)

data/README.md

@@ -1,11 +1,14 @@
 # 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.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.
-The user can query process and raw detection data and set the radar parameters for the sensor.
+![Gem](https://img.shields.io/gem/v/rfbeam?color=green&label=version)
+![Build](https://img.shields.io/gitlab/pipeline-status/robcarruthers/rfbeam?branch=master)
+![Build](https://img.shields.io/gitlab/last-commit/robcarruthers/rfbeam)
+
+RfBeam is a simple, high-level interface and CLI for the RFBeam radar modules.
+The user can query/set radar parameters, raw detection data and stream data from the sensor.
 
 At this stage it only works on Linux and Mac with the K-LD7 module.
 
@@ -23,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
 
@@ -315,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

@@ -5,6 +5,17 @@ require 'tty-table'
 module RfBeam
   module Kld7
     class CliFormatter
+      def format(type, data)
+        case type
+        when :tdat
+          tdat(data)
+        when :pdat
+          pdat(data)
+        when :ddat
+          ddat(data)
+        end
+      end
+
       def tdat(data)
         { dist: data[2], speed: data[3], angle: data[4], mag: data[5] }
       end
@@ -20,20 +31,16 @@ module RfBeam
         table
       end
 
+      private
+
       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
+        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
 
-      private
-
       def to_symbol(string)
         modified_string = string.gsub(' ', '_').downcase
         modified_string.to_sym

data/lib/rfbeam/kld7/cli_output.rb

@@ -80,7 +80,7 @@ module RfBeam
       end
 
       def display_ddat
-        puts RfBeam::Kld7::CliFormatter.new.ddat(@radar.ddat)
+        puts RfBeam::Kld7::CliFormatter.new.format(:ddat, @radar.ddat)
       end
 
       def stream_ddat

data/lib/rfbeam/kld7/constants.rb

@@ -28,7 +28,7 @@ module RfBeam
       detection: %w[No Yes],
       micro_detection: %w[No Yes],
       angle: %w[Left Right],
-      direction: %w[Receding Approaching],
+      direction: ['Going away', 'Approaching'],
       range: %w[Far Near],
       speed: %w[Low High]
     }.freeze

data/lib/rfbeam/version.rb

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

metadata

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