RangingParameters

Stay organized with collections Save and categorize content based on your preferences.
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.UwbConfigId Represents which Config ID should be used. 

Constant Summary

int 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 update rate of the ranging data
  • AUTOMATIC: When the screen is on, the reporting interval is hundreds of milliseconds.
int
getSessionId()
Gets the ID of the ranging session.
byte[]
getSessionKeyInfo()
Gets the session key info to use for the ranging.
int
getUwbConfigId()
Gets the UWB configuration ID.

Inherited Method Summary

Constants

public static final int 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 update rate of the ranging data

  • AUTOMATIC: When the screen is on, the reporting interval is hundreds of milliseconds. When the screen is off, the reporting interval is a few seconds.
  • INFREQUENT: The reporting interval is always the same as in the AUTOMATIC screen-off case. The power consumption is optimized by turning off the radio between ranging reports. (The implementation is hardware and software dependent and it may change between different versions).
  • FREQUENT: The reporting interval is always the same as in the AUTOMATIC screen-on case (Defined by FiRa UCI ranging interval parameter.) The actual reporting interval is UwbConfigId related. Different configuration may use different values. (The default reporting interval at INFREQUENT mode is 4 seconds)

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.

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

public int getUwbConfigId ()

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