Added in API level 36

Summary: Nested Classes | Constants | Inherited Constants | Fields | Methods | Inherited Methods

UwbRangingParams

---

Kotlin |Java

public final class UwbRangingParams
extends Object implements Parcelable

java.lang.Object
↳	android.ranging.uwb.UwbRangingParams

---

UwbRangingParams encapsulates the parameters required for a UWB ranging session.

Summary

Nested classes
class	UwbRangingParams.Builder Builder class for creating instances of UwbRangingParams

Constants
int	CONFIG_MULTICAST_DS_TWR FiRa-defined multicast STATIC STS DS-TWR ranging, deferred mode, ranging interval Fast (120ms), Normal (200ms), Infrequent (600ms)
int	CONFIG_PROVISIONED_INDIVIDUAL_MULTICAST_DS_TWR Same as CONFIG_UNICAST_DS_TWR, except P-STS individual controlee key mode is enabled.
int	CONFIG_PROVISIONED_MULTICAST_DS_TWR Same as CONFIG_MULTICAST_DS_TWR, except P-STS security mode is enabled.
int	CONFIG_PROVISIONED_UNICAST_DS_TWR Same as CONFIG_UNICAST_DS_TWR, except P-STS security mode is enabled.
int	CONFIG_PROVISIONED_UNICAST_DS_TWR_VERY_FAST Same as CONFIG_ID_3, except fast ranging interval is 96 milliseconds.
int	CONFIG_UNICAST_DS_TWR FiRa-defined unicast STATIC STS DS-TWR ranging, deferred mode, ranging interval Fast (120ms), Normal (240ms), Infrequent (600ms)
int	DURATION_1_MS 1 millisecond slot duration
int	DURATION_2_MS 2 millisecond slot duration
int	SUB_SESSION_UNDEFINED Sub session id not applicable.

Inherited constants

From interface android.os.Parcelable int CONTENTS_FILE_DESCRIPTOR Descriptor bit used with describeContents(): indicates that the Parcelable object's flattened representation includes a file descriptor. int PARCELABLE_WRITE_RETURN_VALUE Flag for use with writeToParcel(Parcel, int): the object being written is a return value, that is the result of a function such as "Parcelable someFunction()", "void someFunction(out Parcelable)", or "void someFunction(inout Parcelable)".

Fields
public static final Creator<UwbRangingParams>	CREATOR

Public methods
int	describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation.
boolean	equals(Object o) Indicates whether some other object is "equal to" this one.
UwbComplexChannel	getComplexChannel() Gets the complex channel information for this session.
int	getConfigId() Gets the configuration ID associated with this session.
UwbAddress	getDeviceAddress() Gets the UWB address of the device.
UwbAddress	getPeerAddress() Returns the UwbAddress of the peer device.
int	getRangingUpdateRate() Returns the update rate for ranging operations.
int	getSessionId() Gets the session ID associated with this ranging session.
byte[]	getSessionKeyInfo() Gets session key information, if available.
int	getSlotDuration() Returns slot duration of the session.
int	getSubSessionId() Gets the sub-session ID if applicable for the session.
byte[]	getSubSessionKeyInfo() Gets sub-session key information, if available.
int	hashCode() Returns a hash code value for the object.
String	toString() Returns a string representation of the object.
void	writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Inherited methods
From class java.lang.Object Object clone() Creates and returns a copy of this object. boolean equals(Object obj) Indicates whether some other object is "equal to" this one. void finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. final Class<?> getClass() Returns the runtime class of this Object. int hashCode() Returns a hash code value for the object. final void notify() Wakes up a single thread that is waiting on this object's monitor. final void notifyAll() Wakes up all threads that are waiting on this object's monitor. String toString() Returns a string representation of the object. final void wait(long timeoutMillis, int nanos) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait(long timeoutMillis) Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed. final void wait() Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
From interface android.os.Parcelable abstract int describeContents() Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. abstract void writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel.

Constants

CONFIG_MULTICAST_DS_TWR

Added in API level 36

public static final int CONFIG_MULTICAST_DS_TWR

FiRa-defined multicast STATIC STS DS-TWR ranging, deferred mode, ranging interval Fast (120ms), Normal (200ms), Infrequent (600ms)

Constant Value: 2 (0x00000002)

CONFIG_PROVISIONED_INDIVIDUAL_MULTICAST_DS_TWR

Added in API level 36

public static final int CONFIG_PROVISIONED_INDIVIDUAL_MULTICAST_DS_TWR

Same as CONFIG_UNICAST_DS_TWR, except P-STS individual controlee key mode is enabled.

Constant Value: 5 (0x00000005)

CONFIG_PROVISIONED_MULTICAST_DS_TWR

Added in API level 36

public static final int CONFIG_PROVISIONED_MULTICAST_DS_TWR

Same as CONFIG_MULTICAST_DS_TWR, except P-STS security mode is enabled.

Constant Value: 4 (0x00000004)

CONFIG_PROVISIONED_UNICAST_DS_TWR

Added in API level 36

public static final int CONFIG_PROVISIONED_UNICAST_DS_TWR

Same as CONFIG_UNICAST_DS_TWR, except P-STS security mode is enabled.

Constant Value: 3 (0x00000003)

CONFIG_PROVISIONED_UNICAST_DS_TWR_VERY_FAST

Added in API level 36

public static final int CONFIG_PROVISIONED_UNICAST_DS_TWR_VERY_FAST

Same as CONFIG_ID_3, except fast ranging interval is 96 milliseconds.

Constant Value: 6 (0x00000006)

CONFIG_UNICAST_DS_TWR

Added in API level 36

public static final int CONFIG_UNICAST_DS_TWR

FiRa-defined unicast STATIC STS DS-TWR ranging, deferred mode, ranging interval Fast (120ms), Normal (240ms), Infrequent (600ms)

Constant Value: 1 (0x00000001)

DURATION_1_MS

Added in API level 36

public static final int DURATION_1_MS

1 millisecond slot duration

Constant Value: 1 (0x00000001)

DURATION_2_MS

Added in API level 36

public static final int DURATION_2_MS

2 millisecond slot duration

Constant Value: 2 (0x00000002)

SUB_SESSION_UNDEFINED

Added in API level 36

public static final int SUB_SESSION_UNDEFINED

Sub session id not applicable.

Constant Value: -1 (0xffffffff)

Fields

CREATOR

Added in API level 36

public static final Creator<UwbRangingParams> CREATOR

Public methods

describeContents

Added in API level 36

public int describeContents ()

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel, int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

Returns
int	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or CONTENTS_FILE_DESCRIPTOR

equals

Added in API level 36

public boolean equals (Object o)

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters
o	Object: the reference object with which to compare.

Returns
boolean	true if this object is the same as the obj argument; false otherwise.

getComplexChannel

Added in API level 36

public UwbComplexChannel getComplexChannel ()

Gets the complex channel information for this session.

Returns
UwbComplexChannel	A UwbComplexChannel object containing channel and preamble index. This value cannot be null.

getConfigId

Added in API level 36

public int getConfigId ()

Gets the configuration ID associated with this session.

Returns
int	The configuration ID as an integer. Value is one of the following: CONFIG_UNICAST_DS_TWR CONFIG_MULTICAST_DS_TWR CONFIG_PROVISIONED_UNICAST_DS_TWR CONFIG_PROVISIONED_MULTICAST_DS_TWR CONFIG_PROVISIONED_INDIVIDUAL_MULTICAST_DS_TWR CONFIG_PROVISIONED_UNICAST_DS_TWR_VERY_FAST

getDeviceAddress

Added in API level 36

public UwbAddress getDeviceAddress ()

Gets the UWB address of the device.

Returns
UwbAddress	The UwbAddress of the device. This value cannot be null.

getPeerAddress

Added in API level 36

public UwbAddress getPeerAddress ()

Returns the UwbAddress of the peer device.

Returns
UwbAddress	A UwbAddress corresponding to the peer device to range with. This value cannot be null.

getRangingUpdateRate

Added in API level 36

public int getRangingUpdateRate ()

Returns the update rate for ranging operations.

Returns
int	The ranging update rate. Value is one of the following: RawRangingDevice.UPDATE_RATE_NORMAL RawRangingDevice.UPDATE_RATE_INFREQUENT RawRangingDevice.UPDATE_RATE_FREQUENT

getSessionId

Added in API level 36

public int getSessionId ()

Gets the session ID associated with this ranging session.

Returns
int	The session ID as an integer.

getSessionKeyInfo

Added in API level 36

public byte[] getSessionKeyInfo ()

Gets session key information, if available.

Returns
byte[]	A byte array containing session key info, or null if not available.

getSlotDuration

Added in API level 36

public int getSlotDuration ()

Returns slot duration of the session.

Returns
int	the slot duration. Value is one of the following: DURATION_1_MS DURATION_2_MS

getSubSessionId

Added in API level 36

public int getSubSessionId ()

Gets the sub-session ID if applicable for the session.

Returns
int	The sub-session ID as an integer or SUB_SESSION_UNDEFINED if not applicable.

getSubSessionKeyInfo

Added in API level 36

public byte[] getSubSessionKeyInfo ()

Gets sub-session key information, if available.

Returns
byte[]	A byte array containing sub-session key info, or null if not available.

hashCode

Added in API level 36

public int hashCode ()

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns
int	a hash code value for this object.

toString

Added in API level 36

public String toString ()

Returns a string representation of the object.

Returns
String	a string representation of the object.

writeToParcel

Added in API level 36

public void writeToParcel (Parcel dest, 
                int flags)

Flatten this object in to a Parcel.

Parameters
dest	Parcel: This value cannot be null.
flags	int: Additional flags about how the object should be written. May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following: Parcelable.PARCELABLE_WRITE_RETURN_VALUE