rfbeam 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a612ea7d8038a09e50462eca0c5acaeb6358992df63d0929e26024dbff5004a9
-  data.tar.gz: e3bbc877194756cd958d3616623fb46bc384ae7e73430a3e096a950efe6ae3c9
+  metadata.gz: 641d32533a354fa54db2906e234d7243899286dd85ab72a51d8a477b27f327cd
+  data.tar.gz: a1d94a25fee763ada51a4dc5fd6687f7bb4e1bc67a56adae257dd67efa6ded79
 SHA512:
-  metadata.gz: 4663603c15bb5423ee29710e0a743f9f979b7fd57185495062972189533e3c72f07712abb45ba77ea84dff55a6c2bcf72ef4142833195ca6d68f55632249c4a4
-  data.tar.gz: 4af5abb75a3fe9475ab0a4afd988b8fecc2323afc95d3f64f530f359b08ab0f390012a97272545d69d46da9e8051887a24a345b59434afcf90bc18b0312de2de
+  metadata.gz: 66d1d5f9e22d1adce03395cb153cebbc5eff4336b3cf3ade2a73d77548a7ff233ebe7d45b9ce09a23479c9c60382b0e81052c7da20f584792c8eb642b758a317
+  data.tar.gz: '094f688f3e86604632a1fa5fd05c3ff377e9b848deb6ed56eb024991e7ad8288641d3d29dc16f538cd4b1d564e5ac6f6b6dcaf77862048f3ffa9de351eab7932'

data/.streerc

@@ -0,0 +1 @@
+/Users/rob/.streerc

data/.streerc~1f4cd14e3c0a9afdf972aa5f3982d36a89869b72

@@ -0,0 +1,2 @@
+--print-width=120
+--plugins=plugin/single_quotes

data/.tool-versions

@@ -1 +1 @@
-ruby 3.1.2
+ruby 3.1.3

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+- - -
+## [v0.5.1](https://github.com/robcarruthers/rfbeam/compare/v0.5.0..v0.5.1) - 2023-05-09
+#### Documentation
+- **(cog)** Setup changelog generator - ([23dd6d8](https://github.com/robcarruthers/rfbeam/commit/23dd6d8407edaf6d4c29472fa60775a5aea87daa)) - [@robcarruthers](https://github.com/robcarruthers)
+- **(readme)** Updated - ([14bb58e](https://github.com/robcarruthers/rfbeam/commit/14bb58ecaa6f55166532151425fa24269b515937)) - [@robcarruthers](https://github.com/robcarruthers)
+
+- - -
+
 ## [0.5.0] - 2023-11-4
 
 - Refactored CLI, refined help and options

data/Gemfile.lock

@@ -9,7 +9,7 @@ GIT
 PATH
   remote: .
   specs:
-    rfbeam (0.5.0)
+    rfbeam (0.5.1)
       activesupport (~> 6.1.0)
       rubyserial (~> 0.6.0)
       thor (~> 1.2.1)
@@ -89,6 +89,7 @@ GEM
 PLATFORMS
   aarch64-linux
   arm64-darwin-21
+  arm64-darwin-22
 
 DEPENDENCIES
   minitest (~> 5.0)

data/Rakefile

@@ -2,14 +2,19 @@
 
 require 'bundler/gem_tasks'
 require 'rake/testtask'
+require 'rubocop/rake_task'
 
-Rake::TestTask.new(:test) do |t|
+Rake::TestTask.new(:local_test) do |t|
   t.libs << 'test'
   t.libs << 'lib'
-  t.test_files = FileList['test/**/test_*.rb']
+  t.test_files = FileList['test/local_tests/test_*.rb']
 end
 
-require 'rubocop/rake_task'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/test_*.rb'].exclude('test/local_tests/**/*')
+end
 
 RuboCop::RakeTask.new
 

data/cog.toml

@@ -0,0 +1,24 @@
+from_latest_tag = false
+ignore_merge_commits = false
+branch_whitelist = []
+pre_bump_hooks = [ "bump set {{version}} -p 'chore(version):' -m 'v{{version}}'" ]
+post_bump_hooks = [ "rake release" ]
+pre_package_bump_hooks = []
+post_package_bump_hooks = []
+tag_prefix = "v"
+
+[commit_types]
+
+[changelog]
+path = "CHANGELOG.md"
+template = "remote"
+remote = "github.com"
+repository = "rfbeam"
+owner = "robcarruthers"
+authors = [
+  { signature = "Rob Carruthers", username = "robcarruthers" }
+]
+
+[bump_profiles]
+
+[packages]

data/lib/rfbeam/cli.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'thor'
-require 'rfbeam'
 require 'tty-table'
 require 'tty-logger'
 require 'tty-spinner'
@@ -10,7 +9,7 @@ require 'unicode_plot'
 
 module RfBeam
   class CLI < Thor
-    attr_accessor :logger
+    attr_accessor :radar, :logger
 
     desc 'list', 'List available radar modules'
     def list
@@ -43,12 +42,25 @@ 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, 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)
+      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 'tdat [RADAR_ID]', 'Display tracked target data'
@@ -64,7 +76,7 @@ module RfBeam
       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)
@@ -83,7 +95,44 @@ module RfBeam
       @logger = TTY::Logger.new
       return @logger.warning 'No Radar modules found.' unless devices.count.positive?
 
-      RfBeam::KLD7.new(devices[id.to_i])
+      @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
+
+    def rfft_plot(radar)
+      speed = radar.max_speed
+      speed_label = radar.formatted_parameter(:max_speed)
+      xlim = [speed - speed * 2, 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

data/lib/rfbeam/kld7/cli_output.rb

@@ -111,7 +111,7 @@ module RfBeam
         end
       end
 
-      def display_pdat(options)
+      def display_pdat(*)
         table = RfBeam::Kld7::CliFormatter.new.pdat_table(@radar.pdat)
         puts "\n   Detected Raw Targets"
         puts table.render(:unicode, alignment: :center)

data/lib/rfbeam/kld7/constants.rb

@@ -33,231 +33,158 @@ module RfBeam
       speed: %w[Low High]
     }.freeze
 
-    class Param
-      attr_accessor :name, :grps_index, :description, :default, :units, :str_values
-
-      def initialize(name:, grps_index:, options: {})
-        @name = name
-        @grps_index = grps_index
-        @description = options.fetch(:description, nil)
-        @default = options.fetch(:default, nil)
-        @units = options.fetch(:units, nil)
-        @str_values = options.fetch(:str_values, [])
+    Param =
+      Data.define(:name, :grps_index, :description, :default, :units, :values) do |_param|
+        def initialize(name:, grps_index:, description: nil, default: nil, units: nil, values: [])
+          super(name:, grps_index:, description:, default:, units:, values:)
+        end
       end
-    end
 
     RADAR_PARAMETERS = {
-      sw_version: Param.new(name: 'Software Version', grps_index: 2, options: { default: 'K-LD7_APP-RFB-XXXX' }),
+      sw_version: Param.new(name: 'Software Version', grps_index: 2, default: 'K-LD7_APP-RFB-XXXX'),
       base_frequency:
         Param.new(
           name: 'Base Frequency',
           grps_index: 3,
-          options: {
-            description: '0 = Low, 1 = Middle, 2 = High',
-            default: 1,
-            str_values: %w[Low Middle High]
-          }
+          description: '0 = Low, 1 = Middle, 2 = High',
+          default: 1,
+          values: %w[Low Middle High]
         ),
       max_speed:
         Param.new(
           name: 'Maximum Speed',
           grps_index: 4,
-          options: {
-            description: '0 = 12km/h, 1 = 25km/h, 2 = 50km/h, 3 = 100km/h',
-            default: 1,
-            units: 'km/h',
-            str_values: %w[12.5 25 50 100]
-          }
+          description: '0 = 12km/h, 1 = 25km/h, 2 = 50km/h, 3 = 100km/h',
+          default: 1,
+          units: 'km/h',
+          values: %w[12.5 25 50 100]
         ),
       max_range:
         Param.new(
           name: 'Maximum Range',
           grps_index: 5,
-          options: {
-            description: '0 = 5m, 1 = 10m, 2 = 30m, 3 = 100m',
-            default: 1,
-            str_values: %w[5m 10m 30m 100m]
-          }
+          description: '0 = 5m, 1 = 10m, 2 = 30m, 3 = 100m',
+          default: 1,
+          values: %w[5m 10m 30m 100m]
         ),
       threshold_offset:
-        Param.new(
-          name: 'Threshold Offset',
-          grps_index: 6,
-          options: {
-            description: '10db - 60db',
-            default: 30,
-            units: 'db'
-          }
-        ),
+        Param.new(name: 'Threshold Offset', grps_index: 6, description: '10db - 60db', default: 30, units: 'db'),
       tracking_filter:
         Param.new(
           name: 'Tracking Filter Type',
           grps_index: 7,
-          options: {
-            description: '0 = Standard, 2 = Fast Detection, 3 = Long Visibility',
-            default: 0,
-            str_values: ['standard', 'Fast Detection', 'Long Visibility']
-          }
+          description: '0 = Standard, 2 = Fast Detection, 3 = Long Visibility',
+          default: 0,
+          values: ['standard', 'Fast Detection', 'Long Visibility']
         ),
       vibration_suppression:
         Param.new(
           name: 'Vibration Suppression',
           grps_index: 8,
-          options: {
-            description: '0-16, 0 = No Suppression, 16 = High Suppression',
-            default: 2
-          }
+          description: '0-16, 0 = No Suppression, 16 = High Suppression',
+          default: 2
         ),
       min_detection_distance:
         Param.new(
           name: 'Minimum Detection Distance',
           grps_index: 9,
-          options: {
-            description: '0 - 100% of range setting',
-            default: 0,
-            units: '%'
-          }
+          description: '0 - 100% of range setting',
+          default: 0,
+          units: '%'
         ),
       max_detection_distance:
         Param.new(
           name: 'Maximum Detection Distance',
           grps_index: 10,
-          options: {
-            description: '0 - 100% of range setting',
-            default: 50,
-            units: '%'
-          }
+          description: '0 - 100% of range setting',
+          default: 50,
+          units: '%'
         ),
       min_detection_angle:
-        Param.new(
-          name: 'Minimum Detection Angle',
-          grps_index: 11,
-          options: {
-            description: '-90° - 90°',
-            default: -90,
-            units: '°'
-          }
-        ),
+        Param.new(name: 'Minimum Detection Angle', grps_index: 11, description: '-90° - 90°', default: -90, units: '°'),
       max_detection_angle:
-        Param.new(
-          name: 'Maximum Detection Angle',
-          grps_index: 12,
-          options: {
-            description: '-90° - 90°',
-            default: 90,
-            units: '°'
-          }
-        ),
+        Param.new(name: 'Maximum Detection Angle', grps_index: 12, description: '-90° - 90°', default: 90, units: '°'),
       min_detection_speed:
         Param.new(
           name: 'Minimum Detection Speed',
           grps_index: 13,
-          options: {
-            description: '0 - 100% of speed setting',
-            default: 0,
-            units: '%'
-          }
+          description: '0 - 100% of speed setting',
+          default: 0,
+          units: '%'
         ),
       max_detection_speed:
         Param.new(
           name: 'Maximum Detection Speed',
           grps_index: 14,
-          options: {
-            description: '0 - 100% of speed setting',
-            default: 100,
-            units: '%'
-          }
+          description: '0 - 100% of speed setting',
+          default: 100,
+          units: '%'
         ),
       detection_direction:
         Param.new(
           name: 'Detection Direction',
           grps_index: 15,
-          options: {
-            description: '0 = Receding, 1 = Approaching, 2 = Both',
-            default: 2,
-            str_values: %w[Receding Approaching Both]
-          }
+          description: '0 = Receding, 1 = Approaching, 2 = Both',
+          default: 2,
+          values: %w[Receding Approaching Both]
         ),
       range_threshold:
         Param.new(
           name: 'Range Threshold',
           grps_index: 16,
-          options: {
-            description: '0 - 100% of range setting',
-            default: 10,
-            units: '%'
-          }
+          description: '0 - 100% of range setting',
+          default: 10,
+          units: '%'
         ),
       angle_threshold:
-        Param.new(
-          name: 'Angle Threshold',
-          grps_index: 17,
-          options: {
-            description: '-90° - 90°',
-            default: 0,
-            units: '°'
-          }
-        ),
+        Param.new(name: 'Angle Threshold', grps_index: 17, description: '-90° - 90°', default: 0, units: '°'),
       speed_threshold:
         Param.new(
           name: 'Speed Threshold',
           grps_index: 18,
-          options: {
-            description: '0 - 100% of speed setting',
-            default: 50,
-            units: '%'
-          }
+          description: '0 - 100% of speed setting',
+          default: 50,
+          units: '%'
         ),
       digital_output1:
         Param.new(
           name: 'Digital Output 1',
           grps_index: 19,
-          options: {
-            description: '0 = Direction, 1 = Angle, 2 = Range, 3 = Speed, 4 = Micro Detection',
-            default: 0,
-            str_values: %w[Direction Angle Range Speed Micro]
-          }
+          description: '0 = Direction, 1 = Angle, 2 = Range, 3 = Speed, 4 = Micro Detection',
+          default: 0,
+          values: %w[Direction Angle Range Speed Micro]
         ),
       digital_output2:
         Param.new(
           name: 'Digital Output 2',
           grps_index: 20,
-          options: {
-            description: '0 = Direction, 1 = Angle, 2 = Range, 3 = Speed, 4 = Micro Detection',
-            default: 1,
-            str_values: %w[Direction Angle Range Speed Micro]
-          }
+          description: '0 = Direction, 1 = Angle, 2 = Range, 3 = Speed, 4 = Micro Detection',
+          default: 1,
+          values: %w[Direction Angle Range Speed Micro]
         ),
       digital_output3:
         Param.new(
           name: 'Digital Output 3',
           grps_index: 21,
-          options: {
-            description: '0 = Direction, 1 = Angle, 2 = Range, 3 = Speed, 4 = Micro Detection',
-            default: 2,
-            str_values: %w[Direction Angle Range Speed Micro]
-          }
+          description: '0 = Direction, 1 = Angle, 2 = Range, 3 = Speed, 4 = Micro Detection',
+          default: 2,
+          values: %w[Direction Angle Range Speed Micro]
         ),
-      hold_time:
-        Param.new(name: 'Hold Time', grps_index: 22, options: { description: '1 - 7200s', default: 1, units: 's' }),
+      hold_time: Param.new(name: 'Hold Time', grps_index: 22, description: '1 - 7200s', default: 1, units: 's'),
       micro_detection_retrigger:
         Param.new(
           name: 'Micro Detection Trigger',
           grps_index: 23,
-          options: {
-            description: '0 = Off, 1 = Retrigger',
-            default: 0,
-            str_values: %w[Off Retrigger]
-          }
+          description: '0 = Off, 1 = Retrigger',
+          default: 0,
+          values: %w[Off Retrigger]
         ),
       micro_detection_sensativity:
         Param.new(
           name: 'Micro Detection Sensativity',
           grps_index: 24,
-          options: {
-            description: '0 - 9, 0 = Min, 9 = Max',
-            default: 4
-          }
+          description: '0 - 9, 0 = Min, 9 = Max',
+          default: 4
         )
     }.freeze
   end

data/lib/rfbeam/kld7/radar_messages.rb

@@ -1,6 +1,4 @@
-# frozen_string_literal: true
-
-require 'csv'
+require "csv"
 
 module RfBeam
   module Kld7
@@ -12,26 +10,26 @@ module RfBeam
     def rfft
       request_frame_data(:rfft)
       sleep MEASUREMENT_DELAY
-      data = read(1032).unpack('a4LS256S256')
+      data = read(1032).unpack("a4LS256S256")
       header, length = data.shift(2)
-      raise Error, "RFFT header response, header=#{header}" unless header == 'RFFT'
+      unless header == "RFFT"
+        raise Error, "RFFT header response, header=#{header}"
+      end
       raise Error, "RFFT payload length, length=#{length}" unless length == 1024
 
       data
     end
 
     def reset
-      command = ['RFSE', 0]
-      write command.pack('a4L')
+      command = ["RFSE", 0]
+      write command.pack("a4L")
       check_response
     end
     alias rfse reset
 
     def pdat(formatted: false)
       request_frame_data(:pdat)
-      resp = read(102).unpack('a4LSssSSssSSssSSssSSssSSssSSssSSssSSssSSssS')
-      raise Error, "PDAT response = #{resp[0]}" unless resp[0] == 'PDAT'
-
+      resp = read(102).unpack("a4LSssSSssSSssSSssSSssSSssSSssSSssSSssSSssS")
       return resp unless formatted
 
       target_count = resp[1].to_i / 8
@@ -40,7 +38,9 @@ module RfBeam
       resp.shift 2
       resp.compact
       detected_raw_targets = []
-      target_count.times { detected_raw_targets << format_raw_target_data(resp.shift(4)) }
+      target_count.times do
+        detected_raw_targets << format_raw_target_data(resp.shift(4))
+      end
       detected_raw_targets
     end
 
@@ -48,34 +48,46 @@ module RfBeam
       request_frame_data(:tdat)
       sleep MEASUREMENT_DELAY
 
-      resp = read(16).unpack('a4LSssS')
-      raise Error, "TDAT response = #{resp[0]}" unless resp[0] == 'TDAT'
-
-      resp
+      sleep 0.1
+      resp = read(16).unpack("a4LSssS")
+      unless resp[1].zero?
+        return { dist: resp[2], speed: resp[3], angle: resp[4], mag: resp[5] }
+      end
     end
 
     def ddat
       request_frame_data(:ddat)
-      sleep MEASUREMENT_DELAY
-
-      resp = read(14).unpack('a4LC6')
-      raise Error, "DDAT response = #{resp[0]}" unless resp[0] == 'DDAT'
-
-      resp
+      flags = %w[Low High]
+      array = read(14).unpack("a4LC6")
+      {
+        label: array[0],
+        detection: array[2] == 1,
+        detection_str: DETECTION_FLAGS[:detection][array[2]],
+        micro_detection: DETECTION_FLAGS[:micro_detection][array[3]],
+        angle: DETECTION_FLAGS[:angle][array[4]],
+        direction: DETECTION_FLAGS[:direction][array[5]],
+        range: DETECTION_FLAGS[:range][array[6]],
+        speed: DETECTION_FLAGS[:speed][array[7]]
+      }
     end
 
     # Get the radar parameter structure
     def grps
-      command = ['GRPS', 0]
-      write command.pack('a4L')
+      command = ["GRPS", 0]
+      write command.pack("a4L")
       check_response
-      read(50).unpack('a4LA19C8c2C4cCCCCSCC')
+      read(50).unpack("a4LA19C8c2C4cCCCCSCC")
     end
 
     def config
       data = grps
-      output = []
-      RADAR_PARAMETERS.each_key { |key| output << formatted_parameter(key, data[RADAR_PARAMETERS[key].grps_index]) }
+      output = "\n"
+      RADAR_PARAMETERS.keys.each do |key|
+        output << formatted_parameter(
+          key,
+          data[RADAR_PARAMETERS[key].grps_index]
+        )
+      end
       output
     end
 
@@ -92,12 +104,17 @@ module RfBeam
     private
 
     def format_raw_target_data(array)
-      { dist: array.shift, speed: array.shift, angle: array.shift, mag: array.shift }
+      {
+        dist: array.shift,
+        speed: array.shift,
+        angle: array.shift,
+        mag: array.shift
+      }
     end
 
     def request_frame_data(type)
-      command = ['GNFD', 4, FRAME_DATA_TYPES[type]]
-      write command.pack('a4LL')
+      command = ["GNFD", 4, FRAME_DATA_TYPES[type]]
+      write command.pack("a4LL")
       check_response
     end
   end

data/lib/rfbeam/kld7/radar_parameters.rb

@@ -1,7 +1,5 @@
-# frozen_string_literal: true
-
 module RfBeam
-  module Kld7
+  module KLD7
     # -----------------
     # Software Version, 'K-LD7_APP-RFB-XXXX'
     # -----------------
@@ -20,11 +18,11 @@ module RfBeam
     def base_frequency=(frequency = 1)
       value =
         case frequency
-        when 0, :low, 'low'
+        when 0, :low, "low"
           0
-        when 1, :middle, 'middle'
+        when 1, :middle, "middle"
           1
-        when 2, :high, 'high'
+        when 2, :high, "high"
           2
         else
           raise ArgumentError, "Invalid arg: '#{frequency}'"
@@ -43,8 +41,10 @@ module RfBeam
     end
 
     def max_speed=(speed = 1)
-      raise ArgumentError, "Invalid arg: '#{speed}'" unless (0..3).include?(speed)
-      raise ArgumentError, 'Expected an Integer' unless speed.is_a?(Integer)
+      unless (0..3).include?(speed)
+        raise ArgumentError, "Invalid arg: '#{speed}'"
+      end
+      raise ArgumentError, "Expected an Integer" unless speed.is_a?(Integer)
 
       set_parameter :rspi, speed, :uint32
     end
@@ -60,8 +60,10 @@ module RfBeam
     end
 
     def max_range=(range = 1)
-      raise ArgumentError, "Invalid arg: '#{range}'" unless (0..3).include?(range)
-      raise ArgumentError, 'Expected an Integer' unless range.is_a?(Integer)
+      unless (0..3).include?(range)
+        raise ArgumentError, "Invalid arg: '#{range}'"
+      end
+      raise ArgumentError, "Expected an Integer" unless range.is_a?(Integer)
 
       set_parameter :rrai, range, :uint32
     end
@@ -77,8 +79,10 @@ module RfBeam
     end
 
     def threshold_offset=(offset = 30)
-      raise ArgumentError, "Invalid arg: '#{offset}'" unless (10..60).include?(offset)
-      raise ArgumentError, 'Expected an Integer' unless offset.is_a?(Integer)
+      unless (10..60).include?(offset)
+        raise ArgumentError, "Invalid arg: '#{offset}'"
+      end
+      raise ArgumentError, "Expected an Integer" unless offset.is_a?(Integer)
 
       set_parameter :thof, offset, :uint32
     end
@@ -95,7 +99,7 @@ module RfBeam
 
     def tracking_filter=(type = 0)
       raise ArgumentError, "Invalid arg: '#{type}'" unless (0..2).include?(type)
-      raise ArgumentError, 'Expected an Integer' unless type.is_a?(Integer)
+      raise ArgumentError, "Expected an Integer" unless type.is_a?(Integer)
 
       set_parameter :trft, type, :uint32
     end
@@ -110,8 +114,10 @@ module RfBeam
     end
 
     def vibration_suppression=(value = 2)
-      raise ArgumentError, "Invalid arg: '#{value}'" unless (0..16).include?(value)
-      raise ArgumentError, 'Expected an Integer' unless value.is_a?(Integer)
+      unless (0..16).include?(value)
+        raise ArgumentError, "Invalid arg: '#{value}'"
+      end
+      raise ArgumentError, "Expected an Integer" unless value.is_a?(Integer)
 
       set_parameter :visu, value, :uint32
     end
@@ -126,8 +132,10 @@ module RfBeam
     end
 
     def min_detection_distance=(value = 0)
-      raise ArgumentError, "Invalid arg: '#{value}'" unless (0..100).include?(value)
-      raise ArgumentError, 'Expected an Integer' unless value.is_a?(Integer)
+      unless (0..100).include?(value)
+        raise ArgumentError, "Invalid arg: '#{value}'"
+      end
+      raise ArgumentError, "Expected an Integer" unless value.is_a?(Integer)
 
       set_parameter :mira, value, :uint32
     end
@@ -142,8 +150,10 @@ module RfBeam
     end
 
     def max_detection_distance=(value = 50)
-      raise ArgumentError, "Invalid arg: '#{value}'" unless (0..100).include?(value)
-      raise ArgumentError, 'Expected an Integer' unless value.is_a?(Integer)
+      unless (0..100).include?(value)
+        raise ArgumentError, "Invalid arg: '#{value}'"
+      end
+      raise ArgumentError, "Expected an Integer" unless value.is_a?(Integer)
 
       set_parameter :mara, value, :uint32
     end
@@ -158,8 +168,10 @@ module RfBeam
     end
 
     def min_detection_angle=(angle = -90)
-      raise ArgumentError, "Invalid arg: '#{angle}'" unless (-90..90).include?(angle)
-      raise ArgumentError, 'Expected an Integer' unless angle.is_a?(Integer)
+      unless (-90..90).include?(angle)
+        raise ArgumentError, "Invalid arg: '#{angle}'"
+      end
+      raise ArgumentError, "Expected an Integer" unless angle.is_a?(Integer)
 
       set_parameter :mian, angle, :int32
     end
@@ -174,8 +186,10 @@ module RfBeam
     end
 
     def max_detection_angle=(angle = 90)
-      raise ArgumentError, "Invalid arg: '#{angle}'" unless (-90..90).include?(angle)
-      raise ArgumentError, 'Expected an Integer' unless angle.is_a?(Integer)
+      unless (-90..90).include?(angle)
+        raise ArgumentError, "Invalid arg: '#{angle}'"
+      end
+      raise ArgumentError, "Expected an Integer" unless angle.is_a?(Integer)
 
       set_parameter :maan, angle, :int32
     end
@@ -190,8 +204,10 @@ module RfBeam
     end
 
     def min_detection_speed=(speed = 0)
-      raise ArgumentError, "Invalid arg: '#{speed}'" unless (0..100).include?(speed)
-      raise ArgumentError, 'Expected an Integer' unless speed.is_a?(Integer)
+      unless (0..100).include?(speed)
+        raise ArgumentError, "Invalid arg: '#{speed}'"
+      end
+      raise ArgumentError, "Expected an Integer" unless speed.is_a?(Integer)
 
       set_parameter :misp, speed, :uint32
     end
@@ -206,8 +222,10 @@ module RfBeam
     end
 
     def max_detection_speed=(speed = 100)
-      raise ArgumentError, "Invalid arg: '#{speed}'" unless (0..100).include?(speed)
-      raise ArgumentError, 'Expected an Integer' unless speed.is_a?(Integer)
+      unless (0..100).include?(speed)
+        raise ArgumentError, "Invalid arg: '#{speed}'"
+      end
+      raise ArgumentError, "Expected an Integer" unless speed.is_a?(Integer)
 
       set_parameter :masp, speed, :uint32
     end
@@ -222,8 +240,10 @@ module RfBeam
     end
 
     def detection_direction=(direction = 2)
-      raise ArgumentError, "Invalid arg: '#{direction}'" unless (0..2).include?(direction)
-      raise ArgumentError, 'Expected an Integer' unless direction.is_a?(Integer)
+      unless (0..2).include?(direction)
+        raise ArgumentError, "Invalid arg: '#{direction}'"
+      end
+      raise ArgumentError, "Expected an Integer" unless direction.is_a?(Integer)
 
       set_parameter :dedi, direction, :uint32
     end
@@ -238,8 +258,10 @@ module RfBeam
     end
 
     def range_threshold=(value = 10)
-      raise ArgumentError, "Invalid arg: '#{value}'" unless (0..100).include?(value)
-      raise ArgumentError, 'Expected an Integer' unless value.is_a?(Integer)
+      unless (0..100).include?(value)
+        raise ArgumentError, "Invalid arg: '#{value}'"
+      end
+      raise ArgumentError, "Expected an Integer" unless value.is_a?(Integer)
 
       set_parameter :rath, value, :uint32
     end
@@ -254,8 +276,10 @@ module RfBeam
     end
 
     def angle_threshold=(value = 0)
-      raise ArgumentError, "Invalid arg: '#{value}'" unless (-90..90).include?(value)
-      raise ArgumentError, 'Expected an Integer' unless value.is_a?(Integer)
+      unless (-90..90).include?(value)
+        raise ArgumentError, "Invalid arg: '#{value}'"
+      end
+      raise ArgumentError, "Expected an Integer" unless value.is_a?(Integer)
 
       set_parameter :anth, value, :int32
     end
@@ -270,8 +294,10 @@ module RfBeam
     end
 
     def speed_threshold=(value = 50)
-      raise ArgumentError, "Invalid arg: '#{value}'" unless (0..100).include?(value)
-      raise ArgumentError, 'Expected an Integer' unless value.is_a?(Integer)
+      unless (0..100).include?(value)
+        raise ArgumentError, "Invalid arg: '#{value}'"
+      end
+      raise ArgumentError, "Expected an Integer" unless value.is_a?(Integer)
 
       set_parameter :spth, value, :uint32
     end
@@ -286,8 +312,10 @@ module RfBeam
     end
 
     def digital_output1=(value = 0)
-      raise ArgumentError, "Invalid arg: '#{value}'" unless (0..4).include?(value)
-      raise ArgumentError, 'Expected an Integer' unless value.is_a?(Integer)
+      unless (0..4).include?(value)
+        raise ArgumentError, "Invalid arg: '#{value}'"
+      end
+      raise ArgumentError, "Expected an Integer" unless value.is_a?(Integer)
 
       set_parameter :dig1, value, :uint32
     end
@@ -302,8 +330,10 @@ module RfBeam
     end
 
     def digital_output2=(value = 1)
-      raise ArgumentError, "Invalid arg: '#{value}'" unless (0..4).include?(value)
-      raise ArgumentError, 'Expected an Integer' unless value.is_a?(Integer)
+      unless (0..4).include?(value)
+        raise ArgumentError, "Invalid arg: '#{value}'"
+      end
+      raise ArgumentError, "Expected an Integer" unless value.is_a?(Integer)
 
       set_parameter :dig2, value, :uint32
     end
@@ -318,8 +348,10 @@ module RfBeam
     end
 
     def digital_output3=(value = 2)
-      raise ArgumentError, "Invalid arg: '#{value}'" unless (0..4).include?(value)
-      raise ArgumentError, 'Expected an Integer' unless value.is_a?(Integer)
+      unless (0..4).include?(value)
+        raise ArgumentError, "Invalid arg: '#{value}'"
+      end
+      raise ArgumentError, "Expected an Integer" unless value.is_a?(Integer)
 
       set_parameter :dig3, value, :uint32
     end
@@ -334,8 +366,10 @@ module RfBeam
     end
 
     def hold_time=(time = 1)
-      raise ArgumentError, "Invalid arg: '#{time}'" unless (1..7200).include?(time)
-      raise ArgumentError, 'Expected an Integer' unless time.is_a?(Integer)
+      unless (1..7200).include?(time)
+        raise ArgumentError, "Invalid arg: '#{time}'"
+      end
+      raise ArgumentError, "Expected an Integer" unless time.is_a?(Integer)
 
       set_parameter :hold, time, :uint32
     end
@@ -346,12 +380,16 @@ module RfBeam
     # Micro Detection retrigger, 0 = Off (default), 1 = Retrigger
     # -----------------
     def micro_detection_retrigger
-      query_parameter RADAR_PARAMETERS[:set_micro_detection_retrigger].grps_index
+      query_parameter RADAR_PARAMETERS[
+                        :set_micro_detection_retrigger
+                      ].grps_index
     end
 
     def micro_detection_retrigger=(value = 0)
-      raise ArgumentError, "Invalid arg: '#{value}'" unless (0..1).include?(value)
-      raise ArgumentError, 'Expected an Integer' unless value.is_a?(Integer)
+      unless (0..1).include?(value)
+        raise ArgumentError, "Invalid arg: '#{value}'"
+      end
+      raise ArgumentError, "Expected an Integer" unless value.is_a?(Integer)
 
       set_parameter :mide, value, :uint32
     end
@@ -366,8 +404,10 @@ module RfBeam
     end
 
     def micro_detection_sensitivity=(value = 4)
-      raise ArgumentError, "Invalid arg: '#{value}'" unless (0..9).include?(value)
-      raise ArgumentError, 'Expected an Integer' unless value.is_a?(Integer)
+      unless (0..9).include?(value)
+        raise ArgumentError, "Invalid arg: '#{value}'"
+      end
+      raise ArgumentError, "Expected an Integer" unless value.is_a?(Integer)
 
       set_parameter :mids, value, :uint32
     end
@@ -384,10 +424,14 @@ module RfBeam
     def set_parameter(header, value, return_type = :uint32)
       return_type =
         case return_type
+        when :uint32
+          "L"
         when :int32
-          'l'
+          "l"
+        when :uint32
+          "S"
         else
-          'L'
+          "L"
         end
       command = [header.upcase.to_s, 4, value]
       write command.pack("a4L#{return_type}")

data/lib/rfbeam/kld7/streamer.rb

@@ -0,0 +1,82 @@
+# rubocop:disable all
+require "unicode_plot"
+require "io/console"
+require "stringio"
+require "tty-screen"
+
+module RfBeam
+  module KLD7
+    class Streamer
+      attr_accessor :radar
+
+      def initialize(radar)
+        @radar = radar
+      end
+
+      def monitor_keypress
+        loop do
+          key = STDIN.getch
+          if key.downcase == "q"
+            @stop_streaming = true
+            break
+          end
+        end
+      end
+
+      def rfft
+        out = StringIO.new
+        def out.tty?
+          true
+        end
+
+        Thread.new { monitor_keypress }
+
+        loop do
+          out.truncate(0)
+
+          plot = rfft_plot(@radar)
+          plot.render(out)
+
+          lines = out.string.lines
+          lines.each { |line| $stdout.print "\r#{line}" }
+          $stdout.print "\e[0J"
+          $stdout.flush
+          break if @stop_streaming
+
+          n = lines.count
+          $stdout.print "\e[#{n}F"
+        end
+      end
+
+      private
+
+      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 rfft_plot(radar)
+        width = TTY::Screen.width * 0.65
+        data = plot_data(radar.rfft)
+        plot =
+          UnicodePlot.lineplot(
+            data[:x],
+            data[:series1],
+            name: "IF1/2 Averaged",
+            title: "Raw FFT",
+            height: 25,
+            width: width,
+            xlabel: "Speed (km/h)",
+            ylabel: "Signal (db)",
+            xlim: [-128, 128],
+            ylim: [0, 100]
+          )
+        UnicodePlot.lineplot!(plot, data[:x], data[:series2], name: "Threshold")
+        plot
+      end
+    end
+  end
+end

data/lib/rfbeam/version.rb

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

data/rfbeam.gemspec

@@ -10,15 +10,15 @@ Gem::Specification.new do |spec|
 
   spec.summary = 'Ruby API and CLI for RFBeam doplar radar modules'
   spec.description = 'Currently only tested with K-LD7 on MacOS & Raspian (bullseye)'
-  spec.homepage = 'https://gitlab.com/robcarruthers/rfbeam'
+  spec.homepage = 'https://github.com/robcarruthers/rfbeam'
   spec.license = 'MIT'
   spec.required_ruby_version = '>= 3.1.2'
 
   # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
 
   spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://gitlab.com/robcarruthers/rfbeam'
-  spec.metadata['changelog_uri'] = 'https://gitlab.com/robcarruthers/rfbeam/-/blob/master/CHANGELOG.md'
+  spec.metadata['source_code_uri'] = 'https://github.com/robcarruthers/rfbeam'
+  spec.metadata['changelog_uri'] = 'https://github.com/robcarruthers/rfbeam/CHANGELOG.md'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

data/streamer2.rb

@@ -0,0 +1,55 @@
+require "unicode_plot"
+require "stringio"
+require "io/console"
+
+N = 1000
+M = 50
+
+def generate_random_data(n)
+  Array.new(n) { rand(-10.0..10.0) }
+end
+
+def monitor_keypress
+  loop do
+    key = STDIN.getch
+    if key.downcase == "q"
+      @stop_streaming = true
+      break
+    end
+  end
+end
+
+out = StringIO.new
+def out.tty?
+  true
+end
+
+Thread.new { monitor_keypress }
+
+loop do
+  out.truncate(0)
+
+  plot =
+    UnicodePlot.lineplot(
+      generate_random_data(40),
+      name: "Series 0",
+      width: 120,
+      height: 30
+    )
+  UnicodePlot.lineplot!(
+    plot,
+    generate_random_data(40),
+    name: "Series 1",
+    color: :red
+  )
+  plot.render(out)
+
+  lines = out.string.lines
+  lines.each { |line| $stdout.print "\r#{line}" }
+  $stdout.print "\e[0J"
+  $stdout.flush
+  break if @stop_streaming
+
+  n = lines.count
+  $stdout.print "\e[#{n}F"
+end

data/streaming.rb

@@ -0,0 +1,71 @@
+# rubocop:disable all
+require "unicode_plot"
+require "io/console"
+
+def generate_random_data(n)
+  Array.new(n) { rand(-10.0..10.0) }
+end
+
+def update_data(plot, series1, series2)
+  plot.series_list[0].data.y = series1
+  plot.series_list[1].data.y = series2
+  plot.auto_calc_ylim
+end
+
+def start
+  Thread.new { monitor_keypress }
+  loop do
+    break if @stop_streaming
+    display_plot
+    sleep period
+  end
+end
+
+def monitor_keypress
+  loop do
+    key = STDIN.getch
+    if key.downcase == "q"
+      @stop_streaming = true
+      break
+    end
+  end
+end
+
+def plot_demo
+  out = StringIO.new
+  out.truncate(0)
+  plot =
+    UnicodePlot.lineplot(
+      generate_random_data(40),
+      name: "Series 0",
+      width: 40,
+      height: 10
+    )
+
+  UnicodePlot.lineplot!(
+    plot,
+    generate_random_data(40),
+    name: "Series 1",
+    color: :red
+  )
+  UnicodePlot.lineplot!(
+    plot,
+    generate_random_data(40),
+    name: "Series 2",
+    color: :blue
+  )
+  puts plot.render(out)
+
+  Thread.new { monitor_keypress }
+
+  loop do
+    break if @stop_streaming
+
+    lines = out.string.lines
+    lines.each { |line| $stdout.print "\r#{line}" }
+    $stdout.print "\e[0J"
+    $stdout.flush
+  end
+end
+
+plot_demo

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rfbeam
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Rob Carruthers
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-11 00:00:00.000000000 Z
+date: 2023-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -133,6 +133,7 @@ files:
 - ".DS_Store"
 - ".rubocop.yml"
 - ".streerc"
+- ".streerc~1f4cd14e3c0a9afdf972aa5f3982d36a89869b72"
 - ".tool-versions"
 - CHANGELOG.md
 - Gemfile
@@ -140,6 +141,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- cog.toml
 - exe/rfbeam
 - lib/rfbeam.rb
 - lib/rfbeam/cli.rb
@@ -149,6 +151,7 @@ files:
 - lib/rfbeam/kld7/radar_messages.rb
 - lib/rfbeam/kld7/radar_parameters.rb
 - lib/rfbeam/kld7/serial_connection.rb
+- lib/rfbeam/kld7/streamer.rb
 - lib/rfbeam/version.rb
 - node_modules/.bin/prettier
 - node_modules/.yarn-integrity
@@ -238,16 +241,18 @@ files:
 - package.json
 - rfbeam.gemspec
 - sig/rfbeam.rbs
+- streamer2.rb
+- streaming.rb
 - yarn.lock
-homepage: https://gitlab.com/robcarruthers/rfbeam
+homepage: https://github.com/robcarruthers/rfbeam
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://gitlab.com/robcarruthers/rfbeam
-  source_code_uri: https://gitlab.com/robcarruthers/rfbeam
-  changelog_uri: https://gitlab.com/robcarruthers/rfbeam/-/blob/master/CHANGELOG.md
+  homepage_uri: https://github.com/robcarruthers/rfbeam
+  source_code_uri: https://github.com/robcarruthers/rfbeam
+  changelog_uri: https://github.com/robcarruthers/rfbeam/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -262,8 +267,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: Ruby API and CLI for RFBeam doplar radar modules
 test_files: []

data/.streerc

@@ -1,2 +0,0 @@
---print-width=120
---plugins=plugin/single_quotes