brunowonka / bleno

A node.js module for implementing BLE (Bluetooth low energy) peripherals

bleno

fork from (https://github.com/sandeepmistry/bleno) to implement gatt service/client switching in a ble peripheral. gatt client implementation from (https://github.com/sandeepmistry/noble)

Please mind this is a quick and dirty fork to test some functionality, it's only tested on linux and the APIs may not match sandeepmistry's

Usage

Works about the same as the forked repos, plus the Inquiry remote server stuff AND the fact that the require call exposes a class, not an object.

var Bleno = require('bleno');
var bleno = new Bleno({
    name : deviceName,
});

Inquiry remote server (Central Server)

bleno.on('accept', function (clientAddress) {
    var central = bleno.getCentral();
    central.on('discover',function(){
        /* do anything you would with a NOBLE object on central
          (regarding discovering characteristics and such) */
    });
    central.connect();
});

Actions

Start advertising:

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:

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)]);

Note:: on OS X, in iBeacon mode your peripheral is non-connectable!

Start advertising with EIR data (Linux only):

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 sections and 8 and 18 for more information the data format.

Stop advertising:

bleno.stopAdvertising([callback]);

Set services:

var services = [
   ... // see PrimaryService for data type
];

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

Disconnect client:

bleno.disconnect(); // Linux only

Update RSSI:

bleno.updateRssi([callback(error, rssi)]); // Linux only

Primary Service

var PrimaryService = bleno.PrimaryService;

var primaryService = new PrimaryService({
    uuid: 'fffffffffffffffffffffffffffffff0', // or 'fff0' for 16-bit
    characteristics: [
        // see Characteristic for data type
    ]
});

Characteristic

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'
    secure: [ ... ], // enable security for properties, can be a combination of 'read', 'write', 'writeWithoutResponse', 'notify'
    value: null, // optional static value, must be of type Buffer
    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 subscribe handler, function(maxValueSize, updateValueCallback) { ...}
    onUnsubscribe: null, // optional notify unsubscribe handler, function() { ...}
    onNotify: null // optional notify sent 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.

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.

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 subcribe), with an argument of type Buffer

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

Descriptor

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:

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

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

Advertisement started:

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

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

Advertisement stopped:

bleno.on('advertisingStop', callback);

Services set:

bleno.on('servicesSet', callback);

Accept:

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

Disconnect:

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

RSSI Update:

bleno.on('rssiUpdate', callback(rssi)); // Linux only

Running on Linux

Must be run with sudo or as root user.

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

Example, specify hci1:

sudo BLENO_HCI_DEVICE_ID=1 node <your file>.js