Package: android.hardware.wifi@1.0

IWifiRttController

interface IWifiRttController

Interface used to perform RTT(Round trip time)operations.

Methods

getBoundIface

getBoundIface ()
generates (WifiStatus status, IWifiIface boundIface)

Get the iface on which the RTT operations must be performed.

Details
Generates
status
WifiStatus of the operation.Possible status codes:|WifiStatusCode.SUCCESS|, |WifiStatusCode.ERROR_WIFI_RTT_CONTROLLER_INVALID|
boundIface
HIDL interface object representing the iface if bound to a specific iface, null otherwise

registerEventCallback

registerEventCallback (IWifiRttControllerEventCallback callback)
generates (WifiStatus status)

Requests notifications of significant events on this rtt controller.Multiple calls to this must register multiple callbacks each of which must receive all events.

Details
Parameters
callback
An instance of the |IWifiRttControllerEventCallback| HIDL interface object.
Generates
status
WifiStatus of the operation.Possible status codes:|WifiStatusCode.SUCCESS|, |WifiStatusCode.ERROR_WIFI_IFACE_INVALID|

rangeRequest

rangeRequest (CommandId cmdId, vec<RttConfig> rttConfigs)
generates (WifiStatus status)

API to request RTT measurement.

Details
Parameters
cmdId
command Id to use for this invocation.
rttConfigs
Vector of |RttConfig| parameters.
Generates
status
WifiStatus of the operation.Possible status codes:|WifiStatusCode.SUCCESS|, |WifiStatusCode.ERROR_WIFI_RTT_CONTROLLER_INVALID|, |WifiStatusCode.ERROR_INVALID_ARGS|, |WifiStatusCode.ERROR_NOT_AVAILABLE|, |WifiStatusCode.ERROR_UNKNOWN|

rangeCancel

rangeCancel (CommandId cmdId, vec<MacAddress> addrs)
generates (WifiStatus status)

API to cancel RTT measurements.

Details
Parameters
cmdId
command Id corresponding to the original request.
addrs
Vector of addresses for which to cancel.
Generates
status
WifiStatus of the operation.Possible status codes:|WifiStatusCode.SUCCESS|, |WifiStatusCode.ERROR_WIFI_RTT_CONTROLLER_INVALID|, |WifiStatusCode.ERROR_INVALID_ARGS|, |WifiStatusCode.ERROR_NOT_AVAILABLE|, |WifiStatusCode.ERROR_UNKNOWN|

getCapabilities

getCapabilities ()
generates (WifiStatus status, RttCapabilities capabilities)

RTT capabilities of the device.

Details
Generates
status
WifiStatus of the operation.Possible status codes:|WifiStatusCode.SUCCESS|, |WifiStatusCode.ERROR_WIFI_RTT_CONTROLLER_INVALID|, |WifiStatusCode.ERROR_UNKNOWN|
capabilities
Instance of |RttCapabilities|.

setLci

setLci (CommandId cmdId, RttLciInformation lci)
generates (WifiStatus status)

API to configure the LCI(Location civic information). Used in RTT Responder mode only.

Details
Parameters
cmdId
command Id to use for this invocation.
lci
Instance of |RttLciInformation|.
Generates
status
WifiStatus of the operation.Possible status codes:|WifiStatusCode.SUCCESS|, |WifiStatusCode.ERROR_WIFI_RTT_CONTROLLER_INVALID|, |WifiStatusCode.ERROR_INVALID_ARGS|, |WifiStatusCode.ERROR_NOT_AVAILABLE|, |WifiStatusCode.ERROR_UNKNOWN|

setLcr

setLcr (CommandId cmdId, RttLcrInformation lcr)
generates (WifiStatus status)

API to configure the LCR(Location civic records). Used in RTT Responder mode only.

Details
Parameters
cmdId
command Id to use for this invocation.
lcr
Instance of |RttLcrInformation|.
Generates
status
WifiStatus of the operation.Possible status codes:|WifiStatusCode.SUCCESS|, |WifiStatusCode.ERROR_WIFI_RTT_CONTROLLER_INVALID|, |WifiStatusCode.ERROR_INVALID_ARGS|, |WifiStatusCode.ERROR_NOT_AVAILABLE|, |WifiStatusCode.ERROR_UNKNOWN|

getResponderInfo

getResponderInfo ()
generates (WifiStatus status, RttResponder info)

Get RTT responder information e.g.WiFi channel to enable responder on.

Details
Generates
status
WifiStatus of the operation.Possible status codes:|WifiStatusCode.SUCCESS|, |WifiStatusCode.ERROR_WIFI_RTT_CONTROLLER_INVALID|, |WifiStatusCode.ERROR_NOT_AVAILABLE|, |WifiStatusCode.ERROR_UNKNOWN|
info
Instance of |RttResponderInfo|.

enableResponder

enableResponder (CommandId cmdId, WifiChannelInfo channelHint, uint32_t maxDurationSeconds, RttResponder info)
generates (WifiStatus status)

Enable RTT responder mode.

Details
Parameters
cmdId
command Id to use for this invocation.
channelHint
Hint of the channel information where RTT responder must be enabled on.
maxDurationSeconds
Timeout of responder mode.
info
Instance of |RttResponderInfo|.
Generates
status
WifiStatus of the operation.Possible status codes:|WifiStatusCode.SUCCESS|, |WifiStatusCode.ERROR_WIFI_RTT_CONTROLLER_INVALID|, |WifiStatusCode.ERROR_INVALID_ARGS|, |WifiStatusCode.ERROR_NOT_AVAILABLE|, |WifiStatusCode.ERROR_UNKNOWN|

disableResponder

disableResponder (CommandId cmdId)
generates (WifiStatus status)

Disable RTT responder mode.

Details
Parameters
cmdId
command Id corresponding to the original request.
Generates
status
WifiStatus of the operation.Possible status codes:|WifiStatusCode.SUCCESS|, |WifiStatusCode.ERROR_WIFI_RTT_CONTROLLER_INVALID|, |WifiStatusCode.ERROR_NOT_AVAILABLE|, |WifiStatusCode.ERROR_UNKNOWN|