pcduino 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OWU1YWQ4MGRkYWNkODk2MWM0ZmM2YzA5ZjBiOTUwNTFlZTJjNWY2Mw==
+  data.tar.gz: !binary |-
+    OTllMjU5NGRmYTc0M2Q4OTkzY2VjZjQ4Yjk3M2U1YmM4YjgxNmMzYQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NzU3YmJmOGE2NjE3ZmZiYWU0ODg1YzA2MDEzNTI1ZGE3YjAxZGRlNDdkZjUy
+    YTMxM2ZiOWVjMmI4MDgxMDA3NjU4YjNjYzZlMWFmNzc5YzEzM2MzNTY1OTE0
+    YjY2NjI5MzY4NWI0OWNlMWUxZmRiZTQ0MGUzODI4YmYyYzVhNDc=
+  data.tar.gz: !binary |-
+    ZGMyMGJmYmVjMzhlM2U4NmNmMjhkODlkOTQ4NTU1M2ZkYzlmMDdkNjFiM2I3
+    N2I3MGQ5ZjE3Njk1OGQ2YmJjOGJiYWU0MmI5YzIzOGVhYzA2ZjRjYzUyNDNl
+    MWZiYzNjNjE4NWNhNDU0NDQ3OGExM2Y0YzE2MDMwMzg1MTRkNmY=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in pcduino.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 willoftw
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 TODO: Write your name
+
+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/README.md

@@ -0,0 +1,36 @@
+<<<<<<< HEAD
+# Pcduino
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'pcduino'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pcduino
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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
+=======
+pcduino
+=======
+
+Ruby Gem to talk to pcduino's GPIO pins
+>>>>>>> ee30f6e89a8310aae21264e176b2b6fa005164c6

data/Rakefile

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

data/examples/io_example/blink.rb

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'pcduino'
+
+blink_pin = Pin.new 13
+
+while true
+  blink_pin.toggle
+  sleep 1
+end

data/examples/sinatra_example/app.rb

@@ -0,0 +1,54 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'sinatra'
+require 'haml'
+
+require 'pcduino'
+
+get '/' do
+  haml :index
+end
+
+get '/control' do
+  haml :control
+end
+
+post '/control' do
+  @host = params[:host]
+  @my_pin = Pin.new 13
+  @results = @my_pin.write(@host.to_i)
+  
+
+  haml :control
+end
+
+
+__END__
+@@ layout
+%html
+  %head
+    %title Network Tools
+  %body
+    #header
+      %h1 Network Tools
+    #content
+      =yield
+  %footer
+    %a(href='/') Back to index
+
+@@ index
+%p
+  Welcome to Wills mini home automation server!
+%ul
+  %li
+    %h3
+      %a(href='/control') Control Stuff!
+
+@@ control
+%h3 Controll Stuff yo!
+%form(action='/control' method='POST')
+  %input(type='text' name='host' value=@output)
+  %input(type='submit')
+- if defined?(@results)
+  %pre= @results
+

data/lib/pcduino/pin.rb

@@ -0,0 +1,107 @@
+
+class Pin
+
+  attr_accessor :mode_URI,:status_URI,:pin,:input_value,:input_pu_value,:output_value,:mode
+  def initialize(pin_num)
+    @mode_URI = "/sys/devices/virtual/misc/gpio/mode/"
+    @status_URI = "/sys/devices/virtual/misc/gpio/pin/"
+    @pin = pin_num
+    @mode_URI = @mode_URI << "gpio" << @pin.to_s
+    @status_URI = @status_URI << "gpio" << @pin.to_s
+    @input_value = 0
+    @input_value_pu = 8
+    @output_value = 1
+    @state = 0;
+
+    if @pin < 0 or @pin > 17
+      raise "inaccessable pin specified"
+    end
+  end
+
+  def check_connection(path)
+    if File.exist?(path) 
+      true
+    else
+      raise "Error file:" + path +  " doesnt exist"
+    end
+  end
+
+  def set_as_output
+    if write_to_file(@output_value,@mode_URI)
+      @mode=@output_value
+      self
+    else
+      raise "Error: couldnt write output_value to file"
+    end
+  end
+
+  def set_as_input(file = @mode_URI)
+    if write_to_file(@input_value,file)
+      @mode=@input_value
+      self
+    else
+      raise "Error: couldnt write input_value to file"
+    end
+  end
+
+  def set_as_input_pu
+    if write_to_file(@input_value_pu,@mode_URI)
+      @mode=@input_pu_value
+      self
+    else
+      raise "Error: couldnt write input_value to file"
+    end
+  end
+
+  def write(value)
+    if value.is_a? Integer and value == 0 or value == 1
+      if @mode==@input_pu_value
+        set_as_output
+      end
+      write_to_file(value.to_s,@status_URI)
+    else
+      raise "invalid value passed"
+    end
+  end
+
+  def write_to_file (value,path)
+    begin
+      file = File.open(path, "w")
+      file.write(value) 
+    rescue IOError => e
+      raise "error writing to file"
+    ensure
+      file.close unless file == nil
+    end
+    true
+  end
+
+  def read_from_file(file)
+    begin
+      file = File.open(file)
+      line = file.gets
+    rescue IOError => e
+      raise "error reading from file: " + file
+    ensure
+      file.close unless file == nil
+    end
+    line.to_i
+
+  end
+
+  def read
+      set_as_input
+      read_from_file(@status_URI)
+  end 
+
+  def toggle
+    if @state == 0
+      @state = 1
+    else
+      @state = 0
+    end
+    write @state
+    
+  end
+end
+

data/lib/pcduino/version.rb

@@ -0,0 +1,3 @@
+module Pcduino
+  VERSION = "0.0.1"
+end

data/lib/pcduino.rb

@@ -0,0 +1,14 @@
+require "pcduino/version"
+require "pcduino/pin"
+
+module Pcduino
+  def self.hi
+    p "hello world"
+  end
+require "pcduino/pin"
+end
+
+module Logic
+ HIGH = 1
+ LOW = 0
+end

data/pcduino.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+$:.push File.expand_path("../lib", __FILE__)
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pcduino/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pcduino"
+  spec.version       = Pcduino::VERSION
+  spec.authors       = "Will Olner"
+  spec.email         = "William.olner@gmail.com"
+  spec.description   = "Control GPIO of Pcduino"
+  spec.summary       = "Control GPIO of Pcduino using Ruby"
+  spec.homepage      = "http://github.com/willoftw/pcduino"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/pin_spec.rb

@@ -0,0 +1,156 @@
+require "spec_helper"
+
+describe Pin do
+  @os = RUBY_PLATFORM
+  before :all do
+    @pin = Pin.new 1
+    $on_pcduino = false
+  end
+
+  if @os.include?("darwin")
+    $on_pcduino = false
+  else
+    $on_pcduino = true
+  end
+  describe "#new" do
+
+    it "should return a pin object" do
+      @pin.should be_an_instance_of Pin
+    end
+    
+    it "should raise an error for an incorrect pin number" do
+      lambda { Pin.new(99) }.should raise_error
+    end
+
+    it "should not raise an error for an incorrect pin" do
+	lambda { Pin.new(9) }.should_not raise_error
+    end
+
+    it "should have the correct mode URI" do
+      @pin.mode_URI.should == "/sys/devices/virtual/misc/gpio/mode/gpio1" 
+    end
+
+    it "should have the correct status URI" do
+      @pin.status_URI.should == "/sys/devices/virtual/misc/gpio/pin/gpio1"
+    end
+ 
+  end
+  describe "#write_to_file" do
+    it "should return true for a succesful file write" do
+      test_file_name = "out.txt"
+      out_file = File.new(test_file_name, "w")
+      @pin.write_to_file(0,test_file_name).should be_true
+      lambda{ @pin.write_to_file(0,test_file_name)} .should_not raise_error
+      File.delete(test_file_name)
+    end
+  end
+
+  describe "#set_as_input" do
+    if $on_pcduino
+      it "should return a pin object on pcduino" do
+        @pin.set_as_input.should be_an_instance_of Pin
+      end
+
+      it "should sucessfully write to its pin mode input file on pcduino" do
+       lambda { @pin.set_as_input }.should_not raise_error
+      end
+    else
+      it "should not sucessfully write to its pin mode file when not on pcduino" do
+       lambda { @pin.set_as_input }.should raise_error
+      end
+    end
+  end
+
+  describe "#set_as_input_pu" do
+    if $on_pcduino
+      it "should return a pin object" do
+        @pin.set_as_input_pu.should be_an_instance_of Pin
+      end
+
+      it "should sucessfully write to its pin mode pu file" do
+        lambda { @pin.set_as_input_pu }.should_not raise_error
+      end
+    else
+      it "should not sucessfully write to its pin mode input_pu file when not on pcduino" do
+       lambda { @pin.set_as_input_pu }.should raise_error
+      end
+    end
+  end
+
+  describe "#set_as_output" do
+    if $on_pcduino
+      it "should return a pin object" do
+        @pin.set_as_input.should be_an_instance_of Pin
+      end
+
+      it "should sucessfully write to its pin mode file" do
+       lambda { @pin.set_as_output }.should_not raise_error
+      end
+    else
+      it "should not sucessfully write to its pin mode output file when not on pcduino" do
+       lambda { @pin.set_as_output }.should raise_error
+      end
+    end
+  end
+  
+  describe "#write" do 
+    if $on_pcduino
+      it "should not raise an error" do
+        lambda { @pin.write(Logic::HIGH) }.should_not raise_error
+      end
+
+      it "should not allow invalid values" do 
+        lambda { @pin.write(12) }.should raise_error
+        lambda { @pin.write(-12) }.should raise_error
+      end
+
+    else
+      it "should raise an error" do
+        lambda { @pin.write(Logic::HIGH) }.should raise_error
+      end
+    end
+
+  end
+
+  describe "#read_from_file" do
+    it "should raise error for a non exsistant file" do
+      lambda { @pin.read_from_file("nonexisitantfile.txt") }.should raise_error
+    end
+  end
+
+  describe "#read" do
+    if $on_pcduino
+      it "should return a value for sucessful read when set as input" do
+        @pin.set_as_input
+        @pin.read.should be_an(Integer)
+      end
+
+    else
+      it "should return an error for unsucessful read when set as input" do
+        #@pin.set_as_input
+        lambda { @pin.read }.should raise_error
+      end
+    end
+
+  end
+
+  describe "#toggle" do
+    if $on_pcduino
+      it "should return true for succesful toggle" do
+        @pin.read.should be_true
+      end
+
+      it "should not raise an error" do
+        lambda { @pin.toggle }.should_not raise_error       
+      end
+
+    else
+      it "should return an error for toggle" do
+        #@pin.set_as_input
+        lambda { @pin.toggle }.should raise_error
+      end
+    end
+
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'pcduino'
+
+

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: pcduino
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Will Olner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Control GPIO of Pcduino
+email: William.olner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- examples/io_example/blink.rb
+- examples/sinatra_example/app.rb
+- lib/pcduino.rb
+- lib/pcduino/pin.rb
+- lib/pcduino/version.rb
+- pcduino.gemspec
+- spec/pin_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/willoftw/pcduino
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.7
+signing_key: 
+specification_version: 4
+summary: Control GPIO of Pcduino using Ruby
+test_files:
+- spec/pin_spec.rb
+- spec/spec_helper.rb