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

Class MeshNetwork

java.lang.Object

org.openremote.agent.protocol.bluetooth.mesh.BaseMeshNetwork

org.openremote.agent.protocol.bluetooth.mesh.MeshNetwork

public class MeshNetwork
extends BaseMeshNetwork

Field Summary

Fields inherited from class org.openremote.agent.protocol.bluetooth.mesh.BaseMeshNetwork

appKeyComparator, groupComparator, groupRangeComparator, IV_UPDATE_ACTIVE, LOG, mCallbacks, netKeyComparator, networkExclusions, nodeComparator, NORMAL_OPERATION, sceneRangeComparator, sequenceNumbers, unicastRangeComparator

Constructor Summary

Constructors

Constructor	Description
MeshNetwork(String meshUUID)

Method Summary

Modifier and Type	Method	Description
List<ApplicationKey>	getAppKeys()	Returns a list of ApplicationKey belonging to the mesh network
Group	getGroup(int address)	Returns a group based on the group number
List<Group>	getGroups()
String	getId()
IvIndex	getIvIndex()
UUID	getLabelUuid(int address)	Returns the uuid for a given virtual address
String	getMeshName()	Returns the name of the mesh network
String	getMeshUUID()
List<NetworkKey>	getNetKeys()
NetworkKey	getPrimaryNetworkKey()
Scene	getScene(int number)	Returns a scene based on the scene number.
List<Scene>	getScenes()	Returns a list of scenes.
String	getSchema()
long	getTimestamp()	Returns the time stamp of th e mesh network
String	getVersion()
int	nextAvailableUnicastAddress(int elementCount, Provisioner provisioner)	Returns the next unicast address for a node based on the number of elements and the range allocated to the provisioner.
void	setLastSelected(boolean lastSelected)
void	setPartial(boolean partial)	Set the partial configuration flag to true.
void	setTimestamp(long timestamp)	Sets the time stamp

Methods inherited from class org.openremote.agent.protocol.bluetooth.mesh.BaseMeshNetwork

addAppKey, addNetKey, addProvisioner, createAppKey, createNetworkKey, createProvisioner, deleteNode, distributeAppKey, distributeNetKey, getAppKey, getAppKeys, getNetKey, getNetworkExclusions, getNode, getNode, getNodes, getProvisioners, getProxyFilter, getSelectedProvisioner, isKeyInUse, isProvisionerUuidInUse, loadSequenceNumbers, removeAppKey, removeNetKey, revokeOldKey, selectProvisioner, setProxyFilter, switchToNewKey, updateAppKey, updateAppKey, updateNetKey, updateNetKey

Methods inherited from class java.lang.Object

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

Constructor Details

MeshNetwork

public MeshNetwork(String meshUUID)

Method Details

setTimestamp

public void setTimestamp(long timestamp)

Sets the time stamp

Parameters:

timestamp - timestamp

getScenes

public List<Scene> getScenes()

Returns a list of scenes.

getGroup

public Group getGroup(int address)

Returns a group based on the group number

getGroups

public List<Group> getGroups()

getMeshUUID

public String getMeshUUID()

getNetKeys

public List<NetworkKey> getNetKeys()

getPrimaryNetworkKey

public NetworkKey getPrimaryNetworkKey()

getAppKeys

public List<ApplicationKey> getAppKeys()

Returns a list of ApplicationKey belonging to the mesh network

getIvIndex

public IvIndex getIvIndex()

getSchema

public String getSchema()

getId

public String getId()

getVersion

public String getVersion()

getMeshName

public String getMeshName()

Returns the name of the mesh network

getTimestamp

public long getTimestamp()

Returns the time stamp of th e mesh network

setPartial

public void setPartial(boolean partial)

Set the partial configuration flag to true. To be used internally

Parameters:

partial - true if the network is set to be exported partially.

setLastSelected

public void setLastSelected(boolean lastSelected)

getScene

public Scene getScene(int number)

Returns a scene based on the scene number.

getLabelUuid

public UUID getLabelUuid(int address)
                  throws IllegalArgumentException

Returns the uuid for a given virtual address

Parameters:

address - virtual address

Returns:

The label uuid if it's known to the provisioner or null otherwise

Throws:

IllegalArgumentException

nextAvailableUnicastAddress

public int nextAvailableUnicastAddress(int elementCount,
 Provisioner provisioner)
                                throws IllegalArgumentException

Returns the next unicast address for a node based on the number of elements and the range allocated to the provisioner. P.S. When setting up a new network don't forget to assign an address to the provisioner. When importing a network make sure to create a new provisioner with a different address which is the recommended approach. However you can also use the same provisioner with a different address.

Parameters:

elementCount - Element count

provisioner - provisioner

Returns:

Allocated unicast address or -1 if none

Throws:

IllegalArgumentException - if there is no allocated unicast range to the provisioner