lifx-lan 0.1.0

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

@@ -0,0 +1,24 @@
+module LIFX
+  module LAN
+    module Protocol
+      module HeaderFields
+        def HeaderFields.included(mod)
+          mod.instance_eval do
+            uint16    :msg_size # Size of entire message in bytes including this field.
+            bit12le   :protocol, value: 1024 # Protocol number, always 1024 for LIFX Protocol messages
+            bool_bit1 :addressable, value: true # Message includes an address, always true for LIFX Protocol messages
+            bool_bit1 :tagged # Indicates that the message addresses device tagged with specified tags
+            bit2le    :origin, value: 0 # Message origin indicator, should be zero
+            uint32    :source # Source identifier. Unique 32 bit value sent by the client, used for NAT and responses
+          end
+        end
+      end
+
+      class Header < BinData::Record
+        endian :little
+
+        include HeaderFields
+      end
+    end
+  end
+end

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

@@ -0,0 +1,142 @@
+module LIFX
+  module LAN
+    module Protocol
+      # @api private
+      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..9_000
+        end
+
+        # Introspect the light state
+        class Get < Payload
+          endian :little
+        end
+
+        # class Set < Payload
+        #   endian :little
+
+        #   uint8 :stream # 0 is no stream.
+        #   hsbk :color
+        #   uint32 :duration # Milliseconds.
+        # end
+
+        # Light state including identifying meta data
+        class State < Payload
+          endian :little
+
+          hsbk   :color
+          int16  :dim
+          uint16 :power
+          string :label, length: 32, trim_padding: true
+          uint64 :tags
+        end
+
+        # Simple light color control
+        class SetColor < Payload
+          endian :little
+
+          uint8  :stream, value: 0 # Reserved for LIFX use, must be 0 (0 is no stream)
+          hsbk   :color            # Color value
+          uint32 :duration         # Transition duration in milliseconds
+        end
+
+        # Instrospect light power level on device
+        class GetPower < Payload
+          endian :little
+
+        end
+
+        # Set the power level of a light
+        class SetPower < Payload
+          endian :little
+
+          uint16 :level    # Power level between 0..65535. Zero implies standby and non-zero sets a corresponding power draw level on device
+          uint32 :duration # Duration in milliseconds for the power transition between 0..65535
+        end
+
+        # Current power level of device
+        class StatePower < Payload
+          endian :little
+
+          uint16 :level
+        end
+
+        # Does below code work with LIFX20 ?
+        # ----------------------------------------------------------------
+        class SetWaveform < Payload
+          endian :little
+
+          uint8 :stream # 0 is no stream.
+          bool :transient
+          hsbk :color
+          uint32 :period # Milliseconds per cycle.
+          float :cycles
+          int16 :skew_ratio
+          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 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
+end

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

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

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

@@ -0,0 +1,23 @@
+module LIFX
+  module LAN
+    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
+end

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

@@ -0,0 +1,12 @@
+module LIFX
+  module LAN
+    # @api private
+    module Protocol
+      class Payload < BinData::Record
+        def to_s
+          "#<#{self.class} #{super}>"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+module LIFX
+  module LAN
+    module Protocol
+      # @api private
+      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
+end

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

@@ -0,0 +1,204 @@
+# Generated code ahoy!
+module LIFX
+  module LAN
+    module Protocol
+      TYPE_ID_TO_CLASS = {
+        # 1 => Device::SetSite,
+        # 2 => Device::GetPanGateway,
+        # 3 => Device::StatePanGateway,
+        2 => Device::GetService,
+        3 => Device::StateService,
+        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,
+        12 => Device::GetHostInfo,
+        13 => Device::StateHostInfo,
+        14 => Device::GetHostFirmware,
+        15 => Device::StateHostFirmware,
+        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,
+        38 => Device::SetReboot,
+        43 => Device::StateReboot,
+        45 => Device::Acknowledgement,
+        46 => Device::SetFactoryReset,
+        47 => Device::StateFactoryReset,
+        48 => Device::GetLocation,
+        49 => Device::SetLocation,
+        50 => Device::StateLocation,
+        51 => Device::GetGroup,
+        52 => Device::SetGroup,
+        53 => Device::StateGroup,
+        54 => Device::GetOwner,
+        55 => Device::SetOwner,
+        56 => Device::StateOwner,
+        58 => Device::EchoRequest,
+        59 => Device::EchoResponse,
+
+        101 => Light::Get,
+        # 102 => Light::Set,
+        102 => Light::SetColor,
+        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,
+        116 => Light::GetPower,
+        117 => Light::SetPower,
+        118 => Light::StatePower,
+
+        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,
+        304 => Wifi::GetAccessPoints,
+        305 => Wifi::SetAccessPoint,
+        # 306 => Wifi::StateAccessPoint,
+        306 => Wifi::StateAccessPoints,
+        307 => Wifi::GetAccessPoint,
+        308 => 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::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,
+
+        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,
+
+        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,
+      }
+    end
+  end
+end