sunxi_gpio 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 41a03541797f88a175d5cfb495246278d7c012ee
-  data.tar.gz: 9ed2b04036c93156d325b05936fc923c67453245
+  metadata.gz: b8bea316b90fd80539ea4cf858e05e127c42627a
+  data.tar.gz: 17a8bc451e22a595f6542816689e3564ef6ea8c3
 SHA512:
-  metadata.gz: 6764feff02419af5495fecfca88a5667fbdcb714d58143b908e9ac49e484fefe152f4cbf04b579092dd0aa8858e115a98b1e44eca14457c6ac9d5d4ba6327ad2
-  data.tar.gz: a4d1e92da324fd02a96df7a6c701795eae84a03e75fd20961684f4a354cdc02438a746dc4025e181731356e8c81f5bfb0927e686cf294ae9350e2832bc116b04
+  metadata.gz: 5524fe503a759f13dce9f30c3727ea5773e59810e1fb637d20e687a1af2d5ac9a546d8f27e91389787b50288c3e863c798a3ff30539a751c83276402440bee96
+  data.tar.gz: 1900d7d6970e4f86c12cea69abd332f357684c8515e30b58d8fca3e5626cbf7b74d1f3bbceee8eb883b785d7acbd6f45d5cdf9088a26955421c9bce42715af89

data/README.md

@@ -19,12 +19,14 @@ gem install sunxi_gpio
 ```ruby
 require 'sunxi_gpio/pin'
 
-Sunxi::GPIO.open
+SunxiGPIO::Pin.open
+
 pin = SunxiGPIO::Pin.new(pin: :PB2, direction: :out)
 pin.on
 sleep 1
 pin.off
-Sunxi::GPIO.close
+
+SunxiGPIO::Pin.close
 ```
 
 ### Simple reading
@@ -32,7 +34,8 @@ Sunxi::GPIO.close
 ```ruby
 require 'sunxi_gpio/pin'
 
-Sunxi::GPIO.open
+SunxiGPIO::Pin.open
+
 pin = SunxiGPIO::Pin.new(pin: :PB2, direction: :in)
 
 10.times do
@@ -40,22 +43,39 @@ pin = SunxiGPIO::Pin.new(pin: :PB2, direction: :in)
   puts "result: #{value}"
   sleep 1
 end
-```
 
+SunxiGPIO::Pin.close
+```
 
-### Watching
+### Watch
+Watches the pin going to status in parameter and executes the block. 
+Block will only be triggered with a status change is seen.
 
 ```ruby
 require 'sunxi_gpio/pin'
 
-Sunxi::GPIO.open
+SunxiGPIO::Pin.open
+
 pin = SunxiGPIO::Pin.new(pin: :PB2, direction: :out)
 
-pin.watch do
-  puts "Pin changed from #{last_value} to #{value}"
+pin.watch(SunxiGPIO::PinValues::GPIO_LOW) do
+  puts "I am in the loop with value #{pin.read}"
 end
 
-Sunxi::GPIO.close
+SunxiGPIO::Pin.close
+
+```
+### Enable pull for a pin
+When using pins as input, you can use internal resistors to pull the pin up or pull down. This is important if you use open-collector sensors
+which have floating output in some states. Pull can be used as :up or :down -depending of the type of layout.
+
+```ruby
+SunxiGPIO::Pin.open
+
+pin = SunxiGPIO::Pin.new(pin: :PI15, direction: :in, pull: :up)
+value=pin.read
+
+SunxiGPIO::Pin.close
 ```
 
 

data/ext/sunxi_gpio/gpio_lib.c

@@ -148,7 +148,7 @@ int sunxi_gpio_input(unsigned int pin) {
     return (dat & 0x1);
 }
 
-// http://www.cubieforums.com/index.php?topic=2881.15
+// https://github.com/akarnaukh/gpio_lib_A20
 int sunxi_gpio_set_pull(unsigned int pin, unsigned int val) {
     unsigned int pull;
     unsigned int bank = GPIO_BANK(pin);

data/ext/sunxi_gpio/gpio_lib.h

@@ -58,6 +58,9 @@ struct sunxi_gpio_reg {
 #define GPIO_PULL_INDEX(pin)	(((pin) & 0x1F) >> 4)
 #define GPIO_PULL_OFFSET(pin)	((((pin) & 0x1F) & 0xf) << 1)
 
+#define SUNXI_GPIO_PULL_DISABLE 0
+#define SUNXI_GPIO_PULL_UP 1
+#define SUNXI_GPIO_PULL_DOVN 2
 
 /* GPIO bank sizes */
 #define SUNXI_GPIO_A_NR		(32)

data/lib/sunxi_gpio/pin.rb

@@ -66,7 +66,7 @@ module SunxiGPIO
       @value = invert ? (val ^ 1) : val
     end
 
-    
+    #
     def pull!(state)
       return nil if @direction != :in
       
@@ -82,8 +82,7 @@ module SunxiGPIO
                   nil
               end
       
-      #### Not working yet
-      # ::Gpio_lib.sunxi_gpio_set_pull(@pin, @pull) if @pull
+      ::Gpio_lib.sunxi_gpio_set_pull(@pin, @pull) if @pull
       @pull
     end
 

data/lib/sunxi_gpio/pin_values.rb

@@ -8,8 +8,8 @@ module SunxiGPIO
     ]
 
     GPIO_PUD_OFF = 0
-    GPIO_PUD_DOWN = 1
-    GPIO_PUD_UP = 2
+    GPIO_PUD_DOWN = 2
+    GPIO_PUD_UP = 1
 
     GPIO_HIGH = 1
     GPIO_LOW = 0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sunxi_gpio
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - phortx