Added in Android Baklava

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.
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.
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 Android Baklava

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 Android Baklava

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 Android Baklava

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 Android Baklava

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 Android Baklava

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 Android Baklava

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 Android Baklava

public static final int DURATION_1_MS

1 millisecond slot duration

Constant Value: 1 (0x00000001)

DURATION_2_MS

Added in Android Baklava

public static final int DURATION_2_MS

2 millisecond slot duration

Constant Value: 2 (0x00000002)

SUB_SESSION_UNDEFINED

Added in Android Baklava

public static final int SUB_SESSION_UNDEFINED

Sub session id not applicable.

Constant Value: -1 (0xffffffff)

Fields

CREATOR

Added in Android Baklava

public static final Creator<UwbRangingParams> CREATOR

Public methods

describeContents

Added in Android Baklava

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

getComplexChannel

Added in Android Baklava

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 Android Baklava

public int getConfigId ()

Gets the configuration ID associated with this session.

Returns
int	The configuration ID as an integer. Value is CONFIG_UNICAST_DS_TWR, CONFIG_MULTICAST_DS_TWR, CONFIG_PROVISIONED_UNICAST_DS_TWR, CONFIG_PROVISIONED_MULTICAST_DS_TWR, CONFIG_PROVISIONED_INDIVIDUAL_MULTICAST_DS_TWR, or CONFIG_PROVISIONED_UNICAST_DS_TWR_VERY_FAST

getDeviceAddress

Added in Android Baklava

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 Android Baklava

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 Android Baklava

public int getRangingUpdateRate ()

Returns the update rate for ranging operations.

Returns
int	The ranging update rate. Value is RawRangingDevice.UPDATE_RATE_NORMAL, RawRangingDevice.UPDATE_RATE_INFREQUENT, or RawRangingDevice.UPDATE_RATE_FREQUENT

getSessionId

Added in Android Baklava

public int getSessionId ()

Gets the session ID associated with this ranging session.

Returns
int	The session ID as an integer.

getSessionKeyInfo

Added in Android Baklava

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 Android Baklava

public int getSlotDuration ()

Returns slot duration of the session.

Returns
int	the slot duration. Value is DURATION_1_MS, or DURATION_2_MS

getSubSessionId

Added in Android Baklava

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 Android Baklava

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.

toString

Added in Android Baklava

public String toString ()

Returns a string representation of the object.

Returns
String	a string representation of the object.

writeToParcel

Added in Android Baklava

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 Parcelable.PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES