Summary: Ctors | Methods | Inherited Methods

DlTdoaRangingParams.Builder

---

Kotlin |Java

public static final class DlTdoaRangingParams.Builder
extends Object

java.lang.Object
↳	android.ranging.uwb.DlTdoaRangingParams.Builder

---

Builder for DlTdoaRangingParams.

Summary

Public constructors
Builder(int sessionId) Constructor for the Builder.

Public methods
DlTdoaRangingParams	build() Builds the DlTdoaRangingParams instance.
DlTdoaRangingParams.Builder	setComplexChannel(UwbComplexChannel complexChannel) Sets the complex channel.
DlTdoaRangingParams.Builder	setDeviceAddress(UwbAddress deviceAddress) Sets the UWB address of the device.
DlTdoaRangingParams.Builder	setMeasurementVersion(int measurementVersion) Sets the measurement version.
DlTdoaRangingParams.Builder	setRangingIntervalMillis(int rangingIntervalMs) Sets the ranging interval in milliseconds.
DlTdoaRangingParams.Builder	setRangingRoundIndexes(byte[] rangingRoundIndexes) Sets the active ranging round indexes.
DlTdoaRangingParams.Builder	setSessionKeyInfo(byte[] sessionKeyInfo) Sets the session key information.
DlTdoaRangingParams.Builder	setSlotDuration(int slotDuration) Sets the slot duration.
DlTdoaRangingParams.Builder	setSlotsPerRangingRound(int slotsPerRangingRound) Sets the number of slots per ranging round.

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.

Public constructors

Builder

public Builder (int sessionId)

Constructor for the Builder.

Parameters
sessionId	int: The session ID.

Public methods

build

public DlTdoaRangingParams build ()

Builds the DlTdoaRangingParams instance.

Returns
DlTdoaRangingParams	The DlTdoaRangingParams instance. This value cannot be null.

setComplexChannel

public DlTdoaRangingParams.Builder setComplexChannel (UwbComplexChannel complexChannel)

Sets the complex channel.

If not set, a default channel with channel 9 and preamble index 10 is used.

Parameters
complexChannel	UwbComplexChannel: The complex channel. This value cannot be null.

Returns
DlTdoaRangingParams.Builder	this Builder instance. This value cannot be null.

setDeviceAddress

public DlTdoaRangingParams.Builder setDeviceAddress (UwbAddress deviceAddress)

Sets the UWB address of the device.

If not set, a random short address is used as default.

Parameters
deviceAddress	UwbAddress: The UWB address of the device. This value cannot be null.

Returns
DlTdoaRangingParams.Builder	this Builder instance. This value cannot be null.

setMeasurementVersion

public DlTdoaRangingParams.Builder setMeasurementVersion (int measurementVersion)

Sets the measurement version.

Parameters
measurementVersion	int: The measurement version. Value is one of the following: DlTdoaRangingParams.MEASUREMENT_VERSION_1 DlTdoaRangingParams.MEASUREMENT_VERSION_2 DlTdoaRangingParams.MEASUREMENT_VERSION_UNKNOWN

Returns
DlTdoaRangingParams.Builder	this Builder instance. This value cannot be null.

setRangingIntervalMillis

public DlTdoaRangingParams.Builder setRangingIntervalMillis (int rangingIntervalMs)

Sets the ranging interval in milliseconds.

If not set, 200ms is used as default.

Parameters
rangingIntervalMs	int: The ranging interval in milliseconds. Value is 1 or greater

Returns
DlTdoaRangingParams.Builder	this Builder instance. This value cannot be null.

Throws
IllegalArgumentException	if the ranging interval is not positive.

setRangingRoundIndexes

public DlTdoaRangingParams.Builder setRangingRoundIndexes (byte[] rangingRoundIndexes)

Sets the active ranging round indexes.

If not set, {0} is used as default.

Parameters
rangingRoundIndexes	byte: The active ranging round indexes. This value cannot be null.

Returns
DlTdoaRangingParams.Builder	this Builder instance. This value cannot be null.

setSessionKeyInfo

public DlTdoaRangingParams.Builder setSessionKeyInfo (byte[] sessionKeyInfo)

Sets the session key information.

If not set, {7, 8, 1, 2, 3, 4, 5, 6} is used as default.

Parameters
sessionKeyInfo	byte: The session key information. This value cannot be null.

Returns
DlTdoaRangingParams.Builder	this Builder instance. This value cannot be null.

setSlotDuration

public DlTdoaRangingParams.Builder setSlotDuration (int slotDuration)

Sets the slot duration.

If not set, UwbRangingParams.DURATION_2_MS is used as default.

Parameters
slotDuration	int: The slot duration. Value is one of the following: UwbRangingParams.DURATION_1_MS UwbRangingParams.DURATION_2_MS

Returns
DlTdoaRangingParams.Builder	this Builder instance. This value cannot be null.

setSlotsPerRangingRound

public DlTdoaRangingParams.Builder setSlotsPerRangingRound (int slotsPerRangingRound)

Sets the number of slots per ranging round.

If not set, 25 is used as default.

Parameters
slotsPerRangingRound	int: The number of slots per ranging round. Value is 1 or greater

Returns
DlTdoaRangingParams.Builder	this Builder instance. This value cannot be null.

Throws
IllegalArgumentException	if the slots per ranging round is not positive.