Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/noble/bleno

A Node.js module for implementing BLE (Bluetooth Low Energy) peripherals
https://github.com/noble/bleno

Last synced: 1 day ago
JSON representation

A Node.js module for implementing BLE (Bluetooth Low Energy) peripherals

Awesome Lists containing this project

README 

        
# bleno



[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/sandeepmistry/bleno?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)



A Node.js module for implementing BLE (Bluetooth Low Energy) peripherals.



Need a BLE central module? See [noble](https://github.com/sandeepmistry/noble).



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



## Prerequisites



### OS X



 * install [Xcode](https://itunes.apple.com/ca/app/xcode/id497799835?mt=12)

 * 10.9 or later



### Linux



 * Kernel version 3.6 or above

 * ```libbluetooth-dev```

 * ```bluetoothd``` disabled, if BlueZ 5.14 or later is installed. Use ```sudo hciconfig hci0 up``` to power Bluetooth adapter up after stopping or disabling ```bluetoothd```.

    * ```System V```:

      * ```sudo service bluetooth stop``` (once)

      * ```sudo update-rc.d bluetooth remove``` (persist on reboot)

    * ```systemd```

      * ```sudo systemctl stop bluetooth``` (once)

      * ```sudo systemctl disable bluetooth``` (persist on reboot)



If you're using [noble](https://github.com/sandeepmistry/noble) *and* bleno at the same time, connected BLE devices may not be able to retrieve a list of services from the BLE adaptor. Check out noble's [documentation on bleno compatibility](https://github.com/sandeepmistry/noble#bleno-compatibility)



#### Ubuntu/Debian/Raspbian



```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](https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions)



#### Fedora / Other-RPM based



```sh

sudo yum install bluez bluez-libs bluez-libs-devel

```



#### Intel Edison



See [Configure Intel Edison for Bluetooth LE (Smart) Development](http://rexstjohn.com/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](https://gist.github.com/myfreeweb/44f4f3e791a057bc4f3619a166a03b87) 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](https://github.com/TooTallNate/node-gyp#installation)

   * Python 2.7

   * Visual Studio ([Express](https://www.visualstudio.com/en-us/products/visual-studio-express-vs.aspx))

 * [node-bluetooth-hci-socket prerequisites](https://github.com/sandeepmistry/node-bluetooth-hci-socket#windows)

   * Compatible Bluetooth 4.0 USB adapter

   * [WinUSB](https://msdn.microsoft.com/en-ca/library/windows/hardware/ff540196(v=vs.85).aspx) driver setup for Bluetooth 4.0 USB adapter, using [Zadig tool](http://zadig.akeo.ie/)



## Install



```sh

npm install bleno

```



## Usage



```javascript

var bleno = require('bleno');

```



See [examples folder](https://github.com/sandeepmistry/bleno/blob/master/examples) for code examples.



### Actions



#### Advertising



##### Start advertising



NOTE: ```bleno.state``` must be ```poweredOn``` before advertising is started. ```bleno.on('stateChange', callback(state));``` can be used register for state change events.



```javascript

var name = 'name';

var serviceUuids = ['fffffffffffffffffffffffffffffff0']



bleno.startAdvertising(name, serviceUuids[, callback(error)]);

```



 __Note:__: there are limits on the name and service UUID's



  * name

    * maximum 26 bytes

  * service UUID's

    * 1 128-bit service UUID

    * 1 128-bit service UUID + 2 16-bit service UUID's

    * 7 16-bit service UUID



##### Start advertising iBeacon



```javascript

var uuid = 'e2c56db5dffb48d2b060d0f5a71096e0';

var major = 0; // 0x0000 - 0xffff

var minor = 0; // 0x0000 - 0xffff

var measuredPower = -59; // -128 - 127



bleno.startAdvertisingIBeacon(uuid, major, minor, measuredPower[, callback(error)]);

```



 __Notes:__:

  * OS X:

    * in iBeacon mode your peripheral is non-connectable!



##### Start advertising with EIR data (__Linux only__)



```javascript

var scanData = new Buffer(...); // maximum 31 bytes

var advertisementData = new Buffer(...); // maximum 31 bytes



bleno.startAdvertisingWithEIRData(advertisementData[, scanData, callback(error)]);

```



  * For EIR format section [Bluetooth Core Specification](https://www.bluetooth.org/docman/handlers/downloaddoc.ashx?doc_id=229737) sections and 8 and 18 for more information the data format.



##### Stop advertising



```javascript

bleno.stopAdvertising([callback]);

```



#### Set services



Set the primary services available on the peripheral.



```javascript

var services = [

   ... // see PrimaryService for data type

];



bleno.setServices(services[, callback(error)]);

```



#### Disconnect client



```javascript

bleno.disconnect(); // Linux only

```



#### Update RSSI



```javascript

bleno.updateRssi([callback(error, rssi)]); // not available in OS X 10.9

```



### Primary Service



```javascript

var PrimaryService = bleno.PrimaryService;



var primaryService = new PrimaryService({

    uuid: 'fffffffffffffffffffffffffffffff0', // or 'fff0' for 16-bit

    characteristics: [

        // see Characteristic for data type

    ]

});

```



### Characteristic



```javascript

var Characteristic = bleno.Characteristic;



var characteristic = new Characteristic({

    uuid: 'fffffffffffffffffffffffffffffff1', // or 'fff1' for 16-bit

    properties: [ ... ], // can be a combination of 'read', 'write', 'writeWithoutResponse', 'notify', 'indicate'

    secure: [ ... ], // enable security for properties, can be a combination of 'read', 'write', 'writeWithoutResponse', 'notify', 'indicate'

    value: null, // optional static value, must be of type Buffer - for read only characteristics

    descriptors: [

        // see Descriptor for data type

    ],

    onReadRequest: null, // optional read request handler, function(offset, callback) { ... }

    onWriteRequest: null, // optional write request handler, function(data, offset, withoutResponse, callback) { ...}

    onSubscribe: null, // optional notify/indicate subscribe handler, function(maxValueSize, updateValueCallback) { ...}

    onUnsubscribe: null, // optional notify/indicate unsubscribe handler, function() { ...}

    onNotify: null, // optional notify sent handler, function() { ...}

    onIndicate: null // optional indicate confirmation received handler, function() { ...}

});

```



#### Result codes



  * Characteristic.RESULT_SUCCESS

  * Characteristic.RESULT_INVALID_OFFSET

  * Characteristic.RESULT_INVALID_ATTRIBUTE_LENGTH

  * Characteristic.RESULT_UNLIKELY_ERROR



#### Read requests



Can specify read request handler via constructor options or by extending Characteristic and overriding onReadRequest.



Parameters to handler are

  * ```offset``` (0x0000 - 0xffff)

  * ```callback```



```callback``` must be called with result and data (of type ```Buffer```) - can be async.



```javascript

var result = Characteristic.RESULT_SUCCESS;

var data = new Buffer( ... );



callback(result, data);

```



#### Write requests



Can specify write request handler via constructor options or by extending Characteristic and overriding onWriteRequest.



Parameters to handler are

  * ```data``` (Buffer)

  * ```offset``` (0x0000 - 0xffff)

  * ```withoutResponse``` (true | false)

  * ```callback```.



```callback``` must be called with result code - can be async.



```javascript

var result = Characteristic.RESULT_SUCCESS;



callback(result);

```



#### Notify subscribe



Can specify notify subscribe handler via constructor options or by extending Characteristic and overriding onSubscribe.



Parameters to handler are

  * ```maxValueSize``` (maximum data size)

  * ```updateValueCallback``` (callback to call when value has changed)



#### Notify unsubscribe



Can specify notify unsubscribe handler via constructor options or by extending Characteristic and overriding onUnsubscribe.



#### Notify value changes



Call the ```updateValueCallback``` callback (see Notify subscribe), with an argument of type ```Buffer```



Can specify notify sent handler via constructor options or by extending Characteristic and overriding onNotify.



### Descriptor



```javascript

var Descriptor = bleno.Descriptor;



var descriptor = new Descriptor({

    uuid: '2901',

    value: 'value' // static value, must be of type Buffer or string if set

});

```



### Events



#### Adapter state change



```javascript

state = <"unknown" | "resetting" | "unsupported" | "unauthorized" | "poweredOff" | "poweredOn">



bleno.on('stateChange', callback(state));

```



#### Advertisement started



```javascript

bleno.on('advertisingStart', callback(error));



bleno.on('advertisingStartError', callback(error));

```



#### Advertisement stopped



```javascript

bleno.on('advertisingStop', callback);

```



#### Services set



```javascript

bleno.on('servicesSet', callback(error));



bleno.on('servicesSetError', callback(error));

```



#### Accept



```javascript

bleno.on('accept', callback(clientAddress)); // not available on OS X 10.9

```



#### Disconnect



```javascript

bleno.on('disconnect', callback(clientAddress)); // Linux only

```



#### RSSI Update



```javascript

bleno.on('rssiUpdate', callback(rssi)); // not available on OS X 10.9

```



### Running on Linux



__Note:__ Make sure you've also checked the [Linux Prerequisites](#linux)



#### Running without root/sudo



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 using the following:



 * apt: ```sudo apt-get install libcap2-bin```

 * yum: ```su -c \'yum install libcap2-bin\'```



#### Multiple Adapters



```hci0``` is used by default to override set the ```BLENO_HCI_DEVICE_ID``` environment variable to the interface number.



Example, specify ```hci1```:



```sh

sudo BLENO_HCI_DEVICE_ID=1 node .js

```



#### Set custom device name



By default bleno uses the hostname (```require('os').hostname()```) as the value for the device name (0x2a00) characterisic, to match the behaviour of OS X.



A custom device name can be specified by setting the ```BLENO_DEVICE_NAME``` environment variable:



```sh

sudo BLENO_DEVICE_NAME="custom device name" node .js

```



or



```js

process.env['BLENO_DEVICE_NAME'] = 'custom device name';

```



#### Set Advertising Interval



bleno uses a 100 ms advertising interval by default.



A custom advertising interval can be specified by setting the ```BLENO_ADVERTISING_INTERVAL``` enviroment variable with the desired value in milliseconds:



```sh

sudo BLENO_ADVERTISING_INTERVAL=500 node .js

```



Advertising intervals must be between 20 ms to 10 s (10,000 ms).



## Useful tools/links



 * Tools

   * LightBlue for [iOS](https://itunes.apple.com/us/app/lightblue/id557428110)/[OS X](https://itunes.apple.com/us/app/lightblue/id639944780)

   * [nRF Master Control Panel (BLE)](https://play.google.com/store/apps/details?id=no.nordicsemi.android.mcp&hl=en) for Android

   * [hcitool](http://linux.die.net/man/1/hcitool) and ```gatttool``` by [BlueZ](http://www.bluez.org) for Linux



## 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.



[![Analytics](https://ga-beacon.appspot.com/UA-56089547-1/sandeepmistry/bleno?pixel)](https://github.com/igrigorik/ga-beacon)