cgpio 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0091850b19f944b1602e67b59b074360e035db7
-  data.tar.gz: 8a679bd1fa1ff4eaecd619dc669cdb92a967f42c
+  metadata.gz: 35a8a5032424dc30fda2e8c0eb848e508cb3b9a5
+  data.tar.gz: 69606dbcb7728573176b25ef4a130cae028519a3
 SHA512:
-  metadata.gz: 24258270b27a4f8ed06642aeb34df899ca03ae400c0ea7ffea8040618973865e03895934e6ecb06598a008d3dd06a90ec12b6df686b9a1f1340e68847b473573
-  data.tar.gz: 3c36f48dd452387081633547c925a4c508aec663530b8104ce779ec433e37d1dee775e3be5a32a2683f80c23fa0b837176a5c9228a2eac82f9d23481187d696c
+  metadata.gz: 1087a17b35e4ec77e22c06db7651060258247a1affe00bae3fa149baf3c23b789a9a6ea93664a98214f45016cb4da30425805ff9383ca5efa69180692b1a1b21
+  data.tar.gz: d2c4343dd1ae15c68cf8627ea1b469b3c0ee6547328cdb006c1e4d804709c9a0ac2ee16076538017de26d86ed55ef45f3d33ae554bc129840a73d12daa54b587

data/Gemfile

@@ -2,6 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in cgpio.gemspec
 gemspec
-
-gem "rake"
-gem "rake-compiler"

data/README.md

@@ -2,13 +2,29 @@
 
 A simple GPIO Wrapper in Ruby (which uses C to access the SYSFS structures)
 
-Tested only with Beaglebone Black.
+```ruby
+require 'cgpio'
+
+# switch on a led on port 48
+led = Cgpio::Gpio.new(48)
+led.on
+```
+
+Tested with Linux-Kernel Version "4.1.6" on
+* [Beaglebone Black](http://beagleboard.org/black)  
+* [Raspberry Pi Model B+](https://www.raspberrypi.org/products/model-b-plus/)
 
 WARN: the gem is not stable yet!
 
 ## Features
 * set/get value
 * set/get direction
+* virtual GPIO
+
+## Installation
+```
+gem install cgpio
+```
 
 ## Usage
 ### Example
@@ -64,7 +80,6 @@ led.on
 led.value = false
 # or
 led.off
-
 ```
 
 ### Read value of port
@@ -74,6 +89,25 @@ val = switch.on?
 val = switch.off?
 ```
 
+### Get static info about port
+```ruby
+# get port number
+nr = port.nr
+```
+
+### Virtual GPIO
+When you want to run your program on a hardware which don't have GPIO, you can
+use virtual GPIOs.
+
+For this you have to configure the Cgpio before you use it:
+```ruby
+# put this at the beginning of your program
+Cgpio.configure do |config|
+    # use virtual gpio instead of real gpio
+    config.virtual = true
+end
+```
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/cgpio.gemspec

@@ -19,7 +19,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
   spec.extensions = %w[ext/cgpio/extconf.rb]
+  spec.required_ruby_version = '~> 2.2'
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake-compiler", "~> 0.9"
 end

data/ext/cgpio/cgpio.c

@@ -126,18 +126,18 @@ void
 Init_cgpio()
 {
     VALUE module_Cgpio;
-    VALUE class_Gpio;
+    VALUE class_RealGpio;
 
     // get module
     module_Cgpio = rb_const_get(rb_cObject, rb_intern("Cgpio"));
 
     // get class
-    class_Gpio = rb_const_get(module_Cgpio, rb_intern("Gpio"));
-
-    rb_define_alloc_func(class_Gpio, cgpio_alloc);
-    rb_define_private_method(class_Gpio, "setup", cgpio_setup, 1);
-    rb_define_private_method(class_Gpio, "set_direction", cgpio_set_direction, 1);
-    rb_define_private_method(class_Gpio, "get_direction", cgpio_get_direction, 0);
-    rb_define_method(class_Gpio, "value=", cgpio_set_value, 1);
-    rb_define_method(class_Gpio, "value", cgpio_get_value, 0);
+    class_RealGpio = rb_const_get(module_Cgpio, rb_intern("RealGpio"));
+
+    rb_define_alloc_func(class_RealGpio, cgpio_alloc);
+    rb_define_private_method(class_RealGpio, "setup", cgpio_setup, 1);
+    rb_define_private_method(class_RealGpio, "set_direction", cgpio_set_direction, 1);
+    rb_define_private_method(class_RealGpio, "get_direction", cgpio_get_direction, 0);
+    rb_define_method(class_RealGpio, "value=", cgpio_set_value, 1);
+    rb_define_method(class_RealGpio, "value", cgpio_get_value, 0);
 }

data/ext/cgpio/extconf.rb

@@ -1,3 +1,6 @@
-require "mkmf"
+require 'mkmf'
 
-create_makefile "cgpio/cgpio"
+find_executable('make') or abort "can't find make. please install it."
+find_executable('gcc') or abort "can't find gcc. please install it."
+
+create_makefile 'cgpio/cgpio'

data/lib/cgpio.rb

@@ -1,61 +1,24 @@
-require "cgpio/version"
+require 'cgpio/version'
+require 'cgpio/gpio'
+require 'cgpio/configuration'
 
-module Cgpio
-    class Gpio
-
-        attr_reader :pin
-
-        def initialize(pin, options={})
-            options = {
-                direction: :out
-            }.merge(options)
-
-            @pin = pin
-
-            # this will export the pin
-            setup @pin
-
-            # set the initial direction
-            self.direction = options[:direction]
-        end
-
-        def direction=(direction)
-            if direction == :out
-                # direction values defined in ext/cgpio/gpio.h
-                set_direction(0x01)
-            elsif direction == :in
-                set_direction(0x02)
-            else
-                raise "unsupported gpio direction. use :out or :in"
-            end
-        end
-
-        def direction
-            if (get_direction == 0x01)
-                :out
-            elsif (get_direction == 0x02)
-                :in
-            else
-                raise "unknown gpio direction"
-            end
-        end
+# include c extensions
+require 'cgpio/cgpio'
 
-        def on
-            self.value = true
-        end
+module Cgpio
+    class << self
+        attr_accessor :configuration
+    end
 
-        def off
-            self.value = false
-        end
+    def self.configuration
+        @configuration ||= Configuration.new
+    end
 
-        def on?
-            self.value
-        end
+    def self.reset
+        @configuration = Configuration.new
+    end
 
-        def off?
-            !self.value
-        end
+    def self.configure
+        yield configuration
     end
 end
-
-require 'cgpio/cgpio'

data/lib/cgpio/configuration.rb

@@ -0,0 +1,7 @@
+class Cgpio::Configuration
+    attr_accessor :virtual
+
+    def initialize()
+        @virtual = false
+    end
+end

data/lib/cgpio/gpio.rb

@@ -0,0 +1,12 @@
+require 'cgpio/real_gpio'
+require 'cgpio/virtual_gpio'
+
+class Cgpio::Gpio
+    def self.new(nr, options={})
+        if Cgpio.configuration.virtual
+            Cgpio::VirtualGpio.new(nr, options)
+        else
+            Cgpio::RealGpio.new(nr, options)
+        end
+    end
+end

data/lib/cgpio/real_gpio.rb

@@ -0,0 +1,55 @@
+class Cgpio::RealGpio
+
+    attr_reader :nr
+
+    def initialize(nr, options={})
+        options = {
+            direction: :out
+        }.merge(options)
+
+        @nr = nr
+
+        # this will export the pin
+        setup @nr
+
+        # set the initial direction
+        self.direction = options[:direction]
+    end
+
+    def direction=(direction)
+        if direction == :out
+            # direction values defined in ext/cgpio/gpio.h
+            set_direction(0x01)
+        elsif direction == :in
+            set_direction(0x02)
+        else
+            raise "unsupported gpio direction. use :out or :in"
+        end
+    end
+
+    def direction
+        if (get_direction == 0x01)
+            :out
+        elsif (get_direction == 0x02)
+            :in
+        else
+            raise "unknown gpio direction"
+        end
+    end
+
+    def on
+        self.value = true
+    end
+
+    def off
+        self.value = false
+    end
+
+    def on?
+        self.value
+    end
+
+    def off?
+        !self.value
+    end
+end

data/lib/cgpio/version.rb

@@ -1,3 +1,3 @@
 module Cgpio
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/cgpio/virtual_gpio.rb

@@ -0,0 +1,53 @@
+class Cgpio::VirtualGpio
+    attr_reader :nr
+
+    def initialize(nr, options={})
+        options = {
+            direction: :out
+        }.merge(options)
+
+        @nr = nr
+        @value = false
+
+        # set the initial direction
+        self.direction = options[:direction]
+    end
+
+    def direction=(direction)
+        if direction == :out
+            @direction = 0x01
+        elsif direction == :in
+            @direction = 0x02
+        else
+            raise "unsupported gpio direction. use :out or :in"
+        end
+    end
+
+    def value
+        @value
+    end
+
+    def value=(val)
+        @value = val
+    end
+
+    def direction
+        @direction
+    end
+
+    def on
+        self.value = true
+    end
+
+    def off
+        self.value = false
+    end
+
+    def on?
+        value
+    end
+
+    def off?
+        !value
+    end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cgpio
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Maximilian Etti
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-29 00:00:00.000000000 Z
+date: 2015-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 description: A simple GPIO C Wrapper for Beaglebone Black.
 email:
 - maximilian_etti@yahoo.de
@@ -60,7 +74,11 @@ files:
 - ext/cgpio/gpio.c
 - ext/cgpio/gpio.h
 - lib/cgpio.rb
+- lib/cgpio/configuration.rb
+- lib/cgpio/gpio.rb
+- lib/cgpio/real_gpio.rb
 - lib/cgpio/version.rb
+- lib/cgpio/virtual_gpio.rb
 homepage: http://github.com/metix/cgpio
 licenses:
 - MIT
@@ -71,9 +89,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="