lifx 0.0.1 → 0.4.0

data/lib/lifx/protocol/light.rb

@@ -0,0 +1,110 @@
+# Generated code ahoy!
+module LIFX
+  module Protocol
+    module Light
+      module Waveform
+        SAW = 0
+        SINE = 1
+        HALF_SINE = 2
+        TRIANGLE = 3
+        PULSE = 4
+      end
+
+      class Hsbk < Payload
+        endian :little
+
+        uint16 :hue # 0..65_535 scaled to 0° - 360°.
+        uint16 :saturation # 0..65_535 scaled to 0% - 100%.
+        uint16 :brightness # 0..65_535 scaled to 0% - 100%.
+        uint16 :kelvin # Explicit 2_400..10_000.
+      end
+
+      class Get < Payload
+        endian :little
+
+      end
+
+      class Set < Payload
+        endian :little
+
+        uint8 :stream # 0 is no stream.
+        hsbk :color
+        uint32 :duration # Milliseconds.
+      end
+
+      class SetWaveform < Payload
+        endian :little
+
+        uint8 :stream # 0 is no stream.
+        bool :transient
+        hsbk :color
+        uint32 :period # Milliseconds per cycle.
+        float :cycles
+        int16 :duty_cycle
+        uint8 :waveform
+      end
+
+      class SetDimAbsolute < Payload
+        endian :little
+
+        int16 :brightness # 0 is no change.
+        uint32 :duration # Milliseconds.
+      end
+
+      class SetDimRelative < Payload
+        endian :little
+
+        int32 :brightness # 0 is no change.
+        uint32 :duration # Milliseconds.
+      end
+
+      class Rgbw < Payload
+        endian :little
+
+        uint16 :red
+        uint16 :green
+        uint16 :blue
+        uint16 :white
+      end
+
+      class SetRgbw < Payload
+        endian :little
+
+        rgbw :color
+      end
+
+      class State < Payload
+        endian :little
+
+        hsbk :color
+        int16 :dim
+        uint16 :power
+        string :label, length: 32, trim_padding: true
+        uint64 :tags
+      end
+
+      class GetRailVoltage < Payload
+        endian :little
+
+      end
+
+      class StateRailVoltage < Payload
+        endian :little
+
+        uint32 :voltage
+      end
+
+      class GetTemperature < Payload
+        endian :little
+
+      end
+
+      class StateTemperature < Payload
+        endian :little
+
+        int16 :temperature # Deci-celsius. 25.45 celsius is 2545
+      end
+
+    end
+  end
+end

data/lib/lifx/protocol/message.rb

@@ -0,0 +1,17 @@
+require 'lifx/protocol/header'
+require 'lifx/protocol/address'
+require 'lifx/protocol/metadata'
+
+module LIFX
+  module Protocol
+    class Message < BinData::Record
+      endian :little
+      
+      include HeaderFields
+      include AddressFields
+      include MetadataFields
+
+      rest :payload
+    end
+  end
+end

data/lib/lifx/protocol/metadata.rb

@@ -0,0 +1,21 @@
+module LIFX
+  module Protocol
+    module MetadataFields
+      def MetadataFields.included(mod)
+        mod.instance_eval do
+          hide :_reserved3
+          
+          uint64 :at_time
+          uint16 :type
+          uint16 :_reserved3
+        end
+      end
+    end
+
+    class Metadata < BinData::Record
+      endian :little
+
+      include MetadataFields
+    end
+  end
+end

data/lib/lifx/protocol/payload.rb

@@ -0,0 +1,7 @@
+module LIFX
+  module Protocol
+    # @api private
+    class Payload < BinData::Record
+    end
+  end
+end

data/lib/lifx/protocol/sensor.rb

@@ -0,0 +1,29 @@
+# Generated code ahoy!
+module LIFX
+  module Protocol
+    module Sensor
+      class GetAmbientLight < Payload
+        endian :little
+
+      end
+
+      class StateAmbientLight < Payload
+        endian :little
+
+        float :lux
+      end
+
+      class GetDimmerVoltage < Payload
+        endian :little
+
+      end
+
+      class StateDimmerVoltage < Payload
+        endian :little
+
+        uint32 :voltage
+      end
+
+    end
+  end
+end

data/lib/lifx/protocol/type.rb

@@ -0,0 +1,134 @@
+# Generated code ahoy!
+module LIFX
+  module Protocol
+    TYPE_ID_TO_CLASS = {
+      1 => Device::SetSite,
+      2 => Device::GetPanGateway,
+      3 => Device::StatePanGateway,
+      4 => Device::GetTime,
+      5 => Device::SetTime,
+      6 => Device::StateTime,
+      7 => Device::GetResetSwitch,
+      8 => Device::StateResetSwitch,
+      12 => Device::GetMeshInfo,
+      13 => Device::StateMeshInfo,
+      14 => Device::GetMeshFirmware,
+      15 => Device::StateMeshFirmware,
+      16 => Device::GetWifiInfo,
+      17 => Device::StateWifiInfo,
+      18 => Device::GetWifiFirmware,
+      19 => Device::StateWifiFirmware,
+      20 => Device::GetPower,
+      21 => Device::SetPower,
+      22 => Device::StatePower,
+      23 => Device::GetLabel,
+      24 => Device::SetLabel,
+      25 => Device::StateLabel,
+      26 => Device::GetTags,
+      27 => Device::SetTags,
+      28 => Device::StateTags,
+      29 => Device::GetTagLabels,
+      30 => Device::SetTagLabels,
+      31 => Device::StateTagLabels,
+      32 => Device::GetVersion,
+      33 => Device::StateVersion,
+      34 => Device::GetInfo,
+      35 => Device::StateInfo,
+      36 => Device::GetMcuRailVoltage,
+      37 => Device::StateMcuRailVoltage,
+      38 => Device::Reboot,
+      101 => Light::Get,
+      102 => Light::Set,
+      103 => Light::SetWaveform,
+      104 => Light::SetDimAbsolute,
+      105 => Light::SetDimRelative,
+      106 => Light::SetRgbw,
+      107 => Light::State,
+      108 => Light::GetRailVoltage,
+      109 => Light::StateRailVoltage,
+      110 => Light::GetTemperature,
+      111 => Light::StateTemperature,
+      201 => Wan::ConnectPlain,
+      202 => Wan::ConnectKey,
+      203 => Wan::StateConnect,
+      204 => Wan::Sub,
+      205 => Wan::Unsub,
+      206 => Wan::StateSub,
+      301 => Wifi::Get,
+      302 => Wifi::Set,
+      303 => Wifi::State,
+      304 => Wifi::GetAccessPoint,
+      305 => Wifi::SetAccessPoint,
+      306 => Wifi::StateAccessPoint,
+      401 => Sensor::GetAmbientLight,
+      402 => Sensor::StateAmbientLight,
+      403 => Sensor::GetDimmerVoltage,
+      404 => Sensor::StateDimmerVoltage,
+    }
+
+    CLASS_TO_TYPE_ID = {
+      Device::SetSite => 1,
+      Device::GetPanGateway => 2,
+      Device::StatePanGateway => 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::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,
+      Light::Get => 101,
+      Light::Set => 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,
+      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::SetAccessPoint => 305,
+      Wifi::StateAccessPoint => 306,
+      Sensor::GetAmbientLight => 401,
+      Sensor::StateAmbientLight => 402,
+      Sensor::GetDimmerVoltage => 403,
+      Sensor::StateDimmerVoltage => 404,
+    }
+  end
+end

data/lib/lifx/protocol/wan.rb

@@ -0,0 +1,50 @@
+# Generated code ahoy!
+module LIFX
+  module Protocol
+    module Wan
+      class ConnectPlain < Payload
+        endian :little
+
+        string :user, length: 32, trim_padding: true
+        string :pass, length: 32, trim_padding: true
+      end
+
+      class ConnectKey < Payload
+        endian :little
+
+        string :auth_key, length: 32
+      end
+
+      class StateConnect < Payload
+        endian :little
+
+        string :auth_key, length: 32
+      end
+
+      class Sub < Payload
+        endian :little
+
+        string :target, length: 8
+        string :site, length: 6
+        bool :device # 0 - Targets a device. 1 - Targets a tag.
+      end
+
+      class Unsub < Payload
+        endian :little
+
+        string :target, length: 8
+        string :site, length: 6
+        bool :device # 0 - Targets a device. 1 - Targets a tag.
+      end
+
+      class StateSub < Payload
+        endian :little
+
+        string :target, length: 8
+        string :site, length: 6
+        bool :device # 0 - Targets a device. 1 - Targets a tag.
+      end
+
+    end
+  end
+end

data/lib/lifx/protocol/wifi.rb

@@ -0,0 +1,76 @@
+# Generated code ahoy!
+module LIFX
+  module Protocol
+    module Wifi
+      module Interface
+        SOFT_AP = 1
+        STATION = 2
+      end
+
+      module Security
+        UNKNOWN = 0
+        OPEN = 1
+        WEP_PSK = 2
+        WPA_TKIP_PSK = 3
+        WPA_AES_PSK = 4
+        WPA2_AES_PSK = 5
+        WPA2_TKIP_PSK = 6
+        WPA2_MIXED_PSK = 7
+      end
+
+      module Status
+        CONNECTING = 0
+        CONNECTED = 1
+        FAILED = 2
+        OFF = 3
+      end
+
+      class Get < Payload
+        endian :little
+
+        uint8 :interface
+      end
+
+      class Set < Payload
+        endian :little
+
+        uint8 :interface
+        bool :active
+      end
+
+      class State < Payload
+        endian :little
+
+        uint8 :interface
+        uint8 :status
+        uint32 :ipv4
+        string :ipv6, length: 16
+      end
+
+      class GetAccessPoint < Payload
+        endian :little
+
+      end
+
+      class SetAccessPoint < Payload
+        endian :little
+
+        uint8 :interface
+        string :ssid, length: 32, trim_padding: true
+        string :pass, length: 64, trim_padding: true
+        uint8 :security
+      end
+
+      class StateAccessPoint < Payload
+        endian :little
+
+        uint8 :interface
+        string :ssid, length: 32, trim_padding: true
+        uint8 :security
+        int16 :strength
+        uint16 :channel
+      end
+
+    end
+  end
+end

data/lib/lifx/protocol_path.rb

@@ -0,0 +1,84 @@
+require 'lifx/utilities'
+
+module LIFX
+  class ProtocolPath
+    # ProtocolPath contains all the addressable information that is required
+    # for the protocol.
+    # It handles the conversion between raw binary and hex strings
+    # as well as raw tags_field to tags array
+    include Utilities
+
+    attr_accessor :raw_site, :raw_target, :tagged
+
+    def initialize(raw_site: "\x00".b * 6, raw_target: "\x00".b * 8, tagged: false,
+                   site_id: nil, device_id: nil, tag_ids: nil)
+      self.raw_site = raw_site
+      self.raw_target = raw_target
+      self.tagged = tagged
+
+      self.site_id = site_id if site_id
+      self.device_id = device_id if device_id
+      self.tag_ids = tag_ids if tag_ids
+    end
+
+    def site_id
+      raw_site.unpack('H*').join
+    end
+
+    def site_id=(value)
+      self.raw_site = [value].pack('H12').b
+    end
+
+    def device_id
+      if !tagged?
+        raw_target[0...6].unpack('H*').join
+      else
+        nil
+      end
+    end
+
+    def device_id=(value)
+      self.raw_target = [value].pack('H16').b
+      self.tagged = false
+    end
+
+    def tag_ids
+      if tagged?
+        tag_ids_from_field(tags_field)
+      else
+        nil
+      end
+    end
+
+    def tag_ids=(values)
+      self.tags_field = values.reduce(0) do |value, tag_id|
+        value |= 2 ** tag_id
+      end
+    end
+
+    def tagged?
+      !!tagged
+    end
+
+    def all_sites?
+      site_id == "000000000000"
+    end
+
+    def all_tags?
+      tagged? && tag_ids.empty?
+    end
+
+    protected
+
+    def tags_field
+      raw_target.unpack('Q').first
+    end
+
+    def tags_field=(value)
+      self.raw_target = [value].pack('Q').b
+      self.tagged = true
+    end
+
+
+  end
+end

data/lib/lifx/routing_manager.rb

@@ -0,0 +1,110 @@
+require 'lifx/routing_table'
+require 'lifx/tag_table'
+require 'lifx/utilities'
+
+module LIFX
+  class RoutingManager
+    include Utilities
+    # RoutingManager manages a routing table of site <-> device
+    # It can resolve a target to ProtocolPaths and manages the TagTable
+
+    attr_reader :context, :tag_table, :routing_table
+
+    def initialize(context:)
+      @context = context
+      @routing_table = RoutingTable.new
+      @tag_table = TagTable.new
+      @last_refresh_seen = {}
+    end
+
+    def resolve_target(target)
+      if target.tag?
+        @tag_table.entries_with(label: target.tag).map do |entry|
+          ProtocolPath.new(site_id: entry.site_id, tag_ids: [entry.tag_id])
+        end
+      elsif target.broadcast?
+        if @routing_table.site_ids.empty?
+          [ProtocolPath.new(site_id: "\x00".b * 6, tag_ids: [])]
+        else
+          @routing_table.site_ids.map { |site_id| ProtocolPath.new(site_id: site_id, tag_ids: []) }
+        end
+      elsif target.site_id && target.device_id.nil?
+        [ProtocolPath.new(site_id: target.site_id, tag_ids: [])]
+      elsif target.site_id && target.device_id
+        [ProtocolPath.new(site_id: target.site_id, device_id: target.device_id)]
+      else
+        site_id = @routing_table.site_id_for_device_id(target.device_id)
+        if site_id
+          [ProtocolPath.new(site_id: site_id, device_id: target.device_id)]
+        else
+          @routing_table.site_ids.map { |site_id| ProtocolPath.new(site_id: site_id, device_id: target.device_id)}
+        end
+      end
+    end
+
+    def tags_for_device_id(device_id)
+      entry = @routing_table.entry_for_device_id(device_id)
+      entry.tag_ids.map do |tag_id|
+        tag = @tag_table.entry_with(site_id: entry.site_id, tag_id: tag_id)
+        tag && tag.label
+      end.compact
+    end
+
+    def update_from_message(message)
+      if message.tagged?
+        case message.payload
+        when Protocol::Light::Get
+          if message.path.all_tags?
+            @last_refresh_seen[message.site_id] = Time.now
+          end
+        end
+        return
+      end
+
+      payload = message.payload
+
+      if !@routing_table.site_ids.include?(message.site_id)
+        # New site detected, fire refresh events
+        refresh_site(message.site_id)
+      end
+      case payload
+      when Protocol::Device::StateTagLabels
+        tag_ids = tag_ids_from_field(payload.tags)
+        if payload.label.empty?
+          tag_ids.each do |tag_id|
+            @tag_table.delete_entries_with(site_id: message.site_id, tag_id: tag_id)
+          end
+        else
+          @tag_table.update_table(site_id: message.site_id, tag_id: tag_ids.first, label: payload.label.to_s)
+        end
+      when Protocol::Device::StateTags, Protocol::Light::State
+        @routing_table.update_table(site_id: message.site_id,
+                                    device_id: message.device_id,
+                                    tag_ids: tag_ids_from_field(message.payload.tags))
+      end
+      @routing_table.update_table(site_id: message.site_id, device_id: message.device_id)
+    end
+
+    MINIMUM_REFRESH_INTERVAL = 20
+    def refresh
+      @routing_table.site_ids.each do |site_id|
+        next if (seen = @last_refresh_seen[site_id]) && Time.now - seen < MINIMUM_REFRESH_INTERVAL
+        refresh_site(site_id)
+      end
+    end
+
+    def refresh_site(site_id)
+      get_lights(site_id)
+      get_tag_labels(site_id)
+    end
+
+    def get_lights(site_id)
+      context.send_message(target: Target.new(site_id: site_id), payload: Protocol::Light::Get.new)
+    end
+
+    UINT64_MAX = 2 ** 64 - 1
+    def get_tag_labels(site_id)
+      context.send_message(target: Target.new(site_id: site_id), payload: Protocol::Device::GetTagLabels.new(tags: UINT64_MAX))
+    end
+  end
+end

data/lib/lifx/routing_table.rb

@@ -0,0 +1,33 @@
+module LIFX
+  class RoutingTable
+    class Entry < Struct.new(:site_id, :device_id, :tag_ids, :last_seen); end
+    # RoutingTable stores the device <-> site mapping
+    def initialize(entries: {})
+      @device_site_mapping = entries
+    end
+
+    def update_table(site_id:, device_id:, tag_ids: nil)
+      device_mapping = @device_site_mapping[device_id] ||= Entry.new(site_id, device_id, [])
+      device_mapping.site_id = site_id
+      device_mapping.last_seen = Time.now
+      device_mapping.tag_ids = tag_ids if tag_ids
+    end
+
+    def entry_for_device_id(device_id)
+      @device_site_mapping[device_id]
+    end
+
+    def site_id_for_device_id(device_id)
+      entry = entry_for_device_id(device_id)
+      entry ? entry.site_id : nil
+    end
+
+    def site_ids
+      entries.map(&:site_id).uniq
+    end
+
+    def entries
+      @device_site_mapping.values
+    end
+  end
+end

data/lib/lifx/seen.rb

@@ -0,0 +1,15 @@
+module LIFX
+  module Seen
+    def last_seen
+      @last_seen
+    end
+
+    def seconds_since_seen
+      Time.now - (last_seen || Time.at(0))
+    end
+
+    def seen!
+      @last_seen = Time.now
+    end
+  end
+end