Skip to content

Latest commit

 

History

History

UwbRanging

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
.google
.google
 
 
app
app
 
 
gradle/wrapper
gradle/wrapper
 
 
uwbranging
uwbranging
 
 
.gitignore
.gitignore
 
 
CONTRIBUTING.md
CONTRIBUTING.md
 
 
LICENSE
LICENSE
 
 
README.md
README.md
 
 
build.gradle
build.gradle
 
 
gradle.properties
gradle.properties
 
 
gradlew
gradlew
 
 
gradlew.bat
gradlew.bat
 
 
settings.gradle
settings.gradle
 
 

README.md

Android Ultra-wideband sample

Overview

This project showcases the current features of the Android UWB Jetpack library.

Includes code examples for:

  • Device compatibility - How to check if an Android device supports UWB.
  • Device Discovery - Ultra-wideband currently does not support a native way to discover devices, so an out of band (OOB) mechanism must be provided. This project uses the NearBy Connections API, but other radio protocols like Bluetooth, BLE, or Wi-Fi could also be used.
  • Simple Ranging - The Ranging screen displays the controllee's distance from the the controller.
  • Device Control - The Control screen simulates a use case where a door lock could be opened when a UWB-capable device is near by.
  • Share Media - The Share file screen demonstrates how to transfer a media file using the selected OOB mechanism when devices are in close proximity.
  • Settings - In this screen you can select which Android device will play each role (Controller or Controlee).

Pre-requisites

What is it not?

  • An end to end example of Ultra-wideband technology. The main goal is to demonstrate basic ranging capabilities between two Android devices and how a selected OOB mechanism could be used to facilitate real use cases. For the latest information on the library status check this article
  • A reference for a real production app with proper security, network access, app permissions, user authentication, etc. Check out the Now in Android app instead.
  • A UI/Material Design sample. The interface of the app is deliberately kept simple to focus on the UWB use cases. Check out the Compose Samples instead.
  • A complete Jetpack sample covering all libraries. Check out Android Sunflower or the advanced GitHub Browser Sample instead.

Who is it for?

  • Intermediate developers looking for a simple way to understand how the UWB Jetpack library can be used.
  • Advanced developers looking for a quick reference.

Opening in Android Studio

To open this app in Android Studio, begin by checking out the entire connectivity-samples project:

  1. Clone the repository, this step checks out the master branch.:
git clone git@github.com:android/connectivity-samples.git
  1. Open the UwbRanging folder in the IDE.

License

Copyright 2023 Google, Inc.

Licensed to the Apache Software Foundation (ASF) under one or more contributor
license agreements. See the NOTICE file distributed with this work for
additional information regarding copyright ownership. The ASF licenses this
file to you 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.