!noble

 

A Node.js BLE (Bluetooth Low Energy) central module.

Want to implement a peripheral? Check out bleno.

__Note:__ macOS / Mac OS X, Linux, FreeBSD and Windows are currently the only supported OSes.

Documentation

* Quick Start Example
* Installation
* API docs
* Advanced usage
* Common problems

Quick Start Example

``javascript
// Read the battery level of the first found peripheral exposing the Battery Level characteristic

const noble = require('@abandonware/noble');

noble.on('stateChange', async (state) => {
if (state === 'poweredOn') {
await noble.startScanningAsync(['180f'], false);
}
});

noble.on('discover', async (peripheral) => {
await noble.stopScanningAsync();
await peripheral.connectAsync();
const {characteristics} = await peripheral.discoverSomeServicesAndCharacteristicsAsync(['180f'], ['2a19']);
const batteryLevel = (await characteristics[0].readAsync())[0];

console.log(${peripheral.address} (${peripheral.advertisement.localName}): ${batteryLevel}%);

await peripheral.disconnectAsync();
process.exit(0);
});
`


Use Noble With BLE5 Extended Features With HCI

`javascript
const noble = require('@abandonware/noble/with-custom-binding')({extended: true});

`

Installation

* Prerequisites
* OS X
* Linux
* Ubuntu, Debian, Raspbian
* Fedora and other RPM-based distributions
* Intel Edison
* FreeBSD
* Windows
* Docker
* Installing and using the package

$3

#### OS X

* Install Xcode
* On newer versions of OSX, allow bluetooth access on the terminal app: "System Preferences" —> "Security & Privacy" —> "Bluetooth" -> Add terminal app (see Sandboxed terminal)

#### Linux

* Kernel version 3.6 or above
* libbluetooth-dev needs to be installed. For instructions for specific distributions, see below.
* To set the necessary privileges to run without sudo, see this section. This is required for all distributions (Raspbian, Ubuntu, Fedora, etc). You will not get any errors if running without sudo, but nothing will happen.

##### Ubuntu, Debian, Raspbian

See the generic Linux notes above first.

`sh
sudo apt-get install bluetooth bluez libbluetooth-dev libudev-dev
`

Make sure node is on your PATH. If it's not, some options:
* Symlink nodejs to node: sudo ln -s /usr/bin/nodejs /usr/bin/node
* Install Node.js using the NodeSource package

If you are having trouble connecting to BLE devices on a Raspberry Pi, you should disable the pnat plugin. Add the following line at the bottom of /etc/bluetooth/main.conf:

`
DisablePlugins=pnat
`

Then restart the system.

See Issue #425 · OpenWonderLabs/homebridge-switchbot.

##### Fedora and other RPM-based distributions

See the generic Linux notes above first.

`sh
sudo yum install bluez bluez-libs bluez-libs-devel
`

##### Intel Edison

See the generic Linux notes above first.

See Configure Intel Edison for Bluetooth LE (Smart) Development.

#### FreeBSD

Make sure you have GNU Make:

`sh
sudo pkg install gmake
`

Disable automatic loading of the default Bluetooth stack by putting no-ubt.conf into /usr/local/etc/devd/no-ubt.conf and restarting devd (sudo service devd restart).

Unload ng_ubt kernel module if already loaded:

`sh
sudo kldunload ng_ubt
`

Make sure you have read and write permissions on the /dev/usb/* device that corresponds to your Bluetooth adapter.

#### Windows

node-gyp requirements for Windows

Install the required tools and configurations using Microsoft's windows-build-tools from an elevated PowerShell or cmd.exe (run as Administrator).

`cmd
npm install --global --production windows-build-tools
`

node-bluetooth-hci-socket prerequisites
* Compatible Bluetooth 5.0 Zephyr HCI-USB adapter (you need to add BLUETOOTH_HCI_SOCKET_USB_VID and BLUETOOTH_HCI_SOCKET_USB_PID to the process env)
* Compatible Bluetooth 4.0 USB adapter
* WinUSB.aspx) driver setup for Bluetooth 4.0 USB adapter, using Zadig tool

See @don's setup guide on Bluetooth LE with Node.js and Noble on Windows

#### Docker

Make sure your container runs with --network=host options and all specific environment preriquisites are verified.

$3

`sh
npm install @abandonware/noble
`

In Windows OS add your custom hci-usb dongle to the process env
`sh
set BLUETOOTH_HCI_SOCKET_USB_VID=xxx
set BLUETOOTH_HCI_SOCKET_USB_PID=xxx
`

`javascript
const noble = require('@abandonware/noble');
`

API docs

All operations have two API variants – one expecting a callback, one returning a Promise (denoted by Async suffix).

Additionally, there are events corresponding to each operation (and a few global events).

For example, in case of the "discover services" operation of Peripheral:

* There's a discoverServices method expecting a callback:
`javascript
peripheral.discoverServices((error, services) => {
// callback - handle error and services
});
`
* There's a discoverServicesAsync method returning a Promise:
`javascript
try {
const services = await peripheral.discoverServicesAsync();
// handle services
} catch (e) {
// handle error
}
`
* There's a servicesDiscover event emitted after services are discovered:
`javascript
peripheral.once('servicesDiscover', (services) => {
// handle services
});
`

API structure:

* Scanning and discovery
* _Event: Adapter state changed_
* Start scanning
* _Event: Scanning started_
* Stop scanning
* _Event: Scanning stopped_
* _Event: Peripheral discovered_
* _Event: Warning raised_
* Reset device
* Peripheral
* Connect
* _Event: Connected_
* Cancel a pending connection
* Disconnect
* _Event: Disconnected_
* Update RSSI
* _Event: RSSI updated_
* Discover services
* Discover all services and characteristics
* Discover some services and characteristics
* _Event: Services discovered_
* Read handle
* _Event: Handle read_
* Write handle
* _Event: Handle written_
* Service
* Discover included services
* _Event: Included services discovered_
* Discover characteristics
* _Event: Characteristics discovered_
* Characteristic
* Read
* _Event: Data read_
* Write
* _Event: Data written_
* Broadcast
* _Event: Broadcast sent_
* Subscribe
* _Event: Notification received_
* Unsubscribe
* Discover descriptors
* _Event: Descriptors discovered_
* Descriptor
* Read value
* _Event: Value read_
* Write value
* _Event: Value written_

$3

#### _Event: Adapter state changed_

`javascript
noble.on('stateChange', callback(state));
`

state can be one of:
* unknown
* resetting
* unsupported
* unauthorized
* poweredOff
* poweredOn

#### Start scanning

`javascript
noble.startScanning(); // any service UUID, no duplicates


noble.startScanning([], true); // any service UUID, allow duplicates


var serviceUUIDs = ['', ...]; // default: [] => all
var allowDuplicates = falseOrTrue; // default: false

noble.startScanning(serviceUUIDs, allowDuplicates[, callback(error)]); // particular UUIDs
`

__NOTE:__ noble.state must be poweredOn before scanning is started. noble.on('stateChange', callback(state)); can be used to listen for state change events.

#### _Event: Scanning started_

`javascript
noble.on('scanStart', callback);
`

The event is emitted when:
* Scanning is started
* Another application enables scanning
* Another application changes scanning settings

#### Stop scanning

`javascript
noble.stopScanning();
`

#### _Event: Scanning stopped_

`javascript
noble.on('scanStop', callback);
`

The event is emitted when:
* Scanning is stopped
* Another application stops scanning


#### _Event: Peripheral discovered_

`javascript
noble.on('discover', callback(peripheral));
`

* peripheral:
`javascript
{
id: '',
address: ', // Bluetooth Address of device, or 'unknown' if not known
addressType: '', // Bluetooth Address type (public, random), or 'unknown' if not known
connectable: trueOrFalseOrUndefined, // true or false, or undefined if not known
advertisement: {
localName: '',
txPowerLevel: someInteger,
serviceUuids: ['', ...],
serviceSolicitationUuid: ['', ...],
manufacturerData: someBuffer, // a Buffer
serviceData: [
{
uuid: '',
data: someBuffer // a Buffer
},
// ...
]
},
rssi: integerValue,
mtu: integerValue // MTU will be null, until device is connected and hci-socket is used
};
`

__Note:__ On macOS, the address will be set to '' if the device has not been connected previously.


#### _Event: Warning raised_

`javascript
noble.on('warning', callback(message));
`

$3

`javascript
noble.reset()
`

$3

#### Connect

`javascript
peripheral.connect([callback(error)]);
`

Some of the bluetooth devices doesn't connect seamlessly, may be because of bluetooth device firmware or kernel. Do reset the device with noble.reset() API before connect API.

#### _Event: Connected_

`javascript
peripheral.once('connect', callback);
`

#### Cancel a pending connection

`javascript
peripheral.cancelConnect();
// Will emit a 'connect' event with error
`

#### Disconnect

`javascript
peripheral.disconnect([callback(error)]);
`

#### _Event: Disconnected_

`javascript
peripheral.once('disconnect', callback);
`

#### Update RSSI

`javascript
peripheral.updateRssi([callback(error, rssi)]);
`

#### _Event: RSSI updated_

`javascript
peripheral.once('rssiUpdate', callback(rssi));
`

#### Discover services

`javascript
peripheral.discoverServices(); // any service UUID

var serviceUUIDs = ['', ...];
peripheral.discoverServices(serviceUUIDs[, callback(error, services)]); // particular UUIDs
`

#### Discover all services and characteristics

`javascript
peripheral.discoverAllServicesAndCharacteristics([callback(error, services, characteristics)]);
`

#### Discover some services and characteristics

`javascript
var serviceUUIDs = ['', ...];
var characteristicUUIDs = ['', ...];
peripheral.discoverSomeServicesAndCharacteristics(serviceUUIDs, characteristicUUIDs, [callback(error, services, characteristics));
`

#### _Event: Services discovered_

`javascript
peripheral.once('servicesDiscover', callback(services));
`

#### Read handle

`javascript
peripheral.readHandle(handle, callback(error, data));
`

#### _Event: Handle read_

`javascript
peripheral.once('handleRead', callback(data)); // data is a Buffer
`

is the handle identifier.

#### Write handle

`javascript
peripheral.writeHandle(handle, data, withoutResponse, callback(error));
`

#### _Event: Handle written_

`javascript
peripheral.once('handleWrite', callback());
`

is the handle identifier.

$3

#### Discover included services

`javascript
service.discoverIncludedServices(); // any service UUID

var serviceUUIDs = ['', ...];
service.discoverIncludedServices(serviceUUIDs[, callback(error, includedServiceUuids)]); // particular UUIDs
`

#### _Event: Included services discovered_

`javascript
service.once('includedServicesDiscover', callback(includedServiceUuids));
`

#### Discover characteristics

`javascript
service.discoverCharacteristics() // any characteristic UUID

var characteristicUUIDs = ['', ...];
service.discoverCharacteristics(characteristicUUIDs[, callback(error, characteristics)]); // particular UUIDs
`

#### _Event: Characteristics discovered_

`javascript
service.once('characteristicsDiscover', callback(characteristics));
`

* characteristics
`javascript
{
uuid: '',
properties: ['...'] // 'broadcast', 'read', 'writeWithoutResponse', 'write', 'notify', 'indicate', 'authenticatedSignedWrites', 'extendedProperties'
};
`

$3

#### Read

`javascript
characteristic.read([callback(error, data)]);
`

#### _Event: Data read_

`javascript
characteristic.on('data', callback(data, isNotification));

characteristic.once('read', callback(data, isNotification)); // legacy
`

Emitted when:
* Characteristic read has completed, result of characteristic.read(...)
* Characteristic value has been updated by peripheral via notification or indication, after having been enabled with characteristic.notify(true[, callback(error)])

Note: isNotification event parameter value MAY be undefined depending on platform. The parameter is deprecated after version 1.8.1, and not supported on macOS High Sierra and later.

#### Write

`javascript
characteristic.write(data, withoutResponse[, callback(error)]); // data is a Buffer, withoutResponse is true|false
`

* withoutResponse:
* false: send a write request, used with "write" characteristic property
* true: send a write command, used with "write without response" characteristic property


#### _Event: Data written_

`javascript
characteristic.once('write', withoutResponse, callback());
`

Emitted when characteristic write has completed, result of characteristic.write(...).

#### Broadcast

`javascript
characteristic.broadcast(broadcast[, callback(error)]); // broadcast is true|false
`

#### _Event: Broadcast sent_

`javascript
characteristic.once('broadcast', callback(state));
`

Emitted when characteristic broadcast state changes, result of characteristic.broadcast(...).

#### Subscribe

`javascript
characteristic.subscribe([callback(error)]);
`

Subscribe to a characteristic.

Triggers data events when peripheral sends a notification or indication. Use for characteristics with "notify" or "indicate" properties.

#### _Event: Notification received_

`javascript
characteristic.once('notify', callback(state));
`

Emitted when characteristic notification state changes, result of characteristic.notify(...).

#### Unsubscribe

`javascript
characteristic.unsubscribe([callback(error)]);
`

Unsubscribe from a characteristic.

Use for characteristics with "notify" or "indicate" properties

#### Discover descriptors

`javascript
characteristic.discoverDescriptors([callback(error, descriptors)]);
`

#### _Event: Descriptors discovered_

`javascript
characteristic.once('descriptorsDiscover', callback(descriptors));
`
* descriptors:
`javascript
[
{
uuid: ''
},
// ...
]
`

$3

#### Read value

`javascript
descriptor.readValue([callback(error, data)]);
`

#### _Event: Value read_

`javascript
descriptor.once('valueRead', data); // data is a Buffer
`

#### Write value

`javascript
descriptor.writeValue(data[, callback(error)]); // data is a Buffer
`

#### _Event: Value written_

`javascript
descriptor.once('valueWrite');
`

Advanced usage

$3

By default, noble will select appropriate Bluetooth device bindings based on your platform. You can provide custom bindings using the with-bindings module.

`javascript
var noble = require('@abandonware/noble/with-bindings')(require('./my-custom-bindings'));
`

$3

Run the following command:

`sh
sudo setcap cap_net_raw+eip $(eval readlink -f which node)
`

This grants the node binary cap_net_raw privileges, so it can start/stop BLE advertising.

__Note:__ The above command requires setcap to be installed.
It can be installed the following way:

* apt: sudo apt-get install libcap2-bin
* yum: su -c \'yum install libcap2-bin\'

$3

hci0 is used by default.

To override, set the NOBLE_HCI_DEVICE_ID environment variable to the interface number.

For example, to specify hci1:

`sh
sudo NOBLE_HCI_DEVICE_ID=1 node .js
`

If you are using multiple HCI devices in one setup you can run two instances of noble with different binding configurations by initializing them seperatly in code:

`
const HCIBindings = require('@abandonware/noble/lib/hci-socket/bindings');
const Noble = require('@abandonware/noble/lib/noble');

const params = {
deviceId: 0,
userChannel: true,
extended: false //ble5 extended features
};

const noble = new Noble(new HCIBindings(params));
`

$3

By default, noble waits for both the advertisement data and scan response data for each Bluetooth address. If your device does not use scan response, the NOBLE_REPORT_ALL_HCI_EVENTS environment variable can be used to bypass it.

`sh
sudo NOBLE_REPORT_ALL_HCI_EVENTS=1 node .js
`

$3

By default, noble will respond with an error whenever a GATT request message is received. If your intention is to use bleno in tandem with noble, the NOBLE_MULTI_ROLE environment variable can be used to bypass this behaviour.

__Note:__ this requires a Bluetooth 4.1 adapter.

`sh
sudo NOBLE_MULTI_ROLE=1 node .js
`

Common problems

$3

This limit is imposed by the Bluetooth adapter hardware as well as its firmware.

| Platform | |
| :-------------------------------- | --------------------- |
| OS X 10.11 (El Capitan) | 6 |
| Linux/Windows - Adapter-dependent | 5 (CSR based adapter) |

$3

On newer versions of OSX, the terminal app is sandboxed to not allow bluetooth connections by default. If you run a script that tries to access it, you will get an Abort trap: 6 error.

To enable bluetooth, go to "System Preferences" —> "Security & Privacy" —> "Bluetooth" -> Add your terminal into allowed apps.

$3

Some BLE adapters cannot connect to a peripheral while they are scanning (examples below). You will get the following messages when trying to connect:

Sena UD-100 (Cambridge Silicon Radio, Ltd Bluetooth Dongle (HCI mode)): Error: Command disallowed

Intel Dual Band Wireless-AC 7260 (Intel Corporation Wireless 7260 (rev 73)): Error: Connection Rejected due to Limited Resources (0xd)`

You need to stop scanning before trying to connect in order to solve this issue.

Backers

Support us with a monthly donation and help us continue our activities. [Become a backer]

Sponsors

Become a sponsor and get your logo on our README on Github with a link to your site. [Become a sponsor]

Useful links

* Bluetooth Development Portal
* GATT Specifications
* Bluetooth: ATT and GATT

License

Copyright (C) 2015 Sandeep Mistry

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.