birdbrain 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 927e03b41176f419971ac1faed0d8243638448c044918a2035151dd8a05a796e
+  data.tar.gz: 5f365f6debd7c9af03de923075613252a7c96a47ba94ae683991c7426d24bdf9
+SHA512:
+  metadata.gz: 847a2bbabefcc8cb78319770ced934d7f60c3b76a6d5124a68a53cd0f1580cf63b472c063bc5da6650461a2ea4561792d46488554723ac427f3f4b0f81b2cbc9
+  data.tar.gz: a5f1cb8a3e84329609004645cc1777a2b5ec505c12156e6547977096c670ef535397a9cbc34778722743e884234ae0d949fd8959b29a9f239840ed4063165dc9

data/.gitignore

@@ -0,0 +1,57 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+#/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+

data/.rubocop.yml

@@ -0,0 +1,135 @@
+Metrics/BlockLength:
+  Max: 32
+Naming/MethodParameterName:
+  Enabled: false
+Metrics/ClassLength:
+  Max: 200
+Metrics/MethodLength:
+  Max: 200
+Style/Documentation:
+  Enabled: false
+Style/TernaryParentheses:
+  Enabled: false
+Style/NumericPredicate:
+  Enabled: false
+Style/NumericLiterals:
+  Enabled: false
+Style/IfUnlessModifier:
+  Enabled: false
+Style/SafeNavigation:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Max: 20
+Metrics/PerceivedComplexity:
+  Max: 20
+Metrics/AbcSize:
+  Max: 200
+Layout/LineLength:
+  Max: 150
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/MutableConstant:
+  Enabled: false
+Layout/BeginEndAlignment: # (new in 0.91)
+  Enabled: true
+Layout/EmptyLinesAroundAttributeAccessor: # (new in 0.83)
+  Enabled: true
+Layout/SpaceAroundMethodCallOperator: # (new in 0.82)
+  Enabled: true
+Lint/BinaryOperatorWithIdenticalOperands: # (new in 0.89)
+  Enabled: true
+Lint/ConstantDefinitionInBlock: # (new in 0.91)
+  Enabled: true
+Lint/DeprecatedOpenSSLConstant: # (new in 0.84)
+  Enabled: true
+Lint/DuplicateElsifCondition: # (new in 0.88)
+  Enabled: true
+Lint/DuplicateRequire: # (new in 0.90)
+  Enabled: true
+Lint/DuplicateRescueException: # (new in 0.89)
+  Enabled: true
+Lint/EmptyConditionalBody: # (new in 0.89)
+  Enabled: true
+Lint/EmptyFile: # (new in 0.90)
+  Enabled: true
+Lint/FloatComparison: # (new in 0.89)
+  Enabled: true
+Lint/HashCompareByIdentity: # (new in 0.93)
+  Enabled: true
+Lint/IdentityComparison: # (new in 0.91)
+  Enabled: true
+Lint/MissingSuper: # (new in 0.89)
+  Enabled: true
+Lint/MixedRegexpCaptureTypes: # (new in 0.85)
+  Enabled: true
+Lint/OutOfRangeRegexpRef: # (new in 0.89)
+  Enabled: true
+Lint/RaiseException: # (new in 0.81)
+  Enabled: true
+Lint/RedundantSafeNavigation: # (new in 0.93)
+  Enabled: true
+Lint/SelfAssignment: # (new in 0.89)
+  Enabled: true
+Lint/StructNewOverride: # (new in 0.81)
+  Enabled: true
+Lint/TopLevelReturnWithArgument: # (new in 0.89)
+  Enabled: true
+Lint/TrailingCommaInAttributeDeclaration: # (new in 0.90)
+  Enabled: true
+Lint/UnreachableLoop: # (new in 0.89)
+  Enabled: true
+Lint/UselessMethodDefinition: # (new in 0.90)
+  Enabled: true
+Lint/UselessTimes: # (new in 0.91)
+  Enabled: true
+Style/AccessorGrouping: # (new in 0.87)
+  Enabled: false
+Style/BisectedAttrAccessor: # (new in 0.87)
+  Enabled: true
+Style/CaseLikeIf: # (new in 0.88)
+  Enabled: true
+Style/ClassEqualityComparison: # (new in 0.93)
+  Enabled: true
+Style/CombinableLoops: # (new in 0.90)
+  Enabled: true
+Style/ExplicitBlockArgument: # (new in 0.89)
+  Enabled: false
+Style/ExponentialNotation: # (new in 0.82)
+  Enabled: true
+Style/GlobalStdStream: # (new in 0.89)
+  Enabled: true
+Style/HashAsLastArrayItem: # (new in 0.88)
+  Enabled: true
+Style/HashEachMethods: # (new in 0.80)
+  Enabled: true
+Style/HashLikeCase: # (new in 0.88)
+  Enabled: true
+Style/HashTransformKeys: # (new in 0.80)
+  Enabled: true
+Style/HashTransformValues: # (new in 0.80)
+  Enabled: true
+Style/KeywordParametersOrder: # (new in 0.90)
+  Enabled: true
+Style/OptionalBooleanParameter: # (new in 0.89)
+  Enabled: false
+Style/RedundantAssignment: # (new in 0.87)
+  Enabled: true
+Style/RedundantFetchBlock: # (new in 0.86)
+  Enabled: true
+Style/RedundantFileExtensionInRequire: # (new in 0.88)
+  Enabled: true
+Style/RedundantRegexpCharacterClass: # (new in 0.85)
+  Enabled: true
+Style/RedundantRegexpEscape: # (new in 0.85)
+  Enabled: true
+Style/RedundantSelfAssignment: # (new in 0.90)
+  Enabled: true
+Style/SingleArgumentDig: # (new in 0.89)
+  Enabled: true
+Style/SlicingWithRange: # (new in 0.83)
+  Enabled: true
+Style/SoleNestedConditional: # (new in 0.89)
+  Enabled: true
+Style/StringConcatenation: # (new in 0.89)
+  Enabled: true
+

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in birdbrain.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'minitest', '~> 5.0'
+gem 'rubocop', '~> 0.80'
+
+gem 'pry'

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    birdbrain (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    coderay (1.1.3)
+    method_source (1.0.0)
+    minitest (5.14.3)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.0.3)
+    rexml (3.2.4)
+    rubocop (0.93.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.4.0)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  birdbrain!
+  minitest (~> 5.0)
+  pry
+  rake (~> 13.0)
+  rubocop (~> 0.80)
+
+BUNDLED WITH
+   2.2.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Base2 Incorporated (Frank Morton)
+
+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 @@
+# Birdbrain-Ruby-Library
+
+Ruby Library for the BirdBrainTechnologies Hummingbird Bit and Finch 2
+
+This Ruby library allows students to use Ruby to read sensors and set motors and LEDs with the Hummingbird Bit. To use Ruby with the Hummingbird Bit, you must connect to the Hummingbird Bit via bluetooth with the BlueBird Connector.
+
+For more information about setting up the BlueBird Connector used with their Python library, see www.birdbraintechnologies.com/hummingbirdbit/python/
+
+Rdoc files are available at https://rdoc.info/github/fmorton/BirdBrain-Ruby-Library/
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'birdbrain'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install birdbrain
+
+The library is distributed through https://rubygems.org/gems/birdbrain/
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/fmorton/BirdBrain-Ruby-Library.
+
+## 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,14 @@
+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/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'birdbrain'
+require 'pry'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, do not forget to add pry to your Gemfile!)
+Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/birdbrain.gemspec

@@ -0,0 +1,37 @@
+require_relative 'lib/birdbrain/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'birdbrain'
+  spec.version       = Birdbrain::VERSION
+  spec.authors       = ['fmorton']
+  spec.email         = ['fmorton@mac.com']
+
+  spec.summary       = 'Ruby Library for Hummingbird Bit (and maybe Finch 2 later)'
+  spec.description   = 'This Ruby library allows students to use Ruby to read sensors and set motors and LEDs with the '\
+                      'Birdbrain Technologies Hummingbird Bit. To use Ruby with the Hummingbird Bit, you must connect '\
+                      'to the Hummingbird Bit via bluetooth with the BlueBird Connector.'
+  spec.homepage      = 'https://github.com/fmorton/BirdBrain-Ruby-Library'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/fmorton/BirdBrain-Ruby-Library'
+  spec.metadata['changelog_uri'] = 'https://github.com/fmorton/BirdBrain-Ruby-Library/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.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency 'example-gem', '~> 1.0'
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/birdbrain/birdbrain_device.rb

@@ -0,0 +1,60 @@
+#-----------------------------------------------------------------------------------------------------------------------------------
+# Copyright (c) 2021 Base2 Incorporated--All Rights Reserved.
+#-----------------------------------------------------------------------------------------------------------------------------------
+class BirdbrainDevice
+  DEFAULT_DEVICE = 'A'
+  LEFT = 'L'
+  RIGHT = 'R'
+  VALID_DEVICES = 'ABC'
+
+  attr_accessor :state
+  attr_accessor :connected
+  attr_accessor :device
+
+  def initialize(device = DEFAULT_DEVICE)
+    raise(BirdbrainException, 'Missing device name') if device.nil?
+    raise(BirdbrainException, "Invalid device name: #{device}") unless VALID_DEVICES.include?(device)
+
+    self.state = BirdbrainState.new
+    self.device = device
+    self.connected = BirdbrainRequest.connected?(device)
+
+    raise(BirdbrainException, 'No connection') unless connected?
+  end
+
+  def connected?
+    connected
+  end
+
+  def disconnect
+    BirdbrainRequest.disconnect(device) if connected?
+
+    state.microbit_display_map_clear unless state.nil?
+
+    self.connected = false
+    self.device = nil
+    self.state = nil
+  end
+
+  def microbit?
+    BirdbrainMicrobitInput.microbit?(device) if connected?
+  end
+
+  def hummingbird?
+    BirdbrainHummingbirdInput.hummingbird?(device) if connected?
+  end
+
+  def finch?
+    BirdbrainFinchInput.finch?(device) if connected?
+  end
+
+  def valid?(validate, valid_range)
+    return false if validate.nil?
+
+    valid_range.include?(validate.to_s)
+  end
+
+  def connected_and_valid?(validate, valid_range)
+    valid?(validate, valid_range) && connected?
+  end
+end

data/lib/birdbrain/birdbrain_exception.rb

@@ -0,0 +1,14 @@
+#-----------------------------------------------------------------------------------------------------------------------------------
+# Copyright (c) 2021 Base2 Incorporated--All Rights Reserved.
+#-----------------------------------------------------------------------------------------------------------------------------------
+class BirdbrainException < StandardError
+  def self.disconnect(device, message)
+    begin
+      BirdbrainRequest.disconnect(device)
+    rescue BirdbrainException
+      true
+    end
+
+    raise(BirdbrainException, message)
+  end
+end

data/lib/birdbrain/birdbrain_finch.rb

@@ -0,0 +1,168 @@
+#-----------------------------------------------------------------------------------------------------------------------------------
+# Copyright (c) 2021 Base2 Incorporated--All Rights Reserved.
+#-----------------------------------------------------------------------------------------------------------------------------------
+class BirdbrainFinch < BirdbrainMicrobit
+  FORWARD = 'F'
+  BACKWARD = 'B'
+  LEFT = BirdbrainDevice::LEFT
+  RIGHT = BirdbrainDevice::RIGHT
+  MOVE_START_WAIT_SECONDS = 0.15
+  MOVE_TIMEOUT_SECONDS = 60.0
+  VALID_LED_PORTS = '123'
+  VALID_TAIL_PORTS = '1234all'
+  VALID_TRILED_PORTS = '1234'
+  VALID_SENSOR_PORTS = '123'
+  VALID_SERVO_PORTS = '1234'
+  VALID_MOVE_DIRECTION = 'FB'
+  VALID_TURN_DIRECTION = 'LR'
+
+  attr_accessor :move_start_wait_seconds
+  attr_accessor :move_start_time
+  attr_accessor :move_timeout_seconds
+
+  def initialize(device = DEFAULT_DEVICE)
+    super
+    self.move_start_wait_seconds = MOVE_START_WAIT_SECONDS # seconds to allow finch to start moving
+    self.move_timeout_seconds = MOVE_TIMEOUT_SECONDS # maximum number of seconds to wait for finch moving
+    self.move_start_time = 0 # after move records how long it took the startup to complete for tuning
+  end
+
+  def moving?
+    BirdbrainFinchInput.moving?(device) if connected?
+  end
+
+  def light(direction)
+    BirdbrainFinchInput.light(device, direction) if connected?
+  end
+
+  def distance
+    BirdbrainFinchInput.distance(device) if connected?
+  end
+
+  def line(direction)
+    BirdbrainFinchInput.line(device, direction) if connected?
+  end
+
+  def encoder(direction)
+    BirdbrainFinchInput.encoder(device, direction) if connected?
+  end
+
+  def accelerometer
+    BirdbrainFinchInput.accelerometer(device) if connected?
+  end
+
+  def compass
+    BirdbrainFinchInput.compass(device) if connected?
+  end
+
+  def magnetometer
+    BirdbrainFinchInput.magnetometer(device) if connected?
+  end
+
+  def orientation
+    BirdbrainFinchInput.orientation(device) if connected?
+  end
+
+  def orientation_beak_up?
+    BirdbrainFinchInput.orientation_beak_up?(device) if connected?
+  end
+
+  def orientation_beak_down?
+    BirdbrainFinchInput.orientation_beak_down?(device) if connected?
+  end
+
+  def orientation_tilt_left?
+    BirdbrainFinchInput.orientation_tilt_left?(device) if connected?
+  end
+
+  def orientation_tilt_right?
+    BirdbrainFinchInput.orientation_tilt_right?(device) if connected?
+  end
+
+  def orientation_level?
+    BirdbrainFinchInput.orientation_level?(device) if connected?
+  end
+
+  def orientation_upside_down?
+    BirdbrainFinchInput.orientation_upside_down?(device) if connected?
+  end
+
+  def beak(r_intensity, g_intensity, b_intensity)
+    BirdbrainHummingbirdOutput.tri_led(device, 1, r_intensity, g_intensity, b_intensity) if connected?
+  end
+
+  def tail(port, r_intensity, g_intensity, b_intensity)
+    return unless connected_and_valid?(port, VALID_TAIL_PORTS)
+
+    if port.to_s == 'all'
+      (2..5).each { |each_port| BirdbrainHummingbirdOutput.tri_led(device, each_port, r_intensity, g_intensity, b_intensity) }
+    else
+      BirdbrainHummingbirdOutput.tri_led(device, port + 1, r_intensity, g_intensity, b_intensity)
+    end
+  end
+
+  def play_note(note, beats)
+    BirdbrainHummingbirdOutput.play_note(device, note, beats) if connected?
+  end
+
+  def wait_until_movement
+    start_time = Time.now
+
+    sleep(0.01) while !moving? && ((Time.now - start_time) < move_start_wait_seconds) # short wait for finch to start moving
+
+    self.move_start_time = Time.now - start_time # close to amount of time it took the finch to startup for tuning
+
+    true
+  end
+
+  def wait
+    start_time = Time.now
+
+    sleep(0.01) while moving? && ((Time.now - start_time) < move_timeout_seconds)
+
+    true
+  end
+
+  def wait_until_movement_and_wait
+    wait_until_movement
+    wait
+
+    true
+  end
+
+  def move(direction, distance, speed, wait_to_finish_movement = true)
+    return false unless connected_and_valid?(direction, VALID_MOVE_DIRECTION)
+
+    unless (response = BirdbrainFinchOutput.move(device, direction, distance, speed))
+      return response
+    end
+
+    wait_until_movement_and_wait if wait_to_finish_movement
+
+    true
+  end
+
+  def turn(direction, angle, speed, wait_to_finish_movement = true)
+    return false unless connected_and_valid?(direction, VALID_TURN_DIRECTION)
+
+    unless (response = BirdbrainFinchOutput.turn(device, direction, angle, speed))
+      return response
+    end
+
+    wait_until_movement_and_wait if wait_to_finish_movement
+
+    true
+  end
+
+  def motors(left_speed, right_speed)
+    BirdbrainFinchOutput.motors(device, left_speed, right_speed) if connected?
+  end
+
+  def stop
+    BirdbrainFinchOutput.stop(device) if connected?
+  end
+
+  def reset_encoders
+    BirdbrainFinchOutput.reset_encoders(device) if connected?
+  end
+end