lifx 0.4.8 → 0.4.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4d3a3b49f4182b136607335b3439a6d8c475af4
-  data.tar.gz: 5119e5d44ca2c1649a9f4226678dc1c3c04900c3
+  metadata.gz: 86bc4e0b28d94c9b3d1d0bf22b5f550988c5cab3
+  data.tar.gz: ffc2b6c71d1f4efd5a6bd9732403599b6b357c69
 SHA512:
-  metadata.gz: 76282a8c2b04cf4f0c0b199532d2847b97eacf7f8313c246c9aedafbf1cf6d35b02d9c75e75d472bb4f41a278988b92aae63cace417e5902a9e84095161f62f2
-  data.tar.gz: 0b81b9d0165ce833a8436bb597a5f6398ebf4cebee892f02116a6af9a7450b851c782639c9c077b8672bd3b836cf1f6be03e7dfb219ca02f3255165b12311355
+  metadata.gz: f580ff26c0612fa04dff785c06f770b0bcbd262c463f826dc0795e2339ed61d5ef28a0bd13563b592b636e6ad57086a0d2702147b4b07430a7c910550ea91fc5
+  data.tar.gz: b6a20e239ac5a9b97fc2f8fad4f794937438b6b07439aabcb4c9bf28295b3eec5c3c8b35c973cb023f4a0c787a3ea2f0e8f811fb10b09f10690895b2aa025b0a

data/CHANGES.md

@@ -1,3 +1,12 @@
+### 0.4.10
+
+- Fix `message_rate` visibility bug
+
+### 0.4.9
+
+- Message rate checker only runs when connection is idle
+- Now uses `LIFX::TimeoutError` rather than `Timeout::Error` for internal timeout exceptions
+
 ### 0.4.8
 
 - Routing table is only updated from State messages

data/Rakefile

@@ -7,6 +7,7 @@ end
 task :default => :spec
 
 task :console do
+  $LOAD_PATH << "lib"
   require "lifx"
   require "pry"
   if ENV['DEBUG']

data/lib/lifx.rb

@@ -20,4 +20,6 @@ require "lifx/client"
 
 module LIFX
   NULL_SITE_ID = "000000000000"
+
+  class TimeoutError < StandardError; end
 end

data/lib/lifx/client.rb

@@ -39,13 +39,13 @@ module LIFX
       @context.discover
     end
 
-    class DiscoveryTimeout < Timeout::Error; end
+    class DiscoveryTimeout < TimeoutError; end
     # This method tells the {NetworkContext} to look for devices, and will block
     # until there's at least one device.
     #
     # @example Wait until at least three lights have been found
     #   client.discover! { |c| c.lights.count >= 3 }
-    # 
+    #
     # @param timeout: [Numeric] How long to try to wait for before returning
     # @param condition_interval: [Numeric] Seconds between evaluating the block
     # @yield [Client] This block is evaluated every `condition_interval` seconds. If true, method returns. If no block is supplied, it will block until it finds at least one light.
@@ -75,7 +75,7 @@ module LIFX
     #
     # You cannot nest `sync` calls, nor call synchronous methods inside a `sync` block.
     #
-    # Due to messaging rate constraints, the amount of messages determine the delay before 
+    # Due to messaging rate constraints, the amount of messages determine the delay before
     # the commands are executed. This method also assumes all the lights have the same time.
     # @example This example sets all the lights to a random colour at the same time.
     #   client.sync do
@@ -128,7 +128,7 @@ module LIFX
 
     # Blocks until all messages have been sent to the gateways
     # @param timeout: [Numeric] When specified, flush will wait `timeout:` seconds before throwing `Timeout::Error`
-    # @raise [Timeout::Error] if `timeout:` was exceeded while waiting for send queue to flush
+    # @raise [TimeoutError] if `timeout:` was exceeded while waiting for send queue to flush
     # @return [void]
     def flush(timeout: nil)
       context.flush(timeout: timeout)

data/lib/lifx/gateway_connection.rb

@@ -90,7 +90,7 @@ module LIFX
         end
       end
       if timeout
-        Timeout.timeout(timeout) do
+        Timeout.timeout(timeout, TimeoutError) do
           proc.call
         end
       else

data/lib/lifx/light.rb

@@ -332,6 +332,12 @@ module LIFX
       context.tags_for_device(self)
     end
 
+    # Returns whether the light is a gateway
+    # @api private
+    def gateway?
+      context.transport_manager.gateways.include?(self)
+    end
+
     # Returns a nice string representation of the Light
     # @return [String]
     def to_s
@@ -356,7 +362,9 @@ module LIFX
     end
 
     # An exception for when synchronous messages take too long to receive a response
-    class MessageTimeout < StandardError; end
+    class MessageTimeout < TimeoutError
+      attr_accessor :device
+    end
 
     # Queues a message to be sent to the Light and waits for a response
     # @param payload [Protocol::Payload] the payload to send
@@ -381,10 +389,11 @@ module LIFX
           send_message(payload)
         end
         result
-      rescue Timeout::Error
+      rescue TimeoutError
         backtrace = caller_locations(2).map { |c| c.to_s }
         caller_method = caller_locations(2, 1).first.label
         ex = MessageTimeout.new("#{caller_method}: Timeout exceeded waiting for response from #{self}")
+        ex.device = self
         ex.set_backtrace(backtrace)
         raise ex
       ensure

data/lib/lifx/light_target.rb

@@ -41,7 +41,7 @@ module LIFX
 
     # Attempts to make the light(s) pulse `color` and then back to its original color. Asynchronous.
     # @param color [Color] Color to pulse
-    # @param duty_cycle: [Float] Percentage of a cycle the light(s) is set to `color`
+    # @param duty_cycle: [Float] Ratio of a cycle the light(s) is set to `color`
     # @param cycles: [Integer] Number of cycles
     # @param transient: [Boolean] If false, the light will remain at the color the waveform is at when it ends
     # @param period: [Integer] Number of seconds a cycle. Must be above 1.0 (?)
@@ -64,6 +64,7 @@ module LIFX
     # Attempts to make the light(s) transition to `color` and back in a smooth sine wave. Asynchronous.
     # @param color [Color] Color
     # @param cycles: [Integer] Number of cycles
+    # @param peak: [Float] Defines the peak point of the wave. Defaults to 0.5 which is a standard sine
     # @param transient: [Boolean] If false, the light will remain at the color the waveform is at when it ends
     # @param period: [Integer] Number of seconds a cycle. Must be above 1.0 (?)
     # @param stream: [Integer] Unused
@@ -71,11 +72,12 @@ module LIFX
     # @note Marked as private pending bug fixes in firmware
     def sine(color, cycles: 1,
                     period: 1.0,
+                    peak: 0.5,
                     transient: true,
                     stream: 0)
       set_waveform(color, waveform: Protocol::Light::Waveform::SINE,
                           cycles: cycles,
-                          duty_cycle: 0,
+                          duty_cycle: peak,
                           stream: stream,
                           transient: transient,
                           period: period)
@@ -140,7 +142,7 @@ module LIFX
 
     # Attempts to set the power state to `state` asynchronously.
     # This method cannot guarantee the message was received.
-    # @param state [:on, :off] 
+    # @param state [:on, :off]
     # @return [Light, LightCollection] self for chaining
     def set_power(state)
       level = case state

data/lib/lifx/network_context.rb

@@ -38,8 +38,8 @@ module LIFX
       @transport_manager.discover
     end
 
-    def refresh
-      @routing_manager.refresh
+    def refresh(force: true)
+      @routing_manager.refresh(force: force)
     end
 
     def reset!
@@ -86,9 +86,10 @@ module LIFX
     # Synchronize asynchronous set_color, set_waveform and set_power messages to multiple devices.
     # You cannot use synchronous methods in the block
     # @note This is alpha
+    # @param delay: [Float] The delay to add to sync commands when dealing with latency.
     # @yield Block to synchronize commands in
     # @return [Float] Delay before messages are executed
-    def sync(&block)
+    def sync(delay: 0, &block)
       if within_sync?
         raise "You cannot nest sync"
       end
@@ -106,7 +107,7 @@ module LIFX
         time = light && light.time
       end
 
-      delay = (messages.count + 1) * (1.0 / @transport_manager.message_rate)
+      delay += (messages.count + 1) * (1.0 / @transport_manager.message_rate)
       at_time = ((time.to_f + delay) * 1_000_000_000).to_i
       messages.each do |m|
         m.at_time = at_time

data/lib/lifx/observable.rb

@@ -8,7 +8,7 @@ module LIFX
 
     def add_observer(obj, type, &callback)
       if !callback_type_exists?(type)
-        raise ObserverCallbackNotFound.new
+        raise ObserverCallbackNotFound.new("Callback #{type} not found in #{observer_callback_definition.keys}")
       end
       if !callback_has_required_keys?(type, callback)
         raise ObserverCallbackMismatch.new
@@ -25,6 +25,9 @@ module LIFX
     end
 
     def notify_observers(type, **args)
+      if !callback_type_exists?(type)
+        raise ObserverCallbackNotFound.new("Callback #{type} not found in #{observer_callback_definition.keys}")
+      end
       observers[type].each do |_, callback|
         callback.call(**args)
       end

data/lib/lifx/routing_manager.rb

@@ -96,10 +96,10 @@ module LIFX
       end
     end
 
-    MINIMUM_REFRESH_INTERVAL = 20
-    def refresh
+    MINIMUM_REFRESH_INTERVAL = 15
+    def refresh(force: false)
       @routing_table.site_ids.each do |site_id|
-        next if (seen = @last_refresh_seen[site_id]) && Time.now - seen < MINIMUM_REFRESH_INTERVAL
+        next if (seen = @last_refresh_seen[site_id]) && Time.now - seen < MINIMUM_REFRESH_INTERVAL && !force
         refresh_site(site_id)
       end
     end

data/lib/lifx/transport_manager.rb

@@ -30,7 +30,8 @@ module LIFX
 
       def observer_callback_definition
         {
-          message_received: -> (message: nil, ip: nil, transport: nil) {}
+          message_received: -> (message: nil, ip: nil, transport: nil) {},
+          disconnected: -> {}
         }
       end
     end

data/lib/lifx/transport_manager/lan.rb

@@ -80,6 +80,7 @@ module LIFX
           end
         end
         broadcast_to_peers(message)
+        @message_rate_timer.reset
       end
 
       def on_network?
@@ -112,23 +113,29 @@ module LIFX
       end
 
       def gateways
-        @sites.values.map(&:gateways)
+        @sites.values.map(&:gateways).map(&:keys).flatten.uniq.map { |id| context.lights.with_id(id) }.compact
       end
 
       def gateway_connections
-        gateways.map(&:values).flatten
+        @sites.values.map(&:gateways).map(&:values).flatten
+      end
+
+      def message_rate
+        @message_rate || DEFAULT_MESSAGE_RATE
       end
 
       protected
 
       def initialize_periodic_refresh
         timers.every(10) do
-          context.refresh
+          context.refresh(force: false)
         end
       end
 
+      DEFAULT_MESSAGE_RATE = 5 # per second
+      MESSAGE_RATE_1_2 = 20
       def initialize_message_rate_updater
-        timers.every(5) do
+        @message_rate_timer = timers.every(2) do
           missing_mesh_firmware = context.lights.alive.select { |l| l.mesh_firmware(fetch: false).nil? }
           if missing_mesh_firmware.count > 10
             context.send_message(target: Target.new(broadcast: true), payload: Protocol::Device::GetMeshFirmware.new)
@@ -138,7 +145,7 @@ module LIFX
             @message_rate = context.lights.alive.all? do |light|
               m = light.mesh_firmware(fetch: false)
               m && m >= '1.2'
-            end ? 20 : 5
+            end ? MESSAGE_RATE_1_2 : DEFAULT_MESSAGE_RATE
             gateway_connections.each do |connection|
               connection.set_message_rate(@message_rate)
             end
@@ -146,11 +153,6 @@ module LIFX
         end
       end
 
-      DEFAULT_MESSAGING_RATE = 5 # per second
-      def message_rate
-        @message_rate || 5
-      end
-
       def initialize_transports
         create_broadcast_transport
         create_peer_transport

data/lib/lifx/utilities.rb

@@ -1,7 +1,7 @@
 module LIFX
   # @private
   module Utilities
-    def try_until(condition_proc, timeout_exception: Timeout::Error,
+    def try_until(condition_proc, timeout_exception: TimeoutError,
                                             timeout: 3,
                                  condition_interval: 0.1,
                                     action_interval: 0.5,

data/lib/lifx/version.rb

@@ -1,3 +1,3 @@
 module LIFX
-  VERSION = "0.4.8"
+  VERSION = "0.4.10"
 end

data/spec/gateway_connection_spec.rb

@@ -14,7 +14,7 @@ module LIFX
       it 'does not send if there is no available connection' do
         expect(gateway).to_not receive(:actually_write)
         gateway.write(message)
-        expect { gateway.flush(timeout: 0.5) }.to raise_error(Timeout::Error)
+        expect { gateway.flush(timeout: 0.5) }.to raise_error(TimeoutError)
       end
 
       it 'pushes message back into queue if unable to write' do

data/spec/spec_helper.rb

@@ -16,7 +16,7 @@ shared_context 'integration', integration: true do
         c.discover! do
           c.tags.include?('_Test') && c.lights.with_tag('_Test').count > 0
         end
-      rescue Timeout::Error
+      rescue DiscoveryTimeout
         raise "Could not find any lights with tag _Test in #{c.lights.inspect}"
       end
       c

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lifx
 version: !ruby/object:Gem::Version
-  version: 0.4.8
+  version: 0.4.10
 platform: ruby
 authors:
 - Jack Chen (chendo)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-05 00:00:00.000000000 Z
+date: 2014-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bindata
@@ -215,4 +215,3 @@ test_files:
 - spec/spec_helper.rb
 - spec/transport/udp_spec.rb
 - spec/transport_spec.rb
-has_rdoc: