noble

A node.js BLE (Bluetooth low energy) central library.

noble

A node.js BLE (Bluetooth low energy) central module.

Want to implement a peripheral? Checkout bleno

Note: Mac OS X and Linux are currently the only supported OSes. Other platforms may be developed later on (see Roadmap below).

  • Kernel version 3.6 or above
  • libbluetooth-dev
sudo apt-get install bluetooth bluez-utils libbluetooth-dev

See Configure Intel Edison for Bluetooth LE (Smart) Development

npm install noble
var noble = require('noble');
noble.startScanning(); // any service UUID, no duplicates 
 
 
noble.startScanning([], true); // any service UUID, allow duplicates 
 
 
var serviceUUIDs = ["<service UUID 1>", ...]; // default: [] => all 
var allowDuplicates = <false|true>; // default: false 
 
noble.startScanning(serviceUUIDs, allowDuplicates); // particular UUID's 
noble.stopScanning();
peripheral.connect([callback(error)]);
peripheral.disconnect([callback(error)]);
peripheral.updateRssi([callback(error, rssi)]);
peripheral.discoverServices(); // any service UUID 
 
var serviceUUIDs = ["<service UUID 1>", ...];
peripheral.discoverServices(serviceUUIDs[, callback(error, services)]); // particular UUID's 
peripheral.discoverAllServicesAndCharacteristics([callback(error, services, characteristics));
var serviceUUIDs = ["<service UUID 1>", ...];
var characteristicUUIDs = ["<characteristic UUID 1>", ...];
peripheral.discoverSomeServicesAndCharacteristics(serviceUUIDs, characteristicUUIDs, [callback(error, services, characteristics));
service.discoverIncludedServices(); // any service UUID 
 
var serviceUUIDs = ["<service UUID 1>", ...];
service.discoverIncludedServices(serviceUUIDs[, callback(error, includedServiceUuids)]); // particular UUID's 
service.discoverCharacteristics() // any characteristic UUID 
 
var characteristicUUIDs = ["<characteristic UUID 1>", ...];
service.discoverCharacteristics(characteristicUUIDs[, callback(error, characteristics)]); // particular UUID's 
characteristic.read([callback(error, data)]);
characteristic.write(data, notify[, callback(error)]); // data is a buffer, notify is true|false 
characteristic.broadcast(broadcast[, callback(error)]); // broadcast is true|false 
characteristic.notify(notify[, callback(error)]); // notify is true|false 
  • use for characteristics with notifiy or indicate properties
characteristic.discoverDescriptors([callback(error, descriptors)]);
descriptor.readValue([callback(error, data)]);
descriptor.writeValue(data[, callback(error)]); // data is a buffer 
peripheral.readHandle(handle, callback(error, data));
peripheral.writeHandle(handle, data, withoutResponse, callback(error));
state = <"unknown" | "resetting" | "unsupported" | "unauthorized" | "poweredOff" | "poweredOn">
 
noble.on('stateChange', callback(state));
noble.on('scanStart', callback);
noble.on('scanStop', callback);
peripheral = {
  uuid: "<uuid>",
  advertisement: {
    localName: "<name>",
    txPowerLevel: <int>,
    serviceUuids: ["<service UUID>", ...],
    manufacturerData: <Buffer>,
    serviceData: [
        {
            uuid: "<service UUID>"
            data: <Buffer>
        },
        ...
    ]
  },
  rssi: <rssi>
};
 
noble.on('discover', callback(peripheral));
peripheral.on('connect', callback);
peripheral.on('disconnect', callback);
peripheral.on('rssiUpdate', callback(rssi));
peripheral.on('servicesDiscover', callback(services));
service.on('includedServicesDiscover', callback(includedServiceUuids));
characteristic = {
  uuid: "<uuid>",
   // properties: 'broadcast', 'read', 'writeWithoutResponse', 'write', 'notify', 'indicate', 'authenticatedSignedWrites', 'extendedProperties' 
  properties: [...]
};
 
service.on('characteristicsDiscover', callback(characteristics));
characteristic.on('read', callback(data, isNotification));
characteristic.on('write', withoutResponse, callback());
characteristic.on('broadcast', callback(state));
characteristic.on('notify', callback(state));
descriptor = {
  uuid: '<uuid>'
};
 
characteristic.on('descriptorsDiscover', callback(descriptors));
descriptor.on('valueRead', data);
descriptor.on('valueWrite');

Run the following command in the directory you ran npm install from:

find -path '*noble*Release/hci-ble' -exec sudo setcap cap_net_raw+eip '{}' \;

This grants noble's hci-ble binary cap_net_raw privileges, so it can start/stop scanning for BLE devices.

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\'

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

Example, specify hci1:

sudo NOBLE_HCI_DEVICE_ID=1 node <your file>.js
  • Mac OS X:

    • Adapter state (unknown | reseting | unsupported | unauthorized | off | on)
    • Scan
      • startScanning
        • service UUID's
        • allow duplicates
      • stopScanning
    • Peripheral
      • discovered
      • connect
      • disconnect/cancel connect
      • update RSSI
      • services
        • discover
        • disover included
        • discover characteristics for services
      • characteristics
        • read
        • write
        • set broadcast value
        • set notify/indicate value
        • descriptors
          • discover
          • read
          • write
      • handle
        • read
        • write
          • with response
          • without response
    • error handling
  • Linux

    • Adapter state (unsupported | unauthorized | off | on)
    • Scan
      • startScanning
        • service UUID's
        • allow duplicates
      • stopScanning
    • Peripheral
      • discovered
      • connect
        • public address
        • random address
      • disconnect/cancel connect
      • update RSSI
      • services
        • discover
          • filter by uuid
        • discover included
        • discover characteristics for services
          • filter by uuid
      • characteristics
        • read
        • write
        • set broadcast value
        • set notify/indicate value
        • descriptors
          • discover
          • read
          • write
      • handle
        • read
        • write
          • with response
          • without response
    • error handling
  • Windows

    • TDB (most likely Windows 8 only)

Copyright (C) 2015 Sandeep Mistry sandeep.mistry@gmail.com

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.