Difference between revisions of "LIFX Classes"

From Hubitat Documentation
Jump to: navigation, search
(StateLastHevCycleResult)
(Replaced content with " <big>'''We're moving!''' Please visit http://docs2.hubitat.com for the latest documentation.</big> <big> This document is available at: http://docs2.hubitat.com/en/devel...")
(Tag: Replaced)
 
(25 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{Top}}
 
==Discovery==
 
===GetService===
 
Packet 2
 
  class hubitat.lifx.commands.GetService {
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
  
===StateService===
+
<big>'''We're moving!''' Please visit http://docs2.hubitat.com for the latest documentation.</big>
Packet 3
 
  class hubitat.lifx.commands.StateService {
 
      Short service
 
      Long port
 
     
 
      static Short SERVICE_UDP = 0x01
 
      static Short SERVICE_RESERVED1 = 0x02
 
      static Short SERVICE_RESERVED2 = 0x03
 
      static Short SERVICE_RESERVED3 = 0x04
 
      static Short SERVICE_RESERVED4 = 0x05
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
  
==Device==
+
<big>
===GetHostFirmware===
+
This document is available at: http://docs2.hubitat.com/en/developer/driver/lifx-classes
Packet 14
+
</big>
  class hubitat.lifx.commands.GetHostFirmware {
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
 
 
===StateHostFirmware===
 
Packet 15
 
  class hubitat.lifx.commands.StateHostFirmware {
 
      Long build
 
      Integer versionMinor
 
      Integer versionMajor
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
 
 
===GetWifiInfo===
 
Packet 16
 
  class hubitat.lifx.commands.GetWifiInfo {
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
 
 
===StateWifiInfo===
 
Packet 17
 
  class hubitat.lifx.commands.StateWifiInfo {
 
      Float signal
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
 
 
===GetWifiFirmware===
 
Packet 18
 
  class hubitat.lifx.commands.GetWifiFirmware {
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
 
 
===StateWifiFirmware===
 
Packet 19
 
  class hubitat.lifx.commands.StateWifiFirmware {
 
      Long build
 
      Integer versionMinor
 
      Integer versionMajor
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
 
 
===GetPower===
 
Packet 20
 
  class hubitat.lifx.commands.GetPower {
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
 
 
===SetPower===
 
Packet 21
 
  class hubitat.lifx.commands.SetPower {
 
      Integer level
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
 
 
===StatePower===
 
Packet 22
 
  class hubitat.lifx.commands.StatePower {
 
      Integer level
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
 
 
===GetLabel===
 
Packet 23
 
  class hubitat.lifx.commands.GetLabel {
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
 
 
===SetLabel===
 
Packet 24
 
  class hubitat.lifx.commands.SetLabel {
 
      String label
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
 
 
===StateLabel===
 
Packet 25
 
  class hubitat.lifx.commands.StateLabel {
 
      String label
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
 
 
===GetVersion===
 
Packet 32
 
  class hubitat.lifx.commands.GetVersion {
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
 
 
===StateVersion===
 
Packet 33
 
  class hubitat.lifx.commands.StateVersion {
 
      Long vendor
 
      Long product
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
 
 
===SetReboot===
 
Packet 38
 
  class hubitat.lifx.commands.SetReboot {
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
 
 
===GetLocation===
 
Packet 48
 
  class hubitat.lifx.commands.GetLocation {
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
 
 
===SetLocation===
 
Packet 49
 
  class hubitat.lifx.commands.SetLocation {
 
      String uuid
 
      String label
 
      Long updatedAt
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
 
 
===StateLocation===
 
Packet 50
 
  class hubitat.lifx.commands.StateLocation {
 
      String uuid
 
      String label
 
      Long updatedAt
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
 
 
===GetGroup===
 
Packet 51
 
  class hubitat.lifx.commands.GetGroup {
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
 
 
===SetGroup===
 
Packet 52
 
  class hubitat.lifx.commands.SetGroup {
 
      String uuid
 
      String label
 
      Long updatedAt
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
 
 
===StateGroup===
 
Packet 53
 
  class hubitat.lifx.commands.StateGroup {
 
      String uuid
 
      String label
 
      Long updatedAt
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
 
 
===EchoRequest===
 
Packet 58
 
  class hubitat.lifx.commands.EchoRequest {
 
      byte[] echoing
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
 
 
===EchoResponse===
 
Packet 59
 
  class hubitat.lifx.commands.EchoResponse {
 
      byte[] echoing
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
 
 
==Light==
 
===GetColor===
 
Packet 101
 
  class hubitat.lifx.commands.GetColor {
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
 
 
===SetColor===
 
Packet 102
 
  class hubitat.lifx.commands.SetColor {
 
      Integer hue
 
      Integer saturation
 
      Integer brightness
 
      Integer kelvin
 
      Long duration
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
 
 
===SetWaveform===
 
Packet 103
 
  class hubitat.lifx.commands.SetWaveform {
 
      Boolean isTransient
 
      Integer hue
 
      Integer saturation
 
      Integer brightness
 
      Integer kelvin
 
      Long period
 
      Float cycles
 
      Short skewRatio
 
      Short waveform
 
 
 
      static Short WAVEFORM_SAW = 0x00
 
      static Short WAVEFORM_SINE = 0x01
 
      static Short WAVEFORM_HALF_SINE = 0x02
 
      static Short WAVEFORM_TRIANGLE = 0x03
 
      static Short WAVEFORM_PULSE = 0x04
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
 
 
===LightState===
 
Packet 107
 
  class hubitat.lifx.commands.LightState {
 
      Integer hue
 
      Integer saturation
 
      Integer brightness
 
      Integer kelvin
 
      Integer power
 
      String label
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
 
 
===GetLightPower===
 
Packet 116
 
  class hubitat.lifx.commands.GetLightPower {
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
 
 
===SetLightPower===
 
Packet 117
 
  class hubitat.lifx.commands.SetLightPower {
 
      Integer level
 
      Integer duration
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
 
 
===StateLightPower===
 
Packet 118
 
  class hubitat.lifx.commands.StateLightPower {
 
      Integer level
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
 
 
===SetWaveformOptional===
 
Packet 119
 
  class hubitat.lifx.commands.SetWaveformOptional {
 
      Boolean isTransient
 
      Integer hue
 
      Integer saturation
 
      Integer brightness
 
      Integer kelvin
 
      Long period
 
      Float cycles
 
      Short skewRatio
 
      Short waveform
 
      Boolean hueSet
 
      Boolean saturationSet
 
      Boolean brightnessSet
 
      Boolean kelvinSet
 
 
 
      static Short WAVEFORM_SAW = 0x00
 
      static Short WAVEFORM_SINE = 0x01
 
      static Short WAVEFORM_HALF_SINE = 0x02
 
      static Short WAVEFORM_TRIANGLE = 0x03
 
      static Short WAVEFORM_PULSE = 0x04
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
 
 
===GetInfrared===
 
Packet 120
 
  class hubitat.lifx.commands.GetInfrared {
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
 
 
===StateInfrared===
 
Packet 121
 
  class hubitat.lifx.commands.StateInfrared {
 
      Integer brightness
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
 
 
===SetInfrared===
 
Packet 122
 
  class hubitat.lifx.commands.SetInfrared {
 
      Integer brightness
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
 
 
===GetHevCycle===
 
Packet 142
 
  class hubitat.lifx.commands.GetHevCycle {
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
 
 
===SetHevCycle===
 
Packet 143
 
  class hubitat.lifx.commands.SetHevCycle {
 
      Boolean enabled
 
      Long duration
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
 
 
===StateHevCycle===
 
Packet 144
 
  class hubitat.lifx.commands.StateHevCycle {
 
      Long duration
 
      Long remaining
 
      Boolean lastPower
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
 
 
===GetHevCycleConfiguration===
 
Packet 145
 
  class hubitat.lifx.commands.GetHevCycleConfiguration {
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
 
 
===SetHevCycleConfiguration===
 
Packet 146
 
  class hubitat.lifx.commands.SetHevCycleConfiguration {
 
      Boolean indication
 
      Long duration
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
 
 
===StateHevCycleConfiguration===
 
Packet 147
 
  class hubitat.lifx.commands.StateHevCycleConfiguration {
 
      Boolean indication
 
      Long duration
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
 
 
===GetLastHevCycleResult===
 
Packet 148
 
  class hubitat.lifx.commands.GetLastHevCycleResult {
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
 
 
===StateLastHevCycleResult===
 
Packet 149
 
  class hubitat.lifx.commands.StateLastHevCycleResult {
 
      Short result
 
 
 
      static Short RESULT_SUCCESS = 0x00
 
      static Short RESULT_BUSY = 0x01
 
      static Short RESULT_INTERRUPTED_BY_RESET = 0x02
 
      static Short RESULT_INTERRUPTED_BY_HOMEKIT = 0x03
 
      static Short RESULT_INTERRUPTED_BY_LAN = 0x04
 
      static Short RESULT_INTERRUPTED_BY_CLOUD = 0x05
 
      static Short RESULT_NONE = 0xFF
 
 
 
      byte[] getPayload()
 
      String format()
 
  }
 
 
 
==MultiZone==
 
===SetColorZones===
 
Packet 501
 
===GetColorZones===
 
Packet 502
 
===StateZone===
 
Packet 503
 
===GetMultiZoneEffect===
 
Packet 507
 
===SetMultiZoneEffect===
 
Packet 508
 
===StateMultiZoneEffect===
 
Packet 509
 
===SetExtendedColorZones===
 
Packet 510
 
===GetExtendedColorZones===
 
Packet 511
 
===StateExtendedColorZones===
 
Packet 512
 
==Relay==
 
===GetRPower===
 
Packet 816
 
===SetRPower===
 
Packet 817
 
===StateRPower===
 
Packet 818
 
==Tile==
 
===GetDeviceChain===
 
Packet 701
 
===StateDeviceChain===
 
Packet 702
 
===SetUserPosition===
 
Packet 703
 
===Get64===
 
Packet 707
 
===State64===
 
Packet 711
 
===Set64===
 
Packet 715
 
===GetTileEffect===
 
Packet 718
 
===SetTileEffect===
 
Packet 719
 
===StateTileEffect===
 
Packet 720
 

Latest revision as of 19:42, 25 September 2022

We're moving! Please visit http://docs2.hubitat.com for the latest documentation.

This document is available at: http://docs2.hubitat.com/en/developer/driver/lifx-classes