ledenet_api 1.2.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c112b458368c3f972704f893137b3b0beb90351b
-  data.tar.gz: 0858ba4f9ca296a3d43dd3927f236ecd9f060076
+  metadata.gz: f8da932bc83469d8b334561d08eabd1030db8849
+  data.tar.gz: 2f241cab885aa1cfc4ef122724a918d919f1b9d6
 SHA512:
-  metadata.gz: 2ef300b491b7636e9b271b8a78386074bd7be8b7a179aa69eeb88022fde35edecf1b07da21e36251e6a86d8d7528175f3ba58e5516f7784004a7f2bcdfa0e879
-  data.tar.gz: 7bef60358efe62a5e03a72bb826fa797a492d4bbcc4166cebd8e8efc8f482de4913c226595ae350d41e750c3fd271fadd5857a1bfbc6bb7b7bbb7ea658489046
+  metadata.gz: 6eed4e0f31aa24481f0991d2d868ca297cb6441626f80dbb8091b3e6f1a0e13a31a78bd2607c7fe0abbd7dab2c0f10f8c248388e059665464f4d820999dafbc3
+  data.tar.gz: 098e2b9799d91d21d3f07c829493937f4da485979072613afa373ff902a41f09372c4f5cf5ce997f2960779a42f55c4b52e8d3f2c9fe9eeeb6aa7d62a3b3615d

data/README.md

@@ -39,9 +39,11 @@ $ ledenet-ufo
     -w, --warm-white [VALUE]         Set warm white to VALUE
         --on                         Turn on the controller
         --off                        Turn off the controller
-    -l, --list                       Prints a list of available devices and exists
+    -l, --list                       Prints a list of available devices and exits
     -s, --status                     Prints status as JSON
     -h, --help                       Prints this help message
+        --function-id [VALUE]        Set function id to VALUE
+    -f, --function [VALUE]           Set function to VALUE.
 ```
 
 When using it, you can specify the IP address, hardware (mac) address, or let `ledenet_api` choose an arbitrary device on the local network (this would work well if you only have one).
@@ -76,6 +78,12 @@ $ ledenet-ufo --on -r 200 -g 0 -b 255 --warm-white 0 --status
 $ ledenet-ufo --off
 ```
 
+#### Set function
+
+```
+$ ledenet-ufo --function seven_color_cross_fade --speed 10
+```
+
 ### Ruby API
 
 #### Device discovery
@@ -161,3 +169,27 @@ api.update_color_data(red: 100)
 
 api.update_color_data(blue: 255, warm_white: 0)
 ```
+
+#### Functions
+
+The UFO devices ship with 20 pre-programmed lighting functions. ledenet_api has support for these:
+
+```ruby
+LEDENET::Functions.all_functions
+#=> [:SEVEN_COLOR_CROSS_FADE, :RED_GRADUAL_CHANGE, :GREEN_GRADUAL_CHANGE, :BLUE_GRADUAL_CHANGE, :YELLOW_GRADUAL_CHANGE, :CYAN_GRADUAL_CHANGE, :PURPLE_GRADUAL_CHANGE, :WHITE_GRADUAL_CHANGE, :RED_GREEN_CROSS_FADE, :RED_BLUE_CROSS_FADE, :SEVEN_COLOR_STROBE_FLASH, :RED_STROBE_FLASH, :GREEN_STROBE_FLASH, :BLUE_STROBE_FLASH, :YELLOW_STROBE_FLASH, :CYAN_STROBE_FLASH, :PURPLE_STROBE_FLASH, :WHITE_STROBE_FLASH, :SEVEN_COLOR_JUMPING_CHANGE, :GREEN_BLUE_CROSS_FADE]
+```
+
+```ruby
+fn = LEDENET::Functions::SEVEN_COLOR_CROSS_FADE
+speed = 0 # very slow
+
+api.update_function(fn, speed)
+
+api.update_function(:blue_green_cross_fade, 100) # Very fast
+```
+
+To quit the function and return to a constant color, simply update a color value:
+
+```ruby
+api.update_color_data(warm_white: 255)
+```

data/bin/ledenet-ufo

@@ -99,12 +99,6 @@ if options[:list] && options.count > 1
   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]
     devices = LEDENET.discover_devices(expected_devices: 1000)
@@ -136,22 +130,28 @@ begin
 
     api = LEDENET::Api.new(ip)
 
-    api.set_power(options[:on?]) unless options[:on?].nil?
-
     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])
+    if !options[:on?].nil?
+      api.set_power(options[:on?])
     end
 
-    if options[:print_status?]
-      status = api.current_color_data
-      status = status.merge(is_on: api.on?)
+    if color_params.any?
+      api.update_color_data(color_params)
+    end
 
-      puts status.to_json
+    if options[:function]
+      api.update_function(options[:function])
+    end
+
+    if options[:speed]
+      api.update_function_speed(options[:speed])
+    end
+
+    if options[:print_status?]
+      puts api.status.to_json
     end
   end
 rescue Exception => e

data/lib/ledenet/api.rb

@@ -16,6 +16,13 @@ module LEDENET
       @options = DEFAULT_OPTIONS.merge(options)
     end
 
+    def status
+      response = request_status
+      status = { is_on: on?(response) }
+      status.merge!(current_color_data(response))
+      status.merge!(current_function_data(response))
+    end
+
     def on
       send_packet(LEDENET::Packets::SetPowerRequest.on_request)
     end
@@ -28,8 +35,8 @@ module LEDENET
       v ? on : off
     end
 
-    def on?
-      status.on?
+    def on?(response = request_status)
+      response.on?
     end
 
     def update_rgb(r, g, b)
@@ -53,20 +60,47 @@ module LEDENET
       current_color_data[:warm_white]
     end
 
-    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]
+    def current_color_data(response = request_status)
+      select_status_keys(response, *%w{red green blue warm_white})
     end
 
-    def update_function(fn, speed)
+    def update_function(fn)
       if fn.is_a?(String) or fn.is_a?(Symbol)
         fn = LEDENET::Functions.const_get(fn.upcase)
       end
+      update_function_data(function_id: fn)
+    end
 
-      send_packet(LEDENET::Packets::SetFunctionRequest.new(function_id: fn, speed: speed))
+    def update_function_speed(s)
+      update_function_data(speed: s)
+    end
+
+    def update_function_data(o)
+      o = {}.merge(o)
+      current_data = current_function_data
+      updated_data = {
+        function_id: current_data[:function_id],
+        speed: current_data[:speed_packet_value]
+      }
+
+      if o[:speed]
+        speed = LEDENET::FunctionSpeed.from_value(o.delete(:speed))
+        updated_data[:speed] = speed.packet_value
+      end
+      updated_data.merge!(o)
+
+      send_packet(LEDENET::Packets::SetFunctionRequest.new(updated_data))
+    end
+
+    def current_function_data(response = request_status)
+      raw_function_data = select_status_keys(response, *%w{mode speed})
+      function_data = {
+        running_function?: raw_function_data[:mode] != LEDENET::Functions::NO_FUNCTION,
+        speed: FunctionSpeed.from_packet_value(raw_function_data[:speed]).value,
+        speed_packet_value: raw_function_data[:speed],
+        function_name: LEDENET::Functions.value_of(raw_function_data[:mode]),
+        function_id: raw_function_data[:mode]
+      }
     end
 
     def reconnect!
@@ -85,8 +119,17 @@ module LEDENET
     end
 
     private
-      def status
-        send_packet(LEDENET::Packets::StatusRequest.new)
+      def select_status_keys(status_response, *keys)
+        color_data = keys.map do |x|
+          [x.to_sym, status_response.send(x)]
+        end
+        Hash[color_data]
+      end
+
+      def request_status
+        s = send_packet(LEDENET::Packets::StatusRequest.new)
+        puts s.inspect
+        s
       end
 
       def create_socket

data/lib/ledenet/function_speed.rb

@@ -0,0 +1,36 @@
+module LEDENET
+  class FunctionSpeed
+    # Speed range exposed through API
+    INTERFACE_SPEED_RANGE = (1..100)
+
+    # Speed value is in [0x01, 0x1F], with 0x00 being the fastest.
+    PACKET_SPEED_RANGE = (0x01..0x1F)
+
+    attr_reader :value
+
+    def initialize(value)
+      @value = value
+    end
+
+    def packet_value
+      FunctionSpeed.convert_range(value, INTERFACE_SPEED_RANGE, PACKET_SPEED_RANGE)
+    end
+
+    def self.from_value(value)
+      FunctionSpeed.new(value)
+    end
+
+    def self.from_packet_value(value)
+      v = FunctionSpeed.convert_range(value, PACKET_SPEED_RANGE, INTERFACE_SPEED_RANGE)
+      FunctionSpeed.new(v)
+    end
+
+    private
+      def self.convert_range(value, from, to)
+        scaled_speed = (value / (from.max.to_f / to.max)).round
+        scaled_speed = [to.min, scaled_speed].max
+        scaled_speed = [to.max, scaled_speed].min
+        to.max - scaled_speed
+      end
+  end
+end

data/lib/ledenet/functions.rb

@@ -20,11 +20,16 @@ module LEDENET
       CYAN_STROBE_FLASH = 0x35,
       PURPLE_STROBE_FLASH = 0x36,
       WHITE_STROBE_FLASH = 0x37,
-      SEVEN_COLOR_JUMPING_CHANGE = 0x38
+      SEVEN_COLOR_JUMPING_CHANGE = 0x38,
+      NO_FUNCTION = 0x61
     ]
 
     def self.all_functions
       LEDENET::Functions.constants.reject { |x| x == :VALUES }
     end
+
+    def self.value_of(i)
+      all_functions.select { |x| self.const_get(x) == i }.first
+    end
   end
 end

data/lib/ledenet/packets/set_function_request.rb

@@ -5,30 +5,11 @@ 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 :function_id
+    uint8 :speed
     uint8 :remote_or_local, value: 0x0F
     checksum :checksum, packet_data: ->() { snapshot }
 

data/lib/ledenet/packets/status_response.rb

@@ -21,7 +21,7 @@ module LEDENET::Packets
     uint8 :blue
     uint8 :warm_white
 
-    uint16be :unused_payload
+    uint24be :unused_payload
     uint8 :checksum
 
     def on?

data/lib/ledenet/version.rb

@@ -1,3 +1,3 @@
 module LEDENET
-  VERSION = '1.2.2'
+  VERSION = '1.4.0'
 end

data/lib/ledenet_api.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ledenet_api
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.4.0
 platform: ruby
 authors:
 - Christopher Mullins
@@ -98,6 +98,7 @@ files:
 - ledenet_api.gemspec
 - lib/ledenet/api.rb
 - lib/ledenet/device_discovery.rb
+- lib/ledenet/function_speed.rb
 - lib/ledenet/functions.rb
 - lib/ledenet/packets/empty_response.rb
 - lib/ledenet/packets/fields/checksum.rb