bonekit 0.0.2-arm-linux

data/ext/bonekit/hmc5883l_class.h

@@ -0,0 +1,33 @@
+/*
+ 
+ hmc5883l_class.h
+ BoneKit
+ 
+ Copyright (cc) 2012 Luis Laugga.
+ Some rights reserved, all wrongs deserved.
+ 
+ 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.
+ 
+*/
+
+#ifndef BONEKIT_HMC5883L_CLASS_H__
+#define BONEKIT_HMC5883L_CLASS_H__
+
+void BoneKit_HMC5883L_class_init();
+
+#endif

data/ext/bonekit/pin.c

@@ -0,0 +1,133 @@
+/*
+ 
+ pin.c
+ BoneKit
+ 
+ Copyright (cc) 2012 Luis Laugga.
+ Some rights reserved, all wrongs deserved.
+ 
+ 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.
+ 
+*/
+
+#include "pin.h"
+
+#include "gpio.h"
+#include "adc.h"
+
+#include <stdlib.h>
+
+pin_t * pin_alloc()
+{
+  pin_t * obj;
+  obj = malloc(sizeof(struct pin_s));  
+  return obj;
+}
+
+int pin_init(pin_t * obj, unsigned int beaglebone_global_const)
+{
+  if(obj)
+  {
+    int gpio = beaglebone_gpio(beaglebone_global_const);
+    int ain = beaglebone_ain(beaglebone_global_const);
+    
+    int is_ain = (ain != -1);
+    int is_gpio = (gpio != -1);
+    
+    if(!(is_ain || is_gpio)) // invalid pin
+      return -1;
+    
+    obj->_ain = ain;
+    obj->_is_ain = is_ain;
+    obj->_gpio = gpio;
+    obj->_is_gpio = is_gpio;
+    
+    if(is_gpio)
+      gpio_export(gpio);
+    else if(is_ain)
+      adc_enable();
+  }
+  
+  return 0;
+}
+
+void pin_destroy(pin_t * obj)
+{
+  if(obj->_is_gpio)
+    gpio_unexport(obj->_gpio);
+  
+  free(obj);
+}
+
+int pin_mode(pin_t * obj)
+{
+  int mode = -1;
+  if(obj->_is_gpio)
+    gpio_get_direction(obj->_gpio, &mode);
+  return mode;
+}
+
+void pin_set_mode(pin_t * obj, int mode)
+{
+  if(obj->_is_gpio)
+    gpio_set_direction(obj->_gpio, mode);
+}
+
+int pin_value(pin_t * obj)
+{
+  int value = 0;
+  
+  if(obj->_is_gpio)
+  {
+    gpio_get_value(obj->_gpio, &value);
+  }
+  else if(obj->_is_ain)
+  {
+    int analog_value_raw; // [ADC_MIN_VALUE..ADC_MAX_VALUE]
+    adc_get_value(obj->_ain, &analog_value_raw);
+    value = analog_value_raw > ADC_THRESHOLD ? HIGH : LOW;
+  }
+  
+  return value;
+}
+
+float pin_analog_value(pin_t * obj)
+{
+  float analog_value = 0.0;
+  
+  if(obj->_is_gpio)
+  {
+    int value;
+    gpio_get_value(obj->_gpio, &value);
+    analog_value = (float)value;
+  }
+  else if(obj->_is_ain)
+  {
+    int analog_value_raw; // [ADC_MIN_VALUE..ADC_MAX_VALUE]
+    adc_get_value(obj->_ain, &analog_value_raw);
+    analog_value = (float)(((float)analog_value_raw)/((float)ADC_MAX_VALUE));
+  }
+  
+  return analog_value;
+}
+
+void pin_set_value(pin_t * obj, int value)
+{
+  if(obj->_is_gpio)
+    gpio_set_value(obj->_gpio, value);
+}

data/ext/bonekit/pin.h

@@ -0,0 +1,58 @@
+/*
+ 
+ pin.h
+ BoneKit
+ 
+ Copyright (cc) 2012 Luis Laugga.
+ Some rights reserved, all wrongs deserved.
+ 
+ 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.
+ 
+*/
+
+#ifndef BONEKIT_PIN_H__
+#define BONEKIT_PIN_H__
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+struct pin_s
+{
+  int _is_ain;
+  unsigned _ain;
+  int _is_gpio;
+  unsigned _gpio;
+};
+
+typedef struct pin_s pin_t;
+
+pin_t * pin_alloc();
+int pin_init(pin_t *, unsigned int);
+void pin_destroy(pin_t *);
+int pin_mode(pin_t *);
+void pin_set_mode(pin_t *, int);
+int pin_value(pin_t *);
+float pin_analog_value(pin_t *);
+void pin_set_value(pin_t *, int);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif

data/ext/bonekit/pin_class.c

@@ -0,0 +1,175 @@
+/*
+ 
+ pin_class.c
+ BoneKit
+ 
+ Copyright (cc) 2012 Luis Laugga.
+ Some rights reserved, all wrongs deserved.
+ 
+ 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.
+
+ 
+*/
+
+#include "pin_class.h"
+
+#include "ruby.h"
+#include "gpio.h"
+#include "pin.h"
+
+VALUE cBoneKit_Pin;
+
+static void Pin_free(pin_t * ptr)
+{
+  if(ptr == NULL)
+      return;
+
+  pin_destroy(ptr);
+}
+
+static VALUE Pin_alloc(VALUE class)
+{
+    pin_t * ptr = pin_alloc();
+  
+    VALUE self = Data_Wrap_Struct(class, 0, Pin_free, ptr);
+    return self;
+}
+
+/*
+ * call-seq:
+ *  initialize(pin, mode=Input) -> Pin
+ *
+ * Returns a new Pin object with default value of 0
+ * @param [Integer] pin the beaglebone pin, identified by header (P8 or P9) and number (1-46) (ie. P9_31)
+ * @param [Integer] mode the pin mode to be used (Input or Output) (default is Input)
+ */
+static VALUE Pin_initialize(int argc, VALUE* argv, VALUE self)
+{
+  if (argc > 2 || argc == 0)  // there should only be 1 or 2 arguments
+    rb_raise(rb_eArgError, "wrong number of arguments (%d for 0..1)", argc);
+  
+  pin_t * ptr;
+  Data_Get_Struct(self, pin_t, ptr);
+  
+  if(pin_init(ptr, NUM2UINT(argv[0])) < 0) // pin must support gpio
+    rb_raise(rb_eArgError, "invalid pin (%d GPIO not supported)", NUM2UINT(argv[0]));
+  
+  int mode = INPUT;
+  
+  if(argc == 2)
+    mode = NUM2INT(argv[1]);
+
+  pin_set_mode(ptr, mode);
+  
+  return self;
+}
+
+/*
+ * call-seq:
+ *  value -> integer
+ *
+ * Reads the value from the pin. The values are [0,1].
+ */
+static VALUE Pin_value(VALUE self)
+{
+  pin_t * ptr;
+  Data_Get_Struct(self, pin_t, ptr);
+  
+  return INT2NUM(pin_value(ptr));
+}
+
+/*
+ * call-seq:
+ *  analog_value -> float
+ *
+ * Reads the analog value from the pin. The range of values is [0.0..1.0].
+ * NOTE: If the pin doesn't support ADC, analog_value is the floating point equivalent of value.
+ */
+static VALUE Pin_analog_value(VALUE self)
+{
+  pin_t * ptr;
+  Data_Get_Struct(self, pin_t, ptr);
+  
+  return rb_float_new(pin_analog_value(ptr));
+}
+
+
+/*
+ * call-seq:
+ *  value=(value) -> integer
+ *
+ * Write the value to the pin. The pin mode must be set to Output.
+ * Possible values: High, Low.
+ */
+static VALUE Pin_set_value(VALUE self, VALUE value)
+{
+  pin_t * ptr;
+  Data_Get_Struct(self, pin_t, ptr);
+  pin_set_value(ptr, NUM2INT(value));
+  
+  return value;
+}
+
+/*
+ * call-seq:
+ *  mode -> integer
+ *
+ * Returns the mode of the pin.
+ * Possible modes: Input, Output.
+ */
+static VALUE Pin_mode(VALUE self)
+{
+  pin_t * ptr;
+  Data_Get_Struct(self, pin_t, ptr);
+  return INT2NUM(pin_mode(ptr));
+}
+
+/*
+ * call-seq:
+ *  mode=(mode) -> integer
+ *
+ * Sets the mode of the pin.
+ * Possible modes: Input, Output.
+ */
+static VALUE Pin_set_mode(VALUE self, VALUE value)
+{
+  pin_t * ptr;
+  Data_Get_Struct(self, pin_t, ptr);
+  pin_set_mode(ptr, NUM2INT(value));
+  
+  return value;
+}
+
+void BoneKit_Pin_class_init()
+{
+  cBoneKit_Pin = rb_define_class("Pin", rb_cObject);
+  
+  rb_define_alloc_func(cBoneKit_Pin, Pin_alloc);
+  
+  rb_define_method(cBoneKit_Pin, "initialize", Pin_initialize, -1);
+  rb_define_method(cBoneKit_Pin, "value", Pin_value, 0);
+  rb_define_method(cBoneKit_Pin, "analog_value", Pin_analog_value, 0);
+  rb_define_method(cBoneKit_Pin, "value=", Pin_set_value, 1);
+  rb_define_method(cBoneKit_Pin, "mode", Pin_mode, 0);
+  rb_define_method(cBoneKit_Pin, "mode=", Pin_set_mode, 1);
+  
+  rb_define_global_const("High", INT2NUM(HIGH));
+  rb_define_global_const("Low", INT2NUM(LOW));
+  rb_define_global_const("Input", INT2NUM(INPUT));
+  rb_define_global_const("Output", INT2NUM(OUTPUT));
+}

data/ext/bonekit/pin_class.h

@@ -0,0 +1,33 @@
+/*
+ 
+ pin_class.h
+ BoneKit
+ 
+ Copyright (cc) 2012 Luis Laugga.
+ Some rights reserved, all wrongs deserved.
+ 
+ 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.
+ 
+*/
+
+#ifndef BONEKIT_PIN_CLASS_H__
+#define BONEKIT_PIN_CLASS_H__
+
+void BoneKit_Pin_class_init();
+
+#endif

data/ext/bonekit/rbinit.c

@@ -0,0 +1,42 @@
+/*
+ 
+ rbinit.c
+ BoneKit
+ 
+ Copyright (cc) 2012 Luis Laugga.
+ Some rights reserved, all wrongs deserved.
+ 
+ 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.
+ 
+*/
+
+#include "beaglebone_global_const.h"
+#include "pin_class.h"
+#include "hmc5883l_class.h"
+
+void Init_bonekit(void)
+{
+  // Constants
+  BoneKit_Beaglebone_global_const_init();
+  
+  // IO
+  BoneKit_Pin_class_init();
+  
+  // ICs
+  BoneKit_HMC5883L_class_init();
+}

data/lib/bonekit/version.rb

@@ -0,0 +1,3 @@
+module BoneKit
+	VERSION = "0.0.2"
+end

data/lib/bonekit.rb

@@ -0,0 +1,9 @@
+base_path = File.expand_path(File.dirname(__FILE__))
+require File.join(base_path, 'bonekit', 'version')
+begin
+  m = /(\d+.\d+)/.match(RUBY_VERSION)
+  ver = m[1]
+  require File.join(base_path, 'bonekit', ver, 'bonekit')
+rescue LoadError
+  require File.join(base_path, 'bonekit', 'bonekit')
+end

data/spec/pin_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe Pin do
+  
+  let :pin do
+    Pin.new 30
+  end
+  
+  describe "mode" do
+    context "when default" do
+      it "returns Input" do
+        pin.mode.should eq(Input)
+      end
+    end
+    
+    context "when set to Output" do
+      before(:each) { pin.mode = Output }
+      it "returns Output" do
+        pin.mode.should eq(Output)
+      end
+    end
+    
+    context "when set to Input" do
+      before(:each) { pin.mode = Input }
+      it "returns Input" do
+        pin.mode.should eq(Input)
+      end
+    end
+  end
+  
+  describe "value" do
+    context "when default" do
+      it "returns 0" do
+        pin.value.should eq(0)
+      end
+    end
+    
+    context "when default and mode is Output" do
+      before(:each) { pin.mode = Output }
+      it "returns 0" do
+        pin.value.should eq(0)
+      end
+    end
+    
+    context "when set to 1 and mode is Output" do
+      before(:each) { 
+        pin.mode = Output 
+        pin.value = 1
+      }
+      it "returns 1" do
+        pin.value.should eq(1)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'bonekit'

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'test/unit'
+require 'bonekit'

data/test/unit/pin_test.rb

@@ -0,0 +1,41 @@
+require 'test_helper'
+
+class PinTest < Test::Unit::TestCase
+  
+  def setup
+    @pin = Pin.new 30
+  end
+  
+  def teardown
+  end
+  
+  def test_initialization
+    assert_equal(Input, @pin.mode)
+    assert_equal("in", File.open('/sys/class/gpio/gpio30/direction').read.chomp)
+    assert_equal(Low, @pin.value)
+    assert_equal("0", File.open('/sys/class/gpio/gpio30/value').read.chomp)
+  end
+  
+  def test_mode
+    @pin.mode = Input
+    assert_equal(Input, @pin.mode)
+    assert_equal("in", File.open('/sys/class/gpio/gpio30/direction').read.chomp)
+    
+    @pin.mode = Output
+    assert_equal(Output, @pin.mode)
+    assert_equal("out", File.open('/sys/class/gpio/gpio30/direction').read.chomp)
+  end
+  
+  def test_value
+    @pin.mode = Output # pin must be configured as Output
+    
+    @pin.value = Low
+    assert_equal(Low, @pin.value)
+    assert_equal("0", File.open('/sys/class/gpio/gpio30/value').read.chomp)
+
+    @pin.value = High
+    assert_equal(High, @pin.value)
+    assert_equal("1", File.open('/sys/class/gpio/gpio30/value').read.chomp)
+  end
+  
+end