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

Class ConfigModelPublicationVirtualAddressSet

java.lang.Object
org.openremote.agent.protocol.bluetooth.mesh.transport.MeshMessage
org.openremote.agent.protocol.bluetooth.mesh.transport.ConfigModelPublicationVirtualAddressSet
public class ConfigModelPublicationVirtualAddressSet extends MeshMessage
This is the message class for setting a virtual address as a publication address

  • Field Details

    • LOG

      public static final Logger LOG

  • Constructor Details

    • ConfigModelPublicationVirtualAddressSet

      public ConfigModelPublicationVirtualAddressSet(int elementAddress, UUID labelUuid, int appKeyIndex, boolean credentialFlag, int publishTtl, int publicationSteps, int publicationResolution, int retransmitCount, int retransmitIntervalSteps, int modelIdentifier) throws IllegalArgumentException
      Constructs a ConfigModelPublicationVirtualAddressSet message
      Parameters:
      elementAddress - Element address that should publish
      labelUuid - Value of the Label UUID publish address
      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

    • getLabelUuid

      public UUID getLabelUuid()
      Returns the value of the Label UUID publish address

    • 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()