pixel_pi 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c158234b67ccd01d55b48cf274c5ccb437ae77a
-  data.tar.gz: 5125b6c0d47381ca23ba8fc942ac73d22f9f3bbb
+  metadata.gz: 688bc3e73f552b02b5dc0680b011b5bac6126e5b
+  data.tar.gz: 8834674338856c9c2cff5ade3a2e3bd965a861b1
 SHA512:
-  metadata.gz: d010f3d8e722cb39aea7cd13cb78e92621628014799899bb08def77a0b0e1333dcf88362aa797f88ccdf2949b6d524f80bf23fa3302951e875e974fbf0e7a80b
-  data.tar.gz: acdac849b6517a354918be99681e360592a8edb77ca18a77bc741aba66008c56b42a62a760500a9026f6bd41c7d6d1a7794d5085765e3a39fee56637ef8129e0
+  metadata.gz: 376b26eee53fd8a891d3592e7cdfd07abb335a4280033a28a7f6ee485ee1934739a01fa5ec7432dec92ed34046b3a255cd56631497423a2ab7a8b6ee55629686
+  data.tar.gz: af41e39b37c563710b2d3066fb7673864d0c6bb0af707fb7a4a588335ef641a44bde725106150fca0774b7868873e94f475e354335383413442e2eb31521526e

data/.gitignore

@@ -1,2 +1,4 @@
 *.gem
 tmp
+pkg
+vendor

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Tim Pease
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/Rakefile

@@ -6,7 +6,10 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 spec = Gem::Specification.load("pixel_pi.gemspec")
 
-Gem::PackageTask.new(spec)
+Gem::PackageTask.new(spec) do |pkg|
+  pkg.need_zip = false
+  pkg.need_tar = false
+end
 
 Rake::ExtensionTask.new("pixel_pi", spec) do |ext|
   ext.name    = "leds"

data/examples/strandtest.rb

@@ -145,7 +145,6 @@ module StrandTest
 
     self
   end
-
 end
 
 
@@ -154,7 +153,8 @@ strip = PixelPi::Leds.new \
     :frequency  => LED_FREQ_HZ,
     :dma        => LED_DMA,
     :brightness => LED_BRIGHTNESS,
-    :invert     => LED_INVERT
+    :invert     => LED_INVERT,
+    :debug      => true
 
 strip.extend StrandTest
 

data/ext/pixel_pi/extconf.rb

@@ -1,18 +1,36 @@
 require 'mkmf'
+require 'rbconfig'
 
 pixel_pi_path = File.expand_path("../", __FILE__)
 ws2811_path   = File.expand_path("../../ws2811", __FILE__)
-ws2811_files  = %w[
-  clk.h
-  dma.h
-  gpio.h
-  pwm.h
-  ws2811.h
-  dma.c
-  pwm.c
-  ws2811.c
-]
-ws2811_files.map! { |name| "#{ws2811_path}/#{name}" }
-FileUtils.cp(ws2811_files, pixel_pi_path)
 
-create_makefile("pixel_pi/leds")
+if RbConfig::CONFIG["arch"].to_s =~ /\Aarm-linux/i
+  ws2811_files  = %w[
+    clk.h
+    dma.h
+    gpio.h
+    pwm.h
+    ws2811.h
+    dma.c
+    pwm.c
+    ws2811.c
+  ]
+  ws2811_files.map! { |name| "#{ws2811_path}/#{name}" }
+  FileUtils.cp(ws2811_files, pixel_pi_path)
+
+  create_makefile("pixel_pi/leds")
+else
+  File.open("#{pixel_pi_path}/Makefile", "w") do |fd|
+    fd.write <<-MAKEFILE
+all: ;
+install: ;
+static: ;
+install-so: ;
+install-rb: ;
+clean: ;
+clean-so: ;
+clean-static: ;
+clean-rb: ;
+    MAKEFILE
+  end
+end

data/lib/pixel_pi/fake_leds.rb

@@ -0,0 +1,210 @@
+require "forwardable"
+
+module PixelPi
+
+  # Given a set of RGB values return a single 24-bit color value. The RGB values
+  # are nubmers in the range 0..255.
+  #
+  # Returns a 24-bit RGB color value.
+  def self.Color( red, green, blue )
+    ((red & 0xFF) << 16) | ((green & 0xFF) << 8) | (blue & 0xFF)
+  end
+
+  # PixelPi::Error class
+  Error = StandardError.new
+
+  class Leds
+    extend Forwardable
+
+    # call-seq:
+    #    PixelPi::Leds.new( length, gpio, options = {} )
+    #
+    # Create a new PixelPi::Leds instance that can be used to control a string of
+    # NeoPixels from a RaspberryPi. The length of the pixel string must be given as
+    # well as the GPIO pin number used to control the string. The remaining options
+    # have sensible defaults.
+    #
+    # length  - the nubmer of leds in the string
+    # gpio    - the GPIO pin number
+    # options - Hash of arguments
+    #   :dma        - DMA channel defaults to 5
+    #   :frequency  - output frequency defaults to 800,000 Hz
+    #   :invert     - defaults to `false`
+    #   :brightness - defaults to 255
+    #
+    def initialize( length, gpio, options = {} )
+      @leds       = [0] * length
+      @gpio       = gpio
+      @dma        = options.fetch(:dma, 5)
+      @frequency  = options.fetch(:frequency, 800_000)
+      @invert     = options.fetch(:invert, false)
+      @brightness = options.fetch(:brightness, 255)
+      @debug      = options.fetch(:debug, false)
+
+      if @debug
+        require "rainbow"
+        @debug = "◉ " unless @debug.is_a?(String) && !@debug.empty?
+      end
+    end
+
+    attr_reader :gpio, :dma, :frequency, :invert, :brightness
+
+    def_delegators :@leds, :length, :[]
+
+    # Set the pixel brightness. This is a value between 0 and 255. All pixels will
+    # be scaled by this value. The hue is not affected; only the luminosity is
+    # affected.
+    #
+    # Returns the new brightness.
+    def brightness=( value )
+      @brightness = Integer(value) & 0xFF;
+    end
+
+    # Update the display with the data from the LED buffer. This is a noop method
+    # for the fake LEDs.
+    def show
+      closed!
+      if @debug
+        ary = @leds.map { |value| Rainbow(@debug).color(*to_rgb(value)) }
+        $stdout.print "\r#{ary.join}"
+      end
+      self
+    end
+
+    # Clear the display. This will set all values in the LED buffer to zero, and
+    # then update the display. All pixels will be turned off by this method.
+    def clear
+      closed!
+      @leds.fill 0
+      self
+    end
+
+    # Shutdown the NeoPixels connected to the DMA / PWM channel. After this method
+    # the current PixelPi::Leds instance will no longer be usable; a new instance
+    # will need to be created. This method is automatically invoked when the
+    # instance is deallcoated by the Ruby garbage collector. It does not need to be
+    # explicitly invoked.
+    #
+    # Returns `nil`.
+    def close
+      $stdout.puts if @debug
+      @leds = nil
+    end
+
+    # Set the LED at position `num` to the provided 24-bit RGB color value.
+    #
+    # Returns the 24-bit RGB color value.
+    def []=( num, value )
+      closed!
+      if (num < 0 || num >= @leds.length)
+        raise IndexError, "index #{num} is outside of LED range: 0...#{@leds.length-1}"
+      end
+      @leds[num] = to_color(value)
+    end
+
+    # Set the LED at position `num` to the given color. The color can be a single
+    # 24-bit RGB `color` value or three separate color values - one for `red`, one
+    # for `green`, and one for `blue`.
+    #
+    # Returns this PixelPi::Leds instance.
+    def set_pixel( num, *args )
+      self[num] = to_color(*args)
+      self
+    end
+
+    # Takes the current list of 24-bit RGB values stored in the LED strings and
+    # returns them as an Array. These colors might not be actively displayed; it
+    # all depends if `show` has been called on the PixelPi::Leds instance.
+    #
+    # Returns an Array of 24-bit RGB values.
+    def to_a
+      closed!
+      @leds.dup
+    end
+
+    # Replace the LED colors with the 24-bit RGB color values found in the `ary`.
+    # If the `ary` is longer than the LED string then the extra color values will
+    # be ignored. If the `ary` is shorter than the LED string then only the LEDS
+    # up to `ary.length` will be changed.
+    #
+    # You must call `show` for the new colors to be displayed.
+    #
+    # Returns this PixelPi::Leds instance.
+    def replace( ary )
+      closed!
+      @leds.length.times do |ii|
+        @leds[ii] = Integer(ary[ii])
+      end
+      self
+    end
+
+    # Reverse the order of the LED colors.
+    #
+    # Returns this PixelPi::Leds instance.
+    def reverse
+      closed!
+      @leds.reverse!
+      self
+    end
+
+    # Rotates the LED colors in place so that the color at `count` comes first. If
+    # `count` is negative then it rotates in the opposite direction, starting from
+    # the end of the LEDs where -1 is the last LED.
+    #
+    # Returns this PixelPi::Leds instance.
+    def rotate( *args )
+      closed!
+      @leds.rotate!(*args)
+      self
+    end
+
+    # Set the selected LEDs to the given `color`. The `color` msut be given as a
+    # 24-bit RGB value. You can also supply a block that receives an LED index and
+    # returns a 24-bit RGB color.
+    #
+    # Examples:
+    #    leds.fill( 0x00FF00 )
+    #    leds.fill( 0xFF0000, 2, 2 )
+    #    leds.fill( 0x0000FF, (4...8) )
+    #    leds.fill { |i| 256 << i }
+    #
+    # Returns this PixelPi::Leds instance.
+    def fill( *args )
+      closed!
+      if block_given?
+        @leds.fill do |ii|
+          value = yield(ii)
+          to_color(value)
+        end
+      else
+        value = to_color(args.shift)
+        @leds.fill(value, *args)
+      end
+      self
+    end
+
+  private
+
+    def to_color( *args )
+      case args.length
+      when 1; Integer(args.first) & 0xFFFFFF
+      when 3; PixelPi::Color(*args)
+      else
+        raise ArgumentError, "expecting either 1 or 3 arguments: #{args.length}"
+      end
+    end
+
+    def to_rgb( color )
+      scale = (brightness & 0xFF) + 1
+      [
+        (((color >> 16) & 0xFF) * scale) >> 8,
+        (((color >>  8) & 0xFF) * scale) >> 8,
+        (( color        & 0xFF) * scale) >> 8
+      ]
+    end
+
+    def closed!
+      raise(::PixelPi::Error, "Leds are not initialized") if @leds.nil?
+    end
+  end
+end

data/lib/pixel_pi/version.rb

@@ -1,3 +1,3 @@
 module PixelPi
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/pixel_pi.rb

@@ -1,2 +1,9 @@
-require "pixel_pi/leds"
 require "pixel_pi/version"
+
+begin
+  require "pixel_pi/leds"
+rescue LoadError
+  $stderr.puts "C extension is not configured."
+  $stderr.puts "Using fake LEDs instead."
+  require "pixel_pi/fake_leds"
+end

data/pixel_pi.gemspec

@@ -19,5 +19,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = %w{lib}
 
   spec.add_development_dependency "rake-compiler", "~> 0.9"
+  spec.add_development_dependency "rainbow",       "~> 2.0"
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pixel_pi
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tim Pease
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-22 00:00:00.000000000 Z
+date: 2015-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  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: NeoPixels are fun! Ruby is fun! RaspberryPi is fun! FUN^3
 email:
 - tim.pease@gmail.com
@@ -33,6 +47,7 @@ extensions:
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- LICENSE
 - README.md
 - Rakefile
 - examples/strandtest.rb
@@ -48,6 +63,7 @@ files:
 - ext/ws2811/ws2811.c
 - ext/ws2811/ws2811.h
 - lib/pixel_pi.rb
+- lib/pixel_pi/fake_leds.rb
 - lib/pixel_pi/version.rb
 - pixel_pi.gemspec
 homepage: https://github.com/TwP/pixel_pi
@@ -70,7 +86,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.2.3
 signing_key: 
 specification_version: 4
 summary: A library for controlling NeoPixels via Ruby on the RaspberryPi