BBB 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 63c2eceea0c267f57e2c21cec0d6d82cafc9fd01
-  data.tar.gz: bf11fed2f5ee2654fa14442b74ce90d390e2c8e5
+  metadata.gz: 4573344a902cd2566d5521229f4d7529cb31f633
+  data.tar.gz: b75dc03459a79e65ee931f8c37482524bfa98576
 SHA512:
-  metadata.gz: c07b23cdf6cec474c6d6633b0943dc1854a321fc6904eba49057c8732e19c739327619aef8d0e88a1e0f1b82f537901d246704c4b874b548e8cb48265d073647
-  data.tar.gz: 2f9df659b737fd99151f9df9859fab689d63a483e690b200229d4e257f02c802317bf52266500f4ce571c9895cdbbe30c072912c75bc6e4f45f01d237ac9b1c3
+  metadata.gz: 67101648320187e3e261d19511db14d80a8b8a6ca21c811f8b2f1316fcfad48296cb245646e36d58933540cb09e2f663f2ae66df828a193e13860e017967e667
+  data.tar.gz: 8ffc3dc8effcbf3a7209e7e7f753e0effbdb2787353053f352410aa2bad5fe1c6275c4c21d5c5bf6232340f73503d24bcd9581ac278db79dc12a039d01c3d001

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby-19mode
+  - rbx-19mode
+  - ruby-head
+  - jruby-head

data/Gemfile

@@ -2,3 +2,8 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in BBB.gemspec
 gemspec
+gem 'coveralls', require: false
+
+group :test do
+  gem 'pry'
+end

data/README.md

@@ -1,7 +1,13 @@
+
 # BBB - BeagleBone Black
 
 Helper functions and modules to ruby around on the beagle bone black.
 
+## Badges
+
+[![Coverage Status](https://coveralls.io/repos/Sparkboxx/bbb/badge.png)](https://coveralls.io/r/Sparkboxx/bbb)
+[![Build Status](https://travis-ci.org/Sparkboxx/bbb.png?branch=master)](https://travis-ci.org/Sparkboxx/bbb)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -27,3 +33,28 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## License
+
+Copyright (c) 2013 Wilco van Duinkerken
+
+MIT License
+
+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/Rakefile

@@ -1 +1,5 @@
 require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+task :default => :spec
+RSpec::Core::RakeTask.new

data/examples/led.rb

@@ -0,0 +1,34 @@
+require 'BBB'
+
+##
+# Setup the LED Circuit
+#
+class Circuit < BBB::Circuit
+  def initialize
+    # Attach the led to pin P8_10
+    attach BBB::Components::Led, pin: :P8_10, as: :led
+  end
+end
+
+##
+# Setup the actual Application
+#
+class LedExampleApplication < BBB::Application
+  # Run this on the BeableBoneBlack
+  board BBB::Board.new
+
+  # Connection the led circuit
+  circuit LedExample::Circuit.new
+
+  # This is the basic run loop
+  def run
+    led.on!  # this does what you think it does
+    sleep(1) # sleep for 1 second, kind of blunt, since it blocks everthing.
+    led.off!
+    sleep(1)
+  end
+end
+
+# Initialize and run the LedExampleApplication
+app = LedExampleApplication.new
+app.start

data/examples/sketches.rb

@@ -0,0 +1,86 @@
+require 'bbb'
+
+module Thunderball
+  class Copter << BBB::Application
+    ##
+    # Use the BBB as the board, allows for possible ports to e.g. the Pi
+    #
+    board  BBB::Board.new
+
+    ##
+    # Load the thunderball layout
+    #
+    layout Thunderball::Circuit.new
+
+    attr_reader :stabalizer, :mover
+
+    def initialize
+      @stabalizer = Stabalizer.new(escs: escs,
+                                   gyro: gyro,
+                                   accelerometer: acc)
+
+      @mover = Mover.new(escs: escs)
+    end
+
+    ##
+    # Once start is called the run function will be called in a loop
+    #
+    def run
+      stabalizer
+      move(:forward=>20, :right=>10)
+    end
+
+    ##
+    # Stabalize function is just syntactic sugar to make the run method look nice.
+    #
+    def stabilize
+      stabalizer.update
+    end
+
+    ##
+    # move function is just syntactic sugar to make the run method look nice.
+    #
+    def move
+      mover.update
+    end
+  end # Copter
+
+  class Circuit < BBB::Circuit
+    def initialize
+      attach_escs
+      attach_led
+    end
+
+    def attach_escs
+      attach ESC, :pins=>[:P8_1, :P8_2], :as=>:esc_1, :group=>:escs
+      attach ESC, :pins=>[:P9_1, :P9_2], :as=>:esc_2, :group=>:escs
+    end
+
+    def attach_leds
+      attach Led, :pin=>:P9_12
+    end
+  end # Circuit
+
+  class Mover
+    def initialize(opts={})
+      @escs = opts[:escs]
+    end
+
+    def move
+      # Do some complex logic here with the escs
+    end
+  end # Mover
+
+  def Stabalizer
+    def initialize(opts={})
+      @escs = opts[:escs]
+      @gyo = opts[:gyro]
+      @accelerometer = opts[:accelerometer]
+    end
+
+    def stabalize
+      # Do someting complex with all the components
+      # and update all values
+    end
+  end #Stabalizer
+end

data/lib/BBB.rb

@@ -1,5 +1,22 @@
 require "BBB/version"
+require "BBB/board"
+require "BBB/test_board"
+require "BBB/circuit"
+require "BBB/pin_mapper"
+require "BBB/exceptions"
+
+require "BBB/gpio/base"
+require "BBB/gpio/digital_pin"
+require "BBB/gpio/pin_converter"
+
+require "BBB/io/pinnable"
+require "BBB/io/digital_pin"
+require "BBB/io/mock_pin"
+
+require "BBB/components/pinnable"
+require "BBB/components/led"
+
+require "BBB/application"
 
 module BBB
-  # Your code goes here...
 end

data/lib/BBB/application.rb

@@ -0,0 +1,44 @@
+module BBB
+  class Application
+
+    def self.board(board)
+      @_board = board
+      connect unless @_circuit.nil?
+    end
+
+    def self.circuit(circuit)
+      @_circuit = circuit
+      connect unless @_board.nil?
+    end
+
+    def self._board
+      @_board
+    end
+
+    def self._circuit
+      @_circuit
+    end
+
+    def self.connect
+      @_circuit.components.each_pair do |name, component|
+        component.pins.each do |pin|
+          @_board.connect_io_pin(pin)
+        end
+
+        define_method(name) do
+          circuit.send(name)
+        end
+      end
+    end
+
+    def board
+      @board ||= self.class._board
+    end
+
+    def circuit
+      @circuit ||= self.class._circuit
+    end
+
+
+  end
+end

data/lib/BBB/board.rb

@@ -0,0 +1,41 @@
+module BBB
+  class Board
+    attr_reader :gpio, :pin_converter
+
+    def initialize(pin_converter=nil)
+      @pin_converter = pin_converter || self.class.pin_converter
+      @pins = {}
+    end
+
+    ##
+    # Define methods for a GPIO::PIN
+    #
+    def setup_pin(pin)
+      @pins[pin.position] = pin
+
+      metaclass = class << self; self; end
+      metaclass.class_eval do
+        define_method("p#{pin.position.to_s[1..-1]}") do
+          @pins[pin.position].read
+        end
+
+        define_method("p#{pin.position.to_s[1..-1]}=") do |value|
+          @pins[pin.position].write value
+        end if pin.mode == :output
+      end
+    end
+
+    def connect_io_pin(pin)
+      gpio_pin   = pin_converter.convert(pin)
+      pin.pin_io = gpio_pin
+      setup_pin(pin)
+    end
+
+    private
+
+    def self.pin_converter
+      GPIO::PinConverter.new
+    end
+
+  end
+end

data/lib/BBB/circuit.rb

@@ -0,0 +1,72 @@
+module BBB
+  ##
+  # The idea here is to attach a piece of equipment to a circuit. The circuit
+  # will later be connected to a board.
+  #
+  # A component (e.g. Led or Servo) will define generic pins, like
+  # DigitalInput or AnalogOutput. And then, when the circuit gets attached to
+  # the board those pins will be "connected" to their "physical" counterparts
+  # on the board.
+  #
+  # This allows you to develop generic circuits that can be attached to any
+  # board. At least, in theory :-)
+  #
+  # For now the attachment will be made onto specific pin numbers. For the BBB
+  # this might for example be :P8_3, however, the plan is to, in a future
+  # release, make sure that there are converters between the different kind of
+  # boards. For example by mapping P8_3 on BBB to P1 on an Arduino.
+  #
+  # As of now, the act of "attaching" something onto the circuit equals
+  # setting up a component with generic pins.
+  #
+  class Circuit
+    attr_reader :components
+
+    def components
+      @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 [Array<Symbol>] :pins The list of pin numbers used on the
+    # circuit.
+    #
+    def attach(component, opts={})
+      if component.kind_of?(Class)
+        component = component.new
+      end
+
+      if pin_positions = opts[:pins] || [opts[:pin]]
+        component_pins = component.pins
+        verify_pin_argument_count(component_pins.count, pin_positions.count)
+        component.register_pin_positions(pin_positions)
+      end
+
+      name = opts.fetch(:as)
+      register_component(component, name)
+    end
+
+    def register_component(component, name)
+      components[name] = component
+      eigenclass = class << self; self; end
+      eigenclass.class_eval do
+        define_method(name) do
+          components[name]
+        end
+      end
+    end
+
+    def verify_pin_argument_count(type_count, position_count)
+      if type_count != position_count
+        raise PinsDoNotMatchException,
+          "#{object.to_s} requires #{types_count} but received #{position_count} pin arguments."
+      end
+    end
+
+
+  end
+end

data/lib/BBB/components/led.rb

@@ -0,0 +1,33 @@
+module BBB
+  module Components
+    class Led
+      include Pinnable
+      attr_reader :state, :pin
+
+      def initialize
+        @state = :low
+        @pin = BBB::IO::DigitalPin.new(:output)
+        @pins = [@pin]
+      end
+
+      def on!
+        pin.on!
+        @state = :high
+      end
+
+      def off!
+        pin.off!
+        @state = :low
+      end
+
+      def on?
+        state == :high
+      end
+
+      def off?
+        state == :low
+      end
+
+    end
+  end
+end

data/lib/BBB/components/pinnable.rb

@@ -0,0 +1,15 @@
+module BBB
+  module Components
+    module Pinnable
+      attr_reader :pins
+
+      def register_pin_positions(*positions)
+        positions.flatten!
+        pins.each_with_index do |pin, index|
+          pin.position=positions[index]
+        end
+      end
+
+    end
+  end
+end

data/lib/BBB/exceptions.rb

@@ -0,0 +1,5 @@
+module BBB
+  class UnknownPinException < ArgumentError; end
+  class UnknownPinModeException < ArgumentError; end
+  class PinsDoNotMatchException < ArgumentError; end
+end