Class Provisioner
java.lang.Object
org.openremote.agent.protocol.bluetooth.mesh.Provisioner
Class definition of a Provisioner of mesh network
-
Constructor Summary
ConstructorsConstructorDescriptionProvisioner
(String provisionerUuid, List<AllocatedUnicastRange> allocatedUnicastRanges, List<AllocatedGroupRange> allocatedGroupRanges, List<AllocatedSceneRange> allocatedSceneRanges, String meshUuid) ConstructsProvisioner
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Add a range to the provisionerboolean
assignProvisionerAddress
(Integer address) Assigns provisioner addressReturnsAllocatedGroupRange
for this provisionerReturnsAllocatedSceneRange
for this provisionerReturnsAllocatedUnicastRange
for this provisionerint
Returns the provisionerUuid of the Mesh networkReturns the provisioner nameReturns the provisionerUuidboolean
hasOverlappingGroupRanges
(List<AllocatedGroupRange> otherRanges) boolean
hasOverlappingSceneRanges
(List<AllocatedSceneRange> otherRanges) boolean
hasOverlappingUnicastRanges
(List<AllocatedUnicastRange> otherRanges) boolean
boolean
removeRange
(Range range) Add a range to the provisionervoid
setAllocatedGroupRanges
(List<AllocatedGroupRange> allocatedGroupRanges) SetsAllocatedGroupRange
for this provisionervoid
setAllocatedSceneRanges
(List<AllocatedSceneRange> allocatedSceneRanges) SetsAllocatedSceneRange
for this provisionervoid
setAllocatedUnicastRanges
(List<AllocatedUnicastRange> allocatedUnicastRanges) SetsAllocatedGroupRange
for this provisionervoid
setGlobalTtl
(int ttl) Set the ttl of the provisionervoid
setLastSelected
(boolean lastSelected) void
setMeshUuid
(String uuid) Sets the provisionerUuid of the mesh network to this application keyvoid
setProvisionerAddress
(Integer address) Set provisioner addressvoid
setProvisionerName
(String provisionerName) Sets a friendly name to a provisionervoid
setProvisionerUuid
(String provisionerUuid) boolean
Returns true if the provisioner is allowed to configure the network
-
Constructor Details
-
Provisioner
public Provisioner(String provisionerUuid, List<AllocatedUnicastRange> allocatedUnicastRanges, List<AllocatedGroupRange> allocatedGroupRanges, List<AllocatedSceneRange> allocatedSceneRanges, String meshUuid) ConstructsProvisioner
-
-
Method Details
-
getMeshUuid
Returns the provisionerUuid of the Mesh network- Returns:
- String provisionerUuid
-
setMeshUuid
Sets the provisionerUuid of the mesh network to this application key- Parameters:
uuid
- mesh network provisionerUuid
-
getProvisionerName
Returns the provisioner name- Returns:
- name
-
setProvisionerName
Sets a friendly name to a provisioner- Parameters:
provisionerName
- friendly name- Throws:
IllegalArgumentException
-
getProvisionerUuid
Returns the provisionerUuid- Returns:
- UUID
-
setProvisionerUuid
-
getAllocatedGroupRanges
ReturnsAllocatedGroupRange
for this provisioner- Returns:
- allocated range of group addresses
-
setAllocatedGroupRanges
SetsAllocatedGroupRange
for this provisioner- Parameters:
allocatedGroupRanges
- allocated range of group addresses
-
getAllocatedUnicastRanges
ReturnsAllocatedUnicastRange
for this provisioner- Returns:
- allocated range of unicast addresses
-
setAllocatedUnicastRanges
SetsAllocatedGroupRange
for this provisioner- Parameters:
allocatedUnicastRanges
- allocated range of unicast addresses
-
getAllocatedSceneRanges
ReturnsAllocatedSceneRange
for this provisioner- Returns:
- allocated range of unicast addresses
-
setAllocatedSceneRanges
SetsAllocatedSceneRange
for this provisioner- Parameters:
allocatedSceneRanges
- allocated range of unicast addresses
-
getProvisionerAddress
-
setProvisionerAddress
Set provisioner address- Parameters:
address
- address of the provisioner- Throws:
IllegalArgumentException
-
assignProvisionerAddress
Assigns provisioner address- Parameters:
address
- address of the provisioner- Throws:
IllegalArgumentException
-
getGlobalTtl
public int getGlobalTtl() -
supportsConfiguration
public boolean supportsConfiguration()Returns true if the provisioner is allowed to configure the network -
setGlobalTtl
Set the ttl of the provisioner- Parameters:
ttl
- ttl- Throws:
IllegalArgumentException
- if invalid ttl value is set
-
isLastSelected
public boolean isLastSelected() -
setLastSelected
public void setLastSelected(boolean lastSelected) -
addRange
Add a range to the provisioner- Parameters:
allocatedRange
-Range
-
removeRange
Add a range to the provisioner- Parameters:
range
-Range
-
hasOverlappingUnicastRanges
-
hasOverlappingGroupRanges
-
hasOverlappingSceneRanges
-