LIFX UDP Command Reference

LIFX UDP Get Lights

This command will create/update string variables containing the unique device ID value in the LIFXLIGHTS button for all LIFX devices added to a LIFX cloud account.  Command usage requires an API bearer token from the LIFX Cloud account settings page at https://cloud.lifx.com/settings.  LIFX HTTP API Token value defaults to the button variable defined in the green LIFX Settings receiver button.

Value Name Expected Data Type Usage
LIFX HTTP API Token String HTTP bearer token value

LIFX UDP Get Scenes

This command will create/update array variables containing color zone data values in the LIFXSCENES button for the first MultiZone device in each scene configured in a LIFX cloud account.  For use with the LIFX UDP Extended Color command.  Command usage requires an API bearer token from the LIFX Cloud account settings page at https://cloud.lifx.com/settings.  LIFX HTTP API Token value defaults to the button variable defined in the green LIFX Settings receiver button.

Value Name Expected Data Type Usage
LIFX HTTP API Token String HTTP bearer token value.

LIFX UDP Set Power

Sets a new power state for LIFX devices.  Device ID defaults to the LIFXLIGHTS button variable prefix for device variable names created by the LIFX UDP Get Lights command.  Device ID also supports the LIFXLIGHTS.all variable to change all lights on the local network.

Value Name Expected Data Type Usage
Device ID String Unique device ID/MAC Address string for the target LIFX device.
Power Option [OFF/ON] Set the desired power state.
Duration Integer Time to transition to the new power state in milliseconds.

LIFX UDP Set Color

Sets a new HSBK state for LIFX devices.  Device ID defaults to the LIFXLIGHTS button variable prefix for device variable names created by the LIFX UDP Get Lights command.  Device ID also supports the LIFXLIGHTS.all variable to change all LIFX devices on the local network.  Will set all zones to the target HSBK value on MultiZone devices (strips/beams/tiles).

Value Name Expected Data Type Usage
Device ID String Unique device ID/MAC Address string for the target LIFX device.
Hue Decimal The section of the color wheel spectrum to use, supports decimal values from 0 to 360.  Red is a hue of 0 or 360.  Hue is not visible with a saturation value of zero.
Saturation Decimal Sets the new color "strength", supports decimal values from 0 to 1.  0 = no hue saturation/grayscale, 1 = full hue saturation.
Brightness Decimal New brightness value for the target device, supports decimal values from 0 to 1.  0 effectively turns off the light, 1 is full brightness.
Kelvin Integer New kelvin value for target device that controls the color temperature.  The command supports integer values from 3500 to 9500, check the LIFX device documentation/specification for your device to see the supported kelvin range.  Lower kelvin values set warmer/yellow-tinted whites, higher values set cooler/blue-tinted whites.  Not used with saturation values above zero.
Transition Integer Time to transition to the new HSBK value in milliseconds.

LIFX UDP Set Waveform

Applies HSBK transitions like blinking or flickering to a LIFX device based on a waveform pattern without requiring multiple HSBK changes.  This command applies the transition across all zones on MultiZone devices (strips/beams/tiles).  Device ID also supports the LIFXLIGHTS.all variable to change all LIFX devices on the local network.

Value Name Expected Data Type Usage
Device ID String Unique device ID/MAC Address string for the target LIFX device.
Hue Decimal The section of the color wheel spectrum to use, supports decimal values from 0 to 360.  Red is a hue of 0 or 360.  Hue is not visible with a saturation value of zero.
Saturation Decimal Sets the new color "strength", supports decimal values from 0 to 1.  0 = no hue saturation/grayscale, 1 = full hue saturation.
Brightness Decimal New brightness value, supports decimal values from 0 to 1.  0 effectively turns off the light, 1 is full brightness.
Kelvin Integer New kelvin value for target device that controls the color temperature.  The command supports integer values from 3500 to 9500, check the LIFX device documentation/specification for your device to see the supported kelvin range.  Lower kelvin values set warmer/yellow-tinted whites, higher values set cooler/blue-tinted whites.  Not used with saturation values above zero.
Period Integer Length of time for one wave/cycle of the waveform in milliseconds.
Cycles Integer Controls the number of waves/cycles of the waveform to complete.
Skew Ratio Decimal Only used with pulse waveforms, accepts values of 0 to 1.  Sets the ratio between the current and new HSBK settings of each pulse.  Values closer to zero lengthen the "blink" of the new color, and values closer to one shorten the "blink" length.
Waveform Option [SAW/SINE/HALF SINE/TRIANGLE/PULSE] Controls how the devices applies the new HSBK value over time based on the specified waveform pattern.  Please consult the LIFX Documentation for more information on waveform behavior.
Transient Option [No/Yes] Return to the original color after the effect completes.  No = Keep the new HSBK value, Yes = Revert to the prior HSBK value.  SINE and TRIANGLE waveforms automatically revert.

LIFX UDP Extended Color

Sets individual HSBK states by zone on MultiZone LIFX devices like strips, beams, or tiles.  Device ID defaults to the LIFXLIGHTS button variable prefix for device variable names created by the LIFX UDP Get Lights command.  Colors Array String defaults to the LIFXSCENES button variable prefix for color arrays created by the LIFX UDP Get Scenes command.

Value Name Expected Data Type Usage
Device ID String Unique device ID/MAC Address string for the target LIFX device.
Duration Integer Time to transition to the new HSBK values in milliseconds.
Start Zone Integer The starting zone number to apply the array of colors, supports values of 0 to 80.  0 represents the first zone of the device and should be used to apply scene color data from the LIFX UDP Get Scenes command.
Colors Array String Array Array of individual zone HSBK decimal values defined in the LIFX Documentation for color field types.  Defined array colors beyond the number of available device zones are ignored.

LIFX UDP MultiZone Effect

Enable a hardware based effect for MultiZone devices.  Device ID defaults to the LIFXLIGHTS button variable prefix for device variable names created by the LIFX UDP Get Lights command.

Value Name Expected Data Type Usage
Device ID String Unique device ID/MAC Address string for the target LIFX device.
Type Option [OFF/MOVE] Type of effect to apply.  OFF stops running effects, MOVE rotates the HSBK values along the device zones.
Cycle Speed Integer The length of time to complete one MultiZone effect cycle in milliseconds.
Duration Integer How long to run the MultiZone effect in milliseconds.
Move Direction Option [BACKWARD/FORWARD] Sets the direction for the HSBK value move.  Only used for the MOVE effect type.

 

How to Stream With Other Streamers: Using OBS and DeskCamera

I wrote a two part guest article series on Don't Panic Flip's blog site that discusses a way for stream hosts to pull in remote pinball streamer's camera content into their own OBS or XSplit based stream using the DeskCamera application.

Part 1 - Focuses on incorporating a remote pinball streamer using a physical table with multiple cameras
Part 2 - Expands the overview and setup and focuses on virtual pinball.

Subcategories

Information and guidance on how to resolve commonly reported issues using SAMMI.