Package org.openremote.agent.protocol.bluetooth.mesh

Class BluetoothMeshProtocol

java.lang.Object

org.openremote.agent.protocol.AbstractProtocol<BluetoothMeshAgent,BluetoothMeshAgentLink>

org.openremote.agent.protocol.bluetooth.mesh.BluetoothMeshProtocol

All Implemented Interfaces:

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

public class BluetoothMeshProtocol
extends AbstractProtocol<BluetoothMeshAgent,BluetoothMeshAgentLink>

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_APPLICATION_KEY_INDEX
static final int	DEFAULT_MTU
static final int	DEFAULT_NETWORK_KEY_INDEX
static final int	DEFAULT_SEQUENCE_NUMBER
static final Logger	LOG
static final String	PROTOCOL_DISPLAY_NAME
static final String	REGEXP_INDEX_AND_KEY
static final String	REGEXP_PROXY_ADDRESS

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
BluetoothMeshProtocol(BluetoothMeshAgent agent)

Method Summary

Modifier and Type	Method	Description
static void	addNetwork(BluetoothMeshNetwork network)
protected void	doLinkAttribute(String assetId, org.openremote.model.attribute.Attribute<?> attribute, BluetoothMeshAgentLink agentLink)	Link an Attribute to its linked Agent.
protected void	doLinkedAttributeWrite(org.openremote.model.attribute.Attribute<?> attribute, BluetoothMeshAgentLink agentLink, org.openremote.model.attribute.AttributeEvent event, Object processedValue)	An Attribute event (write) has been requested for an attribute linked to this protocol.
protected 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, BluetoothMeshAgentLink agentLink)	Unlink an Attribute from its linked Agent.
String	getProtocolInstanceUri()	Get a URI that describes this specific protocol instance
String	getProtocolName()	Get the name for this protocol
static void	initMainThread(ScheduledExecutorService executorService)

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

DEFAULT_MTU

public static final int DEFAULT_MTU

See Also:

• Constant Field Values

DEFAULT_SEQUENCE_NUMBER

public static final int DEFAULT_SEQUENCE_NUMBER

See Also:

• Constant Field Values

DEFAULT_NETWORK_KEY_INDEX

public static final int DEFAULT_NETWORK_KEY_INDEX

See Also:

• Constant Field Values

DEFAULT_APPLICATION_KEY_INDEX

public static final int DEFAULT_APPLICATION_KEY_INDEX

See Also:

• Constant Field Values

REGEXP_INDEX_AND_KEY

public static final String REGEXP_INDEX_AND_KEY

See Also:

• Constant Field Values

REGEXP_PROXY_ADDRESS

public static final String REGEXP_PROXY_ADDRESS

See Also:

• Constant Field Values

LOG

public static final Logger LOG

Constructor Details

BluetoothMeshProtocol

public BluetoothMeshProtocol(BluetoothMeshAgent agent)

Method Details

initMainThread

public static void initMainThread(ScheduledExecutorService executorService)

addNetwork

public static void addNetwork(BluetoothMeshNetwork network)

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

doStart

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

Description copied from class: AbstractProtocol

Start this protocol instance

Specified by:

doStart in class AbstractProtocol<BluetoothMeshAgent,BluetoothMeshAgentLink>

Throws:

Exception

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<BluetoothMeshAgent,BluetoothMeshAgentLink>

Throws:

Exception

doLinkAttribute

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

Description copied from class: AbstractProtocol

Link an Attribute to its linked Agent.

Specified by:

doLinkAttribute in class AbstractProtocol<BluetoothMeshAgent,BluetoothMeshAgentLink>

Throws:

RuntimeException

doUnlinkAttribute

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

Description copied from class: AbstractProtocol

Unlink an Attribute from its linked Agent.

Specified by:

doUnlinkAttribute in class AbstractProtocol<BluetoothMeshAgent,BluetoothMeshAgentLink>

doLinkedAttributeWrite

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

Description copied from class: AbstractProtocol

An Attribute event (write) has been requested for an attribute linked to this protocol. The processedValue is the resulting value after applying standard outbound value processing (see ProtocolUtil.doOutboundValueProcessing(java.lang.String, org.openremote.model.attribute.Attribute<?>, org.openremote.model.asset.agent.AgentLink<?>, java.lang.Object, boolean)). Protocol implementations should generally use the processedValue but may also choose to use the original value for some purpose if required.

Specified by:

doLinkedAttributeWrite in class AbstractProtocol<BluetoothMeshAgent,BluetoothMeshAgentLink>