RangingParameters

public class RangingParameters extends Object

Set of parameters which should be passed to the UWB chip to start ranging.

Nested Class Summary

class	RangingParameters.Builder		Builder for creating RangingParameters.
@interface	RangingParameters.RangingUpdateRate		Update rate settings.
@interface	RangingParameters.SlotDuration		Slot duration settings.
@interface	RangingParameters.UwbConfigId		Represents which Config ID should be used.

Constant Summary

int	SESSION_ID_UNSET
int	SLOT_DURATION_DEFAULT
int	SUB_SESSION_ID_UNSET

Public Method Summary

UwbComplexChannel	getComplexChannel() Gets the UWB complex channel.
List<UwbDevice>	getPeerDevices() The peers to perform ranging with.
int	getRangingUpdateRate() Gets the configured RangingParameters.RangingUpdateRate
int	getSessionId() Gets the ID of the ranging session.
byte[]	getSessionKeyInfo() Gets the session key info to use for the ranging.
int	getSlotDuration() Gets the slot duration.
int	getSubSessionId() Gets the ID of the ranging sub-session.
byte[]	getSubSessionKeyInfo() Gets the sub-session key info to use for the ranging.
int	getUwbConfigId() Gets the UWB configuration ID.
UwbRangeDataNtfConfig	getUwbRangeDataNtfConfig() Range data notification configuration (default = enabled).
boolean	isAoaDisabled() Shows whether Angle-of-Arrival (AoA) is enabled or not.

Inherited Method Summary

From class java.lang.Object

Object	clone()
boolean	equals(Object arg0)
void	finalize()
final Class<?>	getClass()
int	hashCode()
final void	notify()
final void	notifyAll()
String	toString()
final void	wait(long arg0, int arg1)
final void	wait(long arg0)
final void	wait()

Constants

public static final int SESSION_ID_UNSET

Constant Value: 0

public static final int SLOT_DURATION_DEFAULT

Constant Value: 2

public static final int SUB_SESSION_ID_UNSET

Constant Value: 0

Public Methods

public UwbComplexChannel getComplexChannel ()

Gets the UWB complex channel. It's optional for ROLE_CONTROLLER. It should be set if device type is ROLE_CONTROLEE.

public List<UwbDevice> getPeerDevices ()

The peers to perform ranging with. If using unicast, length should be 1.

public int getRangingUpdateRate ()

Gets the configured RangingParameters.RangingUpdateRate

public int getSessionId ()

Gets the ID of the ranging session. If the value is SESSION_ID_UNSET (0), it will be created from the hash of controller address and complex channel values.

The same session IDs should be used at both ends (controller and controlee).

public byte[] getSessionKeyInfo ()

Gets the session key info to use for the ranging. If the profile uses STATIC STS, this byte array is 8-byte long with first two bytes as Vendor ID and next six bytes as STATIC STS IV. If the profile uses PROVISIONED STS, this byte array is 16 or 32-byte long which represent session key.

The same session keys should be used at both ends (controller and controlee).

public int getSlotDuration ()

Gets the slot duration.

public int getSubSessionId ()

Gets the ID of the ranging sub-session. This value should be set when the profile uses PROVISIONED STS individual responder cases. If the profile uses other STS, it should remain SUB_SESSION_ID_UNSET (0).

public byte[] getSubSessionKeyInfo ()

Gets the sub-session key info to use for the ranging. This byte array is 16 or 32-byte long when the profile uses PROVISIONED STS individual responder cases. If the profile uses other STS, it should remain null.

public int getUwbConfigId ()

Gets the UWB configuration ID. The ID specifies one fixed set of FiRa UCI parameters.

public UwbRangeDataNtfConfig getUwbRangeDataNtfConfig ()

Range data notification configuration (default = enabled).

public boolean isAoaDisabled ()

Shows whether Angle-of-Arrival (AoA) is enabled or not.