pigpio 0.1.10 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1fa3d31d3fb44ea838005f5a56348e48e5716cbd
-  data.tar.gz: da12abb9a3d79848a8bd90c522b28640332528e2
+SHA256:
+  metadata.gz: ea48e2455183f291ab01d01923f98291d1fc3cbdac8237e0bfb47c6918f1b94d
+  data.tar.gz: 4734cdafc9f127194a972f6fbe366a5c7be1554837d6bd4829ea9ce5ecf56b0f
 SHA512:
-  metadata.gz: 92e28c29a0cc4a88f175d7960ad509356f2aa7b5fd99b6a8a1bf1c03b568ef34ea7df67f17eda4a4bcdaf9f7374095bcd79409ee1931de6f92727637d4bc0c00
-  data.tar.gz: 9b5e95b0514e08aeb557743274958f7c25c446403b16a56140248922c30e87032a0e0010fe0fb25d0e95eec6a59f1cfb7b4c2fc68ea77b0d406299f3bf0c80a4
+  metadata.gz: 86aba3d72fe106c69facc776e655fb6237cbeb2ccb63ee00de8a4e7f5678f14f1dbdd3727b3d48539f6c75e06d61083a2711854d642d6799edf03d82155e3717
+  data.tar.gz: 19750b1ea68bd3fabbe2036fcba8924aded9edcf2e46c0a2fd3bf654d4920006729cdd051ed5cd6886c5affeeea433454968c7b774a6bd4eaba4a437020f7f02

data/.standard_todo.yml

@@ -0,0 +1,51 @@
+# Auto generated files with errors to ignore.
+# Remove from this list as you refactor files.
+---
+ignore:
+- example/e-paper_spi/epd2in13b.rb:
+  - Style/MixinUsage
+- example/loopback/spi.rb:
+  - Style/MixinUsage
+  - Lint/UselessAssignment
+- example/loopback/uart.rb:
+  - Style/MixinUsage
+  - Lint/UselessAssignment
+- example/sharp_memory_display/ls013b7dn05.rb:
+  - Lint/UselessAssignment
+  - Style/SafeNavigation
+  - Style/MixinUsage
+- example/simple/callback.rb:
+  - Style/MixinUsage
+- example/simple/led.rb:
+  - Style/MixinUsage
+- example/simple/pwm.rb:
+  - Style/MixinUsage
+  - Style/InfiniteLoop
+- example/simple/wave.rb:
+  - Style/MixinUsage
+- example/ssd1306_i2c/ssd1306.rb:
+  - Style/MixinUsage
+- lib/pigpio.rb:
+  - Naming/VariableName
+- lib/pigpio/bank.rb:
+  - Naming/ConstantName
+- lib/pigpio/constant.rb:
+  - Naming/ConstantName
+- lib/pigpio/gpio.rb:
+  - Lint/UselessAssignment
+  - Naming/VariableName
+- lib/pigpio/i2c.rb:
+  - Naming/VariableName
+- lib/pigpio/pwm.rb:
+  - Lint/UselessAssignment
+- lib/pigpio/serial.rb:
+  - Naming/ConstantName
+  - Lint/UselessAssignment
+  - Naming/VariableName
+- lib/pigpio/spi.rb:
+  - Naming/VariableName
+- lib/pigpio/user_gpio.rb:
+  - Lint/UselessAssignment
+  - Naming/VariableName
+- spec/ext/extconf.rb:
+  - Style/GlobalVars

data/README.md

@@ -63,7 +63,9 @@ $ ruby example_led.rb
 
 More sample for this circuit. : [Hare](./example/simple/readme.md)
 
-More document : [GitHub Pages](https://nak1114.github.io/ruby-extension-pigpio/)
+More sample for other circuit. : [Hare](./example/readme.md)
+
+More document : [GitHub Pages](https://nak1114.github.io/ruby-extension-pigpio/Pigpio/IF.html)
 
 ## Development
 

data/Rakefile

@@ -9,10 +9,9 @@ end
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec
 
-
-RDOC_FILES = FileList["ext/pigpio/pigpio.c","lib/**/*.rb"]
+RDOC_FILES = FileList["ext/pigpio/pigpio.c", "lib/**/*.rb"]
 
 Rake::RDocTask.new do |rd|
   rd.main = "pigpio.c"
@@ -33,4 +32,4 @@ end
 task :reset do
   sh "git fetch origin"
   sh "git reset --hard origin/master"
-end
+end

data/ext/pigpio/extconf.rb

@@ -1,5 +1,5 @@
-require 'mkmf'
-dir_config('pigpio')
-if find_header('pigpiod_if2.h','/usr/include/') && find_library('pigpiod_if2','gpio_read','/usr/lib/')
-  create_makefile('pigpio/pigpio')
-end
+require "mkmf"
+dir_config("pigpio")
+if find_header("pigpiod_if2.h", "/usr/include/") && find_library("pigpiod_if2", "gpio_read", "/usr/lib/")
+  create_makefile("pigpio/pigpio")
+end

data/ext/pigpio/pigpio.c

@@ -7,6 +7,7 @@
 static VALUE cCallbackID;
 static VALUE cNativeQueue;
 static VALUE cCallbackError;
+static VALUE cBuffer;
 
 typedef struct{
    uint32_t tick;
@@ -2359,18 +2360,16 @@ associated with handle and writes them to buf.
 . .
      pi: >=0 (as returned by [*pigpio_start*]).
  handle: >=0, as returned by a call to [*serial_open*].
-    buf: an array to receive the read data.
   count: the maximum number of bytes to read.
 . .
 
-Returns the number of bytes read (>=0) if OK, otherwise PI_BAD_HANDLE,
+Returns to buf.ret_code attribute the number of bytes read (>=0) if OK, otherwise PI_BAD_HANDLE,
 PI_BAD_PARAM, PI_SER_READ_NO_DATA, or PI_SER_WRITE_FAILED.
 
-If no data is ready zero is returned.
+The received data is get by the buf.to_s method.
 
 :call-seq:
- serial_read(Integer pi,Integer handle, Integer count) -> Integer (When onError)
- serial_read(Integer pi,Integer handle, Integer count) -> String buf (When Success)
+ serial_read(Integer pi,Integer handle, Integer count) -> Pigpio::Buffer buf
 
 See also: {pigpio site}[http://abyz.me.uk/rpi/pigpio/pdif2.html#serial_read]
 */
@@ -2378,7 +2377,9 @@ VALUE pigpio_rbfn_serial_read(VALUE self, VALUE pi, VALUE handle, VALUE count){
   unsigned countc=NUM2UINT(count);
   VALUE buf=rb_str_new("",countc);//#<Encoding:ASCII-8BIT>;
   int ret=serial_read(NUM2INT(pi), NUM2UINT(handle), (void*)StringValuePtr(buf), countc);
-  return (ret < 0)?INT2NUM(ret):rb_str_resize(buf,ret);
+  return rb_funcall((VALUE)cBuffer, rb_intern("new"), 2,INT2NUM(ret),rb_str_resize(buf,ret));
+
+  //return (ret < 0)?INT2NUM(ret):rb_str_resize(buf,ret);
   //if(ret < 0){buf=Qnil;}
   //return rb_ary_new_from_args(2,buf,INT2NUM(ret));
 }
@@ -2436,13 +2437,14 @@ bit bang serial cyclic buffer to the buffer starting at buf.
 . .
         pi: >=0 (as returned by [*pigpio_start*]).
  user_gpio: 0-31, previously opened with [*bb_serial_read_open*].
-       buf: an array to receive the read bytes.
    bufSize: >=0
 . .
 
-Returns the number of bytes copied if OK, otherwise PI_BAD_USER_GPIO
+Returns to buf.ret_code attribute the number of bytes copied if OK, otherwise PI_BAD_USER_GPIO
 or PI_NOT_SERIAL_GPIO.
 
+The received data is get by the buf.to_s method.
+
 The bytes returned for each character depend upon the number of
 data bits [*data_bits*] specified in the [*bb_serial_read_open*] command.
 
@@ -2451,8 +2453,7 @@ data bits [*data_bits*] specified in the [*bb_serial_read_open*] command.
 * For [*data_bits*] 17-32 there will be four bytes per character.
 
 :call-seq:
- bb_serial_read(Integer pi,Integer user_gpio, Integer bufSize) -> Integer (When onError)
- bb_serial_read(Integer pi,Integer user_gpio, Integer bufSize) -> String  (When Success)
+ bb_serial_read(Integer pi,Integer user_gpio, Integer bufSize) -> Pigpio::Buffer buf
 
 See also: {pigpio site}[http://abyz.me.uk/rpi/pigpio/pdif2.html#bb_serial_read]
 */
@@ -2460,7 +2461,8 @@ VALUE pigpio_rbfn_bb_serial_read(VALUE self, VALUE pi, VALUE user_gpio, VALUE bu
   size_t countc=NUM2SIZET(bufSize);
   VALUE buf=rb_str_new("",countc);//#<Encoding:ASCII-8BIT>;
   int ret=bb_serial_read(NUM2INT(pi), NUM2UINT(user_gpio), (void*)StringValuePtr(buf), countc);
-  return (ret < 0)?INT2NUM(ret):rb_str_resize(buf,ret);
+  return rb_funcall((VALUE)cBuffer, rb_intern("new"), 2,INT2NUM(ret),rb_str_resize(buf,ret));
+  //return (ret < 0)?INT2NUM(ret):rb_str_resize(buf,ret);
   //if(ret < 0){buf=Qnil;}
   //return rb_ary_new_from_args(2,buf,INT2NUM(ret));
 }
@@ -3702,9 +3704,6 @@ This class has some constances for pigpio library.
 */
 void Init_pigpio(void){
   VALUE cPulse,cBscXfer,cNativeQueue;
-/*
-This class has some constances for pigpio library.
-*/
   VALUE cPigpio = rb_define_class("Pigpio", rb_cObject);
   /*
   This module is a ruby binding to pigpio library.
@@ -3830,13 +3829,15 @@ This class has some constances for pigpio library.
   /*
   This class wrap gpioPulse_t.
   */
-  cPulse = rb_define_class_under(cPigpio,"Pulse", rb_cData);
+  cPulse = rb_define_class_under(cPigpio,"Pulse", rb_cObject);
+    rb_undef_alloc_func(cPulse);
     rb_define_singleton_method(cPulse, "make", pigpio_rbst_gpioPulse_make, 3);
 
   /*
   This class wrap bsc_xfer_t.
   */
-  cBscXfer = rb_define_class_under(cPigpio,"BscXfer", rb_cData);
+  cBscXfer = rb_define_class_under(cPigpio,"BscXfer", rb_cObject);
+    rb_undef_alloc_func(cBscXfer);
     rb_define_singleton_method(cBscXfer, "make", pigpio_rbst_bsc_xfer_make, 0);
     rb_define_method(cBscXfer, "control=", pigpio_rbst_bsc_xfer_w_control, 1);
     rb_define_method(cBscXfer, "control", pigpio_rbst_bsc_xfer_r_control, 0);
@@ -3848,13 +3849,15 @@ This class has some constances for pigpio library.
   /*
   The class of native queue.
   */
-  cNativeQueue = rb_define_class_under(cAPI,"NativeQueue", rb_cData);
+  cNativeQueue = rb_define_class_under(cAPI,"NativeQueue", rb_cObject);
+    rb_undef_alloc_func(cNativeQueue);
     rb_gc_register_address(&cNativeQueue);
 
   /*
   The class of callback.
   */
-  cCallbackID = rb_define_class_under(cPigpio,"Callback", rb_cData);
+  cCallbackID = rb_define_class_under(cPigpio,"Callback", rb_cObject);
+    rb_undef_alloc_func(cCallbackID);
     rb_define_method(cCallbackID, "id", pigpio_rbst_callback_id_r_id, 0);
     rb_define_method(cCallbackID, "cancel", pigpio_rbst_callback_id_cancel, 0);
     rb_gc_register_address(&cCallbackID);
@@ -3863,5 +3866,13 @@ This class has some constances for pigpio library.
   The class of callback error.
   */
   cCallbackError = rb_define_class_under(cPigpio,"CallbackError", rb_eException);
+    rb_undef_alloc_func(cCallbackError);
     rb_gc_register_address(&cCallbackError);
+
+  /*
+  The class of Rx buffer.
+  */
+  cBuffer = rb_define_class_under(cPigpio,"Buffer", rb_cString);
+    rb_undef_alloc_func(cBuffer);
+    rb_gc_register_address(&cBuffer);
 }

data/lib/pigpio/bank.rb

@@ -1,22 +1,25 @@
-class Pigpio
-  class Bank
-    Set={
-      read:  [:read_bank_1 ,:read_bank_2],
-      clear: [:clear_bank_1,:clear_bank_2],
-      set:   [:set_bank_1  ,:set_bank_2],
-    }
-    def initialize(pi,num)
-      @pi=pi
-      @num=num
-    end
-    def read
-      IF.send(Set[:read][@num],@pi)
-    end
-    def clear(bits)
-      IF.send(Set[:clear][@num],@pi,bits)
-    end
-    def set(bits)
-      IF.send(Set[:set][@num],@pi,bits)
-    end
-  end
-end
+class Pigpio
+  class Bank
+    Set = {
+      read: [:read_bank_1, :read_bank_2],
+      clear: [:clear_bank_1, :clear_bank_2],
+      set: [:set_bank_1, :set_bank_2]
+    }
+    def initialize(pi, num)
+      @pi = pi
+      @num = num
+    end
+
+    def read
+      IF.send(Set[:read][@num], @pi)
+    end
+
+    def clear(bits)
+      IF.send(Set[:clear][@num], @pi, bits)
+    end
+
+    def set(bits)
+      IF.send(Set[:set][@num], @pi, bits)
+    end
+  end
+end

data/lib/pigpio/bit_bang_serial.rb

@@ -1,19 +1,21 @@
-require_relative "./bit_bang_serial_rx"
-require_relative "./bit_bang_serial_tx"
-
-class Pigpio
-  class BitBangSerial < BitBangSerialTx
-    attr_reader :rx
-    def initialize(rx,tx,baud=9600,data_bits=8,stop_bits=1,parity_type=:none)
-      super(tx,baud,data_bits,stop_bits)
-      @rx=BitBangSerialRx.new(rx,baud,data_bits)
-    end
-    def close
-      super
-      @rx.close
-    end
-    def read(bufsize=1)
-      @rx.read(bufsize)
-    end
-  end
-end
+require_relative "./bit_bang_serial_rx"
+require_relative "./bit_bang_serial_tx"
+
+class Pigpio
+  class BitBangSerial < BitBangSerialTx
+    attr_reader :rx
+    def initialize(rx, tx, baud = 9600, data_bits = 8, stop_bits = 1, parity_type = :none)
+      super(tx, baud, data_bits, stop_bits)
+      @rx = BitBangSerialRx.new(rx, baud, data_bits)
+    end
+
+    def close
+      super
+      @rx.close
+    end
+
+    def read(bufsize = 1)
+      @rx.read(bufsize)
+    end
+  end
+end

data/lib/pigpio/bit_bang_serial_rx.rb

@@ -1,19 +1,70 @@
-class Pigpio
-  class BitBangSerialRx
-    attr_reader :rx
-    def initialize(rx,baud=9600,data_bits=8)
-      @rx=rx
-      IF.bb_serial_read_open(@rx.pi,@rx.gpio,baud,data_bits)
-      IF.bb_serial_invert(@rx.pi,@rx.gpio,0)
-    end
-    def close
-      IF.bb_serial_read_close(@rx.pi,@rx.gpio)
-    end
-    def read(bufsize=1)
-      IF.bb_serial_read(@rx.pi,@rx.gpio,bufsize)
-    end
-    def invert(invert=1)
-      IF.bb_serial_invert(@rx.pi,@rx.gpio,invert)
-    end
-  end
-end
+class Pigpio
+  # Set a UserGPIO pin as a serial Rx.
+  class BitBangSerialRx
+    # UserGPIO#.
+    #
+    # This attribute is set at the time of ::new.
+    attr_reader :rx
+
+    # Set 0 if OK, otherwise PI_BAD_USER_GPIO, PI_BAD_WAVE_BAUD, PI_GPIO_IN_USE, PI_NOT_SERIAL_GPIO or PI_BAD_SER_INVERT.
+    #
+    # This attribute is set at the time of ::new.
+    attr_reader :valid
+
+    # Set a UserGPIO pin as a serial Rx.
+    #
+    # The serial data recieves in a internal cyclic buffer and is read using #read method.
+    # It is the caller's responsibility to read data from the cyclic buffer in a timely fashion.
+    #
+    # [Parameter]
+    #  [rx [ Pigpio::UserGPIO ]] Set This pgio as a serial Rx.
+    #  [baud [ Integer ]] 50-250000 [bps]. default 9600.
+    #  [data_bits [ Integer ]] 1-32 [bit/word]. default 8.
+    #
+    # See also: {pigpio site}[http://abyz.me.uk/rpi/pigpio/pdif2.html#bb_serial_read_open]
+    def initialize(rx, baud = 9600, data_bits = 8)
+      @rx = rx
+      @valid = IF.bb_serial_read_open(@rx.pi, @rx.gpio, baud, data_bits)
+      if @valid == 0
+        @valid = IF.bb_serial_invert(@rx.pi, @rx.gpio, 0)
+      end
+    end
+
+    # This method closes a GPIO for bit bang reading of serial data.
+    #
+    # [Return] [Integer] Returns 0 if OK, otherwise PI_BAD_USER_GPIO, or PI_NOT_SERIAL_GPIO.
+    #
+    # See also: {pigpio site}[http://abyz.me.uk/rpi/pigpio/pdif2.html#bb_serial_read_close]
+    def close
+      IF.bb_serial_read_close(@rx.pi, @rx.gpio)
+    end
+
+    # This method copies up to bufSize bytes of data read from the bit bang serial cyclic buffer to the buffer starting at returned value.
+    #
+    # [Parameter] [bufSize [ Integer ]] How many bytes receive.
+    # [Return] [ Pigpio::Buffer ] A copied buffer and status.
+    #
+    # The details of the returned status is the number of bytes copied if OK, otherwise PI_BAD_USER_GPIO or PI_NOT_SERIAL_GPIO.
+    #
+    # The bytes returned for each character depend upon the number of data bits +data_bits+ specified in the ::new method.
+    #
+    # * For +data_bits+ 1-8 there will be one byte per character.
+    # * For +data_bits+ 9-16 there will be two bytes per character.
+    # * For +data_bits+ 17-32 there will be four bytes per character.
+    #
+    # See also: {pigpio site}[http://abyz.me.uk/rpi/pigpio/pdif2.html#bb_serial_read]
+    def read(bufsize = 1)
+      IF.bb_serial_read(@rx.pi, @rx.gpio, bufsize)
+    end
+
+    # This method inverts serial logic for big bang serial reads.
+    #
+    # [Parameter] [Integer] invert 0-1.1 invert, 0 normal.
+    # [Return] [Integer] Returns 0 if OK, otherwise PI_NOT_SERIAL_GPIO or PI_BAD_SER_INVERT.
+    #
+    # See also: {pigpio site}[http://abyz.me.uk/rpi/pigpio/pdif2.html#bb_serial_invert]
+    def invert(invert = 1)
+      IF.bb_serial_invert(@rx.pi, @rx.gpio, invert)
+    end
+  end
+end

data/lib/pigpio/bit_bang_serial_tx.rb

@@ -1,41 +1,47 @@
-class Pigpio
-  class BitBangSerialTx
-    attr_reader :tx
-    def initialize(tx,baud=9600,data_bits=8,stop_bits=1)
-      @tx=tx
-      @baud=baud
-      @data_bits=data_bits
-      @stop_half_bits=(stop_bits*2).round.to_i
-    end
-    def close
-      IF.wave_tx_stop(@tx.pi) if busy?
-      IF.wave_clear(@tx.pi)
-    end
-    def write(buf)
-      IF.wave_clear(@tx.pi)
-      IF.wave_add_new(@tx.pi)
-      ret=IF.wave_add_serial(@tx.pi,@tx.gpio,@baud,@data_bits,@stop_half_bits,0,buf)
-      return ret if ret < 0
-      wid=IF.wave_create(@tx.pi)
-      return wid if wid < 0
-      IF.wave_send_once(@tx.pi,wid)
-    end
-    def sync
-      while busy?
-        sleep 0.1
-      end
-    end
-    def write_sync(buf)
-      ret=write(buf)
-      return ret if ret < 0
-      sync
-      IF.wave_clear(@tx.pi)
-    end
-    def busy?
-      IF.wave_tx_busy(@tx.pi)
-    end
-    def stop
-      IF.wave_tx_stop(@tx.pi)
-    end
-  end
-end
+class Pigpio
+  class BitBangSerialTx
+    attr_reader :tx
+    def initialize(tx, baud = 9600, data_bits = 8, stop_bits = 1)
+      @tx = tx
+      @baud = baud
+      @data_bits = data_bits
+      @stop_half_bits = (stop_bits * 2).round.to_i
+    end
+
+    def close
+      IF.wave_tx_stop(@tx.pi) if busy?
+      IF.wave_clear(@tx.pi)
+    end
+
+    def write(buf)
+      IF.wave_clear(@tx.pi)
+      IF.wave_add_new(@tx.pi)
+      ret = IF.wave_add_serial(@tx.pi, @tx.gpio, @baud, @data_bits, @stop_half_bits, 0, buf)
+      return ret if ret < 0
+      wid = IF.wave_create(@tx.pi)
+      return wid if wid < 0
+      IF.wave_send_once(@tx.pi, wid)
+    end
+
+    def sync
+      while busy?
+        sleep 0.1
+      end
+    end
+
+    def write_sync(buf)
+      ret = write(buf)
+      return ret if ret < 0
+      sync
+      IF.wave_clear(@tx.pi)
+    end
+
+    def busy?
+      IF.wave_tx_busy(@tx.pi)
+    end
+
+    def stop
+      IF.wave_tx_stop(@tx.pi)
+    end
+  end
+end

data/lib/pigpio/buffer.rb

@@ -0,0 +1,13 @@
+class Pigpio
+  class Buffer < String
+    attr_reader :ret_code
+    def initialize(ret_code, str = nil)
+      super(str)
+      @ret_code = ret_code
+    end
+
+    def valid?
+      @ret_code >= 0
+    end
+  end
+end