piface 0.4 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 62414175fab73d83fa196972a27b8178bc4646af
-  data.tar.gz: 85b434904389380c0574cc7023037eeaec645fdd
+  metadata.gz: 0e5ef9896d5b037df0557be6dc961b426d9c4c23
+  data.tar.gz: 508b965d1458584719adf2f8481af7d46f7d8b02
 SHA512:
-  metadata.gz: 4559d83b88665b759c2de81849bf859e9733bdd80551dbafc54662d7b9587c3348eb7e6f5ccb54d6b2468fe3c48cc5e940001ef9651ec9c9843db727d2d571b5
-  data.tar.gz: 4f1dea3ef063bdb39ef88d70bc1a215ff06a4cbb4e46fdcdf83940b2696c4304ce00c71614b629748c0ae35b42045124167d0b971b040e82b2508421a702169a
+  metadata.gz: 5dff8cdda631a359f9662283a243f23abf244d7bad78cb0e8db4988213fb6600e52d44f99c813e9491ce080773df48ffd6abbb1a522c113fb81f9b04dcd01df2
+  data.tar.gz: 32cb149d20cbed53f14653ccc570dc0b927dc83d6e7261c3e588965f4d13c7f9a0913f69e4abcc65ff95f72d8600cfe374c5f9ecb780d260a6d557d46e2a8e34

data/CHANGELOG.md

@@ -3,12 +3,13 @@
 ## Upcoming v1.0
  - Interrupts (change, high, low)
 
-## v0.4.beta
+## v0.4
  - update ffi runtime dependancy to ~> v1.7
  - updated README.md
  - added pfio C library as gem extension
  - updated pfio C library to allow optional pin setup (false by default)
  - fixed deinit bug
+ - added ruby examples
 
 ## v0.31
  - updated the ffi load paths (bugfix for issue #1)

data/README.md

@@ -109,18 +109,6 @@ end
 
 ## Advanced Usage
 
-### Piface Initialization
-By requiring the gem, your Piface will automatically be initialized. By default, your pins will not be reset and will remain in the existing state. This is useful when running multiple scripts and you don't want to reset the outputs (turning them all off). If you want to setup the pins you can do so by calling the `init` method with `true`.
-```ruby
-require 'piface'
-
-# Initialize the piface (without setting up the pins)
-Piface.init # same as Piface.init(false)
-
-# Initialize Piface and setup the pins
-Piface.init(true)
-```
-
 ### Reading Output
 If you need to check whether or not an output is active, you can easily read an output state with the `read_output` method.
 ```ruby
@@ -153,17 +141,22 @@ class Relay
     Piface.write @relay_number, 0
   end
 
+  def state
+    Piface.read_output(@relay_number)
+  end
+
   def toggle
-    Piface.write @relay_number, Piface.read_output(1) ^ 1
+    new_state = state ^ 1
+    Piface.write @relay_number, new_state
   end
 end
 
 relay2 = Relay.new(2)
-relay.toggle # toggle the light without using a stored state
+relay2.toggle # toggle the light without using a stored state
 ```
 
 ## Examples
-For more examples, check out the `example` directory.
+For more examples, check out the `examples` directory.
 * led
 * pir sensor
 * relay (same as stateless relay)

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/examples/relay.rb

@@ -26,4 +26,4 @@ class Relay
 end
 
 relay2 = Relay.new(2)
-relay.toggle # toggle the light without using a stored state
+relay2.toggle # toggle the light without using a stored state

data/ext/piface/pfio.c

@@ -4,8 +4,6 @@
  */
 #include "pfio.h"
 
-#undef VERBOSE_MODE
-
 static Spi * spi;
 
 static void spi_transfer(char * txbuffer, char * rxbuffer);
@@ -13,8 +11,7 @@ static void spi_write(char port, char value);
 static char spi_read(char port);
 
 
-// char pfio_init(void)
-char pfio_init(bool setup_pins)
+char pfio_init(void)
 {
     if ((spi = malloc(sizeof(Spi))) == NULL)
         return -1;
@@ -61,21 +58,16 @@ char pfio_init(bool setup_pins)
     }
     spi->maxspeed = maxspeed;
 
-    if (setup_pins == true) {
-        // set up some ports
-        spi_write(IOCON,  8);    // enable hardware addressing
-        spi_write(IODIRA, 0);    // set port A as outputs
-        spi_write(IODIRB, 0xFF); // set port B as inputs
-        spi_write(GPIOA,  0xFF); // set port A on
-        //spi_write(GPIOB,  0xFF); // set port B on
-        spi_write(GPPUA,  0xFF); // set port A pullups on
-        spi_write(GPPUB,  0xFF); // set port B pullups on
-
-        // initialise all outputs to 0
-        int i;
-        for (i = 1; i <= 8; i++)
-            pfio_digital_write(i, 0);
-    }
+    spi_write(IOCON,  8);    // enable hardware addressing
+    spi_write(GPIOA,  0x00); // turn on port A
+    spi_write(IODIRA, 0);    // set port A as an output
+    spi_write(IODIRB, 0xFF); // set port B as an input
+    spi_write(GPPUB,  0xFF); // turn on port B pullups
+
+    // initialise all outputs to 0
+    int i;
+    for (i = 1; i <= 8; i++)
+        pfio_digital_write(i, 0);
 
     return 0;
 }
@@ -105,20 +97,13 @@ void pfio_digital_write(char pin_number, char value)
     else
         new_pin_values = old_pin_values & ~pin_bit_mask;
 
-#ifdef VERBOSE_MODE
-    printf("digital_write: pin number %d, value %d\n", pin_number, value);
-    printf("pin bit mask: 0x%x\n", pin_bit_mask);
-    printf("old pin values: 0x%x\n", old_pin_values);
-    printf("new pin values: 0x%x\n", new_pin_values);
-    printf("\n");
-#endif
-
     pfio_write_output(new_pin_values);
 }
 
 char pfio_read_input(void)
 {
-    return spi_read(INPUT_PORT);
+    // inverse read values (0 is off, 1 is on), due to pullups
+    return spi_read(INPUT_PORT) ^ 0xFF; //!!! UPDATE DOCUMENTATION
 }
 
 char pfio_read_output(void)
@@ -126,23 +111,57 @@ char pfio_read_output(void)
     return spi_read(OUTPUT_PORT);
 }
 
+// char pfio_read_output_pin(char pin_number)
+// {
+//     return
+// }
+
 void pfio_write_output(char value)
 {
     spi_write(OUTPUT_PORT, value);
 }
 
+void pfio_input_pullup(char pin_number, char value)
+{
+    char pin_bit_mask = pfio_get_pin_bit_mask(pin_number);
+    char old_pin_values = spi_read(INPUT_PULLUP_PORT);
+
+    char new_pin_values;
+    if (value > 0)
+        new_pin_values = old_pin_values | pin_bit_mask;
+    else
+        new_pin_values = old_pin_values & ~pin_bit_mask;
+
+    spi_write(INPUT_PULLUP_PORT, new_pin_values);
+}
+
+// void pfio_output_pullup(char pin_number, char value)
+// {
+//     char pin_bit_mask = pfio_get_pin_bit_mask(pin_number);
+//     char old_pin_values = spi_read(OUTPUT_PULLUP_PORT);
+
+//     char new_pin_values;
+//     if (value > 0)
+//         new_pin_values = old_pin_values | pin_bit_mask;
+//     else
+//         new_pin_values = old_pin_values & ~pin_bit_mask;
+
+//     spi_write(OUTPUT_PULLUP_PORT, new_pin_values);
+// }
+
 char pfio_get_pin_bit_mask(char pin_number)
 {
-    return 1 << (pin_number-1);
+    // changed interface to use 0-8
+    return 1 << pin_number;
 }
 
 char pfio_get_pin_number(char bit_pattern)
 {
-    char pin_number = 1; // assume pin 1
+    char pin_number = 0; // assume pin 0
     while ((bit_pattern & 1) == 0)
     {
         bit_pattern >>= 1;
-        if (++pin_number > 8)
+        if (++pin_number > 7)
         {
             pin_number = 0;
             break;
@@ -151,7 +170,6 @@ char pfio_get_pin_number(char bit_pattern)
     return pin_number;
 }
 
-
 static void spi_transfer(char * txbuffer, char * rxbuffer)
 {
     // set up some transfer information

data/ext/piface/pfio.h

@@ -34,6 +34,8 @@
 #define GPPUB  0x0D // port B pullups
 #define OUTPUT_PORT GPIOA
 #define INPUT_PORT  GPIOB
+#define OUTPUT_PULLUP_PORT GPPUA
+#define INPUT_PULLUP_PORT GPIOB
 
 #define ARRAY_SIZE(a) (sizeof(a) / sizeof((a)[0]))
 
@@ -49,15 +51,18 @@ typedef struct
 typedef enum { false, true } bool;
 
 // extern char pfio_init(void);
-extern char pfio_init(bool setup_pins);
+extern char pfio_init(void);
 extern char pfio_deinit(void);
 extern char pfio_digital_read(char pin_number);
 extern void pfio_digital_write(char pin_number, char value);
 extern char pfio_read_input(void);
 extern char pfio_read_output(void);
+// extern char pfio_read_output_pin(char pin_number);
 extern void pfio_write_output(char value);
 extern char pfio_get_pin_bit_mask(char pin_number);
 extern char pfio_get_pin_number(char bit_mask);
+extern void pfio_input_pullup(char pin_number, char value);
+extern void pfio_output_pullup(char pin_number, char value);
 
 /*
 static void spi_transfer(char * txbuffer, char * rxbuffer);

data/lib/piface.rb

@@ -2,47 +2,83 @@ require "piface/version"
 require "piface/native"
 
 module Piface
+  # extend Forwardable
+
+  # def_delegator Native, :pfio_digital_read, :read
+  # def_delegator Native, :pfio_digital_write, :write
+  # def_delegator Native, :pfio_deinit, :deinit
+  # may need to be in quotes
+
   LOW  = 0
   HIGH = 1
 
+  # DEPRECIATE
   def self.read(pin_number)
     Native.pfio_digital_read(pin_number)
   end
+  # alias :[] :read
 
+  # DEPRECIATE
   def self.write(pin_number, value)
     Native.pfio_digital_write(pin_number, value)
   end
+  # alias :[]= :write
 
-  def self.read_input(pin_number)
-    current_state = Native.pfio_read_input
-    pin_state(current_state, pin_number)
-  end
+  # def self.read_input(pin_number)
+  #   current_state = Native.pfio_read_input
+  #   pin_state(current_state, pin_number)
+  # end
 
   def self.read_output(pin_number)
+    # Native.pfio_read_output_pin(pin_number)
     current_state = Native.pfio_read_output
     pin_state(current_state, pin_number)
   end
 
-  private
-  def self.init(setup_pins = false)
-    Native.pfio_init(setup_pins)
+  def self.init
+    # begin
+      # Native.pfio_init(setup_pins)
+    # rescue LoadError
+    #
+      exit "Error: Piface initialisation failed." unless Native.pfio_init == 0
+    # end
   end
 
+  # def set_pullup(pin_number, value)
+    #
+  # end
+
+  # DEPRECIATE
   def self.deinit
     Native.pfio_deinit
   end
 
+  # Native.pfio_get_pin_bit_mask pin_number
+  # DEPRECIATE
   def self.pin_number_to_flag(pin_number)
-    2**(pin_number - 1)
+    # Native.pfio_get_pin_bit_mask(pin_number)
+    2**(pin_number - 1) #!!! still need the - 1?
   end
 
+  # DEPRECIATE
+  # Native.pfio_get_pin_number bit_mask
   def self.flag_active?(mask, pin_number)
-    mask & pin_number_to_flag(pin_number) > 0
+    # char pfio_digital_read(char pin_number)
+    # {
+    #     char current_pin_values = pfio_read_input();
+    #     char pin_bit_mask = pfio_get_pin_bit_mask(pin_number);
+    #     return (current_pin_values & pin_bit_mask) > 0;
+    # }
+    # mask & pin_number_to_flag(pin_number) > 0
+    mask & pin_number_to_flag(pin_number) == pin_number
   end
 
+  # DEPRECIATE
   def self.pin_state(mask, pin_number)
     flag_active?(mask, pin_number) ? HIGH : LOW
   end
+
+  # module_function :read, :write, :[], :[]=
 end
 
 at_exit { Piface.deinit }

data/lib/piface/native.rb

@@ -5,18 +5,28 @@ module Piface
     extend FFI::Library
     ffi_lib File.expand_path("../pfio.so", __FILE__)
 
-    attach_function :pfio_init, [ :bool ], :char
+    typedef :bool, :setup_pins
+    typedef :char, :pin_number
+    typedef :char, :pin_value
+    typedef :char, :pullup_value
+    typedef :char, :bit_mask
+
+    attach_function :pfio_init, [], :char
     attach_function :pfio_deinit, [], :char
 
-    attach_function :pfio_digital_read, [ :char ], :char
-    attach_function :pfio_digital_write, [ :char, :char ], :void
+    attach_function :pfio_digital_read, [ :pin_number ], :pin_value
+    attach_function :pfio_digital_write, [ :pin_number, :pin_value ], :void
+
+    attach_function :pfio_read_input, [], :bit_mask
+    attach_function :pfio_read_output, [], :bit_mask
+    # attach_function :pfio_read_output_pin, [ :char ], :char
 
-    attach_function :pfio_read_input, [], :char
-    attach_function :pfio_read_output, [], :char
+    # attach_function :pfio_write_output, [ :bit_mask ], :void
 
-    # attach_function :pfio_write_output, [ :char ], :void
+    attach_function :pfio_input_pullup, [ :pin_number, :pullup_value ], :void
+    # attach_function :pfio_output_pullup, [ :pin_number, :pullup_value ], :void
 
-    attach_function :pfio_get_pin_bit_mask, [ :char ], :char
-    attach_function :pfio_get_pin_number, [ :char ], :char
+    attach_function :pfio_get_pin_bit_mask, [ :pin_value ], :bit_mask
+    attach_function :pfio_get_pin_number, [ :bit_mask ], :pin_value
   end
 end

data/lib/piface/version.rb

@@ -1,3 +1,3 @@
 module Piface
-  VERSION = "0.4"
+  VERSION = "0.4.1"
 end

data/piface.gemspec

@@ -14,11 +14,13 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
+  spec.test_files    = Dir.glob("spec/**/*.rb")
   spec.extensions    = ['ext/piface/extconf.rb']
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec', '~> 2.13'
 
   spec.add_dependency "ffi", "~> 1.7"
 end

data/spec/piface_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Piface do
+  # init
+  # deinit
+  # write
+  # read
+  # read_output
+  # pin_number_to_flag
+  # flag_active?
+  # pin_state
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'bundler/setup'
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: piface
 version: !ruby/object:Gem::Version
-  version: '0.4'
+  version: 0.4.1
 platform: ruby
 authors:
 - Blake Jakopovic
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-13 00:00:00.000000000 Z
+date: 2013-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
 - !ruby/object:Gem::Dependency
   name: ffi
   requirement: !ruby/object:Gem::Requirement
@@ -77,6 +91,8 @@ files:
 - lib/piface/native.rb
 - lib/piface/version.rb
 - piface.gemspec
+- spec/piface_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/blakejakopovic/piface
 licenses:
 - MIT
@@ -102,5 +118,7 @@ signing_key:
 specification_version: 4
 summary: Ruby Bindings for the pfio.c C Library for use with the PiFace Digital extension
   board and your Raspberry Pi
-test_files: []
+test_files:
+- spec/piface_spec.rb
+- spec/spec_helper.rb
 has_rdoc: