UwbRangingParams
class UwbRangingParams : Parcelable
| kotlin.Any | |
| ↳ | android.ranging.uwb.UwbRangingParams |
UwbRangingParams encapsulates the parameters required for a UWB ranging session.
Summary
| Nested classes | |
|---|---|
|
Builder class for creating instances of |
|
| Constants | |
|---|---|
| static Int |
FiRa-defined multicast |
| static Int |
Same as |
| static Int |
Same as |
| static Int |
Same as |
| static Int |
Same as |
| static Int |
FiRa-defined unicast |
| static Int |
1 millisecond slot duration |
| static Int |
2 millisecond slot duration |
| static Int |
Sub session id not applicable. |
| Inherited constants | |
|---|---|
| Public methods | |
|---|---|
| Int | |
| UwbComplexChannel |
Gets the complex channel information for this session. |
| Int |
Gets the configuration ID associated with this session. |
| UwbAddress |
Gets the UWB address of the device. |
| UwbAddress |
Returns the UwbAddress of the peer device. |
| Int |
Returns the update rate for ranging operations. |
| Int |
Gets the session ID associated with this ranging session. |
| ByteArray? |
Gets session key information, if available. |
| Int |
Returns slot duration of the session. |
| Int |
Gets the sub-session ID if applicable for the session. |
| ByteArray? |
Gets sub-session key information, if available. |
| String |
toString() |
| Unit |
writeToParcel(dest: Parcel, flags: Int)Flatten this object in to a Parcel. |
| Properties | |
|---|---|
| static Parcelable.Creator<UwbRangingParams!> | |
Constants
CONFIG_MULTICAST_DS_TWR
static val CONFIG_MULTICAST_DS_TWR: Int
FiRa-defined multicast STATIC STS DS-TWR ranging, deferred mode, ranging interval Fast (120ms), Normal (200ms), Infrequent (600ms)
Value: 2CONFIG_PROVISIONED_INDIVIDUAL_MULTICAST_DS_TWR
static val CONFIG_PROVISIONED_INDIVIDUAL_MULTICAST_DS_TWR: Int
Same as CONFIG_UNICAST_DS_TWR, except P-STS individual controlee key mode is enabled.
Value: 5CONFIG_PROVISIONED_MULTICAST_DS_TWR
static val CONFIG_PROVISIONED_MULTICAST_DS_TWR: Int
Same as CONFIG_MULTICAST_DS_TWR, except P-STS security mode is enabled.
Value: 4CONFIG_PROVISIONED_UNICAST_DS_TWR
static val CONFIG_PROVISIONED_UNICAST_DS_TWR: Int
Same as CONFIG_UNICAST_DS_TWR, except P-STS security mode is enabled.
Value: 3CONFIG_PROVISIONED_UNICAST_DS_TWR_VERY_FAST
static val CONFIG_PROVISIONED_UNICAST_DS_TWR_VERY_FAST: Int
Same as CONFIG_ID_3, except fast ranging interval is 96 milliseconds.
Value: 6CONFIG_UNICAST_DS_TWR
static val CONFIG_UNICAST_DS_TWR: Int
FiRa-defined unicast STATIC STS DS-TWR ranging, deferred mode, ranging interval Fast (120ms), Normal (240ms), Infrequent (600ms)
Value: 1DURATION_1_MS
static val DURATION_1_MS: Int
1 millisecond slot duration
Value: 1DURATION_2_MS
static val DURATION_2_MS: Int
2 millisecond slot duration
Value: 2SUB_SESSION_UNDEFINED
static val SUB_SESSION_UNDEFINED: Int
Sub session id not applicable.
Value: -1Public methods
describeContents
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 |
getComplexChannel
fun getComplexChannel(): UwbComplexChannel
Gets the complex channel information for this session.
| Return | |
|---|---|
UwbComplexChannel |
A UwbComplexChannel object containing channel and preamble index. This value cannot be null. |
getConfigId
fun getConfigId(): Int
Gets the configuration ID associated with this session.
getDeviceAddress
fun getDeviceAddress(): UwbAddress
Gets the UWB address of the device.
| Return | |
|---|---|
UwbAddress |
The UwbAddress of the device. This value cannot be null. |
getPeerAddress
fun getPeerAddress(): UwbAddress
Returns the UwbAddress of the peer device.
| Return | |
|---|---|
UwbAddress |
A UwbAddress corresponding to the peer device to range with. This value cannot be null. |
getRangingUpdateRate
fun getRangingUpdateRate(): Int
Returns the update rate for ranging operations.
| Return | |
|---|---|
Int |
The ranging update rate. Value is android.ranging.raw.RawRangingDevice#UPDATE_RATE_NORMAL, android.ranging.raw.RawRangingDevice#UPDATE_RATE_INFREQUENT, or android.ranging.raw.RawRangingDevice#UPDATE_RATE_FREQUENT |
getSessionId
fun getSessionId(): Int
Gets the session ID associated with this ranging session.
| Return | |
|---|---|
Int |
The session ID as an integer. |
getSessionKeyInfo
fun getSessionKeyInfo(): ByteArray?
Gets session key information, if available.
| Return | |
|---|---|
ByteArray? |
A byte array containing session key info, or null if not available. |
getSlotDuration
fun getSlotDuration(): Int
Returns slot duration of the session.
| Return | |
|---|---|
Int |
the slot duration. Value is android.ranging.uwb.UwbRangingParams#DURATION_1_MS, or android.ranging.uwb.UwbRangingParams#DURATION_2_MS |
getSubSessionId
fun getSubSessionId(): Int
Gets the sub-session ID if applicable for the session.
| Return | |
|---|---|
Int |
The sub-session ID as an integer or SUB_SESSION_UNDEFINED if not applicable. |
getSubSessionKeyInfo
fun getSubSessionKeyInfo(): ByteArray?
Gets sub-session key information, if available.
| Return | |
|---|---|
ByteArray? |
A byte array containing sub-session key info, or null if not available. |
toString
fun toString(): String
| Return | |
|---|---|
String |
a string representation of the object. |
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 android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |