birdbrain 0.2.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 927e03b41176f419971ac1faed0d8243638448c044918a2035151dd8a05a796e
-  data.tar.gz: 5f365f6debd7c9af03de923075613252a7c96a47ba94ae683991c7426d24bdf9
+  metadata.gz: cb21675457d7a7b695a6f4b4858987a08cc68ebf295c1d3d869e8f0b5f5a5df6
+  data.tar.gz: cac303fd2d781c1422ba1409e6f18d95b0878d08fb46809dc850c0beefa95e83
 SHA512:
-  metadata.gz: 847a2bbabefcc8cb78319770ced934d7f60c3b76a6d5124a68a53cd0f1580cf63b472c063bc5da6650461a2ea4561792d46488554723ac427f3f4b0f81b2cbc9
-  data.tar.gz: a5f1cb8a3e84329609004645cc1777a2b5ec505c12156e6547977096c670ef535397a9cbc34778722743e884234ae0d949fd8959b29a9f239840ed4063165dc9
+  metadata.gz: 507384baf7913ffd3cfac814352828169d92b73134846fbac52566416e1ecc87e3e798f9921e3f565ccb7b3ed61a16c892fcd1722f11340c0a2edf41e79be54e
+  data.tar.gz: 4e24f99216233d97443b45a88139e68515239d75c0ef1c07265cdd2f8648361e6bf9c6f17105fbffcc50edd660e8554b3f5dc2569a5bda25903ba5b7d8c4d80c

data/lib/birdbrain/birdbrain_device.rb

@@ -12,30 +12,56 @@ class BirdbrainDevice
   attr_accessor :device
 
   def initialize(device = DEFAULT_DEVICE)
+    self.state = BirdbrainState.new
+    self.device = device
+    self.connected = nil
+  end
+
+  def self.connect(device = DEFAULT_DEVICE, raise_exception_if_no_connection = false)
     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)
+    device = new(device)
+
+    device.connect
+
+    raise(BirdbrainException, 'No connection') if raise_exception_if_no_connection && !device.connected?
 
-    raise(BirdbrainException, 'No connection') unless connected?
+    device
   end
 
-  def connected?
+  def connect
+    self.connected = BirdbrainRequest.connected?(device)
+    self.connected = nil unless valid_device_type?
     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.connected = nil
     self.device = nil
     self.state = nil
   end
 
+  def self.find_device
+    ('A'..'C').each do |device|
+      connected_device = connect(device)
+
+      return connected_device if connected_device.valid_device_type?
+    rescue BirdbrainException
+      next
+    end
+
+    new(nil)
+  end
+
   def microbit?
     BirdbrainMicrobitInput.microbit?(device) if connected?
   end

data/lib/birdbrain/birdbrain_exception.rb

@@ -2,13 +2,4 @@
 # 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

@@ -27,6 +27,10 @@ class BirdbrainFinch < BirdbrainMicrobit
     self.move_start_time = 0 # after move records how long it took the startup to complete for tuning
   end
 
+  def valid_device_type?
+    finch?
+  end
+
   def moving?
     BirdbrainFinchInput.moving?(device) if connected?
   end

data/lib/birdbrain/birdbrain_finch_input.rb

@@ -9,11 +9,11 @@ class BirdbrainFinchInput < BirdbrainRequest
   DEFAULT_UNLIMITED_MIN_RESPONSE = -1000000
   DEFAULT_UNLIMITED_MAX_RESPONSE = 1000000
   ORIENTATIONS = ['Beak%20Up', 'Beak%20Down', 'Tilt%20Left', 'Tilt%20Right', 'Level', 'Upside%20Down']
-  ORIENTATION_RESULTS = ['Beak up', 'Beak down', 'Tilt left', 'Tilt right', 'Level', 'Upside down']
+  ORIENTATION_RESULTS = ['Beak up', 'Beak down', 'Tilt left', 'Tilt right', 'Level', 'Upside down', 'In between']
   ORIENTATION_IN_BETWEEN = 'In between'
 
   def self.finch?(device)
-    request_status(response_body('hummingbird', 'in', 'isHummingbird', 'static', device))
+    request_status(response_body('hummingbird', 'in', 'isFinch', 'static', device))
   end
 
   def self.moving?(device)
@@ -92,11 +92,11 @@ class BirdbrainFinchInput < BirdbrainRequest
     orientation_check(device, 5)
   end
 
-  def self.orientation_check(device, index)
+  private_class_method def self.orientation_check(device, index)
     request_status(response_body('hummingbird', 'in', 'finchOrientation', ORIENTATIONS[index], device))
   end
 
-  def self.sensor(device, sensor, other = nil, options = {})
+  private_class_method def self.sensor(device, sensor, other = nil, options = {})
     return false if other == false # for invalid directions
 
     factor = options.key?(:factor) ? options[:factor] : DEFAULT_FACTOR

data/lib/birdbrain/birdbrain_hummingbird.rb

@@ -9,6 +9,10 @@ class BirdbrainHummingbird < BirdbrainMicrobit
   VALID_SENSOR_PORTS = '123'
   VALID_SERVO_PORTS = '1234'
 
+  def valid_device_type?
+    hummingbird?
+  end
+
   def light(port)
     BirdbrainHummingbirdInput.light(device, port) if connected_and_valid?(port, VALID_SENSOR_PORTS)
   end
@@ -48,28 +52,4 @@ class BirdbrainHummingbird < BirdbrainMicrobit
   def play_note(note, beats)
     BirdbrainHummingbirdOutput.play_note(device, note, beats) if connected?
   end
-
-  def orientation_screen_up?
-    BirdbrainMicrobitInput.orientation_screen_up?(device) if connected?
-  end
-
-  def orientation_screen_down?
-    BirdbrainMicrobitInput.orientation_screen_down?(device) if connected?
-  end
-
-  def orientation_tilt_left?
-    BirdbrainMicrobitInput.orientation_tilt_left?(device) if connected?
-  end
-
-  def orientation_tilt_right?
-    BirdbrainMicrobitInput.orientation_tilt_right?(device) if connected?
-  end
-
-  def orientation_logo_up?
-    BirdbrainMicrobitInput.orientation_logo_up?(device) if connected?
-  end
-
-  def orientation_logo_down?
-    BirdbrainMicrobitInput.orientation_logo_down?(device) if connected?
-  end
 end

data/lib/birdbrain/birdbrain_hummingbird_input.rb

@@ -26,7 +26,7 @@ class BirdbrainHummingbirdInput < BirdbrainRequest
     sensor(device, port, 0.012941176470588235) # factor=3.3/255
   end
 
-  def self.sensor(device, port, factor)
+  private_class_method def self.sensor(device, port, factor)
     response = response_body('hummingbird', 'in', 'sensor', port, device)
 
     (response.nil? ? nil : bounds((response.to_f * factor).to_i, 0, 100))

data/lib/birdbrain/birdbrain_microbit.rb

@@ -4,6 +4,10 @@
 class BirdbrainMicrobit < BirdbrainDevice
   VALID_BUTTONS = 'AB'
 
+  def valid_device_type?
+    microbit?
+  end
+
   def microbit_accelerometer
     BirdbrainMicrobitInput.microbit_accelerometer(device) if connected?
   end
@@ -28,6 +32,30 @@ class BirdbrainMicrobit < BirdbrainDevice
     BirdbrainMicrobitInput.microbit_orientation(device) if connected?
   end
 
+  def microbit_orientation_screen_up?
+    BirdbrainMicrobitInput.microbit_orientation_screen_up?(device) if connected?
+  end
+
+  def microbit_orientation_screen_down?
+    BirdbrainMicrobitInput.microbit_orientation_screen_down?(device) if connected?
+  end
+
+  def microbit_orientation_tilt_left?
+    BirdbrainMicrobitInput.microbit_orientation_tilt_left?(device) if connected?
+  end
+
+  def microbit_orientation_tilt_right?
+    BirdbrainMicrobitInput.microbit_orientation_tilt_right?(device) if connected?
+  end
+
+  def microbit_orientation_logo_up?
+    BirdbrainMicrobitInput.microbit_orientation_logo_up?(device) if connected?
+  end
+
+  def microbit_orientation_logo_down?
+    BirdbrainMicrobitInput.microbit_orientation_logo_down?(device) if connected?
+  end
+
   def microbit_display(led_list)
     BirdbrainMicrobitOutput.microbit_display(state, device, led_list) if connected?
   end

data/lib/birdbrain/birdbrain_microbit_input.rb

@@ -2,9 +2,9 @@
 # Copyright (c) 2021 Base2 Incorporated--All Rights Reserved.
 #-----------------------------------------------------------------------------------------------------------------------------------
 class BirdbrainMicrobitInput < BirdbrainRequest
-  ORIENTATIONS = ['Screen%20Up', 'Screen%20Down', 'Tilt%20Left', 'Tilt%20Right', 'Logo%20Up', 'Logo%20Down']
-  ORIENTATION_RESULTS = ['Screen up', 'Screen down', 'Tilt left', 'Tilt right', 'Logo up', 'Logo down']
-  ORIENTATION_IN_BETWEEN = 'In between'
+  MICROBIT_ORIENTATIONS = ['Screen%20Up', 'Screen%20Down', 'Tilt%20Left', 'Tilt%20Right', 'Logo%20Up', 'Logo%20Down']
+  MICROBIT_ORIENTATION_RESULTS = ['Screen up', 'Screen down', 'Tilt left', 'Tilt right', 'Logo up', 'Logo down', 'In between']
+  MICROBIT_ORIENTATION_IN_BETWEEN = 'In between'
 
   def self.microbit?(device)
     request_status(response_body('hummingbird', 'in', 'isHummingbird', 'static', device))
@@ -31,40 +31,40 @@ class BirdbrainMicrobitInput < BirdbrainRequest
   end
 
   def self.microbit_orientation(device)
-    ORIENTATIONS.each_with_index do |orientation, index|
+    MICROBIT_ORIENTATIONS.each_with_index do |orientation, index|
       return nil if (response = response_body('hummingbird', 'in', 'orientation', orientation, device)).nil?
 
-      return ORIENTATION_RESULTS[index] if request_status(response)
+      return MICROBIT_ORIENTATION_RESULTS[index] if request_status(response)
     end
 
-    ORIENTATION_IN_BETWEEN
+    MICROBIT_ORIENTATION_IN_BETWEEN
   end
 
-  def self.orientation_screen_up?(device)
+  def self.microbit_orientation_screen_up?(device)
     orientation_check(device, 0)
   end
 
-  def self.orientation_screen_down?(device)
+  def self.microbit_orientation_screen_down?(device)
     orientation_check(device, 1)
   end
 
-  def self.orientation_tilt_left?(device)
+  def self.microbit_orientation_tilt_left?(device)
     orientation_check(device, 2)
   end
 
-  def self.orientation_tilt_right?(device)
+  def self.microbit_orientation_tilt_right?(device)
     orientation_check(device, 3)
   end
 
-  def self.orientation_logo_up?(device)
+  def self.microbit_orientation_logo_up?(device)
     orientation_check(device, 4)
   end
 
-  def self.orientation_logo_down?(device)
+  def self.microbit_orientation_logo_down?(device)
     orientation_check(device, 5)
   end
 
-  def self.orientation_check(device, index)
-    request_status(response_body('hummingbird', 'in', 'orientation', ORIENTATIONS[index], device))
+  private_class_method def self.orientation_check(device, index)
+    request_status(response_body('hummingbird', 'in', 'orientation', MICROBIT_ORIENTATIONS[index], device))
   end
 end

data/lib/birdbrain/version.rb

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

metadata

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