rfbeam 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0998bf706cfa767dc3a07068c8dbcf7880ef64424f3038c7eb0456d085d23025'
+  data.tar.gz: cbbfe4127e8baf44f60b5f85249e3556529dde8d1b9a15844811eedd6d192aea
+SHA512:
+  metadata.gz: c4ed534db0956ee23f694327f28c193614f9144d7245aa988d4b2748608dc4840f3accf499ce006fcbf97d2ac73323cbc155dcb209b8b480acd9ab11ac78efe4
+  data.tar.gz: b9ba0b492230144d84b8612caf1ee1345c354cd5d95bacf6e4bb9548ebe5c2839375e23b15f8f06028b037ff8fcf96222f29d0bf2b2d894617889a75319945ae

data/.rubocop.yml

@@ -0,0 +1,11 @@
+inherit_from:
+  - node_modules/@prettier/plugin-ruby/rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.6
+
+Layout/LineLength:
+  Max: 120
+
+Documentation:
+  Enabled: false

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.7.6

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## [0.2.0] - 2023-1-23
+
+- KLD7 only
+- Device search and connection
+- Implement simple query interface for detection and target data
+
+## [0.1.0] - 2022-11-29
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rfbeam.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "rubocop", "~> 1.21"

data/Gemfile.lock

@@ -0,0 +1,63 @@
+PATH
+  remote: .
+  specs:
+    rfbeam (0.1.0)
+      activesupport (~> 6.1.0)
+      rubyserial (~> 0.6.0)
+      thor (~> 1.2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.7)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    concurrent-ruby (1.1.10)
+    ffi (1.15.5)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.2)
+    minitest (5.16.3)
+    parallel (1.22.1)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rubocop (1.39.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.23.0)
+      parser (>= 3.1.1.0)
+    ruby-progressbar (1.11.0)
+    rubyserial (0.6.0)
+      ffi (~> 1.9, >= 1.9.3)
+    thor (1.2.1)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.3.0)
+    zeitwerk (2.6.6)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  rfbeam!
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.3.26

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Rob Carruthers
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# Rfbeam
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rfbeam`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add rfbeam
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install rfbeam
+
+## Usage
+
+```ruby
+❯ bin/console
+irb(main):001:0> RfBeam.connected
+=> ["/dev/tty.usbserial-FTBX7TKD"]
+irb(main):002:0> r = RfBeam::K_ld7.new("/dev/tty.usbserial-FTBX7TKD", 115200)
+=> #<RfBeam::K_ld7:0x0000000146bb2ff0 @serial_port=#<Serial:0x0000000146bb2f28 @fd=9, @open=true, @config=#<RubySerial::Posix::Termios:0x0000000146bb2cf8>>>
+irb(main):003:0> r.detection?
+=> false
+irb(main):004:0> r.detection?
+=> true
+irb(main):005:0> r.tdat
+=> {:dist=>68, :speed=>196, :angle=>469, :mag=>6303}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rfbeam.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/rfbeam/kld7/commands.rb

@@ -0,0 +1,89 @@
+module RfBeam
+  module KLD7
+    require 'rubyserial'
+    require 'timeout'
+
+    class Error < StandardError
+    end
+
+    attr_reader :serial_port
+
+    def initialize(path, baude_rate = 0)
+      baude_rate = check_speed(baude_rate)
+      data_bits = 8
+      parity = :even
+      stop_bits = 1
+      open_serial_port(path, baude_rate, data_bits, parity, stop_bits)
+      init_radar if connected?
+
+      yield self if block_given?
+    end
+
+    def close
+      return unless connected?
+
+      @serial_port.close
+      @serial_port = nil
+      @serial_port.nil?
+    end
+
+    def read(bytes)
+      return unless connected?
+
+      @serial_port.read(bytes)
+    end
+
+    def write(string)
+      return unless connected?
+
+      @serial_port.write(string)
+      sleep 0.1
+    end
+
+    private
+
+    def open_serial_port(path, baude_rate, data_bits, parity, stop_bits)
+      @serial_port = Serial.new(path, baude_rate, data_bits, parity, stop_bits)
+    end
+
+    def connected?
+      raise Error, 'ConnectionError: No open Serial device connections.' if @serial_port.nil?
+
+      true
+    end
+
+    def flush
+      return unless connected?
+
+      loop until serial_port.getbyte.nil?
+    end
+
+    def check_speed(baude)
+      if BAUDE_RATES.value? baude
+        baude
+      elsif BAUDE_RATES.key? baude
+        BAUDE_RATES[baude]
+      else
+        115_200
+      end
+    end
+
+    def init_radar
+      command = ['INIT', 4, 0]
+      @serial_port.write command.pack('a4LL') # 4 ASCII bytes, UINT32, UINT32
+      check_response
+    end
+
+    def check_response
+      sleep RESP_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?
+
+      response_key = resp[2]
+      return if response_key.zero? # Everything OK
+
+      error_string = RESP_CODES[response_key].nil? ? 'Response unknown' : RESP_CODES[response_key]
+      raise Error, "Initialisation Error: #{error_string}"
+    end
+  end
+end

data/lib/rfbeam/kld7/detection.rb

@@ -0,0 +1,32 @@
+module RfBeam
+  module KLD7
+    def detection?
+      data = ddat
+      p data
+      (data[2] == 1)
+    end
+
+    def tdat
+      request_frame_data(:tdat)
+
+      sleep 0.1
+      resp = read(16).unpack('a4LSssS')
+      return { dist: resp[2], speed: resp[3], angle: resp[4], mag: resp[5] } unless resp[1].zero?
+    end
+
+    private
+
+    def ddat
+      request_frame_data(:ddat)
+
+      resp = read(14).unpack('a4LC6')
+      return resp
+    end
+
+    def request_frame_data(type)
+      command = ['GNFD', 4, FRAME_DATA_TYPES[type]]
+      write command.pack('a4LL')
+      check_response
+    end
+  end
+end

data/lib/rfbeam/kld7/device_data.rb

@@ -0,0 +1,33 @@
+module RfBeam
+  module KLD7
+    # All supported Serial port baude rates
+    BAUDE_RATES = { 0 => 115_200, 1 => 460_800, 2 => 921_600, 3 => 2_000_000, 4 => 3_000_000 }.freeze
+
+    # 'INIT' command response codes
+    RESP_CODES = {
+      0 => 'OK',
+      1 => 'Unknown command',
+      2 => 'Invalid parameter value',
+      3 => 'Invalid RPST version',
+      4 => 'Uart error (parity, framing, noise)',
+      5 => 'Sensor busy',
+      6 => 'Timeout error',
+    }.freeze
+
+    # The response delay was determined empirically and may need adjusting with baude rate
+    RESP_DELAY = 0.1
+
+    # 'GNFD' command types
+    FRAME_DATA_TYPES = { disabled: 0x00, radc: 0x01, rfft: 0x02, pdat: 0x04, tdat: 0x08, ddat: 0x10, done: 0x20 }.freeze
+
+    # The angle, direction, range and speed flags are only valid if the detection flag is 1.
+    DETECTION_FLAGS = {
+      detection: ['No Detection', 'Detection'],
+      micro_detection: ['No Detection', 'Detection'],
+      angle: %w[Left Right],
+      direction: %w[Receding Approaching],
+      range: %w[Far Near],
+      speed: %w[Low High],
+    }
+  end
+end

data/lib/rfbeam/version.rb

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

data/lib/rfbeam.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'rfbeam/kld7/commands'
+require 'rfbeam/kld7/detection'
+require 'rfbeam/kld7/device_data'
+require_relative 'rfbeam/version'
+
+module RfBeam
+  class Error < StandardError
+  end
+
+  class K_ld7
+    include RfBeam::KLD7
+  end
+
+  def self.connected
+    path_str, dir =
+      if RubySerial::ON_LINUX
+        %w[ttyUSB /dev/]
+      elsif RubySerial::ON_WINDOWS
+        ['TODO: Implement find device for Windows', 'You lazy bugger']
+      else
+        %w[tty.usbserial /dev/]
+      end
+
+    Dir.glob("#{dir}#{path_str}*")
+  end
+end

data/node_modules/.bin/prettier

@@ -0,0 +1 @@
+../prettier/bin-prettier.js

data/node_modules/.yarn-integrity

@@ -0,0 +1,19 @@
+{
+  "systemParams": "darwin-arm64-108",
+  "modulesFolders": [
+    "node_modules"
+  ],
+  "flags": [],
+  "linkedModules": [],
+  "topLevelPatterns": [
+    "@prettier/plugin-ruby@^3.2.2",
+    "prettier@^2.8.0"
+  ],
+  "lockfileEntries": {
+    "@prettier/plugin-ruby@^3.2.2": "https://registry.yarnpkg.com/@prettier/plugin-ruby/-/plugin-ruby-3.2.2.tgz#43c9d85349032f74d34c4f57e6a77487d5c5bdc1",
+    "prettier@>=2.3.0": "https://registry.yarnpkg.com/prettier/-/prettier-2.8.0.tgz#c7df58393c9ba77d6fba3921ae01faf994fb9dc9",
+    "prettier@^2.8.0": "https://registry.yarnpkg.com/prettier/-/prettier-2.8.0.tgz#c7df58393c9ba77d6fba3921ae01faf994fb9dc9"
+  },
+  "files": [],
+  "artifacts": {}
+}