ledenet_api 0.1.11 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b8e62ef0ba30a878e092cfc6b9c00a9285e52fb2
-  data.tar.gz: 012b023d53d167c133d93a2da22a3963b069cc27
+  metadata.gz: ac6a8e5411f0e6bdd37433ddc3d165ba94ca0320
+  data.tar.gz: a642b47d4663a5656a8b7db3f21eb55b8a317e77
 SHA512:
-  metadata.gz: 3f8f635dd04466eed819bea8e0d1f752665332974eec01f9612e65052faee166695449c0154a39397ef7ee9bcd47c1ab414405d423ef59474a5212c6f14fb38e
-  data.tar.gz: e203a19cc9ea01064fdccbb7564a434a958372166eaa06a754b8137bd5b1a5d8e93bda880915d4868603a7461d79b879eae0956d6e53ee6c965a9750c2343b8b
+  metadata.gz: c9d8fd279d1e2b3f6574d2ec800a7e25cce533718bfdc61d5b3083099d6581c62f0981444d1a7f57ca5d296c7175aad64f53ab955b2e1880c4dd6056e96d7d17
+  data.tar.gz: f060415564c23e7adff09a80143703b18e1a023e175724469e8891c51d9cc391dfd2a5427b97b9dee6ff9df42d2233832320ea96c9da3aca5ee827b0bc7f99d1

data/Gemfile.lock

@@ -1,11 +1,13 @@
 PATH
   remote: .
   specs:
-    ledenet_api (0.1.3)
+    ledenet_api (0.1.11)
+      bindata (>= 1.8)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    bindata (2.3.0)
     diff-lcs (1.2.5)
     rake (10.4.2)
     rspec (3.3.0)
@@ -32,4 +34,4 @@ DEPENDENCIES
   rspec
 
 BUNDLED WITH
-   1.10.5
+   1.11.2

data/ledenet_api.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency 'bindata', '>= 2.3'
+
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"

data/lib/ledenet/api.rb

@@ -1,10 +1,13 @@
+require 'ledenet/packets/set_power_request'
+require 'ledenet/packets/status_request'
+require 'ledenet/packets/update_color_request'
+
 module LEDENET
   class Api
-    API_PORT = 5577
-
     DEFAULT_OPTIONS = {
         reuse_connection: false,
-        max_retries: 3
+        max_retries: 3,
+        port: 5577
     }
 
     def initialize(device_address, options = {})
@@ -13,68 +16,69 @@ module LEDENET
     end
 
     def on
-      send_bytes_action(0x71, 0x23, 0x0F, 0xA3)
-
-      true
+      send_packet(LEDENET::Packets::SetPowerRequest.on_request)
     end
 
     def off
-      send_bytes_action(0x71, 0x24 ,0x0F, 0xA4)
-
-      true
+      send_packet(LEDENET::Packets::SetPowerRequest.off_request)
     end
 
     def on?
-      (status.bytes[13] & 0x01) == 1
+      status.on?
     end
 
-    def update_color(r, g, b)
-      checksum = color_checksum(r, g, b)
+    def update_rgb(r, g, b)
+      update_color_data(red: r, green: g, blue: b)
+    end
 
-      send_bytes_action(0x31, r, g, b, 0xFF, 0, 0x0F, checksum)
+    def update_warm_white(warm_white)
+      update_color_data(warm_white: warm_white)
+    end
 
-      true
+    def update_color_data(o)
+      updated_data = current_color.merge(o)
+      send_packet(LEDENET::Packets::UpdateColorRequest.new(updated_data))
     end
 
-    def current_color
-      status.bytes[6, 3]
+    def current_rgb
+      current_color_data.values_at(:red, :green, :blue)
     end
 
-    def reconnect!
-      create_socket
+    def current_warm_white
+      current_color_data[:warm_white]
     end
 
-    private
-      def color_checksum(r, g, b)
-        (r + g + b + 0x3F) % 0x100
+    def current_color_data
+      status_response = status
+      color_data = %w{red green blue warm_white}.map do |x|
+        [x.to_sym, status_response.send(x)]
       end
+      Hash[color_data]
+    end
 
-      def status
-        socket_action do
-          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)
-        end
-      end
+    def reconnect!
+      create_socket
+      true
+    end
 
-      def flush_response(msg_length)
-        @socket.recv(msg_length, Socket::MSG_WAITALL)
-      end
+    def send_packet(packet)
+      socket_action do
+        @socket.write(packet.to_binary_s)
 
-      def send_bytes(*b)
-        @socket.write(b.pack('c*'))
+        if packet.response_reader != LEDENET::Packets::EmptyResponse
+          packet.response_reader.read(@socket)
+        end
       end
+    end
 
-      def send_bytes_action(*b)
-        socket_action { send_bytes(*b) }
+    private
+      def status
+        send_packet(LEDENET::Packets::StatusRequest.new)
       end
 
       def create_socket
         @socket.close unless @socket.nil? or @socket.closed?
-        @socket = TCPSocket.new(@device_address, API_PORT)
+        @socket = TCPSocket.new(@device_address, @options[:port])
       end
 
       def socket_action
@@ -92,7 +96,9 @@ module LEDENET
             raise e
           end
         ensure
-          @socket.close unless @socket.nil? or @socket.closed? or @options[:reuse_connection]
+          if !@socket.nil? && !@socket.closed? && !@options[:reuse_connection]
+            @socket.close
+          end
         end
       end
   end

data/lib/ledenet/device_discovery.rb

@@ -18,7 +18,8 @@ module LEDENET
   DEFAULT_OPTIONS = {
       expected_devices: 1,
       timeout: 5,
-      expected_models: []
+      expected_models: [],
+      udp_port: 48899
   }
 
   # The WiFi controllers these things appear to use support a discovery protocol
@@ -31,7 +32,7 @@ module LEDENET
   def self.discover_devices(options = {})
     options = DEFAULT_OPTIONS.merge(options)
 
-    send_addr = ['<broadcast>', 48899]
+    send_addr = ['<broadcast>', options[:udp_port]]
     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])

data/lib/ledenet/packets/empty_response.rb

@@ -0,0 +1,6 @@
+require 'bindata'
+
+module LEDENET::Packets
+  class EmptyResponse < BinData::Record
+  end
+end

data/lib/ledenet/packets/fields/checksum.rb

@@ -0,0 +1,9 @@
+require 'bindata'
+
+module LEDENET
+  class Checksum < BinData::Record
+    mandatory_parameter :packet_data
+
+    uint8 :checksum, :value => ->() { packet_data.values.reduce(&:+) % 0x100 }
+  end
+end

data/lib/ledenet/packets/set_power_request.rb

@@ -0,0 +1,29 @@
+require 'bindata'
+
+require 'ledenet/packets/fields/checksum'
+require 'ledenet/packets/empty_response'
+
+module LEDENET::Packets
+  class SetPowerRequest < BinData::Record
+    mandatory_parameter :on?
+    hide :checksum
+
+    uint8 :packet_id, value: 0x71
+    uint8 :power_status, value: ->() { on? ? 0x23 : 0x24 }
+    uint8 :remote_or_local, value: 0x0F
+
+    checksum :checksum, packet_data: ->() { snapshot }
+
+    def response_reader
+      LEDENET::Packets::EmptyResponse
+    end
+
+    def self.on_request
+      SetPowerRequest.new(on?: true)
+    end
+
+    def self.off_request
+      SetPowerRequest.new(on?: false)
+    end
+  end
+end

data/lib/ledenet/packets/status_request.rb

@@ -0,0 +1,20 @@
+require 'bindata'
+
+require 'ledenet/packets/fields/checksum'
+require 'ledenet/packets/status_response'
+
+module LEDENET::Packets
+  class StatusRequest < BinData::Record
+    hide :checksum
+
+    uint8 :packet_id, value: 0x81
+    uint8 :payload1, value: 0x8A
+    uint8 :payload2, value: 0x8B
+
+    checksum :checksum, packet_data: ->() { snapshot }
+
+    def response_reader
+      LEDENET::Packets::StatusResponse
+    end
+  end
+end

data/lib/ledenet/packets/status_response.rb

@@ -0,0 +1,31 @@
+require 'bindata'
+
+require 'ledenet/packets/fields/checksum'
+
+module LEDENET::Packets
+  class StatusResponse < BinData::Record
+    hide :checksum, :unused_payload
+
+    uint8 :packet_id, value: 0x81
+    uint8 :device_name
+    uint8 :power_status
+
+    # I'm not sure these are the correct field labels.  Basing it off of some
+    # documentation that looks like it's for a slightly different protocol.
+    uint8 :mode
+    uint8 :run_status
+    uint8 :speed
+
+    uint8 :red
+    uint8 :green
+    uint8 :blue
+    uint8 :warm_white
+
+    uint16be :unused_payload, value: 0x0000
+    uint8 :checksum
+
+    def on?
+      (power_status & 0x01) == 0x01
+    end
+  end
+end

data/lib/ledenet/packets/update_color_request.rb

@@ -0,0 +1,28 @@
+require 'bindata'
+
+require 'ledenet/packets/fields/checksum'
+require 'ledenet/packets/empty_response'
+
+module LEDENET::Packets
+  class UpdateColorRequest < BinData::Record
+    hide :checksum
+
+    uint8 :packet_id, value: 0x31
+
+    uint8 :red
+    uint8 :green
+    uint8 :blue
+    uint8 :warm_white
+
+    uint8 :unused_payload, value: 0
+
+    # Not clear to me what difference this makes. Remote = 0xF0, Local = 0x0F
+    uint8 :remote_or_local, value: 0x0F
+
+    checksum :checksum, packet_data: ->() { snapshot }
+
+    def response_reader
+      LEDENET::Packets::EmptyResponse
+    end
+  end
+end

data/lib/ledenet/version.rb

@@ -1,3 +1,3 @@
 module LEDENET
-  VERSION = '0.1.11'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ledenet_api
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 1.0.0
 platform: ruby
 authors:
 - Christopher Mullins
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-16 00:00:00.000000000 Z
+date: 2016-04-30 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bindata
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -68,6 +82,12 @@ files:
 - ledenet_api.gemspec
 - lib/ledenet/api.rb
 - lib/ledenet/device_discovery.rb
+- lib/ledenet/packets/empty_response.rb
+- lib/ledenet/packets/fields/checksum.rb
+- lib/ledenet/packets/set_power_request.rb
+- lib/ledenet/packets/status_request.rb
+- lib/ledenet/packets/status_response.rb
+- lib/ledenet/packets/update_color_request.rb
 - lib/ledenet/version.rb
 - lib/ledenet_api.rb
 homepage: http://www.github.com/sidoh/ledenet_api