• Stars
    star
    1,853
  • Rank 24,135 (Top 0.5 %)
  • Language
    Java
  • License
    BSD 3-Clause "New...
  • Created over 6 years ago
  • Updated 3 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

A library that makes working with Bluetooth LE on Android a pleasure. Seriously.

Download

Android BLE Library

An Android library that solves a lot of Android's Bluetooth Low Energy problems.

Importing

The library may be found on Maven Central repository. Add it to your project by adding the following dependency:

implementation 'no.nordicsemi.android:ble:2.6.1'

The last version not migrated to AndroidX is 2.0.5.

BLE library with Kotlin extension is available in:

implementation 'no.nordicsemi.android:ble-ktx:2.6.1'

To import the BLE library with set of parsers for common Bluetooth SIG characteristics, use:

implementation 'no.nordicsemi.android:ble-common:2.6.1'

For more information, read this.

An extension for easier integration with LiveData is available after adding:

implementation 'no.nordicsemi.android:ble-livedata:2.6.1'

This extension adds ObservableBleManager with state and bondingState properties, which notify about connection and bond state using androidx.lifecycle.LiveData.

Importing as a module

Clone this project and add it to your project:

  1. In settings.gradle file add the following lines:
if (file('../Android-BLE-Library').exists()) {
    includeBuild('../Android-BLE-Library')
}
  1. Sync project and build it.

The library uses Java 1.8 features. If you're using Android Studio below 4.2, make sure your build.gradle includes the following configuration:

    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
    // For Kotlin projects additionally:
    kotlinOptions {
        jvmTarget = "1.8"
    }

Features

BleManager class provides the following features:

  1. Connection, with automatic retries
  2. Service discovery
  3. Bonding (optional) and removing bond information (using reflections)
  4. Automatic handling of Service Changed indications
  5. Device initialization
  6. Asynchronous and synchronous BLE operations using queue
  7. Splitting and merging long packets when writing and reading characteristics and descriptors
  8. Requesting MTU and connection priority (on Android Lollipop or newer)
  9. Reading and setting preferred PHY (on Android Oreo or newer)
  10. Reading RSSI
  11. Refreshing device cache (using reflections)
  12. Reliable Write support
  13. Operation timeouts (for connect, disconnect and wait for notification requests)
  14. Error handling
  15. Logging
  16. GATT server (since version 2.2)
  17. Kotlin support (coroutines, Flow, ...) (since version 2.3)

Note: The library does not provide support for scanning for Bluetooth LE devices. Instead, we recommend using Android Scanner Compat Library which brings almost all recent features, introduced in Lollipop and later, to the older platforms.

Recent changes

See Releases for details. Below is short summary:

Version 2.6
  1. getGattCallback() method has been deprecated. Instead, simply move the inner methods to the BleManager class. See this PR.
  2. Support for server only implementation using attachClientConnection(BluetoothDevice). Call it instead of connect(BluetoothDevice) to use the device as server-only.
  3. Data provider for read requests (server side) was added.
  4. Cancellation support for flows and suspended methods added to :ble-kts.
Version 2.4
  1. More :ble-ktx extensions.
    1. .suspendForResponse() and .suspendForValidResponse() extension methods added to read and write requests.
    2. .asResponseFlow() and .asValidResponseFlow() methods added to ValueChangedCallback.
    3. .stateAsFlow() and .bondingStateAsFlow() in BleManager now return the same flow when called multiple times.
    4. Progress indications for split outgoing data and merged incoming data can be observed as Flow using splitWithProgressFlow(...) and mergeWithProgressFlow(...).
  2. A new then(...) method added to ValueChangedCallback which will be called when the callback has been unregistered, or the device has invalidated services (i.e. it has disconnected). Useful to release resources.
  3. A new option to remove a handler from each Request using setHandler(null), which will make the callbacks called immediately from the worker looper.
  4. Option to filter logs by priority. By default only logs on Log.INFO or higher will now be logged. Use getMinLogPriority() to return a different value if needed. Logs with lower priority will not be produced at all, making the library less laggy (parsing incoming data to hex takes notable time).
  5. Added support for Big Endian format types with the new Data.FORMAT_xxx_BE types. Also, FORMAT_xxx have been deprecated in favor of FORMAT_xxx_LE.
  6. All user callbacks (before, with, then, fail, ...) are now wrapped in try-catch blocks.
Version 2.3
  1. :ble-ktx module added with support for coroutines and Flow.
    1. .suspend() methods added in Requests.
    2. asFlow() method added to ValueChangedCallback.
    3. Connection and bonding state available as Flow.
    4. New helper methods to get a BluetoothGattCharacteristic with given required properties and instance id added to BluetoothGattService.
  2. JsonMerger class added, which should help with use cases when a device sends a JSON file in multiple packets.
  3. :ble-livedata migrated to Java with some API changes, as sealed classes are no longer available.
  4. Support for new onServicesChanged() callback, added in API 31 (Android 12).
  5. Option to cancel pending Bluetooth LE connection using ConnectRequest.cancelPendingConnection().

When using coroutines, use .suspend() method in Request, instead of enqueue() or await().

To register to notifications and indications (or incoming write requests for server) use

setNotificationCallback(characteristic)
   .merge(JsonMerger()) // Example of how to use JsonMerger, optional
   .asFlow()
Version 2.2
  1. GATT Server support. This includes setting up the local GATT server on the Android device, new requests for server operations:
    • wait for read,
    • wait for write,
    • send notification,
    • send indication,
    • set characteristic value,
    • set descriptor value.
  2. New conditional requests:
    • wait if,
    • wait until.
  3. BLE operations are no longer called from the main thread.
  4. There's a new option to set a handler for invoking callbacks. A handler can also be set per-callback.

Version 2.2 breaks some API known from version 2.1.1. Check out migration guide.

Usage

See Usage for more details.

Examples

Trivia game

The Trivia game is an example demonstrating client and server.

GATT Client Example

Please refer to the examples/ble-gatt-client folder for a project that illustrates the GATT server provided as a foreground service. There's a simple UI with a text field to update with the value of a characteristic that can be read and subscribed to. This characteristic also demands encryption as an illustration of best-practice.

You can run this client on one device and a complimenting server on another (see the next section).

Note: This project is not maintained actively. It is provided as an example only and may not be migrated to latest version.

GATT Server example

Starting from version 2.2 you may now define and use the GATT server in the BLE Library.

Please refer to the examples/ble-gatt-server folder for a project that illustrates the GATT server provided as a foreground service. There's a simple UI with a text field to update the value of a characteristic that can be read and subscribed to. This characteristic also demands encryption as an illustration of best-practice.

Note: This project is not maintained actively. It is provided as an example only and may not be migrated to latest version.

More examples

Find the simple example here Android nRF Blinky.

For an example how to use it from a ViewModel or a Service, check nRF Toolbox.

Version 1.x

The BLE library v 1.x is no longer supported. Please migrate to 2.x for bug fixing releases. Find it on version/1x branch.

A migration guide is available here.

More Repositories

1

Android-nRF-Connect

Documentation and issue tracker for nRF Connect for Android.
1,192
star
2

Android-nRF-Toolbox

The nRF Toolbox is a container app that stores your Nordic Semiconductor apps for Bluetooth Low Energy in one location.
Kotlin
1,048
star
3

Android-Scanner-Compat-Library

A compat library for Bluetooth Low Energy scanning on Android.
Java
739
star
4

Android-DFU-Library

Device Firmware Update library and Android app
Java
728
star
5

IOS-nRF-Toolbox

The nRF Toolbox is a container app that stores your Nordic Semiconductor apps for Bluetooth Low Energy in one location.
Swift
577
star
6

IOS-DFU-Library

OTA DFU Library for Mac and iOS, compatible with nRF5x SoCs
Swift
498
star
7

Android-nRF-Mesh-Library

The Bluetooth Mesh Provisioner and Configurator library.
Java
383
star
8

pc-nrfutil

nrfutil python library and command line client
Python
377
star
9

nRF-Logger-API

The public library with nRF Logger API. Allows to log custom logs into the nRF Logger database.
Java
368
star
10

IOS-nRF-Mesh-Library

Provision, configure and control Bluetooth mesh devices with nRF Mesh library.
Swift
298
star
11

bluetooth-numbers-database

An up-to-date listing of all the various Bluetooth Specification-related elements that are defined by our industry (Company IDs, Service UUIDs, Characteristic UUIDs and Descriptor UUIDs), that you can use instead of rolling your own.
JavaScript
293
star
12

pc-ble-driver

Desktop library for Bluetooth low energy development
C
279
star
13

Android-nRF-Blinky

nRF Blinky is an application developed targeting an audience of developers who are new to Bluetooth Low Energy
Kotlin
249
star
14

ble-sdk-arduino

C++
248
star
15

nrfx

Standalone drivers for peripherals present in Nordic SoCs
C
242
star
16

IOS-CoreBluetooth-Mock

Mocking library for CoreBluetooth framework.
Swift
208
star
17

Nordic-Thingy52-FW

Nordic Thingy:52 software development kit. This kit is designed to assist users in developing their own custom firmware for Thingy. Please see http://www.nordicsemi.com/thingy for the latest news and software releases.
C
208
star
18

nRF-Sniffer-for-802.15.4

nRF-based 802.15.4 sniffer (firmware and software)
Python
206
star
19

Kotlin-BLE-Library

Kotlin
202
star
20

pc-nrfconnect-launcher

nRF Connect for Desktop application and framework
TypeScript
162
star
21

nRF5-SDK-for-Mesh

This repo is a "Release" clone of the zip files available @
C
142
star
22

pc-nrfconnect-ble

Bluetooth low energy app for nRF Connect for Desktop
TypeScript
140
star
23

IOS-nRF-Connect

Info page
129
star
24

pc-ble-driver-py

Python bindings for the ble-driver library
Python
124
star
25

Android-nRF-Beacon

The nRF Beacon application lets you explore the full range of possibilities for beacons using Bluetooth Smart technology. The application has been designed to demonstrate all features of the nRF8122 Bluetooth® Smart Beacon Kit.
Java
107
star
26

Android-Nordic-Thingy

Android SDK and sample application for Nordic Thingy:52
Java
104
star
27

zcbor

Low footprint C/C++ CBOR library and Python tool providing code generation from CDDL descriptions.
C
99
star
28

pc-nrfconnect-ppk

Power Profiler app for nRF Connect for Desktop
TypeScript
92
star
29

pc-ble-driver-js

Node.js interface to the C/C++ pc-ble-driver library. API docs: https://nordicsemiconductor.github.io/pc-ble-driver-js/
JavaScript
81
star
30

IOS-nRF-Connect-Device-Manager

A mobile management library for devices supporting nRF Connect Device Manager.
Swift
81
star
31

pynrfjprog

Python wrapper around the nrfjprog dynamic link library (DLL)
C
74
star
32

Android-nRF-Connect-Device-Manager

A mobile management library for devices running Apache Mynewt and Zephyr (DFU, logs, stats, config, etc.)
Java
67
star
33

IOS-Nordic-Thingy

iOS Library and example application for Thingy:52™
Swift
64
star
34

pc-nrfconnect-programmer

Programmer app for nRF Connect for Desktop
TypeScript
62
star
35

Android-BLE-Common-Library

A companion library for the Android BLE Library. Contains parsers for common Bluetooth SIG characteristics.
Java
55
star
36

IOS-BLE-Library

The Bluetooth LE library for iOS and Mac. 100% Swift.
Swift
48
star
37

Android-nRF-Beacon-for-Eddystone

An application with Eddystone GATT Configuration Service & Google Nearby API and Proximity API.
Java
47
star
38

iOS-nRF-Blinky

A starter app for new developers in the BLE world!
Swift
42
star
39

Android-nRF-Bluetooth-LE-Joiner

nRF BLE Joiner is an application that lets you add new IoT nodes to a network based on Bluetooth Smart.
Java
35
star
40

Linux-ble-6lowpan-joiner

C
35
star
41

pc-nrfconnect-rssi

RSSI Viewer app for nRF Connect for Desktop
C
35
star
42

nrf-udev

Shell
29
star
43

Flutter-nRF-Connect-Device-Manager

A Flutter plugin for McuMgr libraries for Android and iOS.
Dart
28
star
44

nrf-intel-hex

Yet another parser for "Intel HEX" files.
JavaScript
27
star
45

pc-nrfjprog-js

Node.js library that exposes the functionality of the nRF Command Line Tools
C++
26
star
46

pc-nrfconnect-toolchain-manager

Install and manage tools to develop with the nRF Connect SDK (NCS)
TypeScript
23
star
47

pc-nrfconnect-shared

Dependency management for nRF Connect for Desktop packages
TypeScript
19
star
48

pc-nrf-dfu-js

Javascript implementation of Nordic's DFU protocol over serial (or NoBLE).
JavaScript
16
star
49

asset-tracker-cloud-firmware-aws

nRF Asset Tracker for AWS firmware.
C
16
star
50

pc-nrfconnect-linkmonitor

LTE Link Monitor app for nRF Connect for Desktop
JavaScript
14
star
51

nrf-device-setup-js

JavaScript
14
star
52

nRF-IEEE-802.15.4-radio-driver

A generic, stack independent and system independent IEEE 802.15.4 radio driver, intended for nRF SoCs with IEEE 802.15.4 radio. It contains a built-in support for multiprotocol, allowing for concurrent operation of IEEE 802.15.4-based stacks (e.g. Thread, ZigBee) with Bluetooth LE
12
star
53

pc-nrfconnect-gettingstarted

nRF Connect Getting Started Assistant is a tool to guide through the process of setting up the nRF Connect SDK toolchain
SCSS
12
star
54

asset-tracker-cloud-aws-js

A reference implementation of a serverless backend for an IoT product developed using AWS CDK in TypeScript.
TypeScript
12
star
55

pc-nrfconnect-dtm

C
10
star
56

asset-tracker-cloud-docs

The nRF Asset Tracker aims to provide a concrete end-to-end example for an IoT product in the asset tracker space.
CSS
9
star
57

e118-iin-list-js

List of issuer identifier numbers for the international telecommunication charge card (ITU-T E.118)
TypeScript
9
star
58

pc-nrfconnect-boilerplate

Starting point for creating apps for nRF Connect for Desktop
TypeScript
8
star
59

IOS-Memfault-Library

nRF Memfault Library + Example App
Swift
6
star
60

Android-nRF-Wi-Fi-Provisioner

An Android library and app for provisioning Nordic Wi-Fi devices to a network.
Kotlin
6
star
61

IOS-nRF-Edge-Impulse

Connect to a Thing:53, collect sensor data over Bluetooth Low Energy and create your machine learning applications.
Swift
6
star
62

Android-Memfault-Library

An Android library for sending heap dumps to the Memfault cloud.
Kotlin
6
star
63

asset-tracker-cloud-app-js

The nRF Asset Tracker Web Application is a reference single-page application (SPA) developed using create-react-app in TypeScript.
TypeScript
5
star
64

pc-nrfconnect-tracecollector

Trace collector tool for nRF Connect for Desktop
JavaScript
5
star
65

nRF52-Bluetooth-Course

5
star
66

pc-nrfconnect-cellularmonitor

TypeScript
5
star
67

modemtalk

[end-of-life] library to interface with the nRF9160 modem
JavaScript
5
star
68

piccata

Python CoAp Toolkit
Python
4
star
69

cell-geolocation-helpers-js

Helper functions for the cell geolocation feature
TypeScript
4
star
70

microbit-v2-pager

C
4
star
71

Android-Gradle-Plugins

Kotlin
4
star
72

pc-nrfconnect-docs

Developer documentation for nRF Connect for Desktop. Read them at https://NordicSemiconductor.github.io/pc-nrfconnect-docs/
HTML
4
star
73

nrf-device-lister-js

List usb, serialport and jlink devices
JavaScript
4
star
74

svada

SVD Parsing for Python
Python
3
star
75

asset-tracker-cloud-device-ui-js

Provides a user interface via a web application to interact with a simulated device for the nRF Asset Tracker.
TypeScript
3
star
76

at_host-hex

Compiles the AT host sample for 9161DK, 9160DK, and Thingy:91 and publishes it regularly.
3
star
77

asset-tracker-cloud-firmware-azure

nRF Asset Tracker for Azure firmware.
C
3
star
78

object-to-env-js

Helper functions which converts an object to environment variable definitions
TypeScript
3
star
79

NAT-TestServer

Receives NAT test messages from the NAT-TestFirmware and logs them and timeout occurances to S3
TypeScript
3
star
80

cloud-aws-package-layered-lambdas-js

Packages lambda functions and layers for AWS lambda
TypeScript
3
star
81

KMM-BLE-Library

Kotlin
3
star
82

IOS-nRF-Wi-Fi-Provisioner

A Swift library and app for provisioning Nordic Wi-Fi devices to a network.
Swift
3
star
83

random-words-js

Returns random 8-letter words from the Webster's Unabridged Dictionary
JavaScript
3
star
84

npmx

Standalone drivers for Nordic PMICs
C
3
star
85

npmx-zephyr

npmx integration with Zephyr
C
2
star
86

NFC-Connect

Kotlin
2
star
87

cloud-azure-firmware-ci-runner-js

Runs firmware on a real device connected to Azure IoT hub.
TypeScript
2
star
88

pmic-npm6001-lib

C
2
star
89

cloud-device-helpers-js

Helper functions for interacting with the nRF9160 used during end-to-end tests
TypeScript
2
star
90

Android-nRF-Edge-Impulse

Connect to a Thing:53, collect sensor data over Bluetooth Low Energy and create your machine learning applications.
Kotlin
2
star
91

cloud-e2e-bdd-test-runner-js

Implementation of a test-runner for end-to-end tests of cloud-native applications using Gherkin features.
TypeScript
2
star
92

pc-nrfconnect-npm

TypeScript
2
star
93

cloud-aws-timestream-helpers-js

Helper functions which simplify working with AWS Timestream
TypeScript
1
star
94

asset-tracker-cloud-code-style-js

Code style definitions for all nRF Asset Tracker projects.
JavaScript
1
star
95

asset-tracker-cloud-app-aws-js

The nRF Asset Tracker Web Application for AWS is a reference single-page application (SPA) developed using TypeScript.
TypeScript
1
star
96

rsrp-bar-js

React component to render an RSRP bar or a failover icon in case the reported value is not valid
TypeScript
1
star
97

nrfcloud-location-services-tests-js

Verifies the nRF Cloud Location Services REST API.
TypeScript
1
star
98

from-env-js

Helper function which ensures that required environment variables are set.
TypeScript
1
star
99

cloud-azure-firmware-ci-feature-runner-action

Uses @nordicsemiconductor/e2e-bdd-test-runner to run features files of a firmware.
JavaScript
1
star
100

cloud-aws-cloudformation-helpers-js

Helper functions which simplify working with AWS CloudFormation stacks
TypeScript
1
star