rfbeam 0.4.0 → 0.4.2

data/lib/rfbeam/kld7/radar_parameters.rb

@@ -1,6 +1,5 @@
 module RfBeam
   module KLD7
-
     # -----------------
     # Software Version, 'K-LD7_APP-RFB-XXXX'
     # -----------------
@@ -15,9 +14,10 @@ module RfBeam
       query_parameter RADAR_PARAMETERS[:base_frequency].grps_index
     end
     alias rbfr base_frequency
-    
+
     def base_frequency=(frequency = 1)
-      value = case frequency
+      value =
+        case frequency
         when 0, :low, 'low'
           0
         when 1, :middle, 'middle'
@@ -32,341 +32,341 @@ module RfBeam
 
     alias set_base_frequency base_frequency=
     alias rbfr= base_frequency=
-    
+
     # -----------------
     # Maximum Speed, 0 = 12.5km/h, 1 = 25km/h (default), 2 = 50km/h, 3 = 100km/h
     # -----------------
     def max_speed
       query_parameter(RADAR_PARAMETERS[:max_speed].grps_index)
     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)
-      
+      raise ArgumentError, 'Expected an Integer' unless speed.is_a?(Integer)
+
       set_parameter :rspi, speed, :uint32
     end
-    
+
     alias set_max_speed max_speed=
     alias rspi max_speed=
-    
+
     # -----------------
     # Maximum Range, 0 = 5m, 1 = 10m (default), 2 = 30m, 3 = 100m
     # -----------------
     def max_range
       query_parameter(RADAR_PARAMETERS[:max_range].grps_index)
     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)
-      
+      raise ArgumentError, 'Expected an Integer' unless range.is_a?(Integer)
+
       set_parameter :rrai, range, :uint32
     end
-    
+
     alias rrai= max_range=
     alias set_max_range max_range=
-    
+
     # -----------------
     # Threshold Offset, 10 - 60db, (default = 30)
     # -----------------
     def threshold_offset
       query_parameter RADAR_PARAMETERS[:threshold_offset].grps_index
     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)
-      
+      raise ArgumentError, 'Expected an Integer' unless offset.is_a?(Integer)
+
       set_parameter :thof, offset, :uint32
     end
-    
+
     alias thof= threshold_offset=
     alias set_threshold_offset threshold_offset=
-    
+
     # -----------------
     # Tracking filter type, 0 = Standard (Default), 1 = Fast Tracking, 2 = Long visibility
     # -----------------
     def tracking_filter
       query_parameter RADAR_PARAMETERS[:tracking_filter].grps_index
     end
-    
+
     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
     alias trtf= tracking_filter=
     alias set_tracking_filter tracking_filter=
-    
+
     # -----------------
     # Vibration suppression, 0 - 16, 0 = No Suppression, 16 = High Suppression, default = 2
     # -----------------
     def vibration_suppression
       query_parameter RADAR_PARAMETERS[:vibration_suppression].grps_index
     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)
-      
-      set_parameter :visu, value, :uint32  
+      raise ArgumentError, 'Expected an Integer' unless value.is_a?(Integer)
+
+      set_parameter :visu, value, :uint32
     end
     alias visu= vibration_suppression=
     alias set_vibration_suppression vibration_suppression=
-    
+
     # -----------------
     # Minimum Detection distance, 0 - 100% of Range setting, default = 0
     # -----------------
     def min_detection_distance
       query_parameter RADAR_PARAMETERS[:min_detection_distance].grps_index
     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)
-      
+      raise ArgumentError, 'Expected an Integer' unless value.is_a?(Integer)
+
       set_parameter :mira, value, :uint32
     end
     alias mira= min_detection_distance=
     alias set_min_detection_distance min_detection_distance=
-    
+
     # -----------------
     # Maximum Detection distance, 0 - 100% of Range setting, default = 50
     # -----------------
     def max_detection_distance
       query_parameter RADAR_PARAMETERS[:min_detection_distance].grps_index
     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)
-      
+      raise ArgumentError, 'Expected an Integer' unless value.is_a?(Integer)
+
       set_parameter :mara, value, :uint32
     end
     alias mara= max_detection_distance=
     alias set_max_detection_distance max_detection_distance=
-    
+
     # -----------------
     # Minimum Detection Angle, -90° - 90°, default = -90
     # -----------------
     def min_detection_angle
       query_parameter RADAR_PARAMETERS[:min_detection_angle].grps_index
     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)
-      
+      raise ArgumentError, 'Expected an Integer' unless angle.is_a?(Integer)
+
       set_parameter :mian, angle, :int32
     end
     alias mian= min_detection_angle=
     alias set_min_detection_angle min_detection_angle=
-    
+
     # -----------------
     # Maximum Detection Angle, -90° - 90°, default = 90
     # -----------------
     def max_detection_angleq
       query_parameter RADAR_PARAMETERS[:max_detection_angle].grps_index
     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)
-      
+      raise ArgumentError, 'Expected an Integer' unless angle.is_a?(Integer)
+
       set_parameter :maan, angle, :int32
     end
     alias maan= max_detection_angle=
     alias set_max_detection_angle max_detection_angle=
-    
+
     # -----------------
     # Minimum Detection Speed, 0 - 100% of Speed setting, default = 0
     # -----------------
     def min_detection_speed
       query_parameter RADAR_PARAMETERS[:min_detection_angle].grps_index
     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)
-      
+      raise ArgumentError, 'Expected an Integer' unless speed.is_a?(Integer)
+
       set_parameter :misp, speed, :uint32
     end
     alias misp= min_detection_speed=
     alias set_min_detection_speed min_detection_speed=
-    
+
     # -----------------
     # Maximum Detection Speed, 0 - 100% of Speed setting, default = 100
     # -----------------
     def max_detection_speed
       query_parameter RADAR_PARAMETERS[:max_detection_speed].grps_index
     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)
-      
+      raise ArgumentError, 'Expected an Integer' unless speed.is_a?(Integer)
+
       set_parameter :masp, speed, :uint32
     end
     alias masp= max_detection_speed=
     alias set_max_detection_speed max_detection_speed=
-    
+
     # -----------------
     # Detection Direction, 0 = Receding, 1 = Approaching, 2 = Both (default)
     # -----------------
     def detection_direction
       query_parameter RADAR_PARAMETERS[:detection_direction].grps_index
     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)
-      
+      raise ArgumentError, 'Expected an Integer' unless direction.is_a?(Integer)
+
       set_parameter :dedi, direction, :uint32
     end
     alias dedi= detection_direction=
     alias set_detection_direction detection_direction=
-    
+
     # -----------------
     # Range Threshold, 0 - 100% of Range setting, default = 10
     # -----------------
     def range_threshold
       query_parameter RADAR_PARAMETERS[:range_threshold].grps_index
     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)
-      
+      raise ArgumentError, 'Expected an Integer' unless value.is_a?(Integer)
+
       set_parameter :rath, value, :uint32
     end
     alias rath= range_threshold=
     alias set_range_threshold range_threshold=
-    
+
     # -----------------
     # Angle Threshold, -90° to 90°, default = 0
     # -----------------
     def angle_threshold
       query_parameter RADAR_PARAMETERS[:angle_threshold].grps_index
     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)
-      
+      raise ArgumentError, 'Expected an Integer' unless value.is_a?(Integer)
+
       set_parameter :anth, value, :int32
     end
     alias anth= angle_threshold=
     alias set_angle_threshold angle_threshold=
-    
+
     # -----------------
     # Speed Threshold, 0 - 100% of speed setting, default = 50
     # -----------------
     def speed_threshold
       query_parameter RADAR_PARAMETERS[:speed_threshold].grps_index
     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)
-      
+      raise ArgumentError, 'Expected an Integer' unless value.is_a?(Integer)
+
       set_parameter :spth, value, :uint32
     end
     alias spth= angle_threshold=
     alias set_speed_threshold angle_threshold=
-    
+
     # -----------------
     # Digital output 1, 0 = Direction, 1 = Angle, 2 = Range, 3 = Speed, 4 = Micro Detection, default = 0
     # -----------------
     def digital_output1
       query_parameter RADAR_PARAMETERS[:digital_output1].grps_index
     end
-    
-    def digital_output1=(value = 0)      
+
+    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)  
-      
+      raise ArgumentError, 'Expected an Integer' unless value.is_a?(Integer)
+
       set_parameter :dig1, value, :uint32
     end
     alias dig1= digital_output1=
     alias set_digital_output1 digital_output1=
-    
+
     # -----------------
     # Digital output 2, 0 = Direction, 1 = Angle, 2 = Range, 3 = Speed, 4 = Micro Detection, default = 1
     # -----------------
     def digital_output2
       query_parameter RADAR_PARAMETERS[:digital_output2].grps_index
     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)  
-      
+      raise ArgumentError, 'Expected an Integer' unless value.is_a?(Integer)
+
       set_parameter :dig2, value, :uint32
     end
     alias dig2= digital_output2=
     alias set_digital_output2 digital_output2=
-    
+
     # -----------------
     # Digital output 3, 0 = Direction, 1 = Angle, 2 = Range, 3 = Speed, 4 = Micro Detection, default = 2
     # -----------------
     def digital_output3
       query_parameter RADAR_PARAMETERS[:digital_output3].grps_index
     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)  
-      
+      raise ArgumentError, 'Expected an Integer' unless value.is_a?(Integer)
+
       set_parameter :dig3, value, :uint32
     end
     alias dig3= digital_output3=
     alias set_digital_output3 digital_output3=
-    
+
     # -----------------
     # Hold Time, 1 - 7200s, default = 1
     # -----------------
     def hold_time
       query_parameter RADAR_PARAMETERS[:hold_time].grps_index
     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)  
-      
+      raise ArgumentError, 'Expected an Integer' unless time.is_a?(Integer)
+
       set_parameter :hold, time, :uint32
     end
     alias hold= hold_time=
     alias set_hold_time hold_time=
-    
+
     # -----------------
     # Micro Detection retrigger, 0 = Off (default), 1 = Retrigger
     # -----------------
     def micro_detection_retrigger
       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)  
-      
+      raise ArgumentError, 'Expected an Integer' unless value.is_a?(Integer)
+
       set_parameter :mide, value, :uint32
     end
     alias mide= micro_detection_retrigger=
     alias set_micro_detection_retrigger micro_detection_retrigger=
-    
+
     # -----------------
     # Micro Detection sensitivity, 0 - 9, 0 = Min, 9 = Max, default = 4
     # -----------------
     def micro_detection_sensitivity
       query_parameter RADAR_PARAMETERS[:micro_detection_sensitivity].grps_index
     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)  
-      
+      raise ArgumentError, 'Expected an Integer' unless value.is_a?(Integer)
+
       set_parameter :mids, value, :uint32
     end
     alias mids= micro_detection_sensitivity=
@@ -378,17 +378,17 @@ module RfBeam
       data = grps
       data[index]
     end
-    
+
     def set_parameter(header, value, return_type = :uint32)
       return_type =
         case return_type
-          when :uint32
+        when :uint32
           'L'
-          when :int32
+        when :int32
           'l'
-          when :uint32
+        when :uint32
           'S'
-          else
+        else
           'L'
         end
       command = [header.upcase.to_s, 4, value]

data/lib/rfbeam/kld7/serial_connection.rb

@@ -75,7 +75,7 @@ module RfBeam
     end
 
     def check_response
-      sleep RESP_DELAY
+      sleep RESPONSE_DELAY
       resp = @serial_port.read(9).unpack('a4LC') # 4 ASCII bytes, UINT32, UINT8
       raise Error, 'No valid response from Serial Port' if resp[2].nil?
 

data/lib/rfbeam/version.rb

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

data/lib/rfbeam.rb

@@ -4,11 +4,11 @@ require 'rfbeam/kld7/radar_parameters'
 require 'rfbeam/kld7/radar_messages'
 require 'rfbeam/kld7/serial_connection'
 require 'rfbeam/kld7/constants'
-require 'rfbeam/kld7/streamer'
+require 'rfbeam/kld7/cli_output'
+require 'rfbeam/kld7/cli_formatter'
 require 'rfbeam/version'
 require 'rfbeam/cli'
 
-
 module RfBeam
   class Error < StandardError
   end

data/rfbeam.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description = 'Currently only tested with K-LD7 on MacOS & Raspian (bullseye)'
   spec.homepage = 'https://gitlab.com/robcarruthers/rfbeam'
   spec.license = 'MIT'
-  spec.required_ruby_version = '>= 3.2.1'
+  spec.required_ruby_version = '>= 3.1.2'
 
   # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rfbeam
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Rob Carruthers
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-04 00:00:00.000000000 Z
+date: 2023-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -62,6 +62,7 @@ extra_rdoc_files: []
 files:
 - ".DS_Store"
 - ".rubocop.yml"
+- ".streerc"
 - ".tool-versions"
 - CHANGELOG.md
 - Gemfile
@@ -72,11 +73,12 @@ files:
 - exe/rfbeam
 - lib/rfbeam.rb
 - lib/rfbeam/cli.rb
+- lib/rfbeam/kld7/cli_formatter.rb
+- lib/rfbeam/kld7/cli_output.rb
 - lib/rfbeam/kld7/constants.rb
 - 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
@@ -183,14 +185,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.1
+      version: 3.1.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.9
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Ruby API and CLI for RFBeam doplar radar modules

data/lib/rfbeam/kld7/streamer.rb

@@ -1,75 +0,0 @@
-# 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