UwbRangingCapabilities
public final class UwbRangingCapabilities
extends Object implements Parcelable
| java.lang.Object | |
| ↳ | android.ranging.uwb.UwbRangingCapabilities |
Represents the capabilities of Ultra-Wideband (UWB) ranging technology.
This class encapsulates various UWB-related features, including support for specific measurement types (e.g., distance, azimuth, elevation), ranging configurations, and operational parameters like update rates and channel availability.
Summary
Inherited constants |
|---|
Fields | |
|---|---|
public static final Creator<UwbRangingCapabilities> | CREATOR
|
Public methods | |
|---|---|
Duration | getMinimumRangingInterval() Gets the minimum supported ranging interval. |
List<Integer> | getSupportedChannels() Gets the list of supported UWB channels. |
List<Integer> | getSupportedConfigIds() Gets the list of supported configuration IDs. |
List<Integer> | getSupportedNotificationConfigurations() Gets the list of supported notification configurations. |
List<Integer> | getSupportedPreambleIndexes() Gets the list of supported preamble indexes. |
List<Integer> | getSupportedRangingUpdateRates() Gets the list of supported ranging update rates. |
List<Integer> | getSupportedSlotDurations() Gets the list of supported slot durations in microseconds. |
boolean | isAzimuthalAngleSupported() Checks if the device hardware supports azimuthal angle measurement. |
boolean | isBackgroundRangingSupported() Checks if background ranging is supported. |
boolean | isDistanceMeasurementSupported() Checks if the device supports distance measurement. |
boolean | isElevationAngleSupported() Checks if the device hardware supports elevation angle measurement. |
boolean | isRangingIntervalReconfigurationSupported() Checks if the ranging interval can be reconfigured. |
String | toString() Returns a string representation of the object. |
void | writeToParcel(Parcel dest, int flags) Flatten this object in to a Parcel. |
Inherited methods | |
|---|---|
Fields
Public methods
getMinimumRangingInterval
public Duration getMinimumRangingInterval ()
Gets the minimum supported ranging interval.
| Returns | |
|---|---|
Duration | the minimum ranging interval. This value cannot be null. |
getSupportedChannels
public List<Integer> getSupportedChannels ()
Gets the list of supported UWB channels.
| Returns | |
|---|---|
List<Integer> | a list of supported channel numbers. This value cannot be null. Value is UwbComplexChannel.UWB_CHANNEL_5, UwbComplexChannel.UWB_CHANNEL_6, UwbComplexChannel.UWB_CHANNEL_8, UwbComplexChannel.UWB_CHANNEL_9, UwbComplexChannel.UWB_CHANNEL_10, UwbComplexChannel.UWB_CHANNEL_12, UwbComplexChannel.UWB_CHANNEL_13, or UwbComplexChannel.UWB_CHANNEL_14 |
getSupportedConfigIds
public List<Integer> getSupportedConfigIds ()
Gets the list of supported configuration IDs.
| Returns | |
|---|---|
List<Integer> | a list of supported configuration IDs. This value cannot be null. Value is UwbRangingParams.CONFIG_UNICAST_DS_TWR, UwbRangingParams.CONFIG_MULTICAST_DS_TWR, UwbRangingParams.CONFIG_PROVISIONED_UNICAST_DS_TWR, UwbRangingParams.CONFIG_PROVISIONED_MULTICAST_DS_TWR, UwbRangingParams.CONFIG_PROVISIONED_INDIVIDUAL_MULTICAST_DS_TWR, or UwbRangingParams.CONFIG_PROVISIONED_UNICAST_DS_TWR_VERY_FAST |
getSupportedNotificationConfigurations
public List<Integer> getSupportedNotificationConfigurations ()
Gets the list of supported notification configurations.
| Returns | |
|---|---|
List<Integer> | a list of supported notification configuration type. This value cannot be null. Value is DataNotificationConfig.NOTIFICATION_CONFIG_DISABLE, DataNotificationConfig.NOTIFICATION_CONFIG_ENABLE, DataNotificationConfig.NOTIFICATION_CONFIG_PROXIMITY_LEVEL, or DataNotificationConfig.NOTIFICATION_CONFIG_PROXIMITY_EDGE |
getSupportedPreambleIndexes
public List<Integer> getSupportedPreambleIndexes ()
Gets the list of supported preamble indexes.
getSupportedRangingUpdateRates
public List<Integer> getSupportedRangingUpdateRates ()
Gets the list of supported ranging update rates.
| Returns | |
|---|---|
List<Integer> | a list of supported update rates. This value cannot be null. Value is RawRangingDevice.UPDATE_RATE_NORMAL, RawRangingDevice.UPDATE_RATE_INFREQUENT, or RawRangingDevice.UPDATE_RATE_FREQUENT |
getSupportedSlotDurations
public List<Integer> getSupportedSlotDurations ()
Gets the list of supported slot durations in microseconds.
| Returns | |
|---|---|
List<Integer> | a list of supported slot durations. This value cannot be null. Value is UwbRangingParams.DURATION_1_MS, or UwbRangingParams.DURATION_2_MS |
isAzimuthalAngleSupported
public boolean isAzimuthalAngleSupported ()
Checks if the device hardware supports azimuthal angle measurement.
| Returns | |
|---|---|
boolean | true if azimuthal angle measurement is supported; false otherwise. |
isBackgroundRangingSupported
public boolean isBackgroundRangingSupported ()
Checks if background ranging is supported.
| Returns | |
|---|---|
boolean | true if background ranging is supported; false otherwise. |
isDistanceMeasurementSupported
public boolean isDistanceMeasurementSupported ()
Checks if the device supports distance measurement.
| Returns | |
|---|---|
boolean | true if distance measurement is supported; false otherwise. |
isElevationAngleSupported
public boolean isElevationAngleSupported ()
Checks if the device hardware supports elevation angle measurement.
| Returns | |
|---|---|
boolean | true if elevation angle measurement is supported; false otherwise. |
isRangingIntervalReconfigurationSupported
public boolean isRangingIntervalReconfigurationSupported ()
Checks if the ranging interval can be reconfigured.
| Returns | |
|---|---|
boolean | true if the interval is configurable; false otherwise. |
toString
public String toString ()
Returns a string representation of the object.
| Returns | |
|---|---|
String | a string representation of the object. |
writeToParcel
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 |