ledenet_api 1.1.2 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b2322ff3b2b79724713e5b7b620a1f3d160fc61
-  data.tar.gz: 0313e482fccc8cd041f2440f802220e50d1151f1
+  metadata.gz: 6b35153c257762f08c7ddfe36ec752d8a31ab43a
+  data.tar.gz: 8db99c674a748d3ed59154a186f9591c7be052a0
 SHA512:
-  metadata.gz: c5088d200d263359d2846de07822c1d3dbbc4f98fac1482677264d5c86dd28629127ccfebba560fc530fe1898d2a8f1ccf33db2dccaccdff365b484995d31c54
-  data.tar.gz: f942c29bb3e5a98f945f1b9c258b46547300834687f2c0bacff6c497f1492a9ea35c5d0a41ae462c5a3374c1ec9be3c65230c8ddd58047f37dee4a20c121941b
+  metadata.gz: 3a41d1078922bdf008dc686a1c9f24fb19a5feb3c7cad107fb74fbf249926f94b66c43e56f529db4b75c6c5d635ca453e6dcaf8b5822a535e8ab7bc126479b3f
+  data.tar.gz: c20ff4d69afba7a115c750727399211c7c92a93a91147eff469a4ea760bb4a75bd1700b9e791e4e41e0909256229dabeb8de19069bc1c346aa10f5446ed59342

data/bin/ledenet-ufo

@@ -53,7 +53,7 @@ opts = OptionParser.new do |opts|
     options[:on?] = false
   end
 
-  opts.on("-l", "--list", Integer, "Prints a list of available devices and exits") do |v|
+  opts.on("-l", "--list", "Prints a list of available devices and exits") do |v|
     options[:list] = true
   end
 
@@ -64,6 +64,24 @@ opts = OptionParser.new do |opts|
   opts.on("-h", "--help", "Prints this help message") do
     options[:print_help?] = true
   end
+
+  opts.on("--function-id [VALUE]", Integer, "Set function id to VALUE") do |v|
+    options[:function] = v
+  end
+
+  opts.on("-f", "--function [VALUE]", "Set function to VALUE.") do |v|
+    if !LEDENET::Functions.const_defined?(v)
+      warn "Unknown function type: #{v}. Valid function types: \n\t" <<
+           "#{LEDENET::Functions.all_functions.join("\n\t")}"
+      exit 1
+    end
+
+    options[:function] = LEDENET::Functions.const_get(v)
+  end
+
+  opts.on("-p", "--speed [VALUE]", Integer, "Set function speed to VALUE") do |v|
+    options[:speed] = v
+  end
 end
 
 opts.parse!
@@ -73,14 +91,20 @@ if options[:print_help?] || options.empty?
   exit 0
 end
 
+if options[:list] && options.count > 1
+  warn "--list is incompatible with other options!\n\n"
+  warn opts
+  exit 1
+end
+
+if options[:function].nil? != options[:speed].nil?
+  warn "--funciton and --speed must be specified together. You provide " <<
+       "one without also providing the other."
+  exit 1
+end
+
 begin
   if options[:list]
-    if options.count > 1
-      warn "--list is incompatible with other options!\n\n"
-      warn opts
-      exit 1
-    end
-
     devices = LEDENET.discover_devices(expected_devices: 1000)
 
     row_format = "%16s %18s %20s\n"
@@ -111,7 +135,15 @@ begin
     api = LEDENET::Api.new(ip)
 
     api.set_power(options[:on?]) unless options[:on?].nil?
-    api.update_color_data(options.select { |k,_| %w{red green blue warm_white}.include?(k.to_s) })
+
+    color_params = options.select do |k,_|
+      %w{red green blue warm_white}.include?(k.to_s)
+    end
+    api.update_color_data(color_params) unless color_params.empty?
+
+    if options[:function] && options[:speed]
+      api.update_function(options[:function], options[:speed])
+    end
 
     if options[:print_status?]
       status = api.current_color_data

data/lib/ledenet/api.rb

@@ -1,6 +1,7 @@
 require 'ledenet/packets/set_power_request'
 require 'ledenet/packets/status_request'
 require 'ledenet/packets/update_color_request'
+require 'ledenet/packets/set_function_request'
 
 module LEDENET
   class Api
@@ -60,6 +61,14 @@ module LEDENET
       Hash[color_data]
     end
 
+    def update_function(fn, speed)
+      if fn.is_a?(String) or fn.is_a?(Symbol)
+        fn = LEDENET::Functions.const_get(fn.upcase)
+      end
+
+      send_packet(LEDENET::Packets::SetFunctionRequest.new(function_id: fn, speed: speed))
+    end
+
     def reconnect!
       create_socket
       true

data/lib/ledenet/functions.rb

@@ -0,0 +1,30 @@
+module LEDENET
+  module Functions
+    VALUES = [
+      SEVEN_COLOR_CROSS_FADE = 0x25,
+      RED_GRADUAL_CHANGE = 0x26,
+      GREEN_GRADUAL_CHANGE = 0x27,
+      BLUE_GRADUAL_CHANGE = 0x28,
+      YELLOW_GRADUAL_CHANGE = 0x29,
+      CYAN_GRADUAL_CHANGE = 0x2A,
+      PURPLE_GRADUAL_CHANGE = 0x2B,
+      WHITE_GRADUAL_CHANGE = 0x2C,
+      RED_GREEN_CROSS_FADE = 0x2D,
+      RED_BLUE_CROSS_FADE = 0x2E,
+      GREEN_BLUE_CROSS_FADE = 0x2F,
+      SEVEN_COLOR_STROBE_FLASH = 0x30,
+      RED_STROBE_FLASH = 0x31,
+      GREEN_STROBE_FLASH = 0x32,
+      BLUE_STROBE_FLASH = 0x33,
+      YELLOW_STROBE_FLASH = 0x34,
+      CYAN_STROBE_FLASH = 0x35,
+      PURPLE_STROBE_FLASH = 0x36,
+      WHITE_STROBE_FLASH = 0x37,
+      SEVEN_COLOR_JUMPING_CHANGE = 0x38
+    ]
+
+    def self.all_functions
+      LEDENET::Functions.constants.reject { |x| x == :VALUES }
+    end
+  end
+end

data/lib/ledenet/packets/empty_response.rb

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

data/lib/ledenet/packets/set_function_request.rb

@@ -0,0 +1,39 @@
+require 'bindata'
+
+require 'ledenet/packets/fields/checksum'
+require 'ledenet/packets/empty_response'
+
+module LEDENET::Packets
+  class SetFunctionRequest < BinData::Record
+    VALID_SPEED_RANGE = (0..100)
+
+    # Speed value is in [0x00, 0x20], with 0x00 being the fastest.
+    PACKET_SPEED_RANGE = (0x00..0x20)
+
+    hide :checksum
+    mandatory_parameter :function_id
+    mandatory_parameter :speed
+
+    uint8 :packet_id, value: 0x61
+    uint8 :function_id_val, value: ->() { function_id }
+
+    uint8 :speed_val, value: ->() do
+      if !VALID_SPEED_RANGE.include?(speed)
+        raise "Speed should be between #{VALID_SPEED_RANGE.min} and #{VALID_SPEED_RANGE.max}"
+      end
+
+      scaled_speed = (speed / (VALID_SPEED_RANGE.max / PACKET_SPEED_RANGE.max)).round
+      scaled_speed = [PACKET_SPEED_RANGE.min, scaled_speed].max
+      scaled_speed = [PACKET_SPEED_RANGE.max, scaled_speed].min
+
+      PACKET_SPEED_RANGE.max - scaled_speed
+    end
+
+    uint8 :remote_or_local, value: 0x0F
+    checksum :checksum, packet_data: ->() { snapshot }
+
+    def response_reader
+      LEDENET::Packets::EmptyResponse
+    end
+  end
+end

data/lib/ledenet/packets/status_response.rb

@@ -4,7 +4,7 @@ require 'ledenet/packets/fields/checksum'
 
 module LEDENET::Packets
   class StatusResponse < BinData::Record
-    hide :checksum, :unused_payload
+    hide :checksum
 
     uint8 :packet_id, value: 0x81
     uint8 :device_name
@@ -21,7 +21,7 @@ module LEDENET::Packets
     uint8 :blue
     uint8 :warm_white
 
-    uint16be :unused_payload, value: 0x0000
+    uint16be :unused_payload
     uint8 :checksum
 
     def on?

data/lib/ledenet/version.rb

@@ -1,3 +1,3 @@
 module LEDENET
-  VERSION = '1.1.2'
+  VERSION = '1.2.1'
 end

data/lib/ledenet_api.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ledenet_api
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.2.1
 platform: ruby
 authors:
 - Christopher Mullins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-30 00:00:00.000000000 Z
+date: 2016-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bindata
@@ -98,8 +98,10 @@ files:
 - ledenet_api.gemspec
 - lib/ledenet/api.rb
 - lib/ledenet/device_discovery.rb
+- lib/ledenet/functions.rb
 - lib/ledenet/packets/empty_response.rb
 - lib/ledenet/packets/fields/checksum.rb
+- lib/ledenet/packets/set_function_request.rb
 - lib/ledenet/packets/set_power_request.rb
 - lib/ledenet/packets/status_request.rb
 - lib/ledenet/packets/status_response.rb