beaglebone-rails 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 63c4e8a445a9cd50935043e9d14bc4fd0a516c48
-  data.tar.gz: a9d38a2e6a7ac0e0556de016e93d687cdd361a3a
+  metadata.gz: 72b4c75160c895afafbf13b720ff5e01257d25d5
+  data.tar.gz: ad4ab95c6b5e9ef53124bae49136deff8c54e351
 SHA512:
-  metadata.gz: b2f748f0cb0b64902d8e2841c6e6bf2bb75089cc15fa8ecd2ba7bae1f164e2d8332295769754398d150531bce0658899bfa7ebe70184ca09f7ba72deb194a3af
-  data.tar.gz: d5eb524abb647379501a996def5a45d1c1f914f830703fb2a59417bba5f4487f6f36b2021a9aacd4f833338e284851dbf6c31335ac4e68c88357ccece3741cc4
+  metadata.gz: a53ae00c501aeef5a6d87c8a4adc8a3038fd04c30e20ea126ec5ed68e0479aeae91cf14ef74cbfb6053db956a7740ff4aadd21ecd36c6304b259249e72d8d821
+  data.tar.gz: ffa18ce5c22cee86c6eaf9d14e310f6dce12ecfa09a6dd9929e0fdd2da6c8dca126ce782afc2e6e62e199113c3e58622165a29e4306884b24eee8a7f94690094

data/.travis.yml

@@ -1,4 +1,7 @@
+sudo: required
 language: ruby
 rvm:
   - 2.2.2
-before_install: gem install bundler -v 1.10.5
+before_install:
+  - gem install bundler -v 1.10.5
+  - sudo ./install.sh

data/99-beaglebone-rails.rules

@@ -0,0 +1 @@
+SUBSYSTEM=="subsystem", KERNEL=="gpio", ACTION=="add", PROGRAM="/bin/sh -c 'chmod -R 0777 /sys%p'"

data/Gemfile

@@ -5,6 +5,4 @@ gemspec
 
 group :test do
   gem 'rake'
-  gem 'rspec', '~> 3.4'
-  gem 'coveralls', '~> 0.8.10'
 end

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 TODO: Write your name
+Copyright (c) 2016 Nicholaus Brabant
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,6 +1,6 @@
-[![Gem](https://img.shields.io/gem/v/beaglebone-rails.svg)](https://rubygems.org/gems/beaglebone-rails)
-[![Travis](https://img.shields.io/travis/DivXZero/beaglebone-rails.svg)](https://travis-ci.org/DivXZero/beaglebone-rails)
-[![Coveralls](https://img.shields.io/coveralls/DivXZero/beaglebone-rails.svg)](https://coveralls.io/github/DivXZero/beaglebone-rails)
+[![Gem Version](https://badge.fury.io/rb/beaglebone-rails.svg)](https://badge.fury.io/rb/beaglebone-rails)
+[![Build Status](https://travis-ci.org/DivXZero/beaglebone-rails.svg?branch=master)](https://travis-ci.org/DivXZero/beaglebone-rails)
+[![Coverage Status](https://coveralls.io/repos/github/DivXZero/beaglebone-rails/badge.svg?branch=master)](https://coveralls.io/github/DivXZero/beaglebone-rails?branch=master)
 [![Inline docs](http://inch-ci.org/github/DivXZero/beaglebone-rails.svg?branch=master&style=shields)](http://inch-ci.org/github/DivXZero/beaglebone-rails)
 [//]: [![Gemnasium](https://img.shields.io/gemnasium/DivXZero/beaglebone-rails.svg)](https://gemnasium.com/DivXZero/beaglebone-rails)
 
@@ -24,6 +24,10 @@ Or install it yourself as:
 
     $ gem install beaglebone-rails
 
+Run the install script to create the rules that allow the gem to access the subsystem (Warning: This is currently insecure):
+
+    $ sudo ./install.sh
+
 ## Usage
 
 TODO: Write usage instructions here

data/beaglebone-rails.gemspec

@@ -18,5 +18,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '>= 1.9'
+
   spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "coveralls", "~> 0.8.10"
 end

data/install.sh

@@ -0,0 +1,6 @@
+#!/bin/sh
+chown root:root 99-beaglebone-rails.rules
+chmod 0644 99-beaglebone-rails.rules
+cp 99-beaglebone-rails.rules /etc/udev/rules.d/
+udevadm control --reload-rules
+udevadm test --action=add /class/gpio

data/lib/beaglebone-rails.rb

@@ -3,6 +3,8 @@ require 'beaglebone/GPIO/GPIO'
 require 'beaglebone/GPIO/pins'
 require 'beaglebone/version'
 
+# Top Level Module
+#
 module Beaglebone
 
   # Just a friendly greeting :)

data/lib/beaglebone/GPIO/GPIO.rb

@@ -1,14 +1,18 @@
 
 module Beaglebone
+  # General Purpose I/O
+  #
   module GPIO
 
     # Returns an array of active GPIO pins
     #
-    # @param [Bool] optional List all active pins including export and unexport utilites
+    # @param list_all [Bool] optional List all active pins including export and unexport utilites
     #
     # @example Return all active GPIO pins
     #   Beaglebone::GPIO.list #=> ["gpiochip32", "gpiochip64", "gpiochip96", "gpiochip0"]
     #
+    # @return [Array] String array of active gpio pins
+    #
     def self.list(list_all = false)
       gpio_array = Dir.entries('/sys/class/gpio')
       gpio_array.delete('.')
@@ -22,5 +26,73 @@ module Beaglebone
       gpio_array
     end
 
+    # Enables a pin for GPIO
+    #
+    # @param pin [Object] Specifies a value from GPIO::PINS to enable
+    #
+    # @example
+    #   Beaglebone::GPIO.enable_pin(:P9_12)
+    #
+    # @return [Boolean] Returns true for success, false otherwise
+    #
+    def self.enable_pin(pin)
+      pin = PINS[pin]
+      export = File.open('/sys/class/gpio/export', 'w')
+      return false if pin.nil? or export.nil?
+      export.puts(pin)
+      return true
+    end
+
+    # Disables a GPIO pin
+    #
+    # @param pin [Object] Specifies a value from GPIO::PINS
+    #
+    # @example
+    #   Beaglebone::GPIO.disable_pin(:P9_12)
+    #
+    # @return [Boolean] Returns true for success, false otherwise
+    #
+    def self.disable_pin(pin)
+      pin = PINS[pin]
+      unexport = File.open('/sys/class/gpio/unexport', 'w')
+      return false if pin.nil? or unexport.nil?
+      unexport.puts(pin)
+      return true
+    end
+
+    # Set pin direction
+    #
+    # @param pin [Object] Specifies a value from GPIO::PINS
+    # @param direction [Object] Specifies a value from GPIO::DIRECTION
+    #
+    # @example
+    #   Beaglebone::GPIO.set_direction(:P9_12, :OUT)
+    #
+    # @return [Boolean] Returns true for success, false otherwise
+    #
+    def self.set_direction(pin, direction)
+      dir_file = File.open("/sys/class/gpio/gpio#{PINS[pin]}/direction", 'w')
+      return false if dir_file.nil?
+      dir_file.puts(DIRECTION[direction])
+      return true
+    end
+
+    # Set pin value
+    #
+    # @param pin [Object] Specifies a value from GPIO::PINS
+    # @param value [Object] Specifies a value from GPIO::VALUE
+    #
+    # @example
+    #   Beaglebone::GPIO.set_value(:P9_12, :HIGH)
+    #
+    # @return [Boolean] Returns true for success, false otherwise
+    #
+    def self.set_value(pin, value)
+      mode = File.open("/sys/class/gpio/gpio#{PINS[pin]/value}", 'w')
+      return false if mode.nil?
+      mode.puts(VALUE[value])
+      return true
+    end
+
   end
 end

data/lib/beaglebone/GPIO/pins.rb

@@ -1,6 +1,8 @@
 
 module Beaglebone
   module GPIO
+    DIRECTION = { :IN => 'in', :OUT => 'out', :LOW => 'in', :HIGH => 'out' }
+    VALUE = { :LOW => 0, :HIGH => 1, 0 => 0, 1 => 1 }
     PINS = {
       :P9_11 => 30, :P9_12 => 60,
       :P9_13 => 31, :P9_14 => 50,

data/lib/beaglebone/version.rb

@@ -3,6 +3,6 @@ module Beaglebone
 
   # Current Gem Version
   #
-  VERSION = "0.0.5"
+  VERSION = "0.1.0"
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beaglebone-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Nicholaus Brabant
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-26 00:00:00.000000000 Z
+date: 2016-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.10
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.10
 description: 
 email:
 - nicholaus.brabant@gmail.com
@@ -34,6 +62,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- 99-beaglebone-rails.rules
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -42,6 +71,7 @@ files:
 - beaglebone-rails.gemspec
 - bin/console
 - bin/setup
+- install.sh
 - lib/beaglebone-rails.rb
 - lib/beaglebone/GPIO/GPIO.rb
 - lib/beaglebone/GPIO/pins.rb
@@ -58,7 +88,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="