Package org.openremote.agent.protocol.artnet

Class ArtnetProtocol

java.lang.Object

org.openremote.agent.protocol.AbstractProtocol<U,X>

org.openremote.agent.protocol.io.AbstractIOClientProtocol<T,U,V,W,X>

org.openremote.agent.protocol.io.AbstractNettyIOClientProtocol<ArtnetProtocol,ArtnetAgent,ArtnetPacket,UDPIOClient<ArtnetPacket>,org.openremote.model.asset.agent.DefaultAgentLink>

org.openremote.agent.protocol.artnet.ArtnetProtocol

All Implemented Interfaces:

org.openremote.model.asset.agent.Protocol<ArtnetAgent>, org.openremote.model.protocol.ProtocolAssetImport

public class ArtnetProtocol
extends AbstractNettyIOClientProtocol<ArtnetProtocol,ArtnetAgent,ArtnetPacket,UDPIOClient<ArtnetPacket>,org.openremote.model.asset.agent.DefaultAgentLink>
implements org.openremote.model.protocol.ProtocolAssetImport

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<String,ArtnetLightAsset>	lights
static final String	PROTOCOL_DISPLAY_NAME
protected final Map<org.openremote.model.attribute.AttributeRef,Consumer<ArtnetPacket>>	protocolMessageConsumers

Fields inherited from class org.openremote.agent.protocol.io.AbstractIOClientProtocol

client, LOG

Fields inherited from class org.openremote.agent.protocol.AbstractProtocol

agent, assetService, datapointService, dynamicAttributes, executorService, linkedAttributes, messageBrokerContext, predictedDatapointService, producerTemplate, timerService

Fields inherited from interface org.openremote.model.asset.agent.Protocol

ACTUATOR_TOPIC, ACTUATOR_TOPIC_TARGET_PROTOCOL, DYNAMIC_TIME_PLACEHOLDER_REGEXP, DYNAMIC_VALUE_PLACEHOLDER, DYNAMIC_VALUE_PLACEHOLDER_REGEXP, SENSOR_QUEUE, SENSOR_QUEUE_SOURCE_PROTOCOL

Constructor Summary

Constructors

Constructor	Description
ArtnetProtocol(ArtnetAgent agent)

Method Summary

Modifier and Type	Method	Description
protected ArtnetPacket	createWriteMessage(org.openremote.model.attribute.Attribute<?> attribute, org.openremote.model.asset.agent.DefaultAgentLink agentLink, org.openremote.model.attribute.AttributeEvent event, Object processedValue)	Generate the actual message to send to the IOClient for this AttributeEvent
protected UDPIOClient<ArtnetPacket>	doCreateIoClient()	Should return an instance of IOClient for the linked Agent.
protected void	doLinkAttribute(String assetId, org.openremote.model.attribute.Attribute<?> attribute, org.openremote.model.asset.agent.DefaultAgentLink agentLink)	Link an Attribute to its linked Agent.
protected void	doUnlinkAttribute(String assetId, org.openremote.model.attribute.Attribute<?> attribute, org.openremote.model.asset.agent.DefaultAgentLink agentLink)	Unlink an Attribute from its linked Agent.
protected Supplier<io.netty.channel.ChannelHandler[]>	getEncoderDecoderProvider()	Gets the Netty ChannelHandlers for the IO client
String	getProtocolName()	Get the name for this protocol
protected void	onMessageReceived(ArtnetPacket packet)	Called when the IOClient receives a message from the server
Future<Void>	startAssetImport(byte[] fileData, Consumer<org.openremote.model.asset.AssetTreeNode[]> assetConsumer)	Start the process asynchronously; the implementation can make as many calls as it desires to the assetConsumer with the found assets; when the implementation has finished then the returned future will become Future.isDone().

Methods inherited from class org.openremote.agent.protocol.io.AbstractNettyIOClientProtocol

createIoClient

Methods inherited from class org.openremote.agent.protocol.io.AbstractIOClientProtocol

doLinkedAttributeWrite, doStart, doStop, getGenericStringEncodersAndDecoders, getProtocolInstanceUri, onConnectionStatusChanged

Methods inherited from class org.openremote.agent.protocol.AbstractProtocol

getAgent, getLinkedAttributes, linkAttribute, processLinkedAttributeWrite, sendAttributeEvent, sendAttributeEvent, setConnectionStatus, start, stop, toString, unlinkAttribute, updateAgentAttribute, updateLinkedAttribute, updateLinkedAttribute

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openremote.model.asset.agent.Protocol

prefixLogMessage

Field Details

PROTOCOL_DISPLAY_NAME

public static final String PROTOCOL_DISPLAY_NAME

See Also:

• Constant Field Values

protocolMessageConsumers

protected final Map<org.openremote.model.attribute.AttributeRef,Consumer<ArtnetPacket>> protocolMessageConsumers

lights

protected final Map<String,ArtnetLightAsset> lights

Constructor Details

ArtnetProtocol

public ArtnetProtocol(ArtnetAgent agent)

Method Details

getProtocolName

public String getProtocolName()

Description copied from interface: org.openremote.model.asset.agent.Protocol

Get the name for this protocol

Specified by:

getProtocolName in interface org.openremote.model.asset.agent.Protocol<ArtnetAgent>

doCreateIoClient

protected UDPIOClient<ArtnetPacket> doCreateIoClient()
                                              throws Exception

Description copied from class: AbstractIOClientProtocol

Should return an instance of IOClient for the linked Agent.

Specified by:

doCreateIoClient in class AbstractIOClientProtocol<ArtnetProtocol,ArtnetAgent,ArtnetPacket,UDPIOClient<ArtnetPacket>,org.openremote.model.asset.agent.DefaultAgentLink>

Throws:

Exception

getEncoderDecoderProvider

protected Supplier<io.netty.channel.ChannelHandler[]> getEncoderDecoderProvider()

Description copied from class: AbstractNettyIOClientProtocol

Gets the Netty ChannelHandlers for the IO client

Specified by:

getEncoderDecoderProvider in class AbstractNettyIOClientProtocol<ArtnetProtocol,ArtnetAgent,ArtnetPacket,UDPIOClient<ArtnetPacket>,org.openremote.model.asset.agent.DefaultAgentLink>

doLinkAttribute

protected void doLinkAttribute(String assetId,
 org.openremote.model.attribute.Attribute<?> attribute,
 org.openremote.model.asset.agent.DefaultAgentLink agentLink)

Description copied from class: AbstractProtocol

Link an Attribute to its linked Agent.

Specified by:

doLinkAttribute in class AbstractProtocol<ArtnetAgent,org.openremote.model.asset.agent.DefaultAgentLink>

doUnlinkAttribute

protected void doUnlinkAttribute(String assetId,
 org.openremote.model.attribute.Attribute<?> attribute,
 org.openremote.model.asset.agent.DefaultAgentLink agentLink)

Description copied from class: AbstractProtocol

Unlink an Attribute from its linked Agent.

Specified by:

doUnlinkAttribute in class AbstractProtocol<ArtnetAgent,org.openremote.model.asset.agent.DefaultAgentLink>

onMessageReceived

protected void onMessageReceived(ArtnetPacket packet)

Description copied from class: AbstractIOClientProtocol

Called when the IOClient receives a message from the server

Specified by:

onMessageReceived in class AbstractIOClientProtocol<ArtnetProtocol,ArtnetAgent,ArtnetPacket,UDPIOClient<ArtnetPacket>,org.openremote.model.asset.agent.DefaultAgentLink>

createWriteMessage

protected ArtnetPacket createWriteMessage(org.openremote.model.attribute.Attribute<?> attribute,
 org.openremote.model.asset.agent.DefaultAgentLink agentLink,
 org.openremote.model.attribute.AttributeEvent event,
 Object processedValue)

Description copied from class: AbstractIOClientProtocol

Generate the actual message to send to the IOClient for this AttributeEvent

Specified by:

createWriteMessage in class AbstractIOClientProtocol<ArtnetProtocol,ArtnetAgent,ArtnetPacket,UDPIOClient<ArtnetPacket>,org.openremote.model.asset.agent.DefaultAgentLink>

startAssetImport

public Future<Void> startAssetImport(byte[] fileData,
 Consumer<org.openremote.model.asset.AssetTreeNode[]> assetConsumer)

Description copied from interface: org.openremote.model.protocol.ProtocolAssetImport

Start the process asynchronously; the implementation can make as many calls as it desires to the assetConsumer with the found assets; when the implementation has finished then the returned future will become Future.isDone(). The callee can also cancel the future at any time. If for some reason the process cannot be started or encounters an error then this method should log more details before completing the future.

Specified by:

startAssetImport in interface org.openremote.model.protocol.ProtocolAssetImport