lifx 0.4.10 → 0.4.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86bc4e0b28d94c9b3d1d0bf22b5f550988c5cab3
-  data.tar.gz: ffc2b6c71d1f4efd5a6bd9732403599b6b357c69
+  metadata.gz: 0570f28dd8c1392dd1f3d1602d128ac3c3595184
+  data.tar.gz: 3e58c32ab27c29eac2c5dd794d3ce778ddf77c9e
 SHA512:
-  metadata.gz: f580ff26c0612fa04dff785c06f770b0bcbd262c463f826dc0795e2339ed61d5ef28a0bd13563b592b636e6ad57086a0d2702147b4b07430a7c910550ea91fc5
-  data.tar.gz: b6a20e239ac5a9b97fc2f8fad4f794937438b6b07439aabcb4c9bf28295b3eec5c3c8b35c973cb023f4a0c787a3ea2f0e8f811fb10b09f10690895b2aa025b0a
+  metadata.gz: 5d001b9118b4d9648758ff41ffa12bad61e37c1df1fe3068ed9bdc47a65d0ba094856562c7781937379a7e8bcd6a13264c813faf99ac5e1c4501f6194470dcc6
+  data.tar.gz: 46d2a75c7c97f304c8fd3f8394e70f5d58d1c80ac50ce0f7958f035158da012c00f87b410cdbe613066cfa2e6a21fa7c07180cbe8015103ad759223045951517

data/lib/lifx/config.rb

@@ -4,6 +4,8 @@ module LIFX
   Config = Configatron::Store.new
 
   Config.default_duration = 1
+  Config.message_wait_timeout = 3
+  Config.message_retry_interval = 0.5
   Config.broadcast_ip = '255.255.255.255'
   Config.allowed_transports = [:udp, :tcp]
   Config.log_invalid_messages = false

data/lib/lifx/light.rb

@@ -98,11 +98,11 @@ module LIFX
     # @raise [LabelTooLong] if label is greater than {MAX_LABEL_LENGTH}
     # @return [Light] self
     def set_label(label)
-      if label.length > MAX_LABEL_LENGTH
-        raise LabelTooLong.new("Label length must be below or equal to #{MAX_LABEL_LENGTH}")
+      if label.bytes.length > MAX_LABEL_LENGTH
+        raise LabelTooLong.new("Label length in bytes must be below or equal to #{MAX_LABEL_LENGTH}")
       end
       while self.label != label
-        send_message!(Protocol::Device::SetLabel.new(label: label), wait_for: Protocol::Device::StateLabel)
+        send_message!(Protocol::Device::SetLabel.new(label: label.encode('utf-8')), wait_for: Protocol::Device::StateLabel)
       end
       self
     end
@@ -356,9 +356,10 @@ module LIFX
     # Queues a message to be sent the Light
     # @param payload [Protocol::Payload] the payload to send
     # @param acknowledge: [Boolean] whether the device should respond
+    # @param at_time: [Integer] Unix epoch in milliseconds to run the payload. Only applicable to certain payload types.
     # @return [Light] returns self for chaining
-    def send_message(payload, acknowledge: true)
-      context.send_message(target: Target.new(device_id: id, site_id: @site_id), payload: payload, acknowledge: acknowledge)
+    def send_message(payload, acknowledge: true, at_time: nil)
+      context.send_message(target: Target.new(device_id: id, site_id: @site_id), payload: payload, acknowledge: acknowledge, at_time: at_time)
     end
 
     # An exception for when synchronous messages take too long to receive a response
@@ -373,7 +374,7 @@ module LIFX
     # @param block: [Proc] the block that is executed when the expected `wait_for` payload comes back. If the return value is false or nil, it will try to send the message again.
     # @return [Object] the truthy result of `block` is returned.
     # @raise [MessageTimeout] if the device doesn't respond in time
-    def send_message!(payload, wait_for: wait_for, wait_timeout: 3, &block)
+    def send_message!(payload, wait_for: wait_for, wait_timeout: Config.message_wait_timeout, retry_interval: Config.message_retry_interval, &block)
       if Thread.current[:sync_enabled]
         raise "Cannot use synchronous methods inside a sync block"
       end
@@ -385,7 +386,7 @@ module LIFX
           result = block.call(payload)
         }
         add_hook(wait_for, proc)
-        try_until -> { result }, signal: @message_signal do
+        try_until -> { result }, action_interval: retry_interval, signal: @message_signal do
           send_message(payload)
         end
         result
@@ -405,7 +406,7 @@ module LIFX
 
     def add_hooks
       add_hook(Protocol::Device::StateLabel) do |payload|
-        @label = payload.label.to_s
+        @label = payload.label.to_s.force_encoding('utf-8')
         seen!
       end
 

data/lib/lifx/light_collection.rb

@@ -22,7 +22,7 @@ module LIFX
     # Creates a {LightCollection} instance. Should not be used directly.
     # @api private
     # @param context: [NetworkContext] NetworkContext this collection belongs to
-    # @param tag: [String] Tag 
+    # @param tag: [String] Tag
     def initialize(context: required!(:context), tag: nil)
       @context = context
       @tag = tag
@@ -31,13 +31,14 @@ module LIFX
     # Queues a {Protocol::Payload} to be sent to bulbs in the collection
     # @param payload [Protocol::Payload] Payload to be sent
     # @param acknowledge: [Boolean] whether recipients should acknowledge message
+    # @param at_time: [Integer] Unix epoch in milliseconds to run the payload. Only applicable to certain payload types.
     # @api private
     # @return [LightCollection] self for chaining
-    def send_message(payload, acknowledge: false)
+    def send_message(payload, acknowledge: false, at_time: nil)
       if tag
-        context.send_message(target: Target.new(tag: tag), payload: payload, acknowledge: acknowledge)
+        context.send_message(target: Target.new(tag: tag), payload: payload, acknowledge: acknowledge, at_time: at_time)
       else
-        context.send_message(target: Target.new(broadcast: true), payload: payload, acknowledge: acknowledge)
+        context.send_message(target: Target.new(broadcast: true), payload: payload, acknowledge: acknowledge, at_time: at_time)
       end
       self
     end

data/lib/lifx/light_target.rb

@@ -26,7 +26,7 @@ module LIFX
                             stream: 0,
                             transient: true,
                             period: 1.0,
-                            duty_cycle: 0.5,
+                            skew_ratio: 0.5,
                             acknowledge: false)
       send_message(Protocol::Light::SetWaveform.new(
         color: color.to_hsbk,
@@ -35,7 +35,7 @@ module LIFX
         stream: stream,
         transient: transient,
         period: (period * 1_000).to_i,
-        duty_cycle: (duty_cycle * 65535).round - 32768
+        skew_ratio: (skew_ratio * 65535).round - 32768,
       ), acknowledge: acknowledge)
     end
 
@@ -55,7 +55,7 @@ module LIFX
                      stream: 0)
       set_waveform(color, waveform: Protocol::Light::Waveform::PULSE,
                           cycles: cycles,
-                          duty_cycle: duty_cycle,
+                          skew_ratio: 1 - duty_cycle,
                           stream: stream,
                           transient: transient,
                           period: period)
@@ -77,7 +77,7 @@ module LIFX
                     stream: 0)
       set_waveform(color, waveform: Protocol::Light::Waveform::SINE,
                           cycles: cycles,
-                          duty_cycle: peak,
+                          skew_ratio: peak,
                           stream: stream,
                           transient: transient,
                           period: period)
@@ -112,10 +112,12 @@ module LIFX
     # @note Marked as private pending bug fixes in firmware
     def triangle(color, cycles: 1,
                      period: 1.0,
+                     peak: 0.5,
                      transient: true,
                      stream: 0)
       set_waveform(color, waveform: Protocol::Light::Waveform::TRIANGLE,
                           cycles: cycles,
+                          skew_ratio: peak,
                           stream: stream,
                           transient: transient,
                           period: period)
@@ -197,13 +199,5 @@ module LIFX
     def set_time(time = Time.now)
       send_message(Protocol::Device::SetTime.new(time: (time.to_f * NSEC_IN_SEC).round))
     end
-
-
-    # Attempts to reboots the light(s).
-    # This method cannot guarantee the message was received.
-    # @return [Light, LightCollection] self for chaining
-    def reboot!
-      send_message(Protocol::Device::Reboot.new)
-    end
   end
 end

data/lib/lifx/network_context.rb

@@ -61,11 +61,12 @@ module LIFX
     # @param target: [Target] Target of the message
     # @param payload: [Protocol::Payload] Message payload
     # @param acknowledge: [Boolean] If recipients must acknowledge with a response
-    def send_message(target: required!(:target), payload: required!(:payload), acknowledge: false)
+    # @param at_time: [Integer] Unix epoch in milliseconds to run the payload. Only applicable to certain payload types.
+    def send_message(target: required!(:target), payload: required!(:payload), acknowledge: false, at_time: nil)
       paths = @routing_manager.resolve_target(target)
 
       messages = paths.map do |path|
-        Message.new(path: path, payload: payload, acknowledge: acknowledge)
+        Message.new(path: path, payload: payload, acknowledge: acknowledge, at_time: at_time)
       end
 
       if within_sync?

data/lib/lifx/protocol/light.rb

@@ -40,7 +40,7 @@ module LIFX
         hsbk :color
         uint32 :period # Milliseconds per cycle.
         float :cycles
-        int16 :duty_cycle
+        int16 :skew_ratio
         uint8 :waveform
       end
 

data/lib/lifx/routing_manager.rb

@@ -53,6 +53,7 @@ module LIFX
 
     def tags_for_device_id(device_id)
       entry = @routing_table.entry_for_device_id(device_id)
+      return [] if entry.nil?
       entry.tag_ids.map do |tag_id|
         tag = @tag_table.entry_with(site_id: entry.site_id, tag_id: tag_id)
         tag && tag.label

data/lib/lifx/tag_manager.rb

@@ -28,7 +28,7 @@ module LIFX
       # we don't receive a StateTagLabels before another tag gets created
       @tag_table.update_table(tag_id: id, label: label, site_id: site_id)
       context.send_message(target: Target.new(site_id: site_id),
-                           payload: Protocol::Device::SetTagLabels.new(tags: id_to_tags_field(id), label: label))
+                           payload: Protocol::Device::SetTagLabels.new(tags: id_to_tags_field(id), label: label.encode('utf-8')))
     end
 
     def add_tag_to_device(tag: required!(:tag), device: required!(:device))

data/lib/lifx/version.rb

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

data/spec/integration/light_spec.rb

@@ -32,11 +32,22 @@ module LIFX
     end
 
     describe '#set_label' do
-      let(:label) { light.label.sub(/\d+|$/, rand(100).to_s) }
+      let!(:original_label) { light.label }
+
+      after do
+        light.set_label(original_label)
+      end
 
       it 'sets the label of the light synchronously' do
+        label = light.label.sub(/\d+|$/, rand(100).to_s)
+        light.set_label(label)
+        expect(light.label).to eq(label)
+      end
+
+      it 'works with accented characters' do
+        label = 'tést'
         light.set_label(label)
-        expect(light.label).to eq label
+        expect(light.label).to eq(label)
       end
     end
   end

data/spec/integration/tags_spec.rb

@@ -29,5 +29,12 @@ module LIFX
       lifx.purge_unused_tags!
       expect(lifx.unused_tags).to be_empty
     end
+
+    it 'handles non-ascii tags' do
+      light.add_tag('_tést')
+      expect(light.tags).to include('_tést')
+      light.remove_tag('_tést')
+      lifx.purge_unused_tags!
+    end
   end
 end

data/spec/message_spec.rb

@@ -48,7 +48,7 @@ describe LIFX::Message do
       expect(payload.color.kelvin).to eq 3_500
       expect(payload.period).to eq 200
       expect(payload.cycles).to eq 1.0
-      expect(payload.duty_cycle).to eq 0
+      expect(payload.skew_ratio).to eq 0
       expect(payload.waveform).to eq 0
     end
 

metadata

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