c_gpio 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5cd82e4b29799d13c1a63c6ec7dbcf7b3c96e869
-  data.tar.gz: 39a6cf9317d22980a076c39a64f2a30e17473199
+  metadata.gz: 7ccafeaa0502815b135c4bc830c182bbf0824c79
+  data.tar.gz: 0c8dd4659fe70110185f72f5252a5a9d3ac8976d
 SHA512:
-  metadata.gz: c51a22897cf2414ef0774bd989edd69c5981230cc0710f2ace3cee2369f644641f7418d2d28e339474bc0f174586280a27a5e9e5f2dab886677f1ce7420fad92
-  data.tar.gz: 3c89cf81a22997184a86aeda24fc2e82d33332d722354c53913544327c8561c353553e6995d91d9ca4b80d9bdebf53754f066a51e387f443a59c3f81304b5246
+  metadata.gz: effcf66a43487ad13acce3b6036e32dd127ab46a743a3c8b62cba7c36d3aeea37e08a7e227a226d0d39f9176cc303a48ef864b6223734f66565e3ff36b6975bf
+  data.tar.gz: 8b4a5010ea9211373be756ff74cee6962301e764651ab623c7d234dc9492e5c5bb39a2cf8f004b5e508192b89231db1b115999ac7d84d7e363a48cae9528833f

data/README.md

@@ -0,0 +1,134 @@
+# c_GPIO
+
+c_GPIO is a rubygem for controlling GPIO Ports of raspberry PIs out of ruby.
+
+It provides an easy to use interface for accessing the GPIO feature. c_GPIO is written in C to be as close as possible to the system.
+
+I also wrote this as ruby c extension to learn a bit about C.
+
+c_GPIO provides predefined classes for
+
+  - LED
+  - Buttons
+
+There is a base class available as well which provides manual setting of direction (IN / OUT) and value (HIGH / LOW).
+
+## Usage / Examples
+
+Here you will find various examples for this gem.
+
+#### Turning a LED on and off
+
+    require 'c_gpio'
+
+    led = GPIO::Led.new(2) # Initialize a LED connected to PIN 2
+
+    led.turn_on! # Turn on the LED
+
+    sleep(1) # Wait a second
+
+    led.turn_off! # Turn off the LED
+
+#### Connect a button to GPIO
+
+    require 'c_gpio'
+
+    button = GPIO::Button.new(2) # Initialize a button connected to PIN 2
+
+    # pressed? will return true, if the button is being pressed,
+    # otherwise it will return false
+    if(button.pressed?) {
+      puts "The button is currently pressed"
+    }
+
+    # If you want to get notified, once a button is pressed or released,
+    # You can easily use one (or both) of the following callbacks
+
+    button.on_press do
+        puts "You pressed da button"
+    end
+
+    button.on_release do
+        puts "ou stopped pressing the button"
+    end
+
+#### Controlling a PWM Engine
+
+Please note that this is experimental. This gem will create a PWM signal using the CPU which might not be that accurate.
+You can still try it and you are welcome to have a look at the implementation if. Give feedback an collaborate in optimizing it.
+
+    require 'c_gpio'
+
+    stepper = GPIO::Pwm.new(2) # Initialize a stepping motor connected to PIN 2
+
+    # Move the stepper to the one side (0 is the lowest value you can submit)
+    stepper.move_to(0)
+
+    # Move the stepper to the middle position
+    stepper.move_to(100)
+
+    # Move the stepper to the other side (200 is the highest value you can submit)
+    stepper.move_to(200)
+
+Because of the CPU of a PI being unprecise, this class stopps sending a PWM signal after ~1400ms.
+Your stepper will have to reach it's final position after this time. I decided to stop the PWM signal after 1400ms because otherwise, the stepper will start jittering. The reason for this that generating a PWM signal from the CPU is not that accurate as from an arduino. If you know a more precise implementation of PWM signals, feel free to contact me.
+
+#### Using the Base class for reading custom parts
+
+    require 'c_gpio'
+
+    io = GPIO::Base.new(2) # We want to read from PIN 2
+
+    io.direction = :in # Setting the direction to "in", so we can read
+
+    io.value # will return :high or :low depending on what your sensor says
+
+#### Using the Base class for writing custom parts
+
+    require 'c_gpio'
+
+    io = GPIO::Base.new(2) # We want to write to PIN 2
+
+    io.direction = :out # Setting the direction to "out", so we can write
+
+    io.value = :high # will power the connected part on
+
+    io.value = :low # will power the connected part off
+
+#### Using callbacks of the Base class
+
+Those callbacks can be used for both directions, "IN" and "OUT".
+Using them you can observe, if your peripheral device changed the signal from HIGH to LOW or from LOW to HIGH.
+If the direction is set to "OUT", you also can observe, if someone is changing the outgoing signal.
+
+    require 'c_gpio'
+
+    io = GPIO::Base.new(2) # We want to write to PIN 2
+
+    io.direction = :in
+
+    io.on_high do
+        puts "signal changed to HIGH"
+    end
+
+    io.on_low do
+        puts "signal changed to low"
+    end
+
+
+
+License
+----
+
+MIT
+
+
+**Free Software, Hell Yeah!**
+
+Finally
+----
+
+I wrote this as my fist c program and my first c extension.
+I have to Idea if this code is looking pretty or optimized.
+
+But I am open to everyone who wants to give feedback or collaborate in this.

data/lib/c_gpio.rb

@@ -0,0 +1,33 @@
+module GPIO
+  VERSION = '0.0.5'
+end
+
+require 'c_gpio/gpio'
+
+class GPIO::Base
+  def on_high(&block)
+    Thread.new do
+      wait_for_high(block)
+    end
+  end
+
+  def on_low(&block)
+    Thread.new do
+      wait_for_low(block)
+    end
+  end
+end
+
+class GPIO::Button
+  def on_press(&block)
+    Thread.new do
+      wait_for_low(block)
+    end
+  end
+
+  def on_release(&block)
+    Thread.new do
+      wait_for_high(block)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: c_gpio
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - hujiko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-22 00:00:00.000000000 Z
+date: 2018-06-25 00:00:00.000000000 Z
 dependencies: []
 description: Ruby gem to control GPIO ports of a raspberry PI
 email: 
@@ -17,7 +17,9 @@ extensions:
 - ext/c_gpio/extconf.rb
 extra_rdoc_files: []
 files:
+- README.md
 - ext/c_gpio/extconf.rb
+- lib/c_gpio.rb
 homepage: https://github.com/hujiko/c_GPIO
 licenses:
 - MIT
@@ -38,7 +40,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: Ruby gem to control GPIO ports of a raspberry PI