ledenet_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3b9e08414e8a7138101e626e53506a9e101646cc
+  data.tar.gz: e763ee6fffb993e672db3d08ba631c2ad05de48d
+SHA512:
+  metadata.gz: e1ebfcf2ab226033064a9e964c7c9c8cf23b234ccda03bdaff99d0f1a75ff9cb18070a7c876e44c229bbc3b380b05f6d34791d2f89cbc207f43bf757626f7855
+  data.tar.gz: dd2ce1ef6f07fa007a8c1081ef7121ea126bc04365c3e11f8c010cf0e68d269a7945fd928c8cf36dbb79bd78659d1ee56b91a361000cdb5f139df4f2d778e862

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.iml

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in alexa_verifier.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    ledenet_api (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (10.4.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.10)
+  ledenet_api!
+  rake (~> 10.0)
+  rspec
+
+BUNDLED WITH
+   1.10.5

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Christopher
+
+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,2 @@
+# ledenet_api
+An API for the LEDENET Magic UFO LED WiFi Controller

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/ledenet_api.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+$:.push File.expand_path('../lib', __FILE__)
+
+require "ledenet/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ledenet_api"
+  spec.version       = LEDENET::VERSION
+  spec.authors       = ["Christopher Mullins"]
+  spec.email         = ["chris@sidoh.org"]
+
+  spec.summary       = %q{An API for the LEDENET Magic UFO LED WiFi Controller}
+  spec.homepage      = "http://www.github.com/sidoh/ledenet_api"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

data/lib/ledenet/api.rb

@@ -0,0 +1,73 @@
+module LEDENET
+  class Api
+    API_PORT = 5577
+
+    def initialize(device_address)
+      @device_address = device_address
+    end
+
+    def on
+      send_bytes(0x71, 0x23, 0x0F, 0xA3)
+    end
+
+    def off
+      send_bytes(0x71, 0x24 ,0x0F, 0xA4)
+    end
+
+    def on?
+      (status.bytes[13] & 0x01) == 1
+    end
+
+    def update_color(r, g, b)
+      checksum = color_checksum(r, g, b)
+
+      send_bytes(0x31, r, g, b, 0xFF, 0, 0x0F, checksum)
+    end
+
+    def current_color
+      status.bytes[6, 3]
+    end
+
+    def reconnect!
+      create_socket
+    end
+
+    #private
+      def color_checksum(r, g, b)
+        (r + g + b + 0x3F) % 0x100
+      end
+
+      def status
+        begin
+          send_bytes(0x81, 0x8A, 0x8B, 0x96)
+
+          # Example response:
+          # [129, 4, 35, 97, 33, 9, 11, 22, 33, 255, 3, 0, 0, 119]
+          #                         R   G   B   WW            ^--- LSB indicates on/off
+          flush_response(14)
+        rescue Errno::EPIPE
+          reconnect!
+          retry
+        end
+      end
+
+      def flush_response(msg_length)
+        @socket.recv(msg_length, Socket::MSG_WAITALL)
+      end
+
+      def send_bytes(*b)
+        create_socket if @socket.nil?
+
+        begin
+          @socket.write(b.pack('c*'))
+        rescue Errno::EPIPE
+          reconnect!
+          retry
+        end
+      end
+
+      def create_socket
+        @socket = TCPSocket.new(@device_address, API_PORT)
+      end
+  end
+end

data/lib/ledenet/device_discovery.rb

@@ -0,0 +1,49 @@
+require 'socket'
+require 'timeout'
+
+module LEDENET
+  class Device
+    attr_reader :ip, :hw_addr, :model
+
+    def initialize(device_str)
+      parts = device_str.split(',')
+
+      @ip = parts[0]
+      @hw_addr = parts[1]
+      @model = parts[2]
+    end
+  end
+
+  # The WiFi controllers these things appear to use support a discovery protocol
+  # roughly outlined here: http://www.usriot.com/Faq/49.html
+  #
+  # A "password" is sent over broadcast port 48899. We can respect replies
+  # containing IP address, hardware address, and model number. The model number
+  # appears to correspond to the WiFi controller, and not the LED controller
+  # itself.
+  def self.discover_devices(expected_devices = 1, timeout = 5)
+    send_addr = ['<broadcast>', 48899]
+    send_socket = UDPSocket.new
+    send_socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_BROADCAST, true)
+    send_socket.send('HF-A11ASSISTHREAD', 0, send_addr[0], send_addr[1])
+
+    discovered_devices = []
+
+    begin
+      Timeout::timeout(timeout) do
+        while true
+          data = send_socket.recv(1024)
+          discovered_devices.push(LEDENET::Device.new(data))
+
+          raise Timeout::Error if discovered_devices.count >= expected_devices
+        end
+      end
+    rescue Timeout::Error
+      # Expected
+    ensure
+      send_socket.close
+    end
+
+    discovered_devices
+  end
+end

data/lib/ledenet/version.rb

@@ -0,0 +1,3 @@
+module LEDENET
+  VERSION = '0.1.0'
+end

data/lib/ledenet_api.rb

@@ -0,0 +1,3 @@
+require 'ledenet/version'
+require 'ledenet/device_discovery'
+require 'ledenet/api'

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: ledenet_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Christopher Mullins
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- chris@sidoh.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- ledenet_api.gemspec
+- lib/ledenet/api.rb
+- lib/ledenet/device_discovery.rb
+- lib/ledenet/version.rb
+- lib/ledenet_api.rb
+homepage: http://www.github.com/sidoh/ledenet_api
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: An API for the LEDENET Magic UFO LED WiFi Controller
+test_files: []