bonekit 0.0.2-arm-linux → 0.0.3-arm-linux

data/ext/bonekit/pwm.c

@@ -0,0 +1,235 @@
+/*
+ 
+ pwm.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 "pwm.h"
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <fcntl.h>
+#include <unistd.h>
+#include <string.h>
+#include <sys/types.h>
+#include <dirent.h>
+
+int pwm_enable()
+{
+  int fd;
+  if((fd = open(SLOTS, O_WRONLY)) < 0)
+    return -1;
+
+  const char * am33xx_pwm = "am33xx_pwm";
+  write(fd, am33xx_pwm, strlen(am33xx_pwm));
+  close(fd);
+
+  return 0;
+}
+
+int pwm_enable_pin(const char * pin)
+{
+  if(pwm_enable() < 0) // enable pwm
+    return -1;
+  
+  int fd;
+  if((fd = open(SLOTS, O_WRONLY)) < 0)
+    return -1;
+
+  char bone_pwm_pin[15];
+  snprintf(bone_pwm_pin, 15, "bone_pwm_%s", pin);
+  write(fd, bone_pwm_pin, strlen(bone_pwm_pin)); // enable pwm pin
+  close(fd);
+  
+  return 0;
+}
+
+int pwm_get_key(const char * pin, char ** pwm_key)
+{
+    DIR * dd;
+    struct dirent * df;
+
+    dd = opendir(OCP_DIR);
+    if(dd != NULL) 
+    {
+      while((df = readdir(dd))) 
+      {
+        if(strstr(df->d_name, pin)) 
+        {
+          int pwm_key_len = strlen(df->d_name)+1;
+          *pwm_key = (char *)calloc(pwm_key_len, sizeof(char));
+          snprintf(*pwm_key, pwm_key_len, "%s", df->d_name);
+          closedir(dd);
+          return 0;
+        }
+      }
+      closedir (dd);
+    } 
+    
+    return -1;
+}
+
+int pwm_export(const char * pin, char ** pwm_key)
+{
+  if(pwm_enable_pin(pin) < 0) // enable pin
+    return -1;
+  
+  if(pwm_get_key(pin, pwm_key) < 0) // get key for pin
+    return -1;
+  
+  // Set default values
+  pwm_set_polarity(*pwm_key, PWM_POLARITY);
+  pwm_set_period(*pwm_key, PWM_PERIOD_NS);
+
+  return 0;
+}
+
+int pwm_unexport(char * pwm_key)
+{
+  if(pwm_key == NULL)
+    return -1;
+  
+  // TODO disable pwm for key
+  free(pwm_key);
+  
+  return 0;
+}
+
+int pwm_read(char * pwm_key, const char * filename, char * value, unsigned int length)
+{
+  if(pwm_key == NULL)
+    return -1;
+  
+  int fd, len;
+  char filepath[PWM_LEN];
+  snprintf(filepath, sizeof(filepath), "%s/%s/%s", OCP_DIR, pwm_key, filename);
+  
+  if((fd = open(filepath, O_RDONLY | O_NONBLOCK)) < 0)
+    return -1;
+  
+  lseek(fd, 0, SEEK_SET);
+  
+  read(fd, value, length);
+  sscanf(value, "%s\n", value);
+  close(fd);
+  
+  return 0;
+}
+
+int pwm_write(char * pwm_key, const char * filename, char * value)
+{
+  if(pwm_key == NULL)
+    return -1;
+  
+  int fd;
+  char filepath[PWM_LEN];
+  snprintf(filepath, sizeof(filepath), "%s/%s/%s", OCP_DIR, pwm_key, filename);
+
+  if((fd = open(filepath, O_WRONLY)) < 0)
+    return -1;
+
+  write(fd, value, strlen(value));
+  close(fd);
+
+  return 0;
+}
+
+int pwm_set_polarity(char * pwm_key, int polarity)
+{
+  if(pwm_key == NULL)
+    return -1;
+  
+  char value[PWM_LEN];
+  snprintf(value, PWM_LEN, "%d", polarity);
+  pwm_write(pwm_key, "polarity", value);
+  
+  return 0;
+}
+
+int pwm_get_polarity(char * pwm_key, int * polarity)
+{
+  if(pwm_key == NULL)
+    return -1;
+  
+  char value[PWM_LEN];
+  pwm_read(pwm_key, "polarity", value, PWM_LEN);
+  sscanf(value, "%d", polarity);
+  
+  return 0;
+}
+
+int pwm_set_period(char * pwm_key, unsigned long period)
+{
+  if(pwm_key == NULL)
+    return -1;
+  
+  char value[PWM_LEN];
+  snprintf(value, PWM_LEN, "%lu", period);
+  pwm_write(pwm_key, "period", value);
+}
+
+int pwm_get_period(char * pwm_key, unsigned long * period)
+{
+  if(pwm_key == NULL)
+    return -1;
+  
+  char value[PWM_LEN];
+  pwm_read(pwm_key, "period", value, PWM_LEN);
+  sscanf(value, "%lu", period);
+  
+  return 0;
+}
+
+int pwm_set_duty_cycle(char * pwm_key, double duty_cycle) // duty_cycle interval [0.0..1.0]
+{
+  if(pwm_key == NULL)
+    return -1;
+  
+  if(duty_cycle < 0.0) // Check duty cycle upper bound
+    duty_cycle = 0.0;
+
+  if(duty_cycle > 1.0) // Check duty cycle lower bound
+    duty_cycle = 1.0;
+  
+  char value[PWM_LEN];
+  snprintf(value, PWM_LEN, "%lu", (unsigned long)(duty_cycle * PWM_PERIOD_NS));
+  pwm_write(pwm_key, "duty", value);
+
+  return 0;
+}
+
+int pwm_get_duty_cycle(char * pwm_key, double * duty_cycle)
+{
+  if(pwm_key == NULL)
+    return -1;
+  
+  char value[PWM_LEN];
+  pwm_read(pwm_key, "duty", value, PWM_LEN);
+  unsigned long duty_cycle_ns = 0.0;
+  sscanf(value, "%lu", &duty_cycle_ns);
+  
+  *duty_cycle = (double)(duty_cycle_ns/((double)PWM_PERIOD_NS));
+  
+  return 0;
+}

data/ext/bonekit/pwm.h

@@ -0,0 +1,67 @@
+/*
+ 
+ pwm.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_PWM_H__
+#define BONEKIT_PWM_H__
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+  
+#define OCP_DIR "/sys/devices/ocp.2"
+#define SLOTS "/sys/devices/bone_capemgr.8/slots"
+
+#define PWM_LEN 64
+  
+#define PWM_PERIOD_NS 500000 // nanoseconds
+#define PWM_POLARITY 0 // ...
+
+int pwm_enable();
+int pwm_enable_pin(const char *);
+
+int pwm_get_key(const char *, char **);
+
+int pwm_export(const char *, char **);
+int pwm_unexport(char *);
+
+int pwm_read(char *, const char * , char *, unsigned int);
+int pwm_write(char *, const char *, char *);
+
+int pwm_set_polarity(char *, int);
+int pwm_get_polarity(char *, int *);
+
+int pwm_set_period(char *, unsigned long);
+int pwm_get_period(char *, unsigned long *);
+
+int pwm_set_duty_cycle(char *, double);
+int pwm_get_duty_cycle(char *, double *);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif

data/lib/bonekit/version.rb

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

data/lib/bonekit.rb

@@ -1,9 +1,2 @@
-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
+require 'bonekit/version'
+require 'bonekit/bonekit'

data/spec/pin_spec.rb

@@ -2,11 +2,12 @@ require 'spec_helper'
 
 describe Pin do
   
-  let :pin do
-    Pin.new 30
-  end
-  
   describe "mode" do
+    
+    let :pin do
+      Pin.new P9_13
+    end
+    
     context "when default" do
       it "returns Input" do
         pin.mode.should eq(Input)
@@ -29,6 +30,11 @@ describe Pin do
   end
   
   describe "value" do
+    
+    let :pin do
+      Pin.new P9_11
+    end
+    
     context "when default" do
       it "returns 0" do
         pin.value.should eq(0)
@@ -52,4 +58,38 @@ describe Pin do
       end
     end
   end
+  
+  describe "analog_value" do
+    
+    let :pin do
+      Pin.new P9_39 # AIN
+    end
+    
+    it "returns value between 0.0 and 1.0" do
+      pin.analog_value.should be >= 0.0
+      pin.analog_value.should be <= 1.0
+    end
+  end
+  
+  describe "analog_value=" do
+    
+    let :pin do
+      Pin.new P9_42 # PWM
+    end
+    
+    context "when default" do
+      it "returns 0.0" do
+        pin.analog_value.should eq(0.0)
+      end
+    end
+    
+    context "when set to 1.0" do
+      before(:each) { 
+        pin.analog_value = 1.0
+      }
+      it "returns 1.0" do
+        pin.analog_value.should eq(1.0)
+      end
+    end
+  end
 end

data/test/bonekit-c/beaglebone_test.c

@@ -0,0 +1,26 @@
+#include "../../ext/bonekit/beaglebone.h"
+
+#include <stdio.h>
+
+int main()
+{
+  beaglebone_t p = P9_42;
+  
+  printf("p %s %x\n", p.pin_name, p.pin_mask);
+  
+  char pin_name[PIN_NAME_LEN];
+  int gpio, ain, pwm_mux_mode;
+  
+  beaglebone_pin_name(P9_42, pin_name);
+  gpio = beaglebone_gpio(P9_42);
+  ain = beaglebone_ain(P9_42);
+  pwm_mux_mode = beaglebone_pwm_mux_mode(P9_42);
+  
+  printf("%s %d %d %d\n", pin_name, gpio, ain, pwm_mux_mode);
+  
+  beaglebone_t u = USR1;
+  
+  printf("u %s %x\n", u.pin_name, u.pin_mask);
+  
+  return 0;
+}

data/test/bonekit-c/pin_test.c

@@ -0,0 +1,56 @@
+#include "../../ext/bonekit/pin.h"
+
+#include <stdio.h>
+
+int main()
+{
+  beaglebone_t p = P9_42;
+  
+  pin_t * pin = pin_alloc();
+  pin_init(pin, P9_42);
+  
+  pin_set_analog_value(pin, 1.0);
+  
+  sleep(1);
+  
+  pin_set_analog_value(pin, 0.5);
+  
+  sleep(1);
+  
+  pin_set_analog_value(pin, 0.0);
+  
+  pin_destroy(pin);
+  
+  pin = pin_alloc();
+  pin_init(pin, P9_13);
+  
+  pin_set_mode(pin, OUTPUT);
+  pin_set_value(pin, HIGH);
+  
+  sleep(1);
+  
+  pin_set_value(pin, LOW);
+  
+  sleep(1);
+  
+  pin_set_value(pin, HIGH);
+  
+  sleep(1);
+  
+  pin_destroy(pin);
+  
+  pin = pin_alloc();
+  pin_init(pin, P9_39);
+  
+  printf("analog value %f\n", pin_analog_value(pin));
+  
+  sleep(1);
+  
+  printf("analog value %f\n", pin_analog_value(pin));
+  
+  sleep(1);
+  
+  pin_destroy(pin);
+  
+  return 0;
+}

data/test/unit/pin_adc_test.rb

@@ -0,0 +1,16 @@
+require 'test_helper'
+
+class PinAdcTest < Test::Unit::TestCase
+  
+  def setup
+    @pin = Pin.new P9_39 # AIN 0
+  end
+  
+  def teardown
+  end
+  
+  def test_analog_value
+    assert((@pin.analog_value - (File.open('/sys/bus/iio/devices/iio:device0/in_voltage0_raw').read.chomp.to_f/4095.0)).abs < 0.001)
+  end
+  
+end

data/test/unit/{pin_test.rb → pin_gpio_test.rb}

@@ -1,9 +1,9 @@
 require 'test_helper'
 
-class PinTest < Test::Unit::TestCase
+class PinGpioTest < Test::Unit::TestCase
   
   def setup
-    @pin = Pin.new 30
+    @pin = Pin.new P9_11
   end
   
   def teardown

data/test/unit/pin_pwm_test.rb

@@ -0,0 +1,36 @@
+require 'test_helper'
+
+class PinPwmTest < Test::Unit::TestCase
+  
+  def setup
+    @pin = Pin.new P9_42 # PWM
+  end
+  
+  def teardown
+  end
+  
+  def ocp_pwm_value
+    File.open('/sys/devices/ocp.2/pwm_test_P9_42.14/duty').read.chomp.to_f/File.open('/sys/devices/ocp.2/pwm_test_P9_42.14/period').read.chomp.to_f 
+  end
+  
+  def test_set_analog_value
+    @pin.analog_value = 0.0
+    assert_equal(@pin.analog_value, ocp_pwm_value)
+    
+    @pin.analog_value = 0.5
+    assert_equal(@pin.analog_value, ocp_pwm_value)
+    
+    @pin.analog_value = 1.0
+    assert_equal(@pin.analog_value, ocp_pwm_value)
+    
+    @pin.analog_value = -0.1
+    assert_equal(0.0, @pin.analog_value)
+    assert_equal(0.0, ocp_pwm_value)
+    
+    
+    @pin.analog_value = 1.1
+    assert_equal(1.0, @pin.analog_value)
+    assert_equal(1.0, ocp_pwm_value)
+  end
+  
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bonekit
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: arm-linux
 authors:
 - Luis Laugga
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-23 00:00:00.000000000 Z
+date: 2013-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,16 +44,16 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.9.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.9.1
 - !ruby/object:Gem::Dependency
-  name: rpec
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
@@ -95,6 +95,7 @@ files:
 - Rakefile
 - bonekit.gemspec
 - examples/analog/analog_read.rb
+- examples/analog/fading.rb
 - examples/basics/blink.rb
 - examples/basics/digital_read.rb
 - examples/basics/switch.rb
@@ -115,14 +116,20 @@ files:
 - ext/bonekit/pin.h
 - ext/bonekit/pin_class.c
 - ext/bonekit/pin_class.h
+- ext/bonekit/pwm.c
+- ext/bonekit/pwm.h
 - ext/bonekit/rbinit.c
 - lib/bonekit.rb
 - lib/bonekit/version.rb
 - spec/pin_spec.rb
 - spec/spec_helper.rb
+- test/bonekit-c/beaglebone_test.c
+- test/bonekit-c/pin_test.c
 - test/test_helper.rb
-- test/unit/pin_test.rb
-- lib/bonekit.so
+- test/unit/pin_adc_test.rb
+- test/unit/pin_gpio_test.rb
+- test/unit/pin_pwm_test.rb
+- lib/bonekit/bonekit.so
 homepage: http://laugga.com/bonekit
 licenses:
 - MIT
@@ -150,5 +157,9 @@ summary: Physical interaction toolkit for the beaglebone.
 test_files:
 - spec/pin_spec.rb
 - spec/spec_helper.rb
+- test/bonekit-c/beaglebone_test.c
+- test/bonekit-c/pin_test.c
 - test/test_helper.rb
-- test/unit/pin_test.rb
+- test/unit/pin_adc_test.rb
+- test/unit/pin_gpio_test.rb
+- test/unit/pin_pwm_test.rb