birdbrain 0.9.0 → 0.9.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb21675457d7a7b695a6f4b4858987a08cc68ebf295c1d3d869e8f0b5f5a5df6
-  data.tar.gz: cac303fd2d781c1422ba1409e6f18d95b0878d08fb46809dc850c0beefa95e83
+  metadata.gz: 3c97dbbf10c8bd37e84d77c71759400feaba7bac5212e299e55d0eae6f8a1350
+  data.tar.gz: 2b56534b9f49f1126b25c3d8c9833e980ec160e613a0df6a0f910ac953a72404
 SHA512:
-  metadata.gz: 507384baf7913ffd3cfac814352828169d92b73134846fbac52566416e1ecc87e3e798f9921e3f565ccb7b3ed61a16c892fcd1722f11340c0a2edf41e79be54e
-  data.tar.gz: 4e24f99216233d97443b45a88139e68515239d75c0ef1c07265cdd2f8648361e6bf9c6f17105fbffcc50edd660e8554b3f5dc2569a5bda25903ba5b7d8c4d80c
+  metadata.gz: 613d57a819451c0b50ef06ee7f2931a572b1df62b8e3e8b8ab26f00de58b566064f721a7b6229be6b58d867061b194a61dbe4bce9bcf92ea3eec6b684e32393b
+  data.tar.gz: ff072dc975075212f67565716b343022fbaf6ad20394a35312d1a14560dd5df8f4332812bf876537849843157eaee241e5cada879bfc7ea18b264d3ef8f61317

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,7 +13,7 @@ class BirdbrainDevice
 
   def initialize(device = DEFAULT_DEVICE)
     self.state = BirdbrainState.new
-    self.device = device
+    self.device = remap_device(device)
     self.connected = nil
   end
 
@@ -30,6 +30,10 @@ class BirdbrainDevice
     device
   end
 
+  def remap_device(device = DEFAULT_DEVICE)
+    device
+  end
+
   def connect
     self.connected = BirdbrainRequest.connected?(device)
     self.connected = nil unless valid_device_type?

data/lib/birdbrain/birdbrain_finch.rb

@@ -96,7 +96,7 @@ class BirdbrainFinch < BirdbrainMicrobit
   end
 
   def tail(port, r_intensity, g_intensity, b_intensity)
-    return unless connected_and_valid?(port, VALID_TAIL_PORTS)
+    return nil 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) }
@@ -135,7 +135,7 @@ class BirdbrainFinch < BirdbrainMicrobit
   end
 
   def move(direction, distance, speed, wait_to_finish_movement = true)
-    return false unless connected_and_valid?(direction, VALID_MOVE_DIRECTION)
+    return nil unless connected_and_valid?(direction, VALID_MOVE_DIRECTION)
 
     unless (response = BirdbrainFinchOutput.move(device, direction, distance, speed))
       return response
@@ -147,7 +147,7 @@ class BirdbrainFinch < BirdbrainMicrobit
   end
 
   def turn(direction, angle, speed, wait_to_finish_movement = true)
-    return false unless connected_and_valid?(direction, VALID_TURN_DIRECTION)
+    return nil unless connected_and_valid?(direction, VALID_TURN_DIRECTION)
 
     unless (response = BirdbrainFinchOutput.turn(device, direction, angle, speed))
       return response

data/lib/birdbrain/version.rb

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

metadata

@@ -1,18 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: birdbrain
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.5
 platform: ruby
 authors:
 - fmorton
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-05 00:00:00.000000000 Z
+date: 2021-02-15 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: []