Package heronarts.lx.output

Class KinetDatagram

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.output.LXOutput

heronarts.lx.output.LXBufferOutput

heronarts.lx.output.LXDatagram

heronarts.lx.output.KinetDatagram

All Implemented Interfaces:

LXPath, LXSerializable, LXOutput.InetOutput, LXParameterListener

public class KinetDatagram
extends LXDatagram

A datagram implementing the Kinet protocol, used by Color Kinetics devices. These datagrams have a header followed by 512 bytes of color data. A port number on the output device is specified, distinct from the UDP port. For instance, an sPDS-480 has 16 outputs.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	KinetDatagram.Version

Nested classes/interfaces inherited from class heronarts.lx.output.LXDatagram

LXDatagram.BufferException, LXDatagram.ErrorState

Nested classes/interfaces inherited from class heronarts.lx.output.LXBufferOutput

LXBufferOutput.ByteEncoder, LXBufferOutput.ByteOrder

Nested classes/interfaces inherited from class heronarts.lx.output.LXOutput

LXOutput.GammaMode, LXOutput.GammaTable, LXOutput.InetOutput

Nested classes/interfaces inherited from class heronarts.lx.LXComponent

LXComponent.Hidden, LXComponent.Placeholder, LXComponent.Renamable

Nested classes/interfaces inherited from interface heronarts.lx.LXSerializable

LXSerializable.Utils

Field Summary

Fields

Modifier and Type	Field	Description
static final int	KINET_PORT
static final int	MAX_DATA_LENGTH
static final int	MAX_KINET_PORT

Fields inherited from class heronarts.lx.output.LXDatagram

buffer, error

Fields inherited from class heronarts.lx.output.LXBufferOutput

indexBuffer

Fields inherited from class heronarts.lx.output.LXOutput

brightness, enabled, framesPerSecond, gamma, gammaMode, MAX_FRAMES_PER_SECOND, whitePointBlue, whitePointGreen, whitePointRed, whitePointWhite

Fields inherited from class heronarts.lx.LXComponent

children, internalParameters, KEY_CHILDREN, KEY_CLASS, KEY_COMPONENT_ID, KEY_ID, KEY_INTERNAL, KEY_PARAMETER_PATH, KEY_PARAMETERS, KEY_PATH, KEY_RESET, label, legacyInternalParameters, legacyParameters, lx, modulationColor, modulationControlsExpanded, modulationsExpanded, parameters, presetFile

Fields inherited from interface heronarts.lx.output.LXOutput.InetOutput

NO_PORT

Fields inherited from interface heronarts.lx.LXPath

ROOT, ROOT_PREFIX, ROOT_SLASH

Constructor Summary

Constructors

Constructor	Description
KinetDatagram(LX lx, int[] indexBuffer, int kinetPort)	Constructs a datagram that sends on the given kinet supply output port
KinetDatagram(LX lx, int[] indexBuffer, LXBufferOutput.ByteOrder byteOrder, int kinetPort)	Constructs a datagram that sends on the given kinet supply output port
KinetDatagram(LX lx, int[] indexBuffer, LXBufferOutput.ByteOrder byteOrder, int kinetPort, KinetDatagram.Version version)	Constructs a datagram that sends on the given kinet supply output port
KinetDatagram(LX lx, LXModel model, int kinetPort)	Constructs a datagram that sends on the given kinet supply output port
KinetDatagram(LX lx, LXModel model, int kinetPort, KinetDatagram.Version version)	Constructs a datagram that sends on the given kinet supply output port
KinetDatagram(LX lx, IndexBuffer indexBuffer, int kinetPort)	Constructs a datagram that sends on the given kinet supply output port
KinetDatagram(LX lx, IndexBuffer indexBuffer, int kinetPort, KinetDatagram.Version version)	Constructs a datagram that sends on the given kinet supply output port

Method Summary

Modifier and Type	Method	Description
protected int	getDataBufferOffset()	Offset into raw byte buffer where color data is written
KinetDatagram	setKinetPort(byte kinetPort)

Methods inherited from class heronarts.lx.output.LXDatagram

dispose, getAddress, getDataBuffer, getErrorState, getPort, onSend, setAddress, setPort, setSocket, updateSequenceNumber, validateBufferSize

Methods inherited from class heronarts.lx.output.LXBufferOutput

updateDataBuffer

Methods inherited from class heronarts.lx.output.LXOutput

error, error, load, log, onParameterChanged, send, send, setGammaDelegate, setGammaTable, setGammaTable, setGroup

Methods inherited from class heronarts.lx.LXComponent

addArray, addChild, addInternalParameter, addLegacyInternalParameter, addLegacyParameter, addParameter, addParameter, addParameters, contains, copyParameters, getCategory, getChild, getComponentName, getComponentName, getComponentName, getDescription, getId, getLabel, getLX, getOscAddress, getOscLabel, getOscPath, getParameter, getParameters, getParent, getPath, handleOscMessage, hasParameter, isValidOscParameter, loadParameters, loadPreset, removeParameter, removeParameter, removeParameter, removeParameter, save, savePreset, setDescription, setParent, toOscQuery, toOscQuery, toOscQuery, toString, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface heronarts.lx.LXPath

getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, isDescendant

Field Details

MAX_DATA_LENGTH

public static final int MAX_DATA_LENGTH

See Also:

• Constant Field Values

MAX_KINET_PORT

public static final int MAX_KINET_PORT

See Also:

• Constant Field Values

KINET_PORT

public static final int KINET_PORT

See Also:

• Constant Field Values

Constructor Details

KinetDatagram

public KinetDatagram(LX lx,
 LXModel model,
 int kinetPort)

Constructs a datagram that sends on the given kinet supply output port

Parameters:

lx - LX instance

model - Model to output points for

kinetPort - Number of the output port on the kinet power supply

KinetDatagram

public KinetDatagram(LX lx,
 LXModel model,
 int kinetPort,
 KinetDatagram.Version version)

Constructs a datagram that sends on the given kinet supply output port

Parameters:

lx - LX instance

model - Model that this datagram outputs points for

kinetPort - Number of the output port on the kinet power supply

version - Version of Kinet Protocol

KinetDatagram

public KinetDatagram(LX lx,
 int[] indexBuffer,
 int kinetPort)

Constructs a datagram that sends on the given kinet supply output port

Parameters:

lx - LX instance

indexBuffer - A list of the point indices that should be sent on this port

kinetPort - Number of the output port on the kinet power supply

KinetDatagram

public KinetDatagram(LX lx,
 int[] indexBuffer,
 LXBufferOutput.ByteOrder byteOrder,
 int kinetPort)

Constructs a datagram that sends on the given kinet supply output port

Parameters:

lx - LX instance

indexBuffer - A list of the point indices that should be sent on this port

byteOrder - Which byte ordering to use for the output

kinetPort - Number of the output port on the kinet power supply

KinetDatagram

public KinetDatagram(LX lx,
 int[] indexBuffer,
 LXBufferOutput.ByteOrder byteOrder,
 int kinetPort,
 KinetDatagram.Version version)

Constructs a datagram that sends on the given kinet supply output port

Parameters:

lx - LX instance

indexBuffer - Index buffer that this datagram outputs points for

byteOrder - Which byte ordering to use for the output

kinetPort - Number of the output port on the kinet power supply

version - Version of Kinet Protocol

KinetDatagram

public KinetDatagram(LX lx,
 IndexBuffer indexBuffer,
 int kinetPort)

Constructs a datagram that sends on the given kinet supply output port

Parameters:

lx - LX instance

indexBuffer - Index buffer that this datagram outputs points for

kinetPort - Number of the output port on the kinet power supply

KinetDatagram

public KinetDatagram(LX lx,
 IndexBuffer indexBuffer,
 int kinetPort,
 KinetDatagram.Version version)

Constructs a datagram that sends on the given kinet supply output port

Parameters:

lx - LX instance

indexBuffer - Index buffer that this datagram outputs points for

kinetPort - Number of the output port on the kinet power supply

version - Version of Kinet Protocol

Method Details

setKinetPort

public KinetDatagram setKinetPort(byte kinetPort)

getDataBufferOffset

protected int getDataBufferOffset()

Description copied from class: LXBufferOutput

Offset into raw byte buffer where color data is written

Specified by:

getDataBufferOffset in class LXBufferOutput

Returns:

Offset into raw byte buffer for color data