RangingResult

STATUS_BUSY_TRY_LATER

static val STATUS_BUSY_TRY_LATER: Int

Individual range request status, getStatus(). Indicates that the ranging operation failed because the peer is busy and unable to handle the request at this time. The requester should try again after a suggested delay, which can be retrieved with getRetryAfterDurationMillis().

Value: 12

STATUS_FAIL

static val STATUS_FAIL: Int

Individual range request status, getStatus(). Indicates ranging operation failed and the distance value is invalid.

Value: 1

STATUS_RESPONDER_DOES_NOT_SUPPORT_IEEE80211MC

static val STATUS_RESPONDER_DOES_NOT_SUPPORT_IEEE80211MC: Int

Individual range request status, getStatus(). Indicates that the ranging operation failed because the specified peer does not support IEEE 802.11mc RTT operations. Support by an Access Point can be confirmed using android.net.wifi.ScanResult#is80211mcResponder().

On such a failure, the individual result fields of RangingResult such as RangingResult.getDistanceMm() are invalid.

Value: 2

STATUS_SUCCESS

static val STATUS_SUCCESS: Int

Individual range request status, getStatus(). Indicates ranging operation was successful and distance value is valid.

Value: 0

UNSPECIFIED

static val UNSPECIFIED: Int

The unspecified value.

Value: -1

describeContents

fun describeContents(): Int

Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. For example, if the object will include a file descriptor in the output of writeToParcel(android.os.Parcel,int), the return value of this method must include the CONTENTS_FILE_DESCRIPTOR bit.

equals

fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

get80211azInitiatorTxLtfRepetitionsCount

fun get80211azInitiatorTxLtfRepetitionsCount(): Int

Gets LTF repetitions that the initiator station (ISTA) used in the preamble of the initiator to responder (I2R) null data PPDU (NDP) for this result. LTF repetitions is the multiple transmissions of HE-LTF symbols in an HE ranging NDP. An HE-LTF repetition value of 1 indicates no repetitions.

get80211azNumberOfRxSpatialStreams

fun get80211azNumberOfRxSpatialStreams(): Int

Gets number of receive spatial streams that the initiator station (ISTA) used for the initiator to responder (I2R) null data PPDU (NDP) for this result.

get80211azNumberOfTxSpatialStreams

fun get80211azNumberOfTxSpatialStreams(): Int

Gets number of transmit spatial streams that the initiator station (ISTA) used for the initiator to responder (I2R) null data PPDU (NDP) for this result.

get80211azResponderTxLtfRepetitionsCount

fun get80211azResponderTxLtfRepetitionsCount(): Int

Gets LTF repetitions that the responder station (RSTA) used in the preamble of the responder to initiator (I2R) null data PPDU (NDP) for this result. LTF repetitions is the multiple transmissions of HE-LTF symbols in an HE ranging NDP. An HE-LTF repetition value of 1 indicates no repetitions.

getAvailabilityWindowDurationMillis

fun getAvailabilityWindowDurationMillis(): Long

Gets availability window between measurements in milliseconds for proximity detection measurements. P2P Proximity Ranging uses two additional time parameters to coordinate availability duration called Availability Windows (AW). These are the Nominal Time and AW Duration that coordinate the time window period, and the start time of the time window period respectively. During AWs the ISTA and RSTA devices shall be available to exchange N successful FTM measurements instances where N equal the negotiated Meas Per AW. The ISTA indicates its preference for an AW duration and nominal time interval in the P2P Proximity Ranging Availability subelement, and the RSTA assigns the values used during the FTM session. The start of an AW duration is Nominal Time from the 1st successful measurement instance of the previous AW. The 1st AW occurs Nominal Time from the beginning of the 1st measurement instance following the initial FTM negotiation.

getDistanceMm

fun getDistanceMm(): Int

getDistanceStdDevMm

fun getDistanceStdDevMm(): Int

getLci

fun getLci(): ByteArray

getLcr

fun getLcr(): ByteArray

getMacAddress

fun getMacAddress(): MacAddress?

getMaxTimeBetweenNtbMeasurementsMicros

fun getMaxTimeBetweenNtbMeasurementsMicros(): Long

Gets maximum time between measurements in microseconds for IEEE 802.11az non-trigger based ranging. The next 11az ranging request needs to be invoked before the maximum time from the last measurement time getRangingTimestampMillis(). Otherwise, the non-trigger based ranging session will be terminated and a new ranging negotiation will happen with the responding station.

getMeasurementBandwidth

fun getMeasurementBandwidth(): Int

The bandwidth used to transmit the RTT measurement frame.

getMeasurementChannelFrequencyMHz

fun getMeasurementChannelFrequencyMHz(): Int

The center frequency of the primary 20 MHz frequency (in MHz) of the channel over which the measurement frames are sent.

getMinTimeBetweenNtbMeasurementsMicros

fun getMinTimeBetweenNtbMeasurementsMicros(): Long

Gets minimum time between measurements in microseconds for IEEE 802.11az non-trigger based ranging. The next 11az ranging measurement request must be invoked after the minimum time from the last measurement time getRangingTimestampMillis() for the peer. Otherwise, cached ranging result will be returned for the peer.

getNominalTimeMillis

fun getNominalTimeMillis(): Long

Get the nominal duration between adjacent availability window in milliseconds for proximity detection measurements.

getNumAttemptedMeasurements

fun getNumAttemptedMeasurements(): Int

getNumNtbRepetitionsPerMeasurement

fun getNumNtbRepetitionsPerMeasurement(): Int

Get the number of range repetitions carried out for distance calculation in Non Trigger Based (NTB) ranging. Note: Only applicable for IEEE 802.11az result.

getNumSuccessfulMeasurements

fun getNumSuccessfulMeasurements(): Int

getPasnComebackAfterMillis

fun getPasnComebackAfterMillis(): Long

Get Comeback after time in milliseconds. See getPasnComebackCookie(). A value 0 indicates the ranging request operation can be tried immediately with the cookie.

getPasnComebackCookie

fun getPasnComebackCookie(): ByteArray?

Get PASN comeback cookie. PASN authentication allows an AP to indicate the deferral time and optionally a Cookie. See getPasnComebackAfterMillis()

When an AP receives a large volume of initial PASN Authentication frames, it can use the comeback after field in the PASN Parameters element to indicate a deferral time and optionally provide a comeback cookie which is an opaque sequence of octets. Upon receiving this response, the ranging initiator (STA) must wait for the specified time before retrying secure authentication, presenting the received cookie to the AP.

getPeerHandle

fun getPeerHandle(): PeerHandle?

getRangingTimestampMillis

fun getRangingTimestampMillis(): Long

getRetryAfterDurationMillis

fun getRetryAfterDurationMillis(): Int

getRssi

fun getRssi(): Int

getSecureHeLtfProtocolVersion

fun getSecureHeLtfProtocolVersion(): Int

Get Secure HE-LTF protocol version used. The secure HE-LTF negotiation supports negotiation of the secure HE-LTF protocol version which allows a responder and an initiator to negotiate the highest mutually supported secure HE-LTF protocol version. Refer IEEE 802.11az-2022 spec, section 9.4.2.298 Ranging Parameters element.

getStatus

fun getStatus(): Int

getUnverifiedResponderLocation

fun getUnverifiedResponderLocation(): ResponderLocation?

getUsdPeerId

fun getUsdPeerId(): Int

Returns the USD peer identifier of the device whose range measurement was requested.

This value is non-negative if the responder is a USD peer and the range request was placed using android.net.wifi.rtt.RangingRequest.Builder#addWifiUsdPeer(DiscoveryResult,android.net.wifi.rtt.ProximityDetectionConfig,android.net.wifi.rtt.SecureRangingConfig). The peer ID is an opaque identifier for a specific USD peer discovered during USD discovery operations and obtained from the DiscoveryResult#getPeerId()

hashCode

fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

is80211azNtbMeasurement

fun is80211azNtbMeasurement(): Boolean

is80211mcMeasurement

fun is80211mcMeasurement(): Boolean

isLmrDelayed

fun isLmrDelayed(): Boolean

Returns whether the Location Measurement Report (LMR) feedback is delayed. Note: Only applicable for IEEE 802.11az result.

isRangingAuthenticated

fun isRangingAuthenticated(): Boolean

isRangingFrameProtected

fun isRangingFrameProtected(): Boolean

isSecureHeLtfEnabled

fun isSecureHeLtfEnabled(): Boolean

toString

fun toString(): String

writeToParcel

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

Flatten this object in to a Parcel.

CREATOR

static val CREATOR: Parcelable.Creator<RangingResult!>