java.lang.Object
org.openremote.agent.protocol.bluetooth.mesh.Provisioner

public class Provisioner extends Object
Class definition of a Provisioner of mesh network
  • Constructor Details

  • Method Details

    • getMeshUuid

      public String getMeshUuid()
      Returns the provisionerUuid of the Mesh network
      Returns:
      String provisionerUuid
    • setMeshUuid

      public void setMeshUuid(String uuid)
      Sets the provisionerUuid of the mesh network to this application key
      Parameters:
      uuid - mesh network provisionerUuid
    • getProvisionerName

      public String getProvisionerName()
      Returns the provisioner name
      Returns:
      name
    • setProvisionerName

      public void setProvisionerName(String provisionerName) throws IllegalArgumentException
      Sets a friendly name to a provisioner
      Parameters:
      provisionerName - friendly name
      Throws:
      IllegalArgumentException
    • getProvisionerUuid

      public String getProvisionerUuid()
      Returns the provisionerUuid
      Returns:
      UUID
    • setProvisionerUuid

      public void setProvisionerUuid(String provisionerUuid)
    • getAllocatedGroupRanges

      public List<AllocatedGroupRange> getAllocatedGroupRanges()
      Returns AllocatedGroupRange for this provisioner
      Returns:
      allocated range of group addresses
    • setAllocatedGroupRanges

      public void setAllocatedGroupRanges(List<AllocatedGroupRange> allocatedGroupRanges)
      Sets AllocatedGroupRange for this provisioner
      Parameters:
      allocatedGroupRanges - allocated range of group addresses
    • getAllocatedUnicastRanges

      public List<AllocatedUnicastRange> getAllocatedUnicastRanges()
      Returns AllocatedUnicastRange for this provisioner
      Returns:
      allocated range of unicast addresses
    • setAllocatedUnicastRanges

      public void setAllocatedUnicastRanges(List<AllocatedUnicastRange> allocatedUnicastRanges)
      Sets AllocatedGroupRange for this provisioner
      Parameters:
      allocatedUnicastRanges - allocated range of unicast addresses
    • getAllocatedSceneRanges

      public List<AllocatedSceneRange> getAllocatedSceneRanges()
      Returns AllocatedSceneRange for this provisioner
      Returns:
      allocated range of unicast addresses
    • setAllocatedSceneRanges

      public void setAllocatedSceneRanges(List<AllocatedSceneRange> allocatedSceneRanges)
      Sets AllocatedSceneRange for this provisioner
      Parameters:
      allocatedSceneRanges - allocated range of unicast addresses
    • getProvisionerAddress

      public Integer getProvisionerAddress()
    • setProvisionerAddress

      public void setProvisionerAddress(Integer address) throws IllegalArgumentException
      Set provisioner address
      Parameters:
      address - address of the provisioner
      Throws:
      IllegalArgumentException
    • assignProvisionerAddress

      public boolean assignProvisionerAddress(Integer address) throws IllegalArgumentException
      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

      public void setGlobalTtl(int ttl) throws IllegalArgumentException
      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

      public boolean addRange(Range allocatedRange)
      Add a range to the provisioner
      Parameters:
      allocatedRange - Range
    • removeRange

      public boolean removeRange(Range range)
      Add a range to the provisioner
      Parameters:
      range - Range
    • hasOverlappingUnicastRanges

      public boolean hasOverlappingUnicastRanges(List<AllocatedUnicastRange> otherRanges)
    • hasOverlappingGroupRanges

      public boolean hasOverlappingGroupRanges(List<AllocatedGroupRange> otherRanges)
    • hasOverlappingSceneRanges

      public boolean hasOverlappingSceneRanges(List<AllocatedSceneRange> otherRanges)