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

Class PublicationSettings

java.lang.Object
org.openremote.agent.protocol.bluetooth.mesh.transport.PublicationSettings
public class PublicationSettings extends Object

  • Field Details

    • MIN_PUBLICATION_RETRANSMIT_COUNT

      public static final int MIN_PUBLICATION_RETRANSMIT_COUNT
      See Also:

    • MAX_PUBLICATION_RETRANSMIT_COUNT

      public static final int MAX_PUBLICATION_RETRANSMIT_COUNT
      See Also:

  • Constructor Details

    • PublicationSettings

      public PublicationSettings()

    • PublicationSettings

      public PublicationSettings(int publishAddress, int appKeyIndex, boolean credentialFlag, int publishRetransmitCount, int publishRetransmitIntervalSteps)
      Constructs a PublicationSettings
      Parameters:
      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
      publishRetransmitCount - Number of publication retransmits
      publishRetransmitIntervalSteps - Publish retransmit interval steps

  • Method Details

    • getPublishAddress

      public int getPublishAddress()
      Returns the publish address, this is the address the model may publish messages when set
      Returns:
      publish address

    • setPublishAddress

      public void setPublishAddress(int publishAddress)
      Sets a publish address for this model
      Parameters:
      publishAddress - publish address

    • getLabelUUID

      public UUID getLabelUUID()
      Returns the label uuid for this model

    • getAppKeyIndex

      public int getAppKeyIndex()
      Returns the app key index used for publishing by this model
      Returns:
      Global app key index

    • setAppKeyIndex

      public void setAppKeyIndex(int appKeyIndex)
      Set app key index to be used when publishing messages.
      Parameters:
      appKeyIndex - global application key index

    • getCredentialFlag

      public boolean getCredentialFlag()

    • getPublishTtl

      public int getPublishTtl()
      Returns the ttl used for publication.
      Returns:
      publication ttl

    • getPublishRetransmitCount

      public int getPublishRetransmitCount()
      Returns the retransmit count used in publication
      Returns:
      publication retransmit count

    • getPublishRetransmitIntervalSteps

      public int getPublishRetransmitIntervalSteps()
      Returns the retransmit interval steps used in publication
      Returns:
      publication retransmit interval steps

    • getPublicationSteps

      public int getPublicationSteps()
      Returns the publication steps used for publication
      Returns:
      publication steps

    • getPublicationResolution

      public int getPublicationResolution()
      Returns the resolution bit-field of publication steps. The resolution can be 100ms, 1 second, 10 seconds or 10 minutes
      Returns:
      resolution

    • deserializePublicationResolution

      public static int deserializePublicationResolution(int resolution)
      Decodes the publication period resolution.
      Parameters:
      resolution - publication period resolution

    • getPublishPeriod

      public int getPublishPeriod()
      Returns the publish period in seconds

    • getPublishPeriod

      public static int getPublishPeriod(int publicationResolution, int publicationSteps)
      Returns the publish period in seconds

    • getRetransmissionInterval

      public int getRetransmissionInterval()
      Returns the retransmission interval in milliseconds

    • getRetransmissionInterval

      public static int getRetransmissionInterval(int intervalSteps)
      Returns the retransmit interval for a given number of retransmit interval steps in milliseconds
      Parameters:
      intervalSteps - Retransmit interval steps

    • getMinRetransmissionInterval

      public static int getMinRetransmissionInterval()
      Returns the minimum retransmit interval supported in milliseconds

    • getMaxRetransmissionInterval

      public static int getMaxRetransmissionInterval()
      Returns the maximum retransmit interval supported in milliseconds

    • parseRetransmitIntervalSteps

      public static int parseRetransmitIntervalSteps(int retransmitInterval)
      Returns the retransmit interval steps from the retransmit interval
      Parameters:
      retransmitInterval - Retransmit interval in milliseconds