Package com.trx.neon.api.neonSettings.model

Class UWBChannelConfig

  • public final class UWBChannelConfig
extends java.lang.Object
    UWBChannelConfig represents all configuration parameters for configuring an UWB-enabled tracking unit

    • Field Summary

      Fields 
      Modifier and Type Field Description
      java.lang.Integer Channel
      For CUSTOM UWB Channel Type only, specifies the channel for sharing, otherwise null
      UWBChannelType ChannelType
      UWB Channel Type
      java.lang.String Password
      For CUSTOM UWB Channel Type only, specifies the password to be set for sharing, otherwise null
      UWBShareType ShareType
      UWB Sharing Type

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static UWBChannelConfig Custom​(UWBShareType shareType, int channel, java.lang.String password)
      Sets up a custom UWB sharing channel which will share with all UWB trackers with the matching channel/password
      java.lang.String getValidationCode()
      For CUSTOM UWB Channel Type only, when requesting the UWB channel config this will be set with the ValidationCode which is a hash of the password
      static UWBChannelConfig Off()
      disables UWB sharing
      void setValidationCode​(java.lang.String validationCode)  
      static UWBChannelConfig Subscription​(UWBShareType shareType)
      Sets up a subscription UWB sharing channel which will share with all UWB trackers in a subscription

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • ChannelType

        public final UWBChannelType ChannelType
        UWB Channel Type

      • ShareType

        public final UWBShareType ShareType
        UWB Sharing Type

      • Channel

        public final java.lang.Integer Channel
        For CUSTOM UWB Channel Type only, specifies the channel for sharing, otherwise null

      • Password

        public final java.lang.String Password
        For CUSTOM UWB Channel Type only, specifies the password to be set for sharing, otherwise null

    • Method Detail

      • Subscription

        public static UWBChannelConfig Subscription​(UWBShareType shareType)
        Sets up a subscription UWB sharing channel which will share with all UWB trackers in a subscription
        Parameters:
        shareType - What type of constraint to share with the subscription
        Returns:
        An UWBChannelConfig object for a subscription channel

      • Custom

        public static UWBChannelConfig Custom​(UWBShareType shareType,
                                      int channel,
                                      java.lang.String password)
        Sets up a custom UWB sharing channel which will share with all UWB trackers with the matching channel/password
        Parameters:
        shareType - What type of constraint to share with the custom channel
        channel - Channel number (0-255)
        password - String password which will produce a validation code for display
        Returns:
        An UWBChannelConfig object for a custom channel

      • Off

        public static UWBChannelConfig Off()
        disables UWB sharing
        Returns:
        An UWBChannelConfig object for a no sharing

      • getValidationCode

        public java.lang.String getValidationCode()
        For CUSTOM UWB Channel Type only, when requesting the UWB channel config this will be set with the ValidationCode which is a hash of the password
        Returns:
        The validation code

      • setValidationCode

        public void setValidationCode​(java.lang.String validationCode)