cgpio 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b0091850b19f944b1602e67b59b074360e035db7
+  data.tar.gz: 8a679bd1fa1ff4eaecd619dc669cdb92a967f42c
+SHA512:
+  metadata.gz: 24258270b27a4f8ed06642aeb34df899ca03ae400c0ea7ffea8040618973865e03895934e6ecb06598a008d3dd06a90ec12b6df686b9a1f1340e68847b473573
+  data.tar.gz: 3c36f48dd452387081633547c925a4c508aec663530b8104ce779ec433e37d1dee775e3be5a32a2683f80c23fa0b837176a5c9228a2eac82f9d23481187d696c

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+
+lib/cgpio/*.so

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Maximilian Etti
+
+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,79 @@
+# Cgpio
+
+A simple GPIO Wrapper in Ruby (which uses C to access the SYSFS structures)
+
+Tested only with Beaglebone Black.
+
+WARN: the gem is not stable yet!
+
+## Features
+* set/get value
+* set/get direction
+
+## Usage
+### Example
+```ruby
+require 'cgpio'
+
+# setup a new port (output is default)
+led = Cgpio::Gpio.new(48)
+
+# setup a new input port
+switch = Cgpio::Gpio.new(66, direction: :in)
+
+# connect led with switch
+loop do led.value = switch.value end
+```
+
+### Initializing a port
+```ruby
+# setup a new port (output is default)
+led = Cgpio::Gpio.new(48)
+
+# setup a new input port
+switch = Cgpio::Gpio.new(66, direction: :in)
+```
+
+Note: The initialization will export the port (/sys/class/gpio/export) if it is
+not exported already. But when the GC (Garbage Collector) deletes this object,
+the port will not be unexported.
+
+### Set direction of port
+```ruby
+# port as output
+led.direction = :out
+
+# port as input
+switch.direction = :in
+```
+
+### Get direction of port
+```ruby
+# returns :in or :out
+dir = switch.direction
+```
+
+### Set value of port
+```ruby
+# set value to true
+led.value = true
+# or
+led.on
+
+# set value to false
+led.value = false
+# or
+led.off
+
+```
+
+### Read value of port
+```ruby
+val = switch.value
+val = switch.on?
+val = switch.off?
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rake/extensiontask'
+
+Rake::ExtensionTask.new "cgpio" do |ext|
+    ext.lib_dir = "lib/cgpio"
+end

data/bin/console

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cgpio"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+
+require "irb"
+require "irb/completion"
+
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cgpio.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cgpio/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cgpio"
+  spec.version       = Cgpio::VERSION
+  spec.authors       = ["Maximilian Etti"]
+  spec.email         = ["maximilian_etti@yahoo.de"]
+
+  spec.summary       = "GPIO C Wrapper for Beaglebone Black"
+  spec.description   = "A simple GPIO C Wrapper for Beaglebone Black."
+  spec.homepage      = "http://github.com/metix/cgpio"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.extensions = %w[ext/cgpio/extconf.rb]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/ext/cgpio/.gitignore

@@ -0,0 +1 @@
+Makefile

data/ext/cgpio/cgpio.c

@@ -0,0 +1,143 @@
+#include <ruby.h>
+#include "gpio.h"
+
+struct Cgpio
+{
+    struct Gpio *gpio;
+};
+
+static VALUE
+cgpio_setup(VALUE self, VALUE p_port)
+{
+    struct Cgpio *ptr;
+    struct Gpio *gpio;
+
+    int port = NUM2INT(p_port);
+
+    Data_Get_Struct(self, struct Cgpio, ptr);
+
+    gpio = gpio_setup(port);
+
+    if (gpio == NULL)
+            rb_raise(rb_eRuntimeError, "unable to export gpio %d", port);
+
+    ptr->gpio = gpio;
+
+    return self;
+}
+
+static VALUE
+cgpio_set_direction(VALUE self, VALUE p_dir)
+{
+    struct Cgpio *ptr;
+    int dir;
+
+    dir = NUM2INT(p_dir);
+
+    Data_Get_Struct(self, struct Cgpio, ptr);
+
+    if (gpio_mode(ptr->gpio, dir) == -1)
+    {
+            rb_raise(rb_eRuntimeError, "unable to set direction of gpio");
+    }
+
+    return self;
+}
+
+static VALUE
+cgpio_get_direction(VALUE self)
+{
+    struct Cgpio *ptr;
+    int dir;
+
+    Data_Get_Struct(self, struct Cgpio, ptr);
+
+    dir = gpio_get_mode(ptr->gpio);
+
+    if (dir == -1)
+    {
+        rb_raise(rb_eRuntimeError, "unable to read direction of gpio");
+        return self;
+    }
+
+    return INT2NUM(dir);
+}
+
+static VALUE
+cgpio_set_value(VALUE self, VALUE p_value)
+{
+    struct Cgpio *ptr;
+
+    Data_Get_Struct(self, struct Cgpio, ptr);
+
+    if (p_value != Qtrue && p_value != Qfalse)
+    {
+        rb_raise(rb_eArgError, "gpio value have to be true or false");
+        return self;
+    }
+
+    if (gpio_set(ptr->gpio, RTEST(p_value)) == -1)
+        rb_raise(rb_eRuntimeError, "unable to set gpio value");
+
+    return self;
+}
+
+static VALUE
+cgpio_get_value(VALUE self)
+{
+    struct Cgpio *ptr;
+    int value;
+
+    Data_Get_Struct(self, struct Cgpio, ptr);
+    value = gpio_get(ptr->gpio);
+
+    if (value == -1)
+        rb_raise(rb_eRuntimeError, "unable to read gpio value");
+    else if (value)
+        return Qtrue;
+
+    return Qfalse;
+}
+
+static void
+cgpio_free(void *p)
+{
+    struct Cgpio *ptr = p;
+
+    // only close but dont unexport the gpio
+    if (ptr->gpio)
+        gpio_close(ptr->gpio, 0);
+}
+
+static VALUE
+cgpio_alloc(VALUE klass)
+{
+    VALUE obj;
+    struct Cgpio *ptr;
+
+    obj = Data_Make_Struct(klass, struct Cgpio, NULL, cgpio_free, ptr);
+
+    ptr->gpio = NULL;
+
+    return obj;
+}
+
+void
+Init_cgpio()
+{
+    VALUE module_Cgpio;
+    VALUE class_Gpio;
+
+    // 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);
+}

data/ext/cgpio/extconf.rb

@@ -0,0 +1,3 @@
+require "mkmf"
+
+create_makefile "cgpio/cgpio"

data/ext/cgpio/gpio.c

@@ -0,0 +1,195 @@
+#include "gpio.h"
+#include <stdio.h>
+#include <fcntl.h>
+#include <unistd.h>
+#include <stdlib.h>
+#include <string.h>
+#include <errno.h>
+
+#define GPIO_PATH "/sys/class/gpio/"
+#define BUF_SIZE 1024
+
+static int
+gpio_export(int n)
+{
+	char buf[BUF_SIZE];
+	int fd, written;
+
+	// open gpio export file
+	fd = open(GPIO_PATH "export", O_WRONLY);
+	if (fd == -1)
+		return -1;
+
+	// write gpio number in export file
+	sprintf(buf, "%d", n);
+	written = write(fd, buf, strlen(buf));
+	close(fd);
+	if (written == -1)
+		return -1;
+
+	return 0;
+}
+
+static int
+gpio_exists(int n)
+{
+	char buf[BUF_SIZE];
+	sprintf(buf, GPIO_PATH "gpio%d", n);
+
+	if(access(buf, F_OK) != -1 )
+		return 1;
+	return 0;
+}
+
+struct Gpio*
+gpio_setup(int n)
+{
+	char buf[BUF_SIZE];
+	int fd;
+	struct Gpio *gpio;
+
+	if (!gpio_exists(n))
+	{
+		if (gpio_export(n) == -1)
+		{
+			printf("gpio error: couldn't export gpio %d\n", n);
+			return NULL;
+		}
+	}
+
+	// open the value file of the exported gpio
+	sprintf(buf, GPIO_PATH "gpio%d/value", n);
+	fd = open(buf, O_RDWR);
+	if (fd == -1)
+	{
+		printf("gpio error: error at open value file for gpio %d\n", n);
+		return NULL;
+	}
+
+	// allocate the gpio structure
+	gpio = malloc(sizeof (struct Gpio));
+	gpio->nr = n;
+	gpio->fd_value = fd;
+
+	return gpio;
+}
+
+void
+gpio_close(struct Gpio *gpio, int unexport)
+{
+	char buf[BUF_SIZE];
+	int written;
+
+	if (unexport)
+	{
+		// open gpio unexport file
+		int fd = open(GPIO_PATH "unexport", O_WRONLY);
+		if (fd == -1)
+			return;
+
+		// write gpio number in unexport file
+		sprintf(buf, "%d", gpio->nr);
+		written = write(fd, buf, strlen(buf));
+		close(fd);
+		if (written == -1)
+			return;
+	}
+
+	// close the value file of the gpio
+	close(gpio->fd_value);
+
+	// free the gpio structure
+	free(gpio);
+}
+
+int
+gpio_set(struct Gpio *gpio, int value)
+{
+	int written = -1;
+
+	if (value)
+		written = write(gpio->fd_value, "1", 1);
+	else
+		written = write(gpio->fd_value, "0", 1);
+
+	lseek(gpio->fd_value, 0, SEEK_SET);
+
+	return written;
+}
+
+int
+gpio_get(struct Gpio *gpio)
+{
+	int readb;
+	char buf[1];
+
+	readb = read(gpio->fd_value, buf, 1);
+
+	if (readb == -1)
+	{
+		lseek(gpio->fd_value, 0, SEEK_SET);
+		return -1;
+	}
+
+	lseek(gpio->fd_value, 0, SEEK_SET);
+
+	return buf[0] == '1';
+}
+
+int
+gpio_mode(struct Gpio *gpio, int mode)
+{
+	char buf[BUF_SIZE];
+	int fd, written = -1;
+
+	// open the direction file of the gpio
+	sprintf(buf, GPIO_PATH "gpio%d/direction", gpio->nr);
+
+	fd = open(buf, O_WRONLY);
+	if (fd == -1)
+		return -1;
+
+	if (mode == GPIO_MODE_INPUT)
+	{
+		written = write(fd, "in", 2);
+	}
+	else if (mode == GPIO_MODE_OUTPUT)
+	{
+		written = write(fd, "out", 3);
+	}
+
+	close(fd);
+
+	if (written == -1)
+		return -1;
+
+	return 0;
+}
+
+int
+gpio_get_mode(struct Gpio *gpio)
+{
+	char buf[BUF_SIZE];
+	int fd, readb = -1;
+
+	// open the direction file of the gpio
+	sprintf(buf, GPIO_PATH "gpio%d/direction", gpio->nr);
+
+	fd = open(buf, O_RDONLY);
+	if (fd == -1)
+		return -1;
+
+	readb = read(fd, buf, 4);
+
+	close(fd);
+
+	if (readb == -1)
+		return -1;
+
+	if (buf[0] == 'o')
+		return GPIO_MODE_OUTPUT;
+	else if (buf[0] == 'i')
+		return GPIO_MODE_INPUT;
+
+	return -1;
+}

data/ext/cgpio/gpio.h

@@ -0,0 +1,23 @@
+#ifndef _GPIO_H_
+#define _GPIO_H_
+
+#define GPIO_MODE_OUTPUT	0x01
+#define GPIO_MODE_INPUT		0x02
+
+struct Gpio
+{
+    /* file descriptor of the /sys/value/gpio%d/value file */
+    int fd_value;
+
+    /* number of the gpio */
+    int nr;
+};
+
+extern struct Gpio *gpio_setup(int n);
+extern int gpio_set(struct Gpio *gpio, int value);
+extern int gpio_get(struct Gpio *gpio);
+extern int gpio_mode(struct Gpio *gpio, int mode);
+extern int gpio_get_mode(struct Gpio *gpio);
+extern void gpio_close(struct Gpio *gpio, int unexport);
+
+#endif

data/lib/cgpio/version.rb

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

data/lib/cgpio.rb

@@ -0,0 +1,61 @@
+require "cgpio/version"
+
+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
+
+        def on
+            self.value = true
+        end
+
+        def off
+            self.value = false
+        end
+
+        def on?
+            self.value
+        end
+
+        def off?
+            !self.value
+        end
+    end
+end
+
+require 'cgpio/cgpio'

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: cgpio
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Maximilian Etti
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: A simple GPIO C Wrapper for Beaglebone Black.
+email:
+- maximilian_etti@yahoo.de
+executables: []
+extensions:
+- ext/cgpio/extconf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cgpio.gemspec
+- ext/cgpio/.gitignore
+- ext/cgpio/cgpio.c
+- ext/cgpio/extconf.rb
+- ext/cgpio/gpio.c
+- ext/cgpio/gpio.h
+- lib/cgpio.rb
+- lib/cgpio/version.rb
+homepage: http://github.com/metix/cgpio
+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.4.5
+signing_key: 
+specification_version: 4
+summary: GPIO C Wrapper for Beaglebone Black
+test_files: []