lifx-lan 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4ef94c0b7aaaa1efaf0ed5510237c2f8e8638c69
-  data.tar.gz: 24ecd96f704325934c37882f5bd7f7417dbb4287
+SHA256:
+  metadata.gz: fc244c5415dfac35bff4c8c80184c4940d89cfec2c5fb6dbf047d710f942283a
+  data.tar.gz: b775bf867f79b919fafd741ebe2adaed14700f3f99bb8d876644cb7b2fc19f66
 SHA512:
-  metadata.gz: 87d2775a26c2104f0789d07a9bb38ea1dda76ca5d03ac3031bdd41190f76cabc34e932a5785edc940e67458fdab064874a10d50f6a06a0d41da159d8f596157a
-  data.tar.gz: 18691da3eb56988e02c2a3fb94ec9f74b1271a901ea80b76a80e6c91e85bad86b32ea7c5c77051687df06495a88e406810a8fbea5dfa6f48bd6ca53d20c1bc36
+  metadata.gz: d71cc69208fbf7f8750814903751e5069c9c8a27103aebc6615b48129a350d91674efe675ce8e01f25218744b5cc8c18f8574b194dee29c686641bf017b4cbbe
+  data.tar.gz: a34bd68e7efdd872f5b82876f73b62f51d220d3bf0fa65b7749d4c2bd4627778c5a986c69e951e0c9bfcc49e1511328546ad2e437b20b2be1e03c911d4801147

data/lib/lifx/lan/light.rb

@@ -334,6 +334,26 @@ module LIFX
         context.tags_for_device(self)
       end
 
+      def location
+        send_message!(Protocol::Device::GetLocation.new,
+            wait_for: Protocol::Device::StateLocation) do |payload|
+          {
+            location: payload.location,
+            label: payload.label
+          }
+        end
+      end
+
+      def group
+        send_message!(Protocol::Device::GetGroup.new,
+            wait_for: Protocol::Device::StateGroup) do |payload|
+          {
+            group: payload.group,
+            label: payload.label
+          }
+        end
+      end
+
       # Returns whether the light is a gateway
       # @api private
       def gateway?

data/lib/lifx/lan/light_target.rb

@@ -10,7 +10,7 @@ module LIFX
       # @param color [Color] The color to be set
       # @param duration: [Numeric] Transition time in seconds
       # @return [Light, LightCollection] self for chaining
-      def set_color(color, duration: LIFX::Config.default_duration)
+      def set_color(color, duration: LIFX::LAN::Config.default_duration)
         send_message(Protocol::Light::SetColor.new(
           color: color.to_hsbk,
           duration: (duration * MSEC_PER_SEC).to_i,
@@ -19,6 +19,60 @@ module LIFX
         self
       end
 
+      # Attempts to set multiple zones on the light(s) to `color` asynchronously.
+      # This method cannot guarantee that the message was received.
+      # @param color [Color] The color to be set
+      # @param start_index [Numeric] The index of the first zone to be set
+      # @param end_index [Numeric] The index of the last zone to be set
+      # @param duration: [Numeric] Transition time in seconds
+      # @return [Light, LightCollection] self for chaining
+      def set_multizone_color(color, start_index: 0, end_index: 7, duration: LIFX::LAN::Config.default_duration)
+        send_message(Protocol::MultiZone::SetColorZones.new(
+          start_index: start_index,
+          end_index: end_index,
+          color: color.to_hsbk,
+          duration: (duration * MSEC_PER_SEC).to_i,
+          apply: 1,
+        ))
+        self
+      end
+
+      # Attempts to set every pixel on the tile(s) to `colors` asynchronously.
+      # This method cannot guarantee that the message was received.
+      # @param colors [Array<Color>] The 64 Colors to be set as a 1-d array
+      # @param tile_start_index [Numeric] The index of the first tile to be set
+      # @param length [Numeric] The number of tiles to set starting from the index
+      # @param duration: [Numeric] Transition time in seconds
+      # @return [Light, LightCollection] self for chaining
+      def set_tile_colors(colors, tile_start_index: 0, length: 1, duration: LIFX::LAN::Config.default_duration)
+        send_message(Protocol::Tile::SetTileState64.new(
+          colors: colors.map(&:to_hsbk),
+          tile_start_index: tile_start_index,
+          tile_length: [length, 1].min,
+          x: 0,
+          y: 0,
+          width: 8,
+          duration: (duration * MSEC_PER_SEC).to_i
+        ))
+        self
+      end
+
+      # @return [Numeric] Number of zones supported
+      def zone_count
+        send_message!(Protocol::MultiZone::GetColorZones.new(start_index: 0, end_index: 0),
+            wait_for: Protocol::MultiZone::StateZone) do |payload|
+          payload.total_zones
+        end
+      end
+
+      # @return [Hash] Raw tile info
+      def tile_info
+        send_message!(Protocol::Tile::GetDeviceChain.new,
+            wait_for: Protocol::Tile::StateDeviceChain) do |payload|
+          payload
+        end
+      end
+
       # Attempts to apply a waveform to the light(s) asynchronously.
       # @note Don't use this directly.
       # @api private

data/lib/lifx/lan/protocol/multi_zone.rb

@@ -0,0 +1,90 @@
+require "lifx/lan/protocol/light"
+
+module LIFX
+  module LAN
+    module Protocol
+      # @api private
+      module MultiZone
+        module ApplicationRequest
+          NO_APPLY   = 0 # Don't apply the requested changes until a message with APPLY or APPLY_ONLY is sent.
+          APPLY      = 1 # Apply the changes immediately and apply any pending changes.
+          APPLY_ONLY = 2 # Ignore the requested changes in this message and only apply pending changes.
+        end
+
+        # #####
+        # Extended Multizone requests: Unsupported by LIFX Z gen 1
+        # #####
+
+        # Change all the zones on your device in one message
+        class SetExtendedColorZones < Payload
+          endian :little
+
+          uint32 :duration         # Transition duration in milliseconds
+          uint8  :apply            # ApplicationRequest
+          uint16 :start_index      # Zone we start applying the colors from. The first zone is 0.
+          uint8  :colors_count     # Number of colors from colors will be applied sequentially from index
+          array  :colors, :initial_length => 82 do
+            hsbk
+          end
+        end
+
+        # Ask the device to return a StateExtendedColorZones
+        class GetExtendedColorZones < Payload
+          endian :little
+        end
+
+        # StateExtendedColorZones
+        class StateExtendedColorZones < Payload
+          endian :little
+
+          uint16 :total_zones
+          uint16 :start_index
+          uint8  :colors_count
+          array  :colors, :initial_length => 82 do
+            hsbk
+          end
+        end
+
+
+        # #####
+        # All LIFX Z and LIFX Beam products supported:
+        # #####
+
+        class SetColorZones < Payload
+          endian :little
+
+          uint8  :start_index
+          uint8  :end_index
+          hsbk   :color
+          uint32 :duration         # Transition duration in milliseconds
+          uint8  :apply            # ApplicationRequest
+        end
+
+        class GetColorZones < Payload
+          endian :little
+
+          uint8  :start_index
+          uint8  :end_index
+        end
+
+        class StateZone < Payload
+          endian :little
+
+          uint8  :total_zones
+          uint8  :color_index
+          hsbk   :color
+        end
+
+        class StateMultiZone < Payload
+          endian :little
+
+          uint8  :total_zones
+          uint8  :start_index
+          array  :colors, :initial_length => 8 do
+            hsbk
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lifx/lan/protocol/tile.rb

@@ -0,0 +1,96 @@
+require "lifx/lan/protocol/light"
+
+module LIFX
+  module LAN
+    module Protocol
+      # @api private
+      module Tile
+        class Tile < Payload
+          endian :little
+
+          # 55 bytes
+          int16  :accel_meas_x            # Gravity measurements for determining orientation
+          int16  :accel_meas_y            # Gravity measurements for determining orientation
+          int16  :accel_meas_z            # Gravity measurements for determining orientation
+          int16  :reserved_0              #
+          float  :user_x                  # Position of the tile relative to the chain
+          float  :user_y                  # Position of the tile relative to the chain
+          uint8  :width                   # Number of pixels that are on each axis of the tile
+          uint8  :height                  # Number of pixels that are on each axis of the tile
+          uint8  :reserved_1              #
+          uint32 :device_version_vendor   # Same as in Device::StateVersion
+          uint32 :device_version_product  # Same as in Device::StateVersion
+          uint32 :device_version_version  # Same as in Device::StateVersion
+          uint64 :firmware_build          # Same as in Device::StateHostFirmware
+          uint64 :reserved_2              #
+          uint16 :firmware_version_minor  # Same as in Device::StateHostFirmware
+          uint16 :firmware_version_major  # Same as in Device::StateHostFirmware
+          uint32 :reserved_3              #
+        end
+
+        class GetDeviceChain < Payload
+          endian :little
+        end
+
+        class StateDeviceChain < Payload
+          endian :little
+
+          uint8  :start_index
+          array  :tile_devices, :initial_length => 5 do
+            tile
+          end
+          uint8  :total_count
+        end
+
+        # Read this before using: https://lan.developer.lifx.com/v2.0/docs/tile-control
+        class SetUserPosition < Payload
+          endian :little
+
+          uint8  :tile_index
+          uint16 :reserved
+          float  :user_x
+          float  :user_y
+        end
+
+        class GetTileState64 < Payload
+          endian :little
+
+          uint8  :tile_start_index
+          uint8  :tile_length
+          uint8  :reserved
+          uint8  :x
+          uint8  :y
+          uint8  :width
+        end
+
+        class StateTileState64 < Payload
+          endian :little
+
+          uint8  :tile_index
+          uint8  :reserved
+          uint8  :x
+          uint8  :y
+          uint8  :width
+          array  :colors, :initial_length => 64 do
+            hsbk
+          end
+        end
+
+        class SetTileState64 < Payload
+          endian :little
+
+          uint8  :tile_start_index
+          uint8  :tile_length
+          uint8  :reserved
+          uint8  :x
+          uint8  :y
+          uint8  :width
+          uint32 :duration
+          array  :colors, :initial_length => 64 do
+            hsbk
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lifx/lan/protocol/type.rb

@@ -99,106 +99,24 @@ module LIFX
         402 => Sensor::StateAmbientLight,
         403 => Sensor::GetDimmerVoltage,
         404 => Sensor::StateDimmerVoltage,
-      }
 
-      CLASS_TO_TYPE_ID = {
-        # Device::SetSite => 1,
-        # Device::GetPanGateway => 2,
-        # Device::StatePanGateway => 3,
-        Device::GetService => 2,
-        Device::StateService => 3,
-        Device::GetTime => 4,
-        Device::SetTime => 5,
-        Device::StateTime => 6,
-        # Device::GetResetSwitch => 7,
-        # Device::StateResetSwitch => 8,
-        # Device::GetMeshInfo => 12,
-        # Device::StateMeshInfo => 13,
-        # Device::GetMeshFirmware => 14,
-        # Device::StateMeshFirmware => 15,
-        Device::GetHostInfo => 12,
-        Device::StateHostInfo => 13,
-        Device::GetHostFirmware => 14,
-        Device::StateHostFirmware => 15,
-        Device::GetWifiInfo => 16,
-        Device::StateWifiInfo => 17,
-        Device::GetWifiFirmware => 18,
-        Device::StateWifiFirmware => 19,
-        Device::GetPower => 20,
-        Device::SetPower => 21,
-        Device::StatePower => 22,
-        Device::GetLabel => 23,
-        Device::SetLabel => 24,
-        Device::StateLabel => 25,
-        Device::GetTags => 26,
-        Device::SetTags => 27,
-        Device::StateTags => 28,
-        Device::GetTagLabels => 29,
-        Device::SetTagLabels => 30,
-        Device::StateTagLabels => 31,
-        Device::GetVersion => 32,
-        Device::StateVersion => 33,
-        Device::GetInfo => 34,
-        Device::StateInfo => 35,
-        # Device::GetMcuRailVoltage => 36,
-        # Device::StateMcuRailVoltage => 37,
-        # Device::Reboot => 38,
-        Device::SetReboot => 38,
-        Device::StateReboot => 43,
-        Device::Acknowledgement => 45,
-        Device::SetFactoryReset => 46,
-        Device::StateFactoryReset => 47,
-        Device::GetLocation => 48,
-        Device::SetLocation => 49,
-        Device::StateLocation => 50,
-        Device::GetGroup => 51,
-        Device::SetGroup => 52,
-        Device::StateGroup => 53,
-        Device::GetOwner => 54,
-        Device::SetOwner => 55,
-        Device::StateOwner => 56,
-        Device::EchoRequest => 58,
-        Device::EchoResponse => 59,
+        510 => MultiZone::SetExtendedColorZones,
+        511 => MultiZone::GetExtendedColorZones,
+        512 => MultiZone::StateExtendedColorZones,
+        501 => MultiZone::SetColorZones,
+        502 => MultiZone::GetColorZones,
+        503 => MultiZone::StateZone,
+        506 => MultiZone::StateMultiZone,
 
-        Light::Get => 101,
-        # Light::Set => 102,
-        Light::SetColor => 102,
-        # Light::SetWaveform => 103,
-        # Light::SetDimAbsolute => 104,
-        # Light::SetDimRelative => 105,
-        # Light::SetRgbw => 106,
-        Light::State => 107,
-        # Light::GetRailVoltage => 108,
-        # Light::StateRailVoltage => 109,
-        Light::GetTemperature => 110,
-        Light::StateTemperature => 111,
-        Light::GetPower => 116,
-        Light::SetPower => 117,
-        Light::StatePower => 118,
+        701 => Tile::GetDeviceChain,
+        702 => Tile::StateDeviceChain,
+        703 => Tile::SetUserPosition,
+        707 => Tile::GetTileState64,
+        711 => Tile::StateTileState64,
+        715 => Tile::SetTileState64,
+      }.freeze
 
-        Wan::ConnectPlain => 201,
-        Wan::ConnectKey => 202,
-        Wan::StateConnect => 203,
-        Wan::Sub => 204,
-        Wan::Unsub => 205,
-        Wan::StateSub => 206,
-
-        Wifi::Get => 301,
-        Wifi::Set => 302,
-        Wifi::State => 303,
-        # Wifi::GetAccessPoint => 304,
-        Wifi::GetAccessPoints => 304,
-        Wifi::SetAccessPoint => 305,
-        # Wifi::StateAccessPoint => 306,
-        Wifi::StateAccessPoints => 306,
-        Wifi::GetAccessPoint => 307,
-        Wifi::StateAccessPoint => 308,
-
-        Sensor::GetAmbientLight => 401,
-        Sensor::StateAmbientLight => 402,
-        Sensor::GetDimmerVoltage => 403,
-        Sensor::StateDimmerVoltage => 404,
-      }
+      CLASS_TO_TYPE_ID = TYPE_ID_TO_CLASS.invert.freeze
     end
   end
 end

data/lib/lifx/lan/transport/udp.rb

@@ -50,7 +50,7 @@ module LIFX
             reader.bind(ip, port)
             loop do
               begin
-                bytes, (_, _, ip, _) = reader.recvfrom(128)
+                bytes, (_, _, ip, _) = reader.recvfrom(1280)
                 logger.debug("<- #{bytes.each_byte.map { |b| b.to_s(16).rjust(2, '0') }.join}")
                 message = Message.unpack(bytes)
                 logger.debug("<- Incoming message: #{message}")

data/lib/lifx/lan/version.rb

@@ -1,5 +1,5 @@
 module LIFX
   module LAN
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/lifx-lan.rb

@@ -10,7 +10,7 @@ require "lifx/lan/logging"
 require "lifx/lan/thread"
 
 require "lifx/lan/protocol/payload"
-%w(device light sensor wan wifi message).each { |f| require "lifx/lan/protocol/#{f}" }
+%w(device light sensor wan wifi message multi_zone tile).each { |f| require "lifx/lan/protocol/#{f}" }
 require "lifx/lan/protocol/type"
 require "lifx/lan/message"
 require "lifx/lan/transport"

data/lifx-lan.gemspec

@@ -22,5 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency "bindata", "~> 2.0"
   spec.add_dependency "timers", "~> 1.0"
   spec.add_dependency "configatron", "~> 3.0"
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "bundler", "~> 2"
 end

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 LIFX::Client::DiscoveryTimeout
+      rescue LIFX::LAN::Client::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-lan
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jack Chen (chendo), Julian Cheal (juliancheal)
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-01-03 00:00:00.000000000 Z
+date: 2022-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bindata
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2'
 description: A Ruby gem that allows easy interaction with LIFX devices.
 email:
 - julian.cheal+lifx-gem@lifx.co
@@ -108,8 +108,10 @@ files:
 - lib/lifx/lan/protocol/light.rb
 - lib/lifx/lan/protocol/message.rb
 - lib/lifx/lan/protocol/metadata.rb
+- lib/lifx/lan/protocol/multi_zone.rb
 - lib/lifx/lan/protocol/payload.rb
 - lib/lifx/lan/protocol/sensor.rb
+- lib/lifx/lan/protocol/tile.rb
 - lib/lifx/lan/protocol/type.rb
 - lib/lifx/lan/protocol/wan.rb
 - lib/lifx/lan/protocol/wifi.rb
@@ -149,7 +151,7 @@ homepage: https://github.com/juliancheal/lifx-lan
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -164,9 +166,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: A Ruby gem that allows easy interaction with LIFX devices. Handles discovery,
   rate limiting, tags, gateway connections and provides an object-based API for interacting