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).
libbluetooth-devsudo 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
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));
Emitted when characteristic read has completed, result of characteristic.read(...) or characteristic value has been updated by peripheral via notification or indication.
characteristic.on('data', callback(data, isNotification));
characteristic.on('read', callback(data, isNotification)); // legacy
Emitted when characteristic write has completed, result of characteristic.write(...).
characteristic.on('write', withoutResponse, callback());
Emitted when characteristic broadcast state changes, result of characteristic.broadcast(...).
characteristic.on('broadcast', callback(state));
Emitted when characteristic notification state changes, result of characteristic.notify(...).
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:
sudo apt-get install libcap2-binsu -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
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 following enviroment variable can be used to bypass it.
sudo NOBLE_REPORT_ALL_HCI_EVENTS=1 node <your file>.js
Mac OS X:
Linux
Windows
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.
FAQs
A Node.js BLE (Bluetooth Low Energy) central library.
The npm package noble receives a total of 1,543 weekly downloads. As such, noble popularity was classified as popular.
We found that noble demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.