birdbrain 0.9.1 → 0.9.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebef39d5adda74362cc84dcc0e11402873b063e0b73e97ef365098d2705d1dc8
-  data.tar.gz: 4fa86ffb6e3805942a2ba173034043225767c94600a10341dc083d740ec225a3
+  metadata.gz: c19db414d18dc4c867da7c20996eac4776988a6d2cec9f647b0421331f497533
+  data.tar.gz: b1a327063e601aa60b6d52d14ac9839763a77605e8a8b026e73e413864247293
 SHA512:
-  metadata.gz: 2a17c59a131790c6cd95332e292815b1768123bc9b444d478f347ecea123b911405a0c0216859f4af4e256fc661cfc93a4714640792038a2c8a0bd04d4af72da
-  data.tar.gz: c1653974c3353f0e6b8bc696302c5afe5a46c91b912dd59492d2d4c0aadabd78bd8e2f03dd9715dca1b495966c8f3ecde716079eee296a5a808ba1cf4c157af3
+  metadata.gz: caf7ad0fd88ed312cef45ad0c57e5cf2dd1fa475a5fcb9af17c4ff548b6f56107333202246509cfdcd8658128566a433c8bd38333aaca81b1835be89b120b040
+  data.tar.gz: a7da2556c64c151423cc04fa108a3d6fc9cb5dc72aef2998c86c04bb94f0cb595c4b97132bd5ef491bf3b2c71763e8e0bc3f1116811acc2b8b28e3a780365041

data/README.md

@@ -4,9 +4,9 @@ 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/
+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/
+RubyDoc files are available at https://rubydoc.info/github/fmorton/BirdBrain-Ruby-Library
 
 ## Installation
 
@@ -24,11 +24,64 @@ Or install it yourself as:
 
     $ gem install birdbrain
 
-The library is distributed through https://rubygems.org/gems/birdbrain/
+The library is distributed through https://rubygems.org/gems/birdbrain
 
 ## Usage
 
-TODO: Write usage instructions here
+Below are two examples causing a Finch 2 to move in the path of a box. The first example is the long way to do it:
+
+```ruby
+require 'birdbrain'
+
+finch = BirdbrainFinch.connect('A')
+
+finch.beak(0, 50, 0)
+
+finch.tail(1, 0, 50, 0)
+finch.move(BirdbrainFinch::FORWARD, 2, 20)
+finch.turn(BirdbrainFinch::LEFT, 90, 50)
+
+finch.tail(2, 0, 50, 0)
+finch.move(BirdbrainFinch::FORWARD, 2, 20)
+finch.turn(BirdbrainFinch::RIGHT, 90, 50)
+finch.tail(3, 0, 50, 0)
+
+finch.move(BirdbrainFinch::BACKWARD, 2, 20)
+finch.turn(BirdbrainFinch::RIGHT, 90, 50)
+finch.tail(4, 0, 50, 0)
+
+finch.move(BirdbrainFinch::FORWARD, 2, 20)
+finch.turn(BirdbrainFinch::LEFT, 90, 50)
+sleep(1)
+
+finch.disconnect
+```
+
+The second way has the same result, but is more concise:
+
+```ruby
+require 'birdbrain'
+
+def draw(finch, step, move_direction, turn_direction)
+  finch.tail(step, 0, 50, 0)
+  finch.move(move_direction, 2, 20)
+  finch.turn(turn_direction, 90, 50)
+end
+
+finch = BirdbrainFinch.connect('A')
+
+finch.beak(0, 50, 0)
+
+draw(finch, 1, BirdbrainFinch::FORWARD, BirdbrainFinch::LEFT)
+draw(finch, 2, BirdbrainFinch::FORWARD, BirdbrainFinch::RIGHT)
+draw(finch, 3, BirdbrainFinch::BACKWARD, BirdbrainFinch::RIGHT)
+draw(finch, 4, BirdbrainFinch::FORWARD, BirdbrainFinch::LEFT)
+sleep(1)
+
+finch.disconnect
+```
+
+RubyDoc files are available at https://rubydoc.info/github/fmorton/BirdBrain-Ruby-Library
 
 ## Development
 
@@ -43,3 +96,5 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/fmorto
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+

data/birdbrain.gemspec

@@ -6,10 +6,10 @@ Gem::Specification.new do |spec|
   spec.authors       = ['fmorton']
   spec.email         = ['fmorton@mac.com']
 
-  spec.summary       = 'Ruby Library for Hummingbird Bit (and maybe Finch 2 later)'
+  spec.summary       = 'Ruby Library for BirdBrain Technologies Hummingbird Bit and Finch 2'
   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.'
+                      'Birdbrain Technologies Hummingbird Bit and Finch 2. To use Ruby with the Hummingbird Bit or '\
+                      'Finch 2, you must connect 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')

data/lib/birdbrain/birdbrain_device.rb

@@ -13,20 +13,24 @@ class BirdbrainDevice
 
   def initialize(device = DEFAULT_DEVICE)
     self.state = BirdbrainState.new
-    self.device = device
+    self.device = remap_device(device)
     self.connected = nil
   end
 
   def self.connect(device = DEFAULT_DEVICE, raise_exception_if_no_connection = false)
+    device_object = new(device)
+
     raise(BirdbrainException, 'Missing device name') if device.nil?
     raise(BirdbrainException, "Invalid device name: #{device}") unless VALID_DEVICES.include?(device)
 
-    device = new(device)
+    device_object.connect
 
-    device.connect
+    raise(BirdbrainException, 'No connection') if raise_exception_if_no_connection && !device_object.connected?
 
-    raise(BirdbrainException, 'No connection') if raise_exception_if_no_connection && !device.connected?
+    device_object
+  end
 
+  def remap_device(device = DEFAULT_DEVICE)
     device
   end
 

data/lib/birdbrain/version.rb

@@ -4,5 +4,5 @@
 # frozen_string_literal: true
 
 module Birdbrain
-  VERSION = '0.9.1'
+  VERSION = '0.9.6'
 end

metadata

@@ -1,18 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: birdbrain
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.6
 platform: ruby
 authors:
 - fmorton
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-05 00:00:00.000000000 Z
+date: 2021-02-16 00:00:00.000000000 Z
 dependencies: []
 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
+  motors and LEDs with the Birdbrain Technologies Hummingbird Bit and Finch 2. To
+  use Ruby with the Hummingbird Bit or Finch 2, you must connect via bluetooth with
   the BlueBird Connector.
 email:
 - fmorton@mac.com
@@ -72,5 +72,5 @@ requirements: []
 rubygems_version: 3.2.5
 signing_key:
 specification_version: 4
-summary: Ruby Library for Hummingbird Bit (and maybe Finch 2 later)
+summary: Ruby Library for BirdBrain Technologies Hummingbird Bit and Finch 2
 test_files: []