lightpack 0.0.1

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Douwe Maan
+
+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/README.md

@@ -0,0 +1,124 @@
+# lightpack
+
+A Ruby library for communicating with your [Lightpack](http://lightpack.tv).
+
+## Installation
+
+```sh
+gem install lightpack
+```
+
+Or in your Gemfile:
+
+```ruby
+gem "lightpack"
+```
+
+## Usage
+
+```ruby
+require "lightpack"
+
+# You can open a connection to the Lightpack that will live for the duration of the block using `.open`:
+Lightpack.open do |lightpack|
+  # Use `lightpack` as described below.
+end
+
+# If you want a little more control over opening and closing the connection, just use `.new`: 
+lightpack = Lightpack.new("127.0.0.1", 3636, "api_key")
+# "127.0.0.1" and 3636 are the default host and port and can be omitted as in the `.open` example. 
+# The third parameter is the optional api key, which you need to set 
+# if you've set up your Lightpack to require authentication.
+
+# You can then explicitly open a connection to the lightpack. 
+# You're responsible for closing it using `#disconnect` when you're done.
+lightpack.connect
+
+# If you need to authenticate but haven't done so yet with `.open` or `.new`, 
+# you can do so manually after connecting.
+lightpack.authenticate("api_key")
+
+# The Lightpack object exposes a lot of interesting information:
+lightpack.status      # :on, :off, :device_error or :unknown
+lightpack.on?         # true or false
+lightpack.api_status  # :idle or :busy
+
+lightpack.profiles    # ["Lightpack", "Other profile"]
+lightpack.profile     # "Lightpack"
+
+lightpack.led_count   # 10
+lightpack.led_areas   # [{:x=>1920, :y=>1224, :width=>640, :height=>216}, {:x=>2176, :y=>720, ...}, ...] 
+lightpack.colors      # [[170, 170, 173], [190, 190, 192], ...] # Red, Green, Blue
+
+lightpack.fps         # 20.04
+lightpack.screen_size # [0, 0, 2560, 1440]
+lightpack.mode        # :ambilight or :moodlamp
+
+# Of course, you can also _do_ certain things with your Lightpack. 
+# All of these return true when successful and raise an error otherwise.
+lightpack.turn_on
+lightpack.turn_off
+
+lightpack.profile     = "Other profile"
+lightpack.mode        = :moodlamp
+
+lightpack.gamma       = 2.5 # 0.1..10
+lightpack.brightness  = 93  # 0..100
+lightpack.smooth      = 128 # 0..255
+
+lightpack.set_color(0, 255, 0, 0) # index of LED, Red, Green, Blue
+lightpack.set_all_colors(0, 255, 0)
+lightpack.set_led_areas(0, { x: 1920, y: 1224, width: 640, height: 216 })
+lightpack.add_profile("New profile")
+lightpack.delete_profile("Other profile")
+
+# Note that all of the action methods above require a lock on the Lightpack.
+# This lock is acquired automatically if you haven't done so manually, 
+# but if you want to do a number of actions sequentially, acquiring a lock once
+# would be more efficient than acquiring and releasing one for every action.
+
+# You can acquire a lock for the duration of a block like this:
+lightpack.with_lock do
+  lightpack.set_color(0, 255, 0, 0)
+  lightpack.set_color(1, 0, 255, 0)
+  lightpack.set_color(2, 0, 0, 255)
+end
+
+# Alternatively, you can use `#lock` in combination with `#unlock`.
+lightpack.lock
+lightpack.gamma       = 2.5
+lightpack.brightness  = 93
+lightpack.smooth      = 128
+lightpack.unlock
+
+# If you want to, you can check whether a lock is active:
+lightpack.locked?
+
+# When you're done, you can just let the program exit or disconnect explicitly.
+lightpack.disconnect
+```
+
+## Examples
+Check out the [`examples/`](examples) folder for some basic examples.
+
+## License
+Copyright (c) 2014 Douwe Maan
+
+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

@@ -0,0 +1,17 @@
+require "rspec/core/rake_task"
+
+spec = Gem::Specification.load("lightpack.gemspec")
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+desc "Build the .gem file"
+task :build do
+  system "gem build #{spec.name}.gemspec"
+end
+
+desc "Push the .gem file to rubygems.org"
+task release: :build do
+  system "gem push #{spec.name}-#{spec.version}.gem"
+end

data/lib/lightpack.rb

@@ -0,0 +1,245 @@
+require "socket"
+
+class Lightpack
+  module Errors
+    class NotConnected            < StandardError; end
+    class AuthenticationFailed    < StandardError; end
+
+    class AuthenticationRequired  < StandardError; end
+    class UnknownCommand          < StandardError; end
+    class NotLocked               < StandardError; end
+    class Busy                    < StandardError; end
+    class Error                   < StandardError; end
+
+    MESSAGES = {
+      "authorization required"  => AuthenticationRequired,
+      "unknown command"         => UnknownCommand,
+      "not locked"              => NotLocked,
+      "busy"                    => Busy,
+      "error"                   => Error
+    }.freeze
+  end
+
+  def self.open(*args)
+    pack = new(*args)
+
+    begin
+      pack.connect
+      yield pack
+    ensure
+      pack.disconnect
+    end
+  end
+
+  attr_reader   :host, :port
+  attr_accessor :api_key
+
+  def initialize(host = "127.0.0.1", port = 3636, api_key = nil)
+    @host     = host
+    @port     = port
+    @api_key  = api_key
+  end
+
+  def connected?
+    @connected
+  end
+
+  def connect
+    return false if connected?
+
+    @socket = TCPSocket.new(@host, @port)
+    @connected = true
+
+    @socket.gets # Read welcome message
+
+    unless authenticate
+      disconnect
+      raise Errors::AuthenticationFailed
+    end
+
+    true
+  rescue
+    false
+  end
+
+  def disconnect
+    return false unless connected?
+
+    unlock
+
+    @connected = false
+
+    @socket.close if @socket && !@socket.closed?
+    @socket = nil
+
+    true
+  end
+
+  def authenticate(api_key = @api_key)
+    return true unless api_key
+
+    command("apikey:#{api_key}") == true
+  end
+
+  def locked?
+    @locked
+  end
+
+  def lock
+    return true if locked?
+
+    result = command("lock")
+    @locked = result == :success
+  end
+
+  def unlock
+    return false unless locked?
+
+    result = command("unlock")
+    @locked = false
+
+    result == :success
+  end
+
+  def with_lock(&block)
+    already_locked = locked?
+
+    lock unless already_locked
+
+    yield self
+  ensure
+    unlock unless already_locked
+  end
+
+  # Getters
+  def status
+    command("getstatus").gsub(" ", "_").to_sym
+  end
+
+  def on?
+    status == :on
+  end
+
+  def api_status
+    command("getstatusapi").gsub(" ", "_").to_sym
+  end
+
+  def profiles
+    command("getprofiles").split(";")
+  end
+
+  def profile
+    command("getprofile")
+  end
+
+  def led_count
+    command("getcountleds").to_i
+  end
+
+  def led_areas
+    command("getleds").split(";").map do |info|
+      keys = [:x, :y, :width, :height]
+      dimensions = info.split("-", 2)[1].split(",").map(&:to_i)
+
+      Hash[keys.zip(dimensions)]
+    end
+  end
+
+  def colors
+    command("getcolors").split(";").map do |info|
+      info.split("-", 2)[1].split(",").map(&:to_i)
+    end
+  end
+
+  def fps
+    command("getfps").to_f
+  end
+
+  def screen_size
+    command("getscreensize").split(",").map(&:to_i)
+  end
+
+  def mode
+    command("getmode").to_sym
+  end
+
+  # Setters
+  def turn_on
+    with_lock do
+      command("setstatus:on")
+    end
+  end
+
+  def turn_off
+    with_lock do
+      command("setstatus:off")
+    end
+  end
+
+  [:mode, :gamma, :brightness, :smooth, :profile].each do |key|
+    define_method(:"#{key}=") do |value|
+      with_lock do
+        command("set#{key}:#{value}") && value
+      end  
+    end
+  end
+
+  def set_color(n, r, g, b)
+    with_lock do
+      command("setcolor:#{n + 1}-#{[r, g, b].join(",")};")
+    end
+  end
+
+  def set_all_colors(r, g, b)
+    with_lock do
+      colors = [r, g, b].join(",")
+
+      cmd = "setcolor:"
+      led_count.times do |i|
+        cmd << "#{i}-#{colors};"
+      end
+      command cmd
+    end
+  end
+
+  def set_led_areas(n, dimensions)
+    with_lock do
+      dimensions = [:x, :y, :width, :height].map { |key| dimensions[key] }.join(",")
+      command("setleds:#{n + 1}-#{dimensions};")
+    end
+  end
+
+  def add_profile(name)
+    with_lock do
+      command("newprofile:#{name}")
+    end
+  end
+
+  def delete_profile(name)
+    with_lock do
+      command("deleteprofile:#{name}")
+    end
+  end
+
+  private
+    def command(action, type = nil)
+      raise Errors::NotConnected unless connected?
+
+      @socket.puts action
+      result = @socket.recv(8192).chomp
+
+      if error = Errors::MESSAGES[result]
+        raise error 
+      end
+
+      if result == "ok"
+        true
+      elsif result =~ /:/
+        result.split(":", 2)[1]
+      else
+        result.gsub(" ", "_").to_sym
+      end
+    end
+end
+
+require "lightpack/version"

data/lib/lightpack/version.rb

@@ -0,0 +1,3 @@
+class Lightpack
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: lightpack
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Douwe Maan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70272477253440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70272477253440
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70272477250700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70272477250700
+description: A Ruby library for communicating with your Lightpack.
+email: douwe@selenight.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/lightpack/version.rb
+- lib/lightpack.rb
+- LICENSE
+- README.md
+- Rakefile
+- Gemfile
+homepage: https://github.com/DouweM/lightpack
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4336892820563749072
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 4336892820563749072
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Lightpack communication library
+test_files: []