rfbeam 0.5.0 → 0.5.8

data/README.md

@@ -1,14 +1,11 @@
 # Rfbeam
 
-![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)
-
 ![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)
+![Ruby](https://img.shields.io/static/v1?message=Ruby&color=red&logo=Ruby&logoColor=FFFFFF&label=v3.2.1)
+![Ruby](https://img.shields.io/gitlab/license/robcarruthers/rfbeam?color=orange)
 
-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.
+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.
 
 At this stage it only works on Linux and Mac with the K-LD7 module.
 
@@ -26,90 +23,75 @@ 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
 
-```ruby
-RfBeam.connected
-=> ["/dev/ttyUSB0"]
-```
+    RfBeam.connected
 
-Simple pass the path and optional baude rate (default: 115200) to initialise a new radar object
+Simple pass the path and baude rate to initialise a new radar object
 
-```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::Kld7.new("/dev/ttyUSB0", 115200) do |radar|
+        puts radar.config
+    end
 
-## RfBeam::KLD7 API
+## RfBeam::Kld7 API
 
 ### detection?
 
 Returns true if the module has a valid detection.
 
-```ruby
-radar.detection?
-=> true
-```
+    radar.detection?
+    => true
 
 ### ddat
 
 Returns an array with the current detection values
 
-```ruby
-radar.ddat
-=> ["DDAT", 6, 0, 0, 0, 0, 0, 0]
-```
+    radar.ddat
+    => ["DDAT", 6, 0, 0, 0, 0, 0, 0]
 
 ### tdat
 
 Returns a hash with the current tracked object values
 
-```ruby
-radar.tdat
-=> ["TDAT", 4, 68, 196, 469, 6303]
-```
+    radar.tdat
+    => {:dist=>68, :speed=>196, :angle=>469, :mag=>6303}
 
 ### grps
 
 Returns the Parameter settings, values map to setting as detailed in the device datasheet.
 
-```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]
-```
+    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
 
-```ruby
-radar.config
-```
-
-## Radar Parameters
+    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 setters
 
 ### Base Frequency
 
@@ -118,7 +100,7 @@ radar.config
 alias :rbfr
 
 ```ruby
-radar.base_frequency = 1
+set_base_frequency(1)
 ```
 
 ### Maximum Speed
@@ -126,7 +108,7 @@ radar.base_frequency = 1
 0 = 12.5km/h, 1 = 25km/h (default), 2 = 50km/h, 3 = 100km/h, alias :rspi
 
 ```ruby
-radar.max_speed = 1
+set_max_speed(1)
 ```
 
 ### Maximum Range
@@ -134,7 +116,7 @@ radar.max_speed = 1
 0 = 5m, 1 = 10m (default), 2 = 30m, 3 = 100m, alias :rrai
 
 ```ruby
-radar.max_range = 1
+set_max_range(1)
 ```
 
 ### Threshold Offset
@@ -142,7 +124,7 @@ radar.max_range = 1
 10 - 60db, (default = 30), alias :thof
 
 ```ruby
-radar.threshold_offset = 30
+set_threshold_offset(30)
 ```
 
 ### Tracking filter type
@@ -150,7 +132,7 @@ radar.threshold_offset = 30
 0 = Standard (Default), 1 = Fast Tracking, 2 = Long visibility, alias :trtf
 
 ```ruby
-radar.tracking_filter = 0
+set_tracking_filter(0)
 ```
 
 ### Vibration suppression
@@ -158,7 +140,7 @@ radar.tracking_filter = 0
 0 - 16, 0 = No Suppression, 16 = High Suppression, default = 2, alias :visu
 
 ```ruby
-radar.vibration_suppression = 2
+set_vibration_suppression(2)
 ```
 
 ### Minimum Detection distance
@@ -166,7 +148,7 @@ radar.vibration_suppression = 2
 0 - 100% of Range setting, default = 0, alias :mira
 
 ```ruby
-radar.min_detection_distance = 0
+set_min_detection_distance(0)
 ```
 
 ### Maximum Detection distance
@@ -174,7 +156,7 @@ radar.min_detection_distance = 0
 0 - 100% of Range setting, default = 50, alias :mara
 
 ```ruby
-radar.max_detection_distance = 50
+set_max_detection_distance(50)
 ```
 
 ### Minimum Detection Angle
@@ -182,7 +164,7 @@ radar.max_detection_distance = 50
 -90° - 90°, default = -90, alias :mian
 
 ```ruby
-radar.min_detection_angle = -90
+set_min_detection_angle(-90
 ```
 
 ### Maximum Detection Angle
@@ -190,7 +172,7 @@ radar.min_detection_angle = -90
 -90° - 90°, default = 90, alias :maan
 
 ```ruby
-radar.min_detection_angle = 90
+set_min_detection_angle(90)
 ```
 
 ### Minimum Detection Speed
@@ -198,7 +180,7 @@ radar.min_detection_angle = 90
 0 - 100% of Speed setting, default = 0, alias :misp
 
 ```ruby
-radar.min_detection_speed = 0
+set_min_detection_speed(0)
 ```
 
 ### Maximum Detection Speed
@@ -206,7 +188,7 @@ radar.min_detection_speed = 0
 0 - 100% of Speed setting, default = 100, alias :masp
 
 ```ruby
-radar.max_detection_speed = 100
+set_max_detection_speed(100)
 ```
 
 ### Detection Direction
@@ -214,7 +196,7 @@ radar.max_detection_speed = 100
 0 = Receding, 1 = Approaching, 2 = Both (default), alias :dedi
 
 ```ruby
-radar. detection_direction = 2
+ set_detection_direction(2)
 ```
 
 ### Range Threshold
@@ -222,7 +204,7 @@ radar. detection_direction = 2
 0 - 100% of Range setting, default = 10, alias :rath
 
 ```ruby
-radar. range_threshold = 10
+ set_range_threshold(10)
 ```
 
 ### Angle Threshold
@@ -230,7 +212,7 @@ radar. range_threshold = 10
 -90° to 90°, default = 0, alias :anth
 
 ```ruby
-radar. range_threshold = 0
+ set_range_threshold(0)
 ```
 
 ### Speed Threshold
@@ -238,37 +220,37 @@ radar. range_threshold = 0
 0 - 100% of speed setting, default = 50, alias :spth
 
 ```ruby
-radar. angle_threshold = 50
+ set_angle_threshold(50)
 ```
 
 ### Digital output 1
 
 0 = Direction, 1 = Angle, 2 = Range, 3 = Speed, 4 = Micro Detection, default = 0
 
-alias :dig1
+alias :dig1, :set_dio_1
 
 ```ruby
-radar.digital_output1 = 0
+set_dio_1(0)
 ```
 
 ### Digital output 2
 
 0 = Direction, 1 = Angle, 2 = Range, 3 = Speed, 4 = Micro Detection, default = 1
 
-alias :dig2
+alias :dig2, :set_dio_2
 
 ```ruby
-radar.digital_output2 = 1
+set_dio_2(1)
 ```
 
 ### Digital output 3
 
 0 = Direction, 1 = Angle, 2 = Range, 3 = Speed, 4 = Micro Detection, default = 2
 
-alias :dig3
+alias :dig3, :set_dio_3
 
 ```ruby
-radar.digital_output3 = 2
+set_dio_3(2)
 ```
 
 ### Hold Time
@@ -278,7 +260,7 @@ radar.digital_output3 = 2
 alias :hold
 
 ```ruby
-radar.hold_time = 1
+set_hold_time(1)
 ```
 
 ### Micro Detection retrigger
@@ -288,7 +270,7 @@ radar.hold_time = 1
 alias: :mide
 
 ```ruby
-radar.micro_detection_retrigger = 0
+set_micro_detection_retrigger(0)
 ```
 
 ### Micro Detection sensitivity
@@ -298,31 +280,7 @@ radar.micro_detection_retrigger = 0
 alias: :mids
 
 ```ruby
-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
+set_micro_detection_sensitivty(4)
 ```
 
 ## Development
@@ -333,7 +291,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/robcarruthers/rfbeam.
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rfbeam.
 
 ## License
 

data/Rakefile

@@ -2,11 +2,12 @@
 
 require 'bundler/gem_tasks'
 require 'rake/testtask'
+Dir.glob('tasks/*.rake').each { |r| import r }
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
+  t.libs << %w[test spec]
   t.libs << 'lib'
-  t.test_files = FileList['test/**/test_*.rb']
+  t.test_files = FileList['test/**/test_*.rb', 'spec/**/*_spec.rb']
 end
 
 require 'rubocop/rake_task'

data/cliff.toml

@@ -0,0 +1,74 @@
+# configuration file for git-cliff (0.1.0)
+
+[changelog]
+# changelog header
+header = """
+# Changelog\n
+All notable changes to this project will be documented in this file.\n
+"""
+# template for the changelog body
+# https://tera.netlify.app/docs/#introduction
+body = """
+{% if version %}\
+    ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
+{% else %}\
+    ## [unreleased]
+{% endif %}\
+{% if previous %}\
+    {% if previous.commit_id %}
+        [{{ previous.commit_id | truncate(length=7, end="") }}]({{ previous.commit_id }})...\
+            [{{ commit_id | truncate(length=7, end="") }}]({{ commit_id }})
+    {% endif %}\
+{% endif %}\
+{% for group, commits in commits | group_by(attribute="group") %}
+    ### {{ group | upper_first }}
+    {% for commit in commits %}
+        - {{ commit.message | upper_first }} ([{{ commit.id | truncate(length=7, end="") }}]({{ commit.id }}))\
+          {% for footer in commit.footers -%}
+            , {{ footer.token }}{{ footer.separator }}{{ footer.value }}\
+          {% endfor %}\
+    {% endfor %}
+{% endfor %}\n
+"""
+# remove the leading and trailing whitespace from the template
+trim = true
+# changelog footer
+footer = """
+<!-- generated by git-cliff -->
+"""
+
+[git]
+# parse the commits based on https://www.conventionalcommits.org
+conventional_commits = true
+# filter out the commits that are not conventional
+filter_unconventional = true
+# process each line of a commit as an individual commit
+split_commits = false
+# regex for parsing and grouping commits
+commit_parsers = [
+    { message = "^feat", group = "Features"},
+    { message = "^fix", group = "Bug Fixes"},
+    { message = "^doc", group = "Documentation"},
+    { message = "^perf", group = "Performance"},
+    { message = "^refactor", group = "Refactor"},
+    { message = "^style", group = "Styling"},
+    { message = "^test", group = "Testing"},
+    { message = "^chore\\(release\\): prepare for", skip = true},
+    { message = "^chore", group = "Miscellaneous Tasks"},
+    { message = "^task", group = "Miscellaneous Tasks"},
+    { body = ".*security", group = "Security"},
+]
+# protect breaking changes from being skipped due to matching a skipping commit_parser
+protect_breaking_commits = false
+# filter out the commits that are not matched by commit parsers
+filter_commits = false
+# glob pattern for matching git tags
+tag_pattern = "v[0-9]*"
+# regex for skipping tags
+skip_tags = "v0.1.0-beta.1"
+# regex for ignoring tags
+ignore_tags = ""
+# sort the tags topologically
+topo_order = false
+# sort the commits inside sections by oldest/newest order
+sort_commits = "oldest"

data/cog.toml

@@ -0,0 +1,28 @@
+from_latest_tag = true
+ignore_merge_commits = false
+branch_whitelist = []
+pre_bump_hooks = ["bump set {{version}} --no-bundle --no-commit"]
+post_bump_hooks = []
+pre_package_bump_hooks = []
+post_package_bump_hooks = []
+tag_prefix = "v"
+
+[commit_types]
+hotfix = { changelog_title = "Hotfixes" }
+release = { changelog_title = "Releases" }
+task = { changelog_title = "Miscellaneous Tasks" }
+chore = { changelog_title = "Miscellaneous Tasks" }
+
+[changelog]
+path = "CHANGELOG.md"
+template = "remote"
+remote = "github.com"
+repository = "rfbeam"
+owner = "robcarruthers"
+authors = [
+  { signature = "Rob Carruthers", username = "robcarruthers" }
+]
+
+[bump_profiles]
+
+[packages]

data/exe/rfbeam

@@ -1,5 +1,4 @@
 #!/usr/bin/env ruby
-# frozen_string_literal: true
 
 require 'rfbeam'
 

data/lib/rfbeam/cli.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
+# rubocop:disable all
 
 require 'thor'
-require 'rfbeam'
 require 'tty-table'
 require 'tty-logger'
 require 'tty-spinner'
@@ -10,80 +10,137 @@ require 'unicode_plot'
 
 module RfBeam
   class CLI < Thor
-    attr_accessor :logger
+    attr_accessor :radar, :logger
 
     desc 'list', 'List available radar modules'
     def list
       logger = TTY::Logger.new
       devices = RfBeam.connected
-      return logger.warn 'No Radar modules found.' if devices.empty?
+      logger.info 'No Radar modules found.' unless devices.count.positive?
 
       table = TTY::Table.new(header: %w[id Path Version])
 
-      devices.each.with_index { |path, index| table << [index.to_s, path, radar(index).sw_version] }
+      devices.each.with_index do |path, index|
+        init_radar(index)
+        table << ["#{index}", path, @radar.sw_version]
+      end
       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
+      init_radar(radar_id)
+      puts @radar.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
+      init_radar(radar_id)
+      @logger.success 'Radar reset to factory defaults' if @radar.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)
+      init_radar radar_id
+      return @logger.warn("Invalid param: '#{param}'") unless RfBeam::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)
+      @radar.send("#{param}=", value.to_i)
+      @logger.success "Set #{@radar.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, press q to stop'
-    option :raw, type: :boolean, aliases: '-r', desc: 'Display raw data'
+    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'
     def ddat(radar_id)
-      cli = RfBeam::Kld7::CliOutput.new(radar_id)
-      cli.display(:ddat, options)
-    end
-
-    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)
+      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[:detection_str]}"
+          @logger.success "#{@radar.tdat}" if data[:detection]
+        end
+        puts "\nTask Quit."
+      else
+        puts "\n#{@radar.ddat}"
+      end
     end
 
-    desc 'pdat [RADAR_ID]', 'Display Tracked Targets'
+    desc 'pdat <radar_id>', 'Display Tracked Targets'
     def pdat(radar_id)
-      cli = RfBeam::Kld7::CliOutput.new(radar_id)
-      cli.display(:pdat, options)
+      init_radar radar_id
+      puts @radar.pdat
     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)
-      plotter = RfBeam::Kld7::CliOutput.new(radar_id)
-      if options[:raw]
-        print radar(radar_id).rfft
+      init_radar(radar_id)
+
+      case
+      when options[:stream]
+        streamer = RfBeam::KLD7::Streamer.new(@radar)
+        streamer.rfft
+      when options[:raw]
+        print @radar.rfft
       else
-        plotter.plot(:rfft, stream: options[:stream])
+        plot = rfft_plot(@radar)
+        p plot.render
       end
     end
 
     private
 
-    def radar(id)
+    def init_radar(id)
       devices = RfBeam.connected
       @logger = TTY::Logger.new
-      return @logger.warning 'No Radar modules found.' unless devices.count.positive?
+      return @logger.warn '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
+      @stop_streaming = false
+      loop do
+        key = STDIN.getch
+        if key.downcase == 'q'
+          @stop_streaming = true
+          break
+        end
+      end
+    end
 
-      RfBeam::KLD7.new(devices[id.to_i])
+    def rfft_plot(radar)
+      speed = radar.max_speed
+      speed_label = radar.formatted_parameter(:max_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
     end
   end
 end