Security News
NIST Misses 2024 Deadline to Clear NVD Backlog
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.
A node.js BLE (Bluetooth low energy) module.
Note: Mac OS X is currently the only supported OS, and is still under development. Other platforms will be developed later on (see Roadmap below).
npm install noble
var noble = require('noble');
Actions
Start scanning:
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
Stop scanning:
noble.stopScanning();
Peripheral connect:
peripheral.connect([callback(error)]);
Peripheral disconnect or cancel pending connection:
peripheral.disconnect([callback(error)]);
Peripheral update RSSI
peripheral.updateRssi([callback(error, rssi)]);
Peripheral discover services
peripheral.discoverServices(); // any service UUID
var serviceUUIDs = ["<service UUID 1>", ...];
peripheral.discoverServices(serviceUUIDs[, callback(error, services)]); // particular UUID's
Service discover included services
service.discoverIncludedServices(); // any service UUID
var serviceUUIDs = ["<service UUID 1>", ...];
service.discoverIncludedServices(serviceUUIDs[, callback(error, includedServiceUuids)]); // particular UUID's
Service discover characteristics
service.discoverCharacteristics() // any characteristic UUID
var characteristicUUIDs = ["<characteristic UUID 1>", ...];
service.discoverCharacteristics(characteristicUUIDs[, callback(error, characteristics)]); // particular UUID's
Characteristic read
characteristic.read([callback(error, data)]);
Characteristic write
characteristic.write(data, notify[, callback(error)]); // data is a buffer, notify is true|false
Characteristic broadcast
characteristic.broadcast(broadcast[, callback(error)]); // broadcast is true|false
Characteristic notify
characteristic.notify(notify[, callback(error)]); // notify is true|false
Characteristic discover descriptors
characteristic.discoverDescriptors([callback(error, descriptors)]);
Descriptor read value
descriptor.readValue([callback(error, data)]);
Descriptor write value
descriptor.writeValue(data[, callback(error)]); // data is a buffer
Events
Adapter state change:
state = <"unknown" | "resetting" | "unsupported" | "unsupported" | "unauthorized" | "poweredOff" | "poweredOn">
noble.on('stateChange', callback(state));
Scan started:
noble.on('scanStart', callback);
Scan stopped:
noble.on('scanStop', callback);
Peripheral discovered:
peripheral = {
uuid: "<uuid>",
advertisement: {
localName: "<name>",
serviceData: <Buffer>,
txPowerLevel: <int>,
serviceUuids: ["<service UUID>", ...],
},
rssi: <rssi>
};
noble.on('discover', callback(peripheral));
Peripheral connected:
peripheral.on('connect', callback);
Peripheral disconnected:
peripheral.on('disconnect', callback);
Peripheral RSSI update
peripheral.on('rssiUpdate', callback(rssi));
Peripheral services discovered
peripheral.on('servicesDiscovered', callback(services));
Service included services discovered
service.on('includedServicesDiscover', callback(includedServiceUuids));
Service characteristics discovered
characteristic = {
uuid: "<uuid>",
// properties: 'broadcast', 'read', 'writeWithoutResponse', 'write', 'notify', 'indicate', 'authenticatedSignedWrites', 'extendedProperties'
properties: [...]
};
service.on('characteristicsDiscover', callback(characteristics));
Characteristic read
characteristic.on('read', callback(data, isNotification));
Characteristic write
characteristic.on('write', callback());
Characteristic broadcast
characteristic.on('broadcast', callback(state));
Characteristic notify
characteristic.on('notify', callback(state));
Characteristic descriptors discovered
descriptor = {
uuid: '<uuid>'
};
characteristic.on('descriptorsDiscover', callback(descriptors));
Descriptor value read
descriptor.on('valueRead', data);
Descriptor value write
descriptor.on('valueWrite');
Mac OS X:
Linux
Windows
Copyright (C) 2013 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 488 weekly downloads. As such, noble popularity was classified as not 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
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.
Security News
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
Security News
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.