RangingResult


sealed class RangingResult

Known direct subclasses
RangingResult.RangingResultFailure

A ranging result indicating failure or suspension of a ranging session.

RangingResult.RangingResultInitialized

A ranging result when a ranging session is initialized with peer device.

RangingResult.RangingResultPeerDisconnected

A ranging result with peer disconnected status update.

RangingResult.RangingResultPosition

A ranging result with the device position update.


Class for UWB ranging result update.

Summary

Nested types

A ranging result indicating failure or suspension of a ranging session.

A ranging result when a ranging session is initialized with peer device.

A ranging result with peer disconnected status update.

A ranging result with the device position update.

Constants

const Int

Ranging failed due to bad or invalid parameters.

const Int

Generic failure to start the ranging session.

const Int

Ranging stopped because the maximum number of ranging round retries was reached.

const Int

The ranging session was stopped by a local request.

const Int

The ranging session was stopped by the peer device.

const Int

Ranging stopped or failed due to system policy.

const Int

Unknown failure reason.

Protected constructors

Public properties

abstract UwbDevice

Constants

RANGING_FAILURE_REASON_BAD_PARAMETERS

const val RANGING_FAILURE_REASON_BAD_PARAMETERS = 1: Int

Ranging failed due to bad or invalid parameters.

RANGING_FAILURE_REASON_FAILED_TO_START

const val RANGING_FAILURE_REASON_FAILED_TO_START = 2: Int

Generic failure to start the ranging session.

RANGING_FAILURE_REASON_MAX_RR_RETRY_REACHED

const val RANGING_FAILURE_REASON_MAX_RR_RETRY_REACHED = 6: Int

Ranging stopped because the maximum number of ranging round retries was reached.

RANGING_FAILURE_REASON_STOPPED_BY_LOCAL

const val RANGING_FAILURE_REASON_STOPPED_BY_LOCAL = 4: Int

The ranging session was stopped by a local request.

RANGING_FAILURE_REASON_STOPPED_BY_PEER

const val RANGING_FAILURE_REASON_STOPPED_BY_PEER = 3: Int

The ranging session was stopped by the peer device.

RANGING_FAILURE_REASON_SYSTEM_POLICY

const val RANGING_FAILURE_REASON_SYSTEM_POLICY = 5: Int

Ranging stopped or failed due to system policy.

RANGING_FAILURE_REASON_UNKNOWN

const val RANGING_FAILURE_REASON_UNKNOWN = 0: Int

Unknown failure reason.

Protected constructors

RangingResult

protected RangingResult()

Public properties

device

Added in 1.0.0-alpha11
abstract val deviceUwbDevice