ffi-wiring_pi 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96d67497059bd425b34843259199031c0945ffa4ea239af8c7a5a4dd61ab23e6
-  data.tar.gz: e85e81abfca1d648175cde24b841f9a1be6e25df7ff6b99ef5a575ab6db3dd4c
+  metadata.gz: e2d098355a7b9f55120d935e27114a215ac7c3aac2e0dfe3ec2a09bf5c7e8909
+  data.tar.gz: ca6b7da382e795cf235125ed0f06ec4352cdd212b6643b8afdc209d707725b5b
 SHA512:
-  metadata.gz: 6d0381b71c738cf6342da8bcde90403d9dc7c2a3485dbfd7ee284e706b9f94c79e55cc723e220ed955934c6269085e058d238a0614dd271b42664963b4f1895a
-  data.tar.gz: 693a22b26b22d46b4c4229e95c6f2b3981a47436eb01b5007e4d495292e661ad89dc6774c7d727ea83d679658ebebf749841d926ed36f269fef532f14b0d7adc
+  metadata.gz: d441d40e6fa144d1a02633691d2883cd90a6fcc4c20e7cec270bbb33b7d8fa928934f38d284470b7d226d0d0aa8814e73b7cc8117e038e927221589c879b6990
+  data.tar.gz: 934367bebb0e49ae9e62ad4da043d623cb10629c97425709b5c9608bf49ded08fd66728d9cd687e19544e10e713511e1d28dd9a539323a6401f7d1b2f3a1c36f

data/.gitignore

@@ -48,3 +48,4 @@ build-iPhoneSimulator/
 
 # unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
 .rvmrc
+build

data/.travis.yml

@@ -4,6 +4,7 @@ before_install:
   - cd wiringPi
   - ./build
   - gem install ffi
+  - gem install bundler:2.0.1
 rvm:
   - 2.6.1
 script: rake test

data/ChangeLog.md

@@ -1,2 +1,3 @@
+# 0.3.0 Added Software PWM, added instructions for libws281x, but not enabled
 # 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.6)
+    ffi-wiring_pi (0.3.0)
       ffi (~> 1.0)
 
 GEM

data/Makefile.template

@@ -0,0 +1,86 @@
+VERSION=$(shell cat version)
+DESTDIR?=/usr
+PREFIX?=/local
+
+LDCONFIG?=ldconfig
+
+ifneq ($V,1)
+Q ?= @
+endif
+
+STATIC=libws281x.a
+DYNAMIC=libws281x.so.$(VERSION)
+
+#DEBUG	= -g -O0
+DEBUG	= -O2
+CC	= gcc
+INCLUDE	= -I.
+DEFS	= -D_GNU_SOURCE
+CFLAGS	= $(DEBUG) $(DEFS) -Wformat=2 -Wall -Wextra -Winline $(INCLUDE) -pipe -fPIC
+#CFLAGS	= $(DEBUG) $(DEFS) -Wformat=2 -Wall -Wextra -Wconversion -Winline $(INCLUDE) -pipe -fPIC
+
+LIBS    = -lm -lpthread -lrt -lcrypt
+
+###############################################################################
+
+SRC	=	ws2811.c	\
+      pwm.c		\
+      pcm.c  \
+      dma.c \
+      rpihw.c \
+      mailbox.c
+
+
+HEADERS =	$(shell ls *.h)
+
+OBJ	=	$(SRC:.c=.o)
+
+all:		$(DYNAMIC)
+
+.PHONY:	static
+static:
+		$Q cat noMoreStatic
+
+$(DYNAMIC):	$(OBJ)
+	$Q echo "[Link (Dynamic)]"
+	$Q $(CC) -shared -Wl,-soname,libws281x.so -o libws281x.so.$(VERSION) $(LIBS) $(OBJ)
+
+.c.o:
+	$Q echo [Compile] $<
+	$Q $(CC) -c $(CFLAGS) $< -o $@
+
+
+.PHONY:	clean
+clean:
+	$Q echo "[Clean]"
+	$Q rm -f $(OBJ) $(OBJ_I2C) *~ core tags Makefile.bak libws281x.*
+
+.PHONY:	tags
+tags:	$(SRC)
+	$Q echo [ctags]
+	$Q ctags $(SRC)
+
+
+.PHONY:	install
+install:	$(DYNAMIC)
+	$Q echo "[Install Headers]"
+	$Q install -m 0755 -d						$(DESTDIR)$(PREFIX)/include
+	$Q install -m 0644 $(HEADERS)					$(DESTDIR)$(PREFIX)/include
+	$Q echo "[Install Dynamic Lib]"
+	$Q install -m 0755 -d						$(DESTDIR)$(PREFIX)/lib
+	$Q install -m 0755 libws281x.so.$(VERSION)			$(DESTDIR)$(PREFIX)/lib/libws281x.so.$(VERSION)
+	$Q ln -sf $(DESTDIR)$(PREFIX)/lib/libws281x.so.$(VERSION)	$(DESTDIR)/lib/libws281x.so
+	$Q $(LDCONFIG)
+
+.PHONY:	uninstall
+uninstall:
+	$Q echo "[UnInstall]"
+	$Q cd $(DESTDIR)$(PREFIX)/include/ && rm -f $(HEADERS)
+	$Q cd $(DESTDIR)$(PREFIX)/lib/     && rm -f libws281x.*
+	$Q $(LDCONFIG)
+
+
+.PHONY:	depend
+depend:
+	makedepend -Y $(SRC) $(SRC_I2C)
+

data/README.md

@@ -12,6 +12,7 @@ Ruby FFI bindings for the [wiringPi](http://wiringpi.com) library.
 ## Features
 
 * Can setup and work with GPIO
+* In progress: bindings to rpi_ws281x library to work with NeoPixel (ws2811 & ws2812) LED strips
 
 ## Examples
 
@@ -45,6 +46,7 @@ Setup GPIO:
 * [Ruby](http://ruby-lang.org/) >= 2.6.1 or
 * [wiringPi](http://wiringpi.com/download-and-install/) >= 2.46
 * [ffi](http://github.com/ffi/ffi) ~> 1.0
+* [rpi_ws281x](https://github.com/jgarff/rpi_ws281x)
 
 ## Install
 

data/build_rpi_ws281x.sh

@@ -0,0 +1,103 @@
+#!/bin/bash
+
+# ---------------------------------------------------------------------------------------------------------------------
+# Compiles shared libraries required for interfacing with Raspberry Pi GPIO hardware from Java, using JNI.
+# ---------------------------------------------------------------------------------------------------------------------
+# Author(s):    limpygnome <limpygnome@gmail.com>, mbelling <matthew.bellinger@gmail.com>
+# ---------------------------------------------------------------------------------------------------------------------
+
+# *********************************************************************************************************************
+# Configuration
+# *********************************************************************************************************************
+
+
+# Relative dir names for input/output
+BASE_DIR="$(dirname "$0")/"
+OUTPUT="${BASE_DIR}/build"
+
+NATIVE_SRC="${OUTPUT}/ws281x"
+NATIVE_OUT="${NATIVE_SRC}/output"
+NATIVE_LIB_NAME="ws281x.so"
+LIB_BASE_NAME="libws281x"
+WRAPPER_LIB_NAME="${LIB_BASE_NAME}.so"
+
+
+# *********************************************************************************************************************
+# Functions
+# *********************************************************************************************************************
+
+function compileSrc
+{
+    SRC="${1}"
+    OUT="${2}"
+
+    gcc -shared -fPIC -w -o "${OUT}" -c "${SRC}" -I./
+}
+
+function programInstalled
+(
+    CMD="${1}"
+    EXPECTED="${2}"
+    ERROR="${3}"
+    SUCCESS="${4}"
+
+    OUTPUT=$(eval ${CMD} || echo "fail")
+    if [[ "${OUTPUT}" != *"${EXPECTED}"* ]]; then
+        echo "${ERROR}"
+        exit 1
+    else
+        echo "${SUCCESS}"
+    fi
+)
+
+# *********************************************************************************************************************
+# Main
+# *********************************************************************************************************************
+
+echo "NeoPixel ws281x Library Compiler"
+echo "****************************************************"
+
+# Check dependencies installed
+set -e
+programInstalled "gcc --version" "free software" "Error - GCC is not installed, cannot continue!" "Check - GCC installed..."
+programInstalled "git --version" "git version" "Error - git is not installed, cannot continue!" "Check - git installed..."
+set +e
+
+# Clean workspace
+echo "Deleting build directory to start clean..."
+rm -rf build
+
+# Retrieve rpi_ws281x repository
+echo "Cloning rpi_ws281x repository..."
+git clone https://github.com/jgarff/rpi_ws281x.git ${NATIVE_SRC}
+
+# # At the time of this writing this repository does not tag versions, so checking out at a specific commit so we build a consistent library
+# echo "Checking out specific revision..."
+# pushd ${NATIVE_SRC}
+# git checkout master
+# popd
+
+# Create all the required dirs
+echo "Creating required dirs..."
+mkdir -p "${NATIVE_OUT}"
+mkdir -p "${OUTPUT}/nativeLib"
+
+# Compile library objects
+echo "Compiling ws281x library objects..."
+
+compileSrc "${NATIVE_SRC}/ws2811.c"        "${NATIVE_OUT}/ws2811.o"
+compileSrc "${NATIVE_SRC}/pwm.c"           "${NATIVE_OUT}/pwm.o"
+compileSrc "${NATIVE_SRC}/pcm.c"           "${NATIVE_OUT}/pcm.o"
+compileSrc "${NATIVE_SRC}/dma.c"           "${NATIVE_OUT}/dma.o"
+compileSrc "${NATIVE_SRC}/rpihw.c"         "${NATIVE_OUT}/rpihw.o"
+compileSrc "${NATIVE_SRC}/mailbox.c"       "${NATIVE_OUT}/mailbox.o"
+
+
+# Compile library
+echo "Compiling ws281x library..."
+gcc -shared -o "${OUTPUT}/${NATIVE_LIB_NAME}" "${NATIVE_OUT}/ws2811.o" "${NATIVE_OUT}/pwm.o" "${NATIVE_OUT}/pcm.o" "${NATIVE_OUT}/dma.o" "${NATIVE_OUT}/rpihw.o" "${NATIVE_OUT}/mailbox.o"
+
+cp "Makefile.template" "${NATIVE_SRC}/Makefile"
+cd $NATIVE_SRC && make
+sudo make install
+echo "Done!"

data/gemspec.yml

@@ -1,5 +1,5 @@
 name: ffi-wiring_pi
-version: 0.2.0
+version: 0.3.0
 summary: FFI bindings for wiringPi
 description: Ruby FFI bindings for the wiringPi library.
 license: MIT

data/lib/ffi/wiring_pi.rb

@@ -11,3 +11,4 @@ module FFI
 end
 
 require 'ffi/wiring_pi/gpio'
+require 'ffi/wiring_pi/soft_pwm'

data/lib/ffi/wiring_pi/neopixel.rb

@@ -0,0 +1,15 @@
+#frozen_string_literal: true
+
+module FFI::WiringPi::Neopixel
+  extend FFI::Library
+
+  ffi_lib 'libws281x'
+  # ws2811_return_t ws2811_init(ws2811_t *ws2811);                         //< Initialize buffers/hardware
+  # void ws2811_fini(ws2811_t *ws2811);                                    //< Tear it all down
+  # ws2811_return_t ws2811_render(ws2811_t *ws2811);                       //< Send LEDs off to hardware
+  # ws2811_return_t ws2811_wait(ws2811_t *ws2811);                         //< Wait for DMA completion
+  # const char * ws2811_get_return_t_str(const ws2811_return_t state);     //< Get string representation of the given return state
+
+  # attach_function :setup, :wiringPiSetup, [], :int
+
+end

data/lib/ffi/wiring_pi/soft_pwm.rb

@@ -0,0 +1,26 @@
+#frozen_string_literal: true
+
+module FFI::WiringPi::SoftPwm
+  extend FFI::Library
+
+  ffi_lib 'wiringPi'
+
+  attach_function :soft_pwm_create, :softPwmCreate, [:int, :int, :int], :int
+  attach_function :soft_pwm_write, :softPwmWrite, [:int, :int], :void
+
+  class Pin
+    def initialize(pin, initial_state = 0, range = 100)
+      raise ArgumentError, 'Range should be Integer > 0' unless range.is_a?(Integer) && range > 0
+      raise ArgumentError, 'State should be within the range' unless initial_state.is_a?(Integer) && (0..range).cover?(initial_state)
+      @pin = pin
+      @range = range
+      FFI::WiringPi::SoftPwm.soft_pwm_create pin, initial_state, range
+    end
+
+    def write(value)
+      raise ArgumentError, 'Value should be within the range' unless value.is_a?(Integer) && (0..@range).cover?(value)
+      FFI::WiringPi::SoftPwm.soft_pwm_write @pin, value
+    end
+  end
+end
+

data/spec/ffi/wiring_pi/soft_pwm_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+RSpec.describe FFI::WiringPi::SoftPwm do
+
+  before :each do
+    allow(FFI::WiringPi::SoftPwm).to receive(:soft_pwm_create)
+  end
+
+  describe '::Pin' do
+    it 'raises error when range is negative' do
+      expect { described_class::Pin.new 0, 0, -1 }.to raise_error('Range should be Integer > 0')
+    end
+
+    it 'raises error when initial state is negative' do
+      expect { described_class::Pin.new 0, -1, 100 }.to raise_error('State should be within the range')
+    end
+
+    it 'raises error when initial state is out of range' do
+      expect { described_class::Pin.new 0, 101, 100 }.to raise_error('State should be within the range')
+    end
+
+    describe '#write' do
+      subject do
+        described_class::Pin.new 0, 0, 100
+      end
+
+      it 'raises error when value is out of range', :aggregate_failures do
+        expect { subject.write(-1) }.to raise_error('Value should be within the range')
+        expect { subject.write(101) }.to raise_error('Value should be within the range')
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ffi-wiring_pi
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Mark Huk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-16 00:00:00.000000000 Z
+date: 2019-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -83,13 +83,18 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
+- Makefile.template
 - README.md
 - Rakefile
+- build_rpi_ws281x.sh
 - ffi-wiring_pi.gemspec
 - gemspec.yml
 - lib/ffi/wiring_pi.rb
 - lib/ffi/wiring_pi/gpio.rb
+- lib/ffi/wiring_pi/neopixel.rb
+- lib/ffi/wiring_pi/soft_pwm.rb
 - spec/ffi/wiring_pi/gpio_spec.rb
+- spec/ffi/wiring_pi/soft_pwm_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/vimutter/ffi-wiring_pi
 licenses:
@@ -117,3 +122,4 @@ specification_version: 4
 summary: FFI bindings for wiringPi
 test_files:
 - spec/ffi/wiring_pi/gpio_spec.rb
+- spec/ffi/wiring_pi/soft_pwm_spec.rb