Loading core/java/android/uwb/AngleOfArrivalSupport.aidl 0 → 100644 +44 −0 Original line number Diff line number Diff line /* * Copyright 2020 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package android.uwb; /** * @hide */ @Backing(type="int") enum AngleOfArrivalSupport { /** * The device does not support angle of arrival */ NONE, /** * The device supports planar angle of arrival */ TWO_DIMENSIONAL, /** * The device does supports three dimensional angle of arrival with hemispherical azimuth angles */ THREE_DIMENSIONAL_HEMISPHERICAL, /** * The device does supports three dimensional angle of arrival with full azimuth angles */ THREE_DIMENSIONAL_SPHERICAL, } core/java/android/uwb/CloseReason.aidl 0 → 100644 +58 −0 Original line number Diff line number Diff line /* * Copyright 2020 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package android.uwb; /** * @hide */ @Backing(type="int") enum CloseReason { /** * Unknown reason */ UNKNOWN, /** * A local API call triggered the close, such as a call to * IUwbAdapter.stopRanging. */ LOCAL_API, /** * The maximum number of sessions has been reached. This error may be generated * for an active session if a higher priority session begins. */ MAX_SESSIONS_REACHED, /** * The system state has changed resulting in the session ending (e.g. the user * disables UWB, or the user's locale changes and an active channel is no longer * permitted to be used). */ SYSTEM_POLICY, /** * The remote device has requested to terminate the session */ REMOTE_REQUEST, /** * The session was closed for a protocol specific reason */ PROTOCOL_SPECIFIC, } core/java/android/uwb/IUwbAdapter.aidl 0 → 100644 +170 −0 Original line number Diff line number Diff line /* * Copyright 2020 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package android.uwb; import android.os.PersistableBundle; import android.uwb.AngleOfArrivalSupport; import android.uwb.IUwbAdapterStateCallbacks; import android.uwb.IUwbRangingCallbacks; import android.uwb.SessionHandle; /** * @hide */ interface IUwbAdapter { /* * Register the callbacks used to notify the framework of events and data * * The provided callback's IUwbAdapterStateCallbacks#onAdapterStateChanged * function must be called immediately following registration with the current * state of the UWB adapter. * * @param callbacks callback to provide range and status updates to the framework */ void registerAdapterStateCallbacks(in IUwbAdapterStateCallbacks adapterStateCallbacks); /* * Unregister the callbacks used to notify the framework of events and data * * Calling this function with an unregistered callback is a no-op * * @param callbacks callback to unregister */ void unregisterAdapterStateCallbacks(in IUwbAdapterStateCallbacks callbacks); /** * Returns true if ranging is supported, false otherwise */ boolean isRangingSupported(); /** * Get the angle of arrival supported by this device * * @return the angle of arrival type supported */ AngleOfArrivalSupport getAngleOfArrivalSupport(); /** * Generates a list of the supported 802.15.4z channels * * The list must be prioritized in the order of preferred channel usage. * * The list must only contain channels that are permitted to be used in the * device's current location. * * @return an array of support channels on the device for the current location. */ int[] getSupportedChannels(); /** * Generates a list of the supported 802.15.4z preamble codes * * The list must be prioritized in the order of preferred preamble usage. * * The list must only contain preambles that are permitted to be used in the * device's current location. * * @return an array of supported preambles on the device for the current * location. */ int[] getSupportedPreambleCodes(); /** * Get the accuracy of the ranging timestamps * * @return accuracy of the ranging timestamps in nanoseconds */ long getTimestampResolutionNanos(); /** * Get the supported number of simultaneous ranging sessions * * @return the supported number of simultaneous ranging sessions */ int getMaxSimultaneousSessions(); /** * Get the maximum number of remote devices per session * * @return the maximum number of remote devices supported in a single session */ int getMaxRemoteDevicesPerSession(); /** * Provides the capabilities and features of the device * * @return specification specific capabilities and features of the device */ PersistableBundle getSpecificationInfo(); /** * Request to start a new ranging session * * This function must return before calling IUwbAdapterCallbacks * #onRangingStarted, #onRangingClosed, or #onRangingResult. * * A ranging session does not need to be started before returning. * * IUwbAdapterCallbacks#onRangingStarted must be called within * RANGING_SESSION_START_THRESHOLD_MS milliseconds of #startRanging being called * if the ranging session is scheduled to start successfully. * * IUwbAdapterCallbacks#onRangingStartFailed must be called within * RANGING_SESSION_START_THRESHOLD_MS milliseconds of #startRanging being called * if the ranging session fails to be scheduled to start successfully. * * @param rangingCallbacks the callbacks used to deliver ranging information * @param parameters the configuration to use for ranging * @return a SessionHandle used to identify this ranging request */ SessionHandle startRanging(in IUwbRangingCallbacks rangingCallbacks, in PersistableBundle parameters); /** * Stop and close ranging for the session associated with the given handle * * Calling with an invalid handle or a handle that has already been closed * is a no-op. * * IUwbAdapterCallbacks#onRangingClosed must be called within * RANGING_SESSION_CLOSE_THRESHOLD_MS of #stopRanging being called. * * @param sessionHandle the session handle to stop ranging for */ void closeRanging(in SessionHandle sessionHandle); /** * The maximum allowed time to start a ranging session. */ const int RANGING_SESSION_START_THRESHOLD_MS = 3000; // Value TBD /** * The maximum allowed time to notify the framework that a session has been * closed. */ const int RANGING_SESSION_CLOSE_THRESHOLD_MS = 3000; // Value TBD /** * Ranging scheduling time unit (RSTU) for High Rate Pulse (HRP) PHY */ const int HIGH_RATE_PULSE_CHIRPS_PER_RSTU = 416; /** * Ranging scheduling time unit (RSTU) for Low Rate Pulse (LRP) PHY */ const int LOW_RATE_PULSE_CHIRPS_PER_RSTU = 1; } core/java/android/uwb/IUwbAdapterStateCallbacks.aidl 0 → 100644 +32 −0 Original line number Diff line number Diff line /* * Copyright 2020 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package android.uwb; import android.uwb.StateChangeReason; /** * @hide */ interface IUwbAdapterStateCallbacks { /** * Called whenever the adapter state changes * * @param isEnabled true if the adapter is enabled, false otherwise * @param reason the reason that the state has changed */ void onAdapterStateChanged(boolean isEnabled, StateChangeReason reason); } No newline at end of file core/java/android/uwb/IUwbRangingCallbacks.aidl 0 → 100644 +73 −0 Original line number Diff line number Diff line /* * Copyright 2020 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package android.uwb; import android.os.PersistableBundle; import android.uwb.CloseReason; import android.uwb.RangingReport; import android.uwb.SessionHandle; import android.uwb.StartFailureReason; /** * @hide */ interface IUwbRangingCallbacks { /** * Called when ranging has started * * May output parameters generated by the lower layers that must be sent to the * remote device(s). The PersistableBundle must be constructed using the UWB * support library. * * @param sessionHandle the session the callback is being invoked for * @param rangingOutputParameters parameters generated by the lower layer that * should be sent to the remote device. */ void onRangingStarted(in SessionHandle sessionHandle, in PersistableBundle parameters); /** * Called when a ranging session fails to start * * @param sessionHandle the session the callback is being invoked for * @param reason the reason the session failed to start * @param parameters protocol specific parameters */ void onRangingStartFailed(in SessionHandle sessionHandle, StartFailureReason reason, in PersistableBundle parameters); /** * Called when a ranging session is closed * * @param sessionHandle the session the callback is being invoked for * @param reason the reason the session was closed * @param parameters protocol specific parameters */ void onRangingClosed(in SessionHandle sessionHandle, CloseReason reason, in PersistableBundle parameters); /** * Provides a new RangingResult to the framework * * The reported timestamp for a ranging measurement must be calculated as the * time which the ranging round that generated this measurement concluded. * * @param sessionHandle an identifier to associate the ranging results with a * session that is active * @param result the ranging report */ void onRangingResult(in SessionHandle sessionHandle, in RangingReport result); } Loading
core/java/android/uwb/AngleOfArrivalSupport.aidl 0 → 100644 +44 −0 Original line number Diff line number Diff line /* * Copyright 2020 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package android.uwb; /** * @hide */ @Backing(type="int") enum AngleOfArrivalSupport { /** * The device does not support angle of arrival */ NONE, /** * The device supports planar angle of arrival */ TWO_DIMENSIONAL, /** * The device does supports three dimensional angle of arrival with hemispherical azimuth angles */ THREE_DIMENSIONAL_HEMISPHERICAL, /** * The device does supports three dimensional angle of arrival with full azimuth angles */ THREE_DIMENSIONAL_SPHERICAL, }
core/java/android/uwb/CloseReason.aidl 0 → 100644 +58 −0 Original line number Diff line number Diff line /* * Copyright 2020 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package android.uwb; /** * @hide */ @Backing(type="int") enum CloseReason { /** * Unknown reason */ UNKNOWN, /** * A local API call triggered the close, such as a call to * IUwbAdapter.stopRanging. */ LOCAL_API, /** * The maximum number of sessions has been reached. This error may be generated * for an active session if a higher priority session begins. */ MAX_SESSIONS_REACHED, /** * The system state has changed resulting in the session ending (e.g. the user * disables UWB, or the user's locale changes and an active channel is no longer * permitted to be used). */ SYSTEM_POLICY, /** * The remote device has requested to terminate the session */ REMOTE_REQUEST, /** * The session was closed for a protocol specific reason */ PROTOCOL_SPECIFIC, }
core/java/android/uwb/IUwbAdapter.aidl 0 → 100644 +170 −0 Original line number Diff line number Diff line /* * Copyright 2020 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package android.uwb; import android.os.PersistableBundle; import android.uwb.AngleOfArrivalSupport; import android.uwb.IUwbAdapterStateCallbacks; import android.uwb.IUwbRangingCallbacks; import android.uwb.SessionHandle; /** * @hide */ interface IUwbAdapter { /* * Register the callbacks used to notify the framework of events and data * * The provided callback's IUwbAdapterStateCallbacks#onAdapterStateChanged * function must be called immediately following registration with the current * state of the UWB adapter. * * @param callbacks callback to provide range and status updates to the framework */ void registerAdapterStateCallbacks(in IUwbAdapterStateCallbacks adapterStateCallbacks); /* * Unregister the callbacks used to notify the framework of events and data * * Calling this function with an unregistered callback is a no-op * * @param callbacks callback to unregister */ void unregisterAdapterStateCallbacks(in IUwbAdapterStateCallbacks callbacks); /** * Returns true if ranging is supported, false otherwise */ boolean isRangingSupported(); /** * Get the angle of arrival supported by this device * * @return the angle of arrival type supported */ AngleOfArrivalSupport getAngleOfArrivalSupport(); /** * Generates a list of the supported 802.15.4z channels * * The list must be prioritized in the order of preferred channel usage. * * The list must only contain channels that are permitted to be used in the * device's current location. * * @return an array of support channels on the device for the current location. */ int[] getSupportedChannels(); /** * Generates a list of the supported 802.15.4z preamble codes * * The list must be prioritized in the order of preferred preamble usage. * * The list must only contain preambles that are permitted to be used in the * device's current location. * * @return an array of supported preambles on the device for the current * location. */ int[] getSupportedPreambleCodes(); /** * Get the accuracy of the ranging timestamps * * @return accuracy of the ranging timestamps in nanoseconds */ long getTimestampResolutionNanos(); /** * Get the supported number of simultaneous ranging sessions * * @return the supported number of simultaneous ranging sessions */ int getMaxSimultaneousSessions(); /** * Get the maximum number of remote devices per session * * @return the maximum number of remote devices supported in a single session */ int getMaxRemoteDevicesPerSession(); /** * Provides the capabilities and features of the device * * @return specification specific capabilities and features of the device */ PersistableBundle getSpecificationInfo(); /** * Request to start a new ranging session * * This function must return before calling IUwbAdapterCallbacks * #onRangingStarted, #onRangingClosed, or #onRangingResult. * * A ranging session does not need to be started before returning. * * IUwbAdapterCallbacks#onRangingStarted must be called within * RANGING_SESSION_START_THRESHOLD_MS milliseconds of #startRanging being called * if the ranging session is scheduled to start successfully. * * IUwbAdapterCallbacks#onRangingStartFailed must be called within * RANGING_SESSION_START_THRESHOLD_MS milliseconds of #startRanging being called * if the ranging session fails to be scheduled to start successfully. * * @param rangingCallbacks the callbacks used to deliver ranging information * @param parameters the configuration to use for ranging * @return a SessionHandle used to identify this ranging request */ SessionHandle startRanging(in IUwbRangingCallbacks rangingCallbacks, in PersistableBundle parameters); /** * Stop and close ranging for the session associated with the given handle * * Calling with an invalid handle or a handle that has already been closed * is a no-op. * * IUwbAdapterCallbacks#onRangingClosed must be called within * RANGING_SESSION_CLOSE_THRESHOLD_MS of #stopRanging being called. * * @param sessionHandle the session handle to stop ranging for */ void closeRanging(in SessionHandle sessionHandle); /** * The maximum allowed time to start a ranging session. */ const int RANGING_SESSION_START_THRESHOLD_MS = 3000; // Value TBD /** * The maximum allowed time to notify the framework that a session has been * closed. */ const int RANGING_SESSION_CLOSE_THRESHOLD_MS = 3000; // Value TBD /** * Ranging scheduling time unit (RSTU) for High Rate Pulse (HRP) PHY */ const int HIGH_RATE_PULSE_CHIRPS_PER_RSTU = 416; /** * Ranging scheduling time unit (RSTU) for Low Rate Pulse (LRP) PHY */ const int LOW_RATE_PULSE_CHIRPS_PER_RSTU = 1; }
core/java/android/uwb/IUwbAdapterStateCallbacks.aidl 0 → 100644 +32 −0 Original line number Diff line number Diff line /* * Copyright 2020 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package android.uwb; import android.uwb.StateChangeReason; /** * @hide */ interface IUwbAdapterStateCallbacks { /** * Called whenever the adapter state changes * * @param isEnabled true if the adapter is enabled, false otherwise * @param reason the reason that the state has changed */ void onAdapterStateChanged(boolean isEnabled, StateChangeReason reason); } No newline at end of file
core/java/android/uwb/IUwbRangingCallbacks.aidl 0 → 100644 +73 −0 Original line number Diff line number Diff line /* * Copyright 2020 The Android Open Source Project * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package android.uwb; import android.os.PersistableBundle; import android.uwb.CloseReason; import android.uwb.RangingReport; import android.uwb.SessionHandle; import android.uwb.StartFailureReason; /** * @hide */ interface IUwbRangingCallbacks { /** * Called when ranging has started * * May output parameters generated by the lower layers that must be sent to the * remote device(s). The PersistableBundle must be constructed using the UWB * support library. * * @param sessionHandle the session the callback is being invoked for * @param rangingOutputParameters parameters generated by the lower layer that * should be sent to the remote device. */ void onRangingStarted(in SessionHandle sessionHandle, in PersistableBundle parameters); /** * Called when a ranging session fails to start * * @param sessionHandle the session the callback is being invoked for * @param reason the reason the session failed to start * @param parameters protocol specific parameters */ void onRangingStartFailed(in SessionHandle sessionHandle, StartFailureReason reason, in PersistableBundle parameters); /** * Called when a ranging session is closed * * @param sessionHandle the session the callback is being invoked for * @param reason the reason the session was closed * @param parameters protocol specific parameters */ void onRangingClosed(in SessionHandle sessionHandle, CloseReason reason, in PersistableBundle parameters); /** * Provides a new RangingResult to the framework * * The reported timestamp for a ranging measurement must be calculated as the * time which the ranging round that generated this measurement concluded. * * @param sessionHandle an identifier to associate the ranging results with a * session that is active * @param result the ranging report */ void onRangingResult(in SessionHandle sessionHandle, in RangingReport result); }
