DlTdoaRangingParams

---

Kotlin |Java

class DlTdoaRangingParams : Parcelable

kotlin.Any
↳	android.ranging.uwb.DlTdoaRangingParams

Class to represent UWB Downlink TDoA ranging parameters.

Summary

Nested classes
	Builder Builder for DlTdoaRangingParams.

Constants
static Int	MEASUREMENT_VERSION_1 DL-TDoA Ranging Measurement version 1
static Int	MEASUREMENT_VERSION_2 DL-TDoA Ranging Measurement version 2
static Int	MEASUREMENT_VERSION_UNKNOWN DL-TDoA Ranging Measurement version unknown

Inherited constants

From class 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: 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)". Some implementations may want to release resources at this point.

Public methods
static DlTdoaRangingParams	createFromFiraConfigPacket(config: ByteArray, rangingRoundIndexes: ByteArray?) Creates a DlTdoaRangingParams from a FiRa compliant configuration packet.
Int	describeContents()
Boolean	equals(other: Any?)
UwbComplexChannel	getComplexChannel() Gets the complex channel used for the session.
UwbAddress	getDeviceAddress() Gets the UWB address of the device.
Int	getMeasurementVersion() Gets the measurement version.
Int	getRangingIntervalMillis() Gets the ranging interval in milliseconds.
ByteArray?	getRangingRoundIndexes() Gets the active ranging round indexes.
Int	getSessionId() Gets the session ID.
ByteArray?	getSessionKeyInfo() Gets the session key information.
Int	getSlotDuration() Gets the slot duration.
Int	getSlotsPerRangingRound() Gets the number of slots per ranging round.
Int	hashCode()
String	toString()
Unit	writeToParcel(dest: Parcel, flags: Int) Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<DlTdoaRangingParams!>	CREATOR

Constants

MEASUREMENT_VERSION_1

static val MEASUREMENT_VERSION_1: Int

DL-TDoA Ranging Measurement version 1

Value: 1

MEASUREMENT_VERSION_2

static val MEASUREMENT_VERSION_2: Int

DL-TDoA Ranging Measurement version 2

Value: 2

MEASUREMENT_VERSION_UNKNOWN

static val MEASUREMENT_VERSION_UNKNOWN: Int

DL-TDoA Ranging Measurement version unknown

Value: 2147483647

Public methods

createFromFiraConfigPacket

static fun createFromFiraConfigPacket(
    config: ByteArray, 
    rangingRoundIndexes: ByteArray?
): DlTdoaRangingParams

Creates a DlTdoaRangingParams from a FiRa compliant configuration packet.

Parameters
config	ByteArray: The byte array containing the FiRa configuration packet. This value cannot be null.
rangingRoundIndexes	ByteArray?: The active ranging round indexes. If null, use the default value of DlTdoaRangingParams.Builder.

Return
DlTdoaRangingParams	A DlTdoaRangingParams instance. This value cannot be null.

Exceptions
java.lang.IllegalArgumentException	if the configuration packet is malformed or missing mandatory fields.

See Also

describeContents

fun describeContents(): Int

equals

fun equals(other: Any?): Boolean

getComplexChannel

fun getComplexChannel(): UwbComplexChannel

Gets the complex channel used for the session.

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

getDeviceAddress

fun getDeviceAddress(): UwbAddress

Gets the UWB address of the device.

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

getMeasurementVersion

fun getMeasurementVersion(): Int

Gets the measurement version.

Return
Int	The measurement version. Value is one of the following: MEASUREMENT_VERSION_1 MEASUREMENT_VERSION_2 MEASUREMENT_VERSION_UNKNOWN

getRangingIntervalMillis

fun getRangingIntervalMillis(): Int

Gets the ranging interval in milliseconds.

Return
Int	The ranging interval in milliseconds.

getRangingRoundIndexes

fun getRangingRoundIndexes(): ByteArray?

Gets the active ranging round indexes.

Return
ByteArray?	This value may be null.

getSessionId

fun getSessionId(): Int

Gets the session ID.

Return
Int	The session ID as an integer.

getSessionKeyInfo

fun getSessionKeyInfo(): ByteArray?

Gets the session key information.

Return
ByteArray?	A byte array containing session key info, or null if not available.

getSlotDuration

fun getSlotDuration(): Int

Gets the slot duration.

Return
Int	The slot duration. Value is one of the following: android.ranging.uwb.UwbRangingParams#DURATION_1_MS android.ranging.uwb.UwbRangingParams#DURATION_2_MS

getSlotsPerRangingRound

fun getSlotsPerRangingRound(): Int

Gets the number of slots per ranging round.

Return
Int	The number of slots per ranging round.

hashCode

fun hashCode(): Int

toString

fun toString(): String

writeToParcel

fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

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_WRITE_RETURN_VALUE. Value is either 0 or a combination of the following: PARCELABLE_WRITE_RETURN_VALUE

Properties

CREATOR

static val CREATOR: Parcelable.Creator<DlTdoaRangingParams!>