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

Class ConfigModelPublicationSet

java.lang.Object

org.openremote.agent.protocol.bluetooth.mesh.transport.MeshMessage

org.openremote.agent.protocol.bluetooth.mesh.transport.ConfigModelPublicationSet

public class ConfigModelPublicationSet
extends MeshMessage

To be used as a wrapper class to create a ConfigModelPublicationSet message.

Field Summary

Fields

Modifier and Type	Field	Description
static final Logger	LOG

Fields inherited from class org.openremote.agent.protocol.bluetooth.mesh.transport.MeshMessage

messageTtl, mMessage

Constructor Summary

Constructors

Constructor	Description
ConfigModelPublicationSet(int elementAddress, int modelIdentifier)	Constructs a ConfigModelPublicationSet message.
ConfigModelPublicationSet(int elementAddress, int publishAddress, int appKeyIndex, boolean credentialFlag, int publishTtl, int publicationSteps, int publicationResolution, int retransmitCount, int retransmitIntervalSteps, int modelIdentifier)	Constructs a ConfigModelPublicationSet message.

Method Summary

Modifier and Type	Method	Description
final int	getAid()
final int	getAkf()
int	getAppKeyIndex()	Returns the global index of the app key to be used for publication.
boolean	getCredentialFlag()	Returns the credential flag to be used for this message.
int	getElementAddress()	Returns the element address to which the app key must be bound.
int	getModelIdentifier()	Returns the model identifier to which the key is to be bound.
int	getOpCode()	Returns the opCode of this message
final byte[]	getParameters()
int	getPublicationResolution()	Returns the resolution for the publication steps.
int	getPublicationSteps()	Returns the number of publication steps.
int	getPublishAddress()	Returns the publish address to which the model must publish to
int	getPublishRetransmitCount()	Returns the number of retransmissions for each published message.
int	getPublishRetransmitIntervalSteps()	Returns the number of 50-milliseconds steps between retransmissions.
int	getPublishTtl()	Returns the ttl of publication messages

Methods inherited from class org.openremote.agent.protocol.bluetooth.mesh.transport.MeshMessage

getAszmic, getDst, getMessage, getMessageTtl, getSrc, setMessageTtl

Methods inherited from class java.lang.Object

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

Field Details

LOG

public static final Logger LOG

Constructor Details

ConfigModelPublicationSet

public ConfigModelPublicationSet(int elementAddress,
 int modelIdentifier)
                          throws IllegalArgumentException

Constructs a ConfigModelPublicationSet message. Use this constructor to clear publications

Parameters:

elementAddress - Element address that should publish

modelIdentifier - identifier for this model that will do publication

Throws:

IllegalArgumentException - for invalid arguments

ConfigModelPublicationSet

public ConfigModelPublicationSet(int elementAddress,
 int publishAddress,
 int appKeyIndex,
 boolean credentialFlag,
 int publishTtl,
 int publicationSteps,
 int publicationResolution,
 int retransmitCount,
 int retransmitIntervalSteps,
 int modelIdentifier)
                          throws IllegalArgumentException

Constructs a ConfigModelPublicationSet message.

Parameters:

elementAddress - Element address that should publish

publishAddress - Address to which the element must publish

appKeyIndex - Index of the application key

credentialFlag - Credentials flag define which credentials to be used, set true to use friendship credentials and false for master credentials. Currently supports only master credentials

publishTtl - Publication ttl

publicationSteps - Publication steps for the publication period

publicationResolution - Publication resolution of the publication period

retransmitCount - Number of publication retransmits

retransmitIntervalSteps - Publish retransmit interval steps

modelIdentifier - identifier for this model that will do publication

Throws:

IllegalArgumentException - for invalid arguments

Method Details

getOpCode

public int getOpCode()

Description copied from class: MeshMessage

Returns the opCode of this message

Specified by:

getOpCode in class MeshMessage

Returns:

opcode

getElementAddress

public int getElementAddress()

Returns the element address to which the app key must be bound.

Returns:

element address

getPublishAddress

public int getPublishAddress()

Returns the publish address to which the model must publish to

getAppKeyIndex

public int getAppKeyIndex()

Returns the global index of the app key to be used for publication.

Returns:

app key index

getCredentialFlag

public boolean getCredentialFlag()

Returns the credential flag to be used for this message.

Returns:

true if friendship credentials to be used or false if master credentials is to be used.

getPublishTtl

public int getPublishTtl()

Returns the ttl of publication messages

Returns:

publication ttl

getPublicationSteps

public int getPublicationSteps()

Returns the number of publication steps.

Returns:

number of steps

getPublicationResolution

public int getPublicationResolution()

Returns the resolution for the publication steps.

Returns:

resolution

getPublishRetransmitCount

public int getPublishRetransmitCount()

Returns the number of retransmissions for each published message.

Returns:

number of retransmits

getPublishRetransmitIntervalSteps

public int getPublishRetransmitIntervalSteps()

Returns the number of 50-milliseconds steps between retransmissions.

Returns:

retransmit interval steps

getModelIdentifier

public int getModelIdentifier()

Returns the model identifier to which the key is to be bound.

Returns:

16-bit or 32-bit vendor model identifier

getAkf

public final int getAkf()

getAid

public final int getAid()

getParameters

public final byte[] getParameters()