[go: up one dir, main page]

Skip to content

Documentation and issue tracker for nRF Connect for Android.

Notifications You must be signed in to change notification settings

NordicSemiconductor/Android-nRF-Connect

Repository files navigation

nRF Connect

The nRF Connect for Mobile is an application designed for Bluetooth Low Energy developers. It allows for scanning for BLE devices and communicating with them.

The nRF Connect for Android application requires Android version 4.3 or later and is available on Google Play or releases, in case Google Play is not available. We recommend to install the application using Google Play as it will get automatic updates.

Get it on Google Play

Important

The source code of nRF Connect is not available. This repo provides only documentation and Issue tracker.

Features

  1. Scanning for Bluetooth LE devices in range
  2. Displaying the RSSI graph with an option to export to CSV or EXCEL
  3. Displaying detailed packet history with RSSI, packet changes and advertising intervals
  4. Displaying advertisements of mutliple devices on a timeline
  5. Connecting to multiple devices at the same time
  6. Showing device services and characteristics
  7. Reading and writing characteristics
  8. Configuring GATT Server
  9. Peripheral mode (BLE advertising) (newest Android 5+ devices only)
  10. Logging events and packets to nRF Logger app (available on Google Play)
  11. Device Firmware Update (DFU) (read below)
  12. Automated tests (read below)
  13. Recording and playing macros to automate operations
  14. Parsing most of Bluetooth SIG adopted characteristics + some proprietary ones
  15. Support for Eddystone (parsing, decrypting EID, Eddystone Config Service)

DFU - Device Firmware Update

nRF Connect supports the following DFU proptocols:

Name SDK Supported Devices Documentation
Legacy DFU nRF5 SDK nRF51, nRF52 Link
Secure DFU nRF5 SDK nRF52 Link
McuManager nRF Connect SDK, Zephyr, Mynewt nRF52, nRF53, nRF54, ... Link

Automated testing

The nRF Connect allows for executing XML scripts with test suites. Two sample XMLs for testing: the HRM-DFU sample and HRM-Scanning sample are available in documentation. They contains the full documentation of the currently available features. Copy those files and the test.bat script to your PC and run. Currently only Windows batch script is available, but adb commands can be called from Mac and Linux as well.

To start the test run the test.bat script:

test.bat [-d device_id] [-E KEY EXTRA] test.xml

or test.sh script:

./test.sh [-d device_id] [-E KEY EXTRA] test.xml 

You may specify key-value pairs in execution or inside the test using

<set name="KEY" value="VALUE" />

and then use them as ${KEY} (see the sample_test_hrm.xml).

Read mode about the test suites in the documentation.

Macros

Starting from version 4.4.0 it is now possible to automate operations using macros. Macros can be recorded, or imported from a XML file.

Read more about macros in the macros documentation.