rfbeam 0.4.10 → 0.5.1

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.4.10'
+  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