BBB 0.2.0 → 0.3.0

data/lib/BBB.rb

@@ -2,12 +2,26 @@ require "json"
 require "stringio"
 
 require "BBB/version"
+require "BBB/configuration"
 
-require "BBB/circuit"
-require "BBB/exceptions"
 require "BBB/pins"
 require "BBB/components"
+require "BBB/attachable"
+require "BBB/circuit"
+require "BBB/exceptions"
 require "BBB/application"
 
 module BBB
+
+  def self.configuration
+    Configuration.instance
+  end
+
+  def self.escape_test(&block)
+    old_mode = configuration.test_mode
+    configuration.test_mode = false
+    yield
+    configuration.test_mode = old_mode
+  end
+
 end

data/lib/BBB/application.rb

@@ -1,17 +1,23 @@
 module BBB
   class Application
     include Attachable
+    include Components
 
+    ##
+    # Start the application by activating the components and
+    # load the run loop.
+    #
     def start
-      activate_components
       loop do
         run
       end
     end
 
-    def activate_components
-    end
-
+    ##
+    # The run funciton gets called as part of the run loop on every iteration.
+    # This is where you put your main application code that needs to be
+    # evaluaded.
+    #
     def run
       raise NotImplementedError
     end

data/lib/BBB/attachable.rb

@@ -0,0 +1,77 @@
+module BBB
+  module Attachable
+    module ClassMethods
+
+      def class_components
+        @class_components ||= {}
+      end
+
+      def class_component_groups
+        @class_component_groups ||= Hash.new { |hash, key| hash[key] = [] }
+      end
+
+      ##
+      # Attach a component of a certain type to the circuit
+      #
+      # @param component [Class] The class of the object you # want to attach.
+      # @param opts [Hash] Hash of options that setup the component
+      #
+      # @option opts [Symbol] :pin The pin position for the component
+      # @option opts [Array<Symbol>] :pins The list of pin numbers used on the
+      #     circuit.
+      # @options opts [Symbol] :as The name of the component
+      #
+      def attach(object, opts={})
+        name   = opts.delete(:as)
+        group  = opts.delete(:group)
+
+        class_components[name] = object
+        define_method_for_object(object, name, opts)
+
+        define_method_for_group(group)
+        add_to_group(name, group) if group
+      end
+
+      def define_method_for_object(component, name, opts)
+        define_method(name) do
+          value = components[name]
+          return value if value
+
+          object = self.class.class_components[name]
+          value = object.kind_of?(Class) ? object.new(opts) : object
+          components[name] = value
+        end
+      end
+
+      def define_method_for_group(group_name)
+        return if group_name.nil? || respond_to?(group_name)
+        define_method(group_name) do
+          if component_groups[group_name].empty?
+            component_groups[group_name] = self.class.class_component_groups[group_name]
+          end
+
+          component_groups[group_name].map do |component_name|
+            self.send(component_name)
+          end
+        end
+      end
+
+      def add_to_group(component_name, group_name)
+        class_component_groups[group_name] << component_name
+      end
+
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    def components
+      @components ||= {}
+    end
+
+    def component_groups
+      @component_groups ||= Hash.new { |hash, key| hash[key] = [] }
+    end
+  end
+end

data/lib/BBB/circuit.rb

@@ -1,51 +1,4 @@
 module BBB
-  module Attachable
-    module ClassMethods
-
-      def class_components
-        @class_components ||= {}
-      end
-
-      ##
-      # Attach a component of a certain type to the circuit
-      #
-      # @param component [Class] The class of the object you # want to attach.
-      # @param opts [Hash] Hash of options that setup the component
-      #
-      # @option opts [Symbol] :pin The pin position for the component
-      # @option opts [Array<Symbol>] :pins The list of pin numbers used on the
-      #     circuit.
-      # @options opts [Symbol] :as The name of the component
-      #
-      def attach(object, opts={})
-        name   = opts.delete(:as)
-        class_components[name] = object
-        define_method_for_object(object, name)
-      end
-
-      def define_method_for_object(component, name)
-        define_method(name) do
-          value = components[name]
-          return value if value
-
-          object = self.class.class_components[name]
-          value = object.kind_of?(Class) ? object.new : object
-
-          components[name] = value
-        end
-      end
-    end
-
-    def self.included(base)
-      base.extend(ClassMethods)
-    end
-
-    def components
-      @components ||= {}
-    end
-
-  end
-
   ##
   # The idea here is to attach a piece of equipment to a circuit.
   #
@@ -59,6 +12,13 @@ module BBB
   # boards. For example by mapping P8_3 on BBB to P1 on an Arduino.
   #
   class Circuit
+    attr_reader :options
+
     include Attachable
+    include Components
+
+    def initialize(options={})
+      @options = options
+    end
   end
 end

data/lib/BBB/components/button.rb

@@ -1,10 +1,55 @@
 module BBB
   module Components
     class Button
+      attr_reader :status
+      attr_accessor :release_callbacks, :press_callbacks
+
       include Pinnable
 
       uses BBB::Pins::DigitalInputPin
 
+      def initialize(options={})
+        @status = :released
+        @release_callbacks = []
+        @press_callbacks = []
+      end
+
+      def pressed?
+        status == :pressed
+      end
+
+      def released?
+        !pressed
+      end
+
+      def press!
+        old_state = status
+        @status = :pressed
+        on_press if old_state != status
+      end
+
+      def release!
+        old_state = status
+        @status = :released
+        on_release if old_state != status
+      end
+
+      def update(value=pin.high?)
+        value == true ? press! : release!
+      end
+
+      def on_release(&block)
+        @release_callbacks.each{ |c| c.call(status) }
+      end
+
+      def on_press(&block)
+        if block_given?
+          @press_callbacks << block
+        else
+          @press_callbacks.each{ |c| c.call(status) }
+        end
+      end
+
       def high?
         pin.on?
       end
@@ -14,11 +59,6 @@ module BBB
         !high
       end
       alias_method :off?, :low?
-
-      def status
-        pin.status
-      end
-      alias_method :state, :status
     end
   end
 end

data/lib/BBB/components/esc.rb

@@ -17,7 +17,7 @@ module BBB
       #   period of the pin. Use the "after pin initialization" method for that.
       #
       def initialize(options={})
-        set_options
+        set_options(options)
 
         @period = options.fetch(:period, 20e6)
         @speed  = 0

data/lib/BBB/components/led.rb

@@ -49,6 +49,25 @@ module BBB
         pin.off?
       end
 
+
+      ##
+      # Returns the status of the current led
+      #
+      def status
+        on? ? :on : :off
+      end
+
+      ##
+      # Toggle the led between on and off
+      #
+      def toggle!
+        if on?
+          off!
+        elsif off?
+          on!
+        end
+      end
+
     end
   end
 end

data/lib/BBB/components/nunchuck.rb

@@ -130,49 +130,6 @@ module BBB
           @axis[:y].update(bytes[1])
         end
 
-        class Button
-          attr_reader :status
-          attr_accessor :release_callbacks, :press_callbacks
-
-          def initialize
-            @status = :released
-            @release_callbacks = []
-            @press_callbacks = []
-          end
-
-          def pressed?
-            status == :pressed
-          end
-
-          def press!
-            @status = :pressed
-            on_press if old_state != status
-          end
-
-          def release!
-            old_state = status
-            @status = :released
-            on_release if old_state != status
-          end
-
-          def released?
-            !pressed
-          end
-
-          def update(value)
-            value == true ? release! : press!
-          end
-
-          def on_release
-            @release_callbacks.each{ |c| c.call(status) }
-          end
-
-          def on_press
-            @press_callbacks.each{ |c| c.call(status) }
-          end
-
-        end
-
         class ControlAxis
           attr_accessor :value
           attr_accessor :change_callbacks

data/lib/BBB/components/pinnable.rb

@@ -147,7 +147,10 @@ module BBB
       # @param options [Hash]
       #
       def set_options(options)
-        @positions = [options.fetch(:pin, nil)].compact
+        @positions = [options[:pin],
+                      options[:pins],
+                      options[:position],
+                      options[:path]].flatten.compact
       end
     end
   end

data/lib/BBB/components/wii_motion_plus.rb

@@ -27,11 +27,15 @@ module BBB
 
       attr_reader :gyro, :positions
 
+      ##
+      # the WMP uses I2C pins, so you can give it a name like "I2C2_SDA"
+      #
       def initialize(options = {})
         @started = false
         @calibrated = false
         @gyro = Gyro.new
         @positions = [options.fetch(:i2c, nil)].compact
+        @extension = options[:extension]
       end
 
       def start

data/lib/BBB/configuration.rb

@@ -0,0 +1,14 @@
+require 'singleton'
+
+module BBB
+  class Configuration
+    include Singleton
+
+    attr_accessor :test_mode
+
+    def initialize
+      @test_mode = false
+    end
+  end
+end
+

data/lib/BBB/pins/pinnable.rb

@@ -37,7 +37,7 @@ module BBB
       # @return [Boolean]
       #
       def mock?
-        @mock ||= @opts.fetch(:mock, false)
+        @mock ||= @opts.fetch(:mock, BBB.configuration.test_mode)
       end
 
       ##

data/lib/BBB/version.rb

@@ -1,3 +1,3 @@
 module BBB
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/spec/application_spec.rb

@@ -6,23 +6,45 @@ describe BBB::Application do
     lambda { BBB::Application.new }.should_not raise_exception
   end
 
+  it "it responds to start" do
+    BBB::Application.new.respond_to?(:start).should be_true
+  end
+
+  it "start calls run" do
+    app = BBB::Application.new
+    app.should_receive(:run).and_raise(StopIteration)
+    app.start
+  end
+
+  it "run raises NotImplementedError" do
+    app = BBB::Application.new
+    lambda { app.run }.should raise_error(NotImplementedError)
+  end
+
   class TestLedCircuit < BBB::Circuit
-    attach BBB::Components::Led, as: :led
+    attach Led, as: :led
   end
 
-  class TestConnectionApp < BBB::Application
+  class TestCircuitConnectionApp < BBB::Application
     attach TestLedCircuit, as: :circuit
   end
 
   it "attaches virtual pins to board pins" do
-    app = TestConnectionApp.new
+    app = TestCircuitConnectionApp.new
     app.circuit.respond_to?(:led).should be_true
     app.circuit.led.respond_to?(:on!).should be_true
   end
 
-  class FunctionsInApp < BBB::Application
-    attach TestLedCircuit.new, as: :circuit
+  class TestBasicApp < BBB::Application
+    attach Led, as: :led
+  end
 
+  it "adds helper functions to applications" do
+    app = TestBasicApp.new
+    app.respond_to?(:led).should be_true
+  end
+
+  class FunctionsInApp < BBB::Application
     def run
       raise StopIteration
     end