RawRangingDevice

Kotlin |Java

class RawRangingDevice : Parcelable

kotlin.Any
↳	android.ranging.raw.RawRangingDevice

Represents a device participating in ranging operations. This class supports multiple ranging technologies, including UWB, BLE CS, BLE RSSI and Wi-Fi NAN-RTT. The configuration for each technology is provided through corresponding parameter objects.

Summary

Nested classes
	`Builder` Builder class for creating instances of `RawRangingDevice`.

Constants
static Int	`UPDATE_RATE_FREQUENT` Frequent ranging interval.
static Int	`UPDATE_RATE_INFREQUENT` Infrequent ranging interval.
static Int	`UPDATE_RATE_NORMAL` Normal ranging interval (Default).

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
Int	`describeContents()`
BleRssiRangingParams?	`getBleRssiRangingParams()` Returns the BLE rssi ranging parameters, if applicable.
BleCsRangingParams?	`getCsRangingParams()` Returns the CS ranging parameters, if applicable.
RangingDevice	`getRangingDevice()` Returns the `RangingDevice` associated with this instance.
MutableMap<Int!, Duration!>	`getRangingIntervalValues()` Returns a map of ranging technologies to their corresponding ranging interval durations for available ranging technologies parameters.
RttRangingParams?	`getRttRangingParams()` Returns the RTT ranging parameters, if applicable.
RttStationRangingParams?	`getRttStationRangingParams()` Returns the Wi-Fi STA-AP ranging parameters, if applicable.
UwbRangingParams?	`getUwbRangingParams()` Returns the UWB ranging parameters, if applicable.
String	`toString()`
Unit	`writeToParcel(dest: Parcel, flags: Int)` Flatten this object in to a Parcel.

Properties
static Parcelable.Creator<RawRangingDevice!>	`CREATOR`

Constants

UPDATE_RATE_FREQUENT

Added in API level 36

static val UPDATE_RATE_FREQUENT: Int

Frequent ranging interval.

UWB - 96 milliseconds for config id UwbRangingParams.CONFIG_PROVISIONED_UNICAST_DS_TWR_VERY_FAST, 120 milliseconds otherwise. See UwbRangingCapabilities.getSupportedRangingUpdateRates() to verify Frequent update rate is supported.
BLE RSSI - 500 milliseconds.
BLE CS - 100 milliseconds.
WiFi Rtt - 128 milliseconds if RttRangingCapabilities.hasPeriodicRangingHardwareFeature() is true, 256 milliseconds otherwise.

Value: 3

UPDATE_RATE_INFREQUENT

Added in API level 36

static val UPDATE_RATE_INFREQUENT: Int

Infrequent ranging interval.

UWB - 600 milliseconds.
BLE RSSI - 3 seconds.
BLE CS - 5 seconds.
WiFi Rtt - 8192 milliseconds otherwise.

Value: 2

UPDATE_RATE_NORMAL

Added in API level 36

static val UPDATE_RATE_NORMAL: Int

Normal ranging interval (Default).

UWB - 200 milliseconds for config ids UwbRangingParams.getConfigId() with multicast ranging, 240 milliseconds for unicast.
BLE RSSI - 1 second.
BLE CS - 200 ms.
WiFi Rtt - 256 milliseconds if RttRangingCapabilities.hasPeriodicRangingHardwareFeature() is true, 512 milliseconds otherwise.

Value: 1

Public methods

describeContents

Added in API level 36

fun describeContents(): Int

Return
`Int`	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either `0` or `android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR`

getBleRssiRangingParams

Added in API level 36

fun getBleRssiRangingParams(): BleRssiRangingParams?

Returns the BLE rssi ranging parameters, if applicable.

Return
`BleRssiRangingParams?`	the `BleRssiRangingParams`, or `null` if not set.

getCsRangingParams

Added in API level 36

fun getCsRangingParams(): BleCsRangingParams?

Returns the CS ranging parameters, if applicable.

Return
`BleCsRangingParams?`	the `BleCsRangingParams`, or `null` if not set.

getRangingDevice

Added in API level 36

fun getRangingDevice(): RangingDevice

Returns the RangingDevice associated with this instance.

Return
`RangingDevice`	the ranging device. This value cannot be `null`.

getRangingIntervalValues

Added in API level 36.1

fun getRangingIntervalValues(): MutableMap<Int!, Duration!>

Returns a map of ranging technologies to their corresponding ranging interval durations for available ranging technologies parameters.

The duration for each technology is determined by its configured android.ranging.raw.RawRangingDevice.RangingUpdateRate and, in some cases, technology-specific parameters like UwbRangingParams.getConfigId() for UWB.

Return
`MutableMap<Int!, Duration!>`	A non-null, possibly empty, map where keys are RangingTechnology integers and values are the calculated `Duration` for that technology's ranging interval.

getRttRangingParams

Added in API level 36

fun getRttRangingParams(): RttRangingParams?

Returns the RTT ranging parameters, if applicable.

Return
`RttRangingParams?`	the `RttRangingParams`, or `null` if not set.

getRttStationRangingParams

Added in API level 36.1

fun getRttStationRangingParams(): RttStationRangingParams?

Returns the Wi-Fi STA-AP ranging parameters, if applicable.

Return
`RttStationRangingParams?`	the `RttStationRangingParams`, or `null` if not set.

getUwbRangingParams

Added in API level 36

fun getUwbRangingParams(): UwbRangingParams?

Returns the UWB ranging parameters, if applicable.

Return
`UwbRangingParams?`	the `UwbRangingParams`, or `null` if not set.

toString

Added in API level 36

fun toString(): String

Return
`String`	a string representation of the object.

writeToParcel

Added in API level 36

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

Properties

CREATOR

Added in API level 36

static val CREATOR: Parcelable.Creator<RawRangingDevice!>