ffi-wiring_pi 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 962f843bea2e0dccefa8fd5cb8faebafe8068db826ab30ec9b54e0caaab2ed45
-  data.tar.gz: a5d1ae87d2b9a000f6eb3245cef96b5d71d749eaaa1031eab2ddaef9d900d0bd
+  metadata.gz: 96d67497059bd425b34843259199031c0945ffa4ea239af8c7a5a4dd61ab23e6
+  data.tar.gz: e85e81abfca1d648175cde24b841f9a1be6e25df7ff6b99ef5a575ab6db3dd4c
 SHA512:
-  metadata.gz: da5c71679617596f1599c0ca72ca0e51aecefc52129bb14fd620378faac05c31427a592876aac3e2a00507eac7ac91890e41549fdff05b9e84e9ca3ef406194f
-  data.tar.gz: 246476b43969217116ebb6812a28153119c025186f1a1da99e7856f7e6f12303fea92b77aa442e3e6c5a82d49e8460bf8e7bfa325e35492ebe8bb04b4ce38b70
+  metadata.gz: 6d0381b71c738cf6342da8bcde90403d9dc7c2a3485dbfd7ee284e706b9f94c79e55cc723e220ed955934c6269085e058d238a0614dd271b42664963b4f1895a
+  data.tar.gz: 693a22b26b22d46b4c4229e95c6f2b3981a47436eb01b5007e4d495292e661ad89dc6774c7d727ea83d679658ebebf749841d926ed36f269fef532f14b0d7adc

data/ChangeLog.md

@@ -0,0 +1,2 @@
+# 0.2.0 Added PWM pin control functions
+# 0.1.0 Added GPIO basic functions: read and write

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ffi-wiring_pi (0.1.0)
+    ffi-wiring_pi (0.1.6)
       ffi (~> 1.0)
 
 GEM
@@ -28,6 +28,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  bundler (~> 2.0)
   ffi-wiring_pi!
   rspec (~> 3.8)
   yard (~> 0.9.1)

data/README.md

@@ -1,5 +1,7 @@
 # ffi-wiring-pi
 
+[![Gem Version](https://badge.fury.io/rb/ffi-wiring_pi.svg)](https://badge.fury.io/rb/ffi-wiring_pi)[![Build Status](https://travis-ci.org/vimutter/ffi-wiring_pi.svg?branch=master)](https://travis-ci.org/vimutter/ffi-wiring_pi)
+
 * [Source](https://github.com/vimutter/ffi-wiring_pi/)
 * [Issues](https://github.com/vimutter/ffi-wiring_pi/issues)
 
@@ -27,6 +29,17 @@ Setup GPIO:
     pin = FFI::WiringPi::GPIO.get(0)
     pin.up!
 
+    # Or
+
+    extend FFI::WiringPi::GPIO
+
+    setup
+    pin = get 0
+    pin.up!
+
+    pin2 = get 1, INPUT
+    p pin2.value
+
 ## Requirements
 
 * [Ruby](http://ruby-lang.org/) >= 2.6.1 or
@@ -41,4 +54,4 @@ Setup GPIO:
 
 Copyright (c) 2019 Mark Huk
 
-See {file:LICENSE.txt} for license information.
+See [Licence](LICENSE.txt) for license information.

data/gemspec.yml

@@ -1,5 +1,5 @@
 name: ffi-wiring_pi
-version: 0.1.6
+version: 0.2.0
 summary: FFI bindings for wiringPi
 description: Ruby FFI bindings for the wiringPi library.
 license: MIT
@@ -16,3 +16,4 @@ dependencies:
 development_dependencies:
   rspec: ~> 3.8
   yard: ~> 0.9.1
+  bundler: ~> 2.0

data/lib/ffi/wiring_pi/gpio.rb

@@ -105,6 +105,44 @@ module FFI::WiringPi::GPIO
     end
   end
 
+  # @param pin [Integer] pin position (depends on setup mode)
+  # @param value [Integer] 0-1023
+  attach_function :pwm_write, :pwmWrite, [:int, :int], :void
+
+  # This writes the 8-bit byte supplied to the first 8 GPIO pins.
+  # It’s the fastest way to set all 8 bits at once to a particular value,
+  # although it still takes two write operations to the Pi’s GPIO hardware.
+  # @param pin [Integer] pin position (depends on setup mode)
+  # @param value [Integer] 0-1023
+  attach_function :digital_write_byte, :digitalWriteByte, [:int], :void
+
+  def self.batch_write(boolean_array)
+    digital_write_byte boolean_array.each_with_index.sum { |bit, i| (bit ? 1 : 0 ) << i }
+  end
+
+  # The PWM generator can run in 2 modes – :balanced and :mark_space
+  # The :mark_space mode is traditional, however the default mode in the Pi is :balanced.
+  # @param value [Integer] PWM_MODE_BAL or PWM_MODE_MS
+  attach_function :pwm_set_mode, :pwmSetMode, [:int], :void
+
+  def self.pwm_mode(mode = :balanced)
+    raise ArgumentError("mode is invalid: #{mode.inspect}") unless mode.in?([:balanced, :mark_space])
+    pwm_set_mode mode == :balanced ? PWM_MODE_BAL : PWM_MODE_MS
+  end
+
+  # This sets the range register in the PWM generator. The default is 1024.
+  # @param value [Integer]
+  attach_function :pwm_set_range, :pwmSetRange, [:uint], :void
+
+  def self.pwm_range(range = 1024)
+    raise ArgumentError("range is invalid: #{range.inspect}") unless range.is_a?(Integer) && range >= 0
+    pwm_set_range range
+  end
+
+  # This sets the divisor for the PWM clock.
+  # @param value [Integer]
+  attach_function :pwm_set_clock, :pwmSetClock, [:int], :void
+
   class Pin
     def initialize(position, mode)
       @position = position
@@ -120,5 +158,10 @@ module FFI::WiringPi::GPIO
       raise ArgumentError('Can only set in OUTPUT mode') && return unless @mode == FFI::WiringPi::GPIO::OUTPUT
       FFI::WiringPi::GPIO.down(@position)
     end
+
+    def value
+      raise ArgumentError('Can only set in INPUT mode') && return unless @mode == FFI::WiringPi::GPIO::INPUT
+      FFI::WiringPi::GPIO.read(@position)
+    end
   end
 end

data/spec/ffi/wiring_pi/gpio_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+RSpec.describe FFI::WiringPi::GPIO do
+
+  describe '.batch_write' do
+    shared_examples_for 'byte converter' do |byte, array|
+      it 'converts boolean array to byte' do
+        expect(described_class).to receive(:digital_write_byte).with(byte)
+        described_class.batch_write array
+      end
+    end
+
+    it_behaves_like 'byte converter', 1, [true, false, false, false,  false, false, false, false]
+    it_behaves_like 'byte converter', 2, [false, true, false, false,  false, false, false, false]
+    it_behaves_like 'byte converter', 3, [true, true, false, false,  false, false, false, false]
+    it_behaves_like 'byte converter', 17, [true, false, false, false,  true, false, false, false]
+  end
+end

data/spec/spec_helper.rb

@@ -1,5 +1,2 @@
-gem 'rspec', '~> 2.4'
-require 'rspec'
-
 require 'ffi'
-include FFI
+require 'ffi/wiring_pi'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ffi-wiring_pi
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - Mark Huk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-14 00:00:00.000000000 Z
+date: 2019-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: Ruby FFI bindings for the wiringPi library.
 email: mark.guk.e@gmail.com
 executables: []
@@ -75,6 +89,7 @@ files:
 - gemspec.yml
 - lib/ffi/wiring_pi.rb
 - lib/ffi/wiring_pi/gpio.rb
+- spec/ffi/wiring_pi/gpio_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/vimutter/ffi-wiring_pi
 licenses:
@@ -100,4 +115,5 @@ rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: FFI bindings for wiringPi
-test_files: []
+test_files:
+- spec/ffi/wiring_pi/gpio_spec.rb