Package heronarts.lx.output

Class ArtNetDatagram

java.lang.Object

heronarts.lx.LXComponent

heronarts.lx.output.LXOutput

heronarts.lx.output.LXBufferOutput

heronarts.lx.output.LXDatagram

heronarts.lx.output.ArtNetDatagram

All Implemented Interfaces:

LXPath, LXSerializable, LXOutput.InetOutput, LXParameterListener

public class ArtNetDatagram
extends LXDatagram

Nested Class Summary

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.Description, LXComponent.Hidden, LXComponent.Name, LXComponent.Placeholder, LXComponent.PluginRequired, LXComponent.Renamable

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

LXSerializable.Utils

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ARTNET_HEADER_LENGTH
static final int	ARTNET_PORT
static final int	DATA_LENGTH_LSB
static final int	DATA_LENGTH_MSB
static final byte[]	HEADER
static final int	MAX_DATA_LENGTH
static final int	MAX_UNIVERSE
static final int	SEQUENCE_INDEX
static final int	UNIVERSE_LSB
static final int	UNIVERSE_MSB

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

childArrays, 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

DEFAULT_SEPARATOR, ROOT, ROOT_PREFIX, ROOT_SLASH

Constructor Summary

Constructors

Constructor	Description
ArtNetDatagram(LX lx, int[] indexBuffer)	Creates an ArtNetDatagram for the given index buffer
ArtNetDatagram(LX lx, int[] indexBuffer, int universeNumber)	Creates an ArtNetDatagram for the given index buffer and universe number
ArtNetDatagram(LX lx, int[] indexBuffer, int dataLength, int universeNumber)	Creates an ArtNetDatagram with fixed data length for given index buffer and universe
ArtNetDatagram(LX lx, int[] indexBuffer, LXBufferOutput.ByteOrder byteOrder)	Creates an ArtNetDatagram for the given index buffer and byte ordering
ArtNetDatagram(LX lx, int[] indexBuffer, LXBufferOutput.ByteOrder byteOrder, int universeNumber)	Creates an ArtNetDatagram for the given index buffer, universe and byte ordering
ArtNetDatagram(LX lx, int[] indexBuffer, LXBufferOutput.ByteOrder byteOrder, int dataLength, int universeNumber)	Creates an ArtNetDatagram with fixed data length for given index buffer, universe, and byte order
ArtNetDatagram(LX lx, LXModel model)	Creates an ArtNetDatagram for the given model
ArtNetDatagram(LX lx, LXModel model, int universeNumber)	Creates an ArtNetDatagram for the given model and universe number
ArtNetDatagram(LX lx, LXModel model, int dataLength, int universeNumber)	Creates an ArtNetDatagram for the given model, with fixed data length and universe
ArtNetDatagram(LX lx, LXModel model, LXBufferOutput.ByteOrder byteOrder, int universeNumber)	Creates an ArtNetDatagram for the given model, universe, and byte order
ArtNetDatagram(LX lx, LXModel model, LXBufferOutput.ByteOrder byteOrder, int dataLength, int universeNumber)	Creates an ArtNetDatagram with fixed data length for given model, universe, and byte ordering
ArtNetDatagram(LX lx, IndexBuffer indexBuffer, int universeNumber)	Creates an ArtNetDatagram with fixed data length for given index buffer, universe, and byte order
ArtNetDatagram(LX lx, IndexBuffer indexBuffer, int dataLength, int universeNumber)	Creates an ArtNetDatagram with fixed data length for given index buffer, universe, and byte order

Method Summary

Modifier and Type	Method	Description
protected int	getDataBufferOffset()	Offset into raw byte buffer where color data is written
int	getDataLength()
int	getUniverseNumber()
ArtNetDatagram	setSequenceEnabled(boolean sequenceEnabled)	Set whether to increment and send sequence numbers
ArtNetDatagram	setUniverseNumber(int universeNumber)
protected void	updateSequenceNumber()	Subclasses may override to update a sequence number in the packet when appropriate as part of the protocol.

Methods inherited from class heronarts.lx.output.LXDatagram

getAddress, getDataBuffer, getErrorState, getPort, onSend, setAddress, setPort, setSocket, 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, assertDisposed, contains, copyParameters, dispose, getCategory, getChild, getComponentDescription, 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, getCanonicalLabel, getCanonicalLabel, getCanonicalLabel, getCanonicalPath, getCanonicalPath, isDescendant

Field Details

ARTNET_PORT

public static final int ARTNET_PORT

See Also:

• Constant Field Values

MAX_DATA_LENGTH

public static final int MAX_DATA_LENGTH

See Also:

• Constant Field Values

MAX_UNIVERSE

public static final int MAX_UNIVERSE

See Also:

• Constant Field Values

ARTNET_HEADER_LENGTH

public static final int ARTNET_HEADER_LENGTH

See Also:

• Constant Field Values

SEQUENCE_INDEX

public static final int SEQUENCE_INDEX

See Also:

• Constant Field Values

UNIVERSE_LSB

public static final int UNIVERSE_LSB

See Also:

• Constant Field Values

UNIVERSE_MSB

public static final int UNIVERSE_MSB

See Also:

• Constant Field Values

DATA_LENGTH_MSB

public static final int DATA_LENGTH_MSB

See Also:

• Constant Field Values

DATA_LENGTH_LSB

public static final int DATA_LENGTH_LSB

See Also:

• Constant Field Values

HEADER

public static final byte[] HEADER

Constructor Details

ArtNetDatagram

public ArtNetDatagram(LX lx,
 LXModel model)

Creates an ArtNetDatagram for the given model

Parameters:

lx - LX instance

model - Model of points

ArtNetDatagram

public ArtNetDatagram(LX lx,
 int[] indexBuffer)

Creates an ArtNetDatagram for the given index buffer

Parameters:

lx - LX instance

indexBuffer - Index buffer

ArtNetDatagram

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

Creates an ArtNetDatagram for the given index buffer and byte ordering

Parameters:

lx - LX instance

indexBuffer - Index buffer

byteOrder - Byte ordering for points

ArtNetDatagram

public ArtNetDatagram(LX lx,
 LXModel model,
 int universeNumber)

Creates an ArtNetDatagram for the given model and universe number

Parameters:

lx - LX instance

model - Model of points

universeNumber - universe number

ArtNetDatagram

public ArtNetDatagram(LX lx,
 LXModel model,
 LXBufferOutput.ByteOrder byteOrder,
 int universeNumber)

Creates an ArtNetDatagram for the given model, universe, and byte order

Parameters:

lx - LX instance

model - Model of points

byteOrder - Byte ordering

universeNumber - Universe number

ArtNetDatagram

public ArtNetDatagram(LX lx,
 int[] indexBuffer,
 int universeNumber)

Creates an ArtNetDatagram for the given index buffer and universe number

Parameters:

lx - LX instance

indexBuffer - Index buffer

universeNumber - Universe number

ArtNetDatagram

public ArtNetDatagram(LX lx,
 int[] indexBuffer,
 LXBufferOutput.ByteOrder byteOrder,
 int universeNumber)

Creates an ArtNetDatagram for the given index buffer, universe and byte ordering

Parameters:

lx - LX instance

indexBuffer - Index buffer

byteOrder - Byte ordering

universeNumber - Universe number

ArtNetDatagram

public ArtNetDatagram(LX lx,
 LXModel model,
 int dataLength,
 int universeNumber)

Creates an ArtNetDatagram for the given model, with fixed data length and universe

Parameters:

lx - LX instance

model - Model

dataLength - Fixed data payload length

universeNumber - Universe number

ArtNetDatagram

public ArtNetDatagram(LX lx,
 LXModel model,
 LXBufferOutput.ByteOrder byteOrder,
 int dataLength,
 int universeNumber)

Creates an ArtNetDatagram with fixed data length for given model, universe, and byte ordering

Parameters:

lx - LX instance

model - Model of points

byteOrder - Byte ordering

dataLength - Fixed data payload length

universeNumber - Universe number

ArtNetDatagram

public ArtNetDatagram(LX lx,
 int[] indexBuffer,
 int dataLength,
 int universeNumber)

Creates an ArtNetDatagram with fixed data length for given index buffer and universe

Parameters:

lx - LX instance

indexBuffer - Index buffer

dataLength - Fixed data payload length

universeNumber - Universe number

ArtNetDatagram

public ArtNetDatagram(LX lx,
 int[] indexBuffer,
 LXBufferOutput.ByteOrder byteOrder,
 int dataLength,
 int universeNumber)

Creates an ArtNetDatagram with fixed data length for given index buffer, universe, and byte order

Parameters:

lx - LX instance

indexBuffer - Index buffer

byteOrder - Byte order

dataLength - Fixed data payload length

universeNumber - Universe number

ArtNetDatagram

public ArtNetDatagram(LX lx,
 IndexBuffer indexBuffer,
 int universeNumber)

Creates an ArtNetDatagram with fixed data length for given index buffer, universe, and byte order

Parameters:

lx - LX instance

indexBuffer - Index buffer

universeNumber - Universe number

ArtNetDatagram

public ArtNetDatagram(LX lx,
 IndexBuffer indexBuffer,
 int dataLength,
 int universeNumber)

Creates an ArtNetDatagram with fixed data length for given index buffer, universe, and byte order

Parameters:

lx - LX instance

indexBuffer - Index buffer

dataLength - Fixed data payload length

universeNumber - Universe number

Method Details

setUniverseNumber

public ArtNetDatagram setUniverseNumber(int universeNumber)

getUniverseNumber

public int getUniverseNumber()

getDataLength

public int getDataLength()

setSequenceEnabled

public ArtNetDatagram setSequenceEnabled(boolean sequenceEnabled)

Set whether to increment and send sequence numbers

Parameters:

sequenceEnabled - true if sequence should be incremented and transmitted

Returns:

this

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

updateSequenceNumber

protected void updateSequenceNumber()

Description copied from class: LXDatagram

Subclasses may override to update a sequence number in the packet when appropriate as part of the protocol.

Overrides:

updateSequenceNumber in class LXDatagram