LIFX Classes

From Hubitat Documentation
Revision as of 17:58, 24 November 2021 by Bcopeland (talk | contribs) (→‎Device)
Jump to: navigation, search
Go to the top of the page

Discovery

GetService

Packet 2 

 class hubitat.lifx.commands.GetService {
 
     byte[] getPayload()
     String format()
 }

StateService

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

GetHostFirmware

Packet 14 

 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()
 }

GetInfo

Packet 34

StateInfo

Packet 35

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 

 class hubitat.lifx.commands.SetColorZones {
     Short startIndex
     Short endIndex
     Integer hue
     Integer saturation
     Integer brightness
     Integer kelvin
     Long duration
     Short apply
 
     static Short APPLY_NO_APPLY = 0x00
     static Short APPLY_APPLY = 0x01
     static Short APPLY_APPLY_ONLY = 0x02
 
     byte[] getPayload()
     String format()
 }

GetColorZones

Packet 502 

 class hubitat.lifx.commands.GetColorZones {
     Short startIndex
     Short endIndex
 
     byte[] getPayload()
     String format()
 }

StateZone

Packet 503 

 class hubitat.lifx.commands.StateZone {
     Short zonesCount
     Short zoneIndex
     Integer hue
     Integer saturation
     Integer brightness
     Integer kelvin
 
     byte[] getPayload()
     String format()
 }

GetMultiZoneEffect

Packet 507 

 class hubitat.lifx.commands.GetMultiZoneEffect {
 
     byte[] getPayload()
     String format()
 }

SetMultiZoneEffect

Packet 508 

 class hubitat.lifx.commands.SetMultiZoneEffect {
     Long instanceId
     Short type
     Long speed
     Long duration
     byte[] parameters
 
     static Short EFFECT_TYPE_OFF = 0x00
     static Short EFFECT_TYPE_MOVE = 0x01
     static Short EFFECT_TYPE_RESERVED1 = 0x02
     static Short EFFECT_TYPE_RESERVED2 = 0x03
 
     byte[] getPayload()
     String format()
 }

StateMultiZoneEffect

Packet 509 

 class hubitat.lifx.commands.SetMultiZoneEffect {
     Long instanceId
     Short type
     Long speed
     Long duration
     byte[] parameters
 
     static Short EFFECT_TYPE_OFF = 0x00
     static Short EFFECT_TYPE_MOVE = 0x01
     static Short EFFECT_TYPE_RESERVED1 = 0x02
     static Short EFFECT_TYPE_RESERVED2 = 0x03
 
     byte[] getPayload()
     String format()
 }

SetExtendedColorZones

Packet 510 

 class hubitat.lifx.commands.SetExtendedColorZones {
     Long duration
     Short apply
     Integer zoneIndex
     Short colorsCount
     List<hubitat.lifx.structures.Color> colors
 
     static Short APPLY_NO_APPLY = 0x00
     static Short APPLY_APPLY = 0x01
     static Short APPLY_APPLY_ONLY = 0x02
 
     byte[] getPayload()
     String format()
 }

GetExtendedColorZones

Packet 511 

 class hubitat.lifx.commands.GetExtendedColorZones {
 
     byte[] getPayload()
     String format()
 }

StateExtendedColorZones

Packet 512 

 class hubitat.lifx.commands.SetColorZones {
     Integer zonesCount
     Integer zoneIndex
     Short colorsCount
     List<hubitat.lifx.structures.Color> colors
 
     byte[] getPayload()
     String format()
 }

Relay

GetRPower

Packet 816 

 class hubitat.lifx.commands.GetRPower {
     Short relayIndex
 
     byte[] getPayload()
     String format()
 }

SetRPower

Packet 817 

 class hubitat.lifx.commands.SetRPower {
     Short relayIndex
     Integer level
 
     byte[] getPayload()
     String format()
 }

StateRPower

Packet 818 

 class hubitat.lifx.commands.StateRPower {
     Short relayIndex
     Integer level
 
     byte[] getPayload()
     String format()
 }

Tile

GetDeviceChain

Packet 701 

 class hubitat.lifx.commands.GetDeviceChain {
 
     byte[] getPayload()
     String format()
 }

StateDeviceChain

Packet 702 

 class hubitat.lifx.commands.StateDeviceChain {
     Short startIndex
     List<hubitat.lifx.structures.Tile> tileDevices
     Short tileDevicesCount
 
     byte[] getPayload()
     String format()
 }

SetUserPosition

Packet 703

Get64

Packet 707 

 class hubitat.lifx.commands.Get64 {
     Short tileIndex
     Short length
     Short x
     Short y
     Short width
 
     byte[] getPayload()
     String format()
 }

State64

Packet 711 

 class hubitat.lifx.commands.State64 {
     Short tileIndex
     Short x
     Short y
     Short width
     List<hubitat.lifx.structures.Color> colors
 
     byte[] getPayload()
     String format()
 }

Set64

Packet 715 

 class hubitat.lifx.commands.Set64 {
     Short tileIndex
     Short length
     Short x
     Short y
     Short width
     Long duration
     List<hubitat.lifx.structures.Color> colors
 
     byte[] getPayload()
     String format()
 }

GetTileEffect

Packet 718 

 class hubitat.lifx.commands.GetTileEffect {
 
     byte[] getPayload()
     String format()
 }

SetTileEffect

Packet 719 

 class hubitat.lifx.commands.SetTileEffect {
     Long instanceId
     Short type
     Long speed
     Long duration
     byte[] parameters
     Short paletteCount
     List<hubitat.lifx.structures.Color> palette
 
     static Short TILE_EFFECT_TYPE_OFF = 0x00
     static Short TILE_EFFECT_TYPE_RESERVED1 = 0x01
     static Short TILE_EFFECT_TYPE_MORPH = 0x02
     static Short TILE_EFFECT_TYPE_FLAME = 0x03
     static Short TILE_EFFECT_TYPE_RESERVED2 = 0x04
 
     byte[] getPayload()
     String format()
 }

StateTileEffect

Packet 720 

 class hubitat.lifx.commands.StateTileEffect {
     Long instanceId
     Short type
     Long speed
     Long duration
     byte[] parameters
     Short paletteCount
     List<hubitat.lifx.structures.Color> palette
 
     static Short TILE_EFFECT_TYPE_OFF = 0x00
     static Short TILE_EFFECT_TYPE_RESERVED1 = 0x01
     static Short TILE_EFFECT_TYPE_MORPH = 0x02
     static Short TILE_EFFECT_TYPE_FLAME = 0x03
     static Short TILE_EFFECT_TYPE_RESERVED2 = 0x04
 
     byte[] getPayload()
     String format()
 }
Retrieved from "https://docs.hubitat.com/index.php?title=LIFX_Classes&oldid=5316"