Package org.openremote.agent.protocol.controller

Class ControllerProtocol

java.lang.Object

org.openremote.agent.protocol.AbstractProtocol<ControllerAgent,ControllerAgentLink>

org.openremote.agent.protocol.controller.ControllerProtocol

All Implemented Interfaces:

org.openremote.model.asset.agent.Protocol<ControllerAgent>

public class ControllerProtocol
extends AbstractProtocol<ControllerAgent,ControllerAgentLink>

This is a Controller 2.5 protocol to communicate with a running Controller 2.5 instance and getting sensor's status and executing commands.

The protocol communicate with Controller by using Controller REST API.

The protocol manage two kinds of request :

• A set of polling requests (one by controller/device name couple) pollingSensorList. For each request we just wait for a response 200 (new status) or 403 (timeout after 60 seconds) and relaunch the same request as soon as we have one of those two responses.
• Executing commands provided by Write Attribute with necessary information. There is different kind of situations explained in ControllerCommand

Two cases are considered:

• A sensor : if we want to link an attribute to a controller 2.5 sensor to get status we should create an Attribute with proper type considering the situation (temperature, time,...) and two necessary META ControllerAgent#META_DEVICE_NAME and ControllerAgent#META_SENSOR_NAME
• A command : if we want to execute a command on a controller 2.5, we create an attribute with the following available META (see details in ControllerCommand) : ControllerAgent#META_DEVICE_NAME or ControllerAgent#META_COMMAND_DEVICE_NAME, ControllerAgent#META_COMMAND_NAME or ControllerAgent#META_COMMANDS_MAP

Field Summary

Fields

Modifier and Type	Field	Description
protected org.jboss.resteasy.client.jaxrs.ResteasyClient	client
static final int	HEARTBEAT_DELAY_SECONDS
static final String	PROTOCOL_DISPLAY_NAME

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
ControllerProtocol(ControllerAgent agent)

Method Summary

Modifier and Type	Method	Description
protected void	doLinkAttribute(String assetId, org.openremote.model.attribute.Attribute<?> attribute, ControllerAgentLink agentLink)	Link an Attribute to its linked Agent.
protected void	doLinkedAttributeWrite(org.openremote.model.attribute.Attribute<?> attribute, ControllerAgentLink agentLink, org.openremote.model.attribute.AttributeEvent event, Object processedValue)	Write action on a linked attribute mean we execute a command on the Controller.
void	doStart(org.openremote.model.Container container)	Start this protocol instance
protected void	doStop(org.openremote.model.Container container)	Stop this protocol instance
protected void	doUnlinkAttribute(String assetId, org.openremote.model.attribute.Attribute<?> attribute, ControllerAgentLink agentLink)	Clearing elements if an attribute is unlinked from Controller Agent We don't have to clear pollingSensorList as a check is done before scheduling task schedulePollingTask(java.lang.String)
String	getProtocolInstanceUri()	Get a URI that describes this specific protocol instance
String	getProtocolName()	Get the name for this protocol
protected void	setConnectionStatus(org.openremote.model.asset.agent.ConnectionStatus connectionStatus)

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

getAgent, getLinkedAttributes, linkAttribute, processLinkedAttributeWrite, sendAttributeEvent, sendAttributeEvent, 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

HEARTBEAT_DELAY_SECONDS

public static final int HEARTBEAT_DELAY_SECONDS

See Also:

• Constant Field Values

PROTOCOL_DISPLAY_NAME

public static final String PROTOCOL_DISPLAY_NAME

See Also:

• Constant Field Values

client

protected org.jboss.resteasy.client.jaxrs.ResteasyClient client

Constructor Details

ControllerProtocol

public ControllerProtocol(ControllerAgent agent)

Method Details

doStart

public void doStart(org.openremote.model.Container container)
             throws Exception

Description copied from class: AbstractProtocol

Start this protocol instance

Specified by:

doStart in class AbstractProtocol<ControllerAgent,ControllerAgentLink>

Throws:

Exception

setConnectionStatus

protected void setConnectionStatus(org.openremote.model.asset.agent.ConnectionStatus connectionStatus)

Overrides:

setConnectionStatus in class AbstractProtocol<ControllerAgent,ControllerAgentLink>

doStop

protected void doStop(org.openremote.model.Container container)
               throws Exception

Description copied from class: AbstractProtocol

Stop this protocol instance

Specified by:

doStop in class AbstractProtocol<ControllerAgent,ControllerAgentLink>

Throws:

Exception

doLinkAttribute

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

Description copied from class: AbstractProtocol

Link an Attribute to its linked Agent.

Specified by:

doLinkAttribute in class AbstractProtocol<ControllerAgent,ControllerAgentLink>

doUnlinkAttribute

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

Clearing elements if an attribute is unlinked from Controller Agent We don't have to clear pollingSensorList as a check is done before scheduling task schedulePollingTask(java.lang.String)

Specified by:

doUnlinkAttribute in class AbstractProtocol<ControllerAgent,ControllerAgentLink>

doLinkedAttributeWrite

protected void doLinkedAttributeWrite(org.openremote.model.attribute.Attribute<?> attribute,
 ControllerAgentLink agentLink,
 org.openremote.model.attribute.AttributeEvent event,
 Object processedValue)

Write action on a linked attribute mean we execute a command on the Controller. It induce a HTTP request and manage it's return code. (No value is returned from the execution of a command)

Specified by:

doLinkedAttributeWrite in class AbstractProtocol<ControllerAgent,ControllerAgentLink>

getProtocolName

public String getProtocolName()

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

Get the name for this protocol

getProtocolInstanceUri

public String getProtocolInstanceUri()

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

Get a URI that describes this specific protocol instance