webbluetooth
Advanced tools
Changelog
Readme
Node.js implementation of the Web Bluetooth Specification
Node.js > v10.20.0, which includes npm.
$ npm install webbluetooth
See the examples or view the API documentation at:
https://thegecko.github.io/webbluetooth/
The module exports a default navigator.bluetooth instance, the Bluetooth class to allow you to instantiate your own bluetooth instances and the Bluetooth helper methods:
To use existing Web Bluetooth scripts, you can simply use the default bluetooth instance in place of the navigator.bluetooth object:
const bluetooth = require('webbluetooth').bluetooth;
const device = await bluetooth.requestDevice({
filters:[{ services:[ 'heart_rate' ] }]
});
const server = await device.gatt.connect();
...
The first device matching the filters will be returned.
You may want to create your own instance of the Bluetooth class. For example, to inject a device chooser function or control the referring device:
const Bluetooth = require('webbluetooth').Bluetooth;
const deviceFound = (device, selectFn) => {
// If device can be automatically selected, do so by returning true
if (device.name === 'myName') return true;
// Otherwise store the selectFn somewhere and execute it later to select this device
};
const bluetooth = new Bluetooth({ deviceFound });
const device = await bluetooth.requestDevice({
filters:[{ services:[ 'heart_rate' ] }]
});
const server = await device.gatt.connect();
...
The Web Bluetooth specification can be found here:
https://webbluetoothcg.github.io/web-bluetooth/
This repository uses a submodule to reference the SimpleBLE library. Clone it as follows:
git clone https://github.com/thegecko/webbluetooth
cd webbluetooth
git submodule update --init
To build the SimpleBLE module, bindings and TypeScriptsource, run:
yarn build:all
The tests are set up to use a BBC micro:bit in range with the following services available:
Firmware for this hardware including the services can be found here: https://microbit.org/get-started/user-guide/firmware/
To run the tests:
yarn test
FAQs
Node.js implementation of the Web Bluetooth Specification
We found that webbluetooth demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer 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
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).
Security News
LDAPjs, an LDAP Client and Server API for Node.js, was decommissioned after its maintainer received an abusive email from a user, raising concerns about this form of abuse as a potential attack vector.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.