@stoprocent/bluetooth-hci-socket v2.2.3

node-bluetooth-hci-socket

Bluetooth HCI socket binding for Node.js

NOTE: Currently only supports Linux, FreeBSD, Windows or any operating systems when using HCI over uart.

About This Fork

This fork of node-bluetooth-hci-socket exists to introduce several important improvements and address compatibility issues across different operating systems.

1. System-independent UART HCI driver: I have introduced a driver that allows UART HCI dongles to be used seamlessly across any operating system, making the library much more flexible and portable.

2. Rewriting Native Code: The C++ native binding code has been fully rewritten from Nan to N-API, ensuring long-term compatibility with modern versions of Node.js. Along with this, I have also resolved numerous issues that plagued the original code, improving both stability and performance.

If you value these contributions and the ongoing maintenance of this project, please consider supporting my work.

Install

npm install @stoprocent/bluetooth-hci-socket

Usage

Typescript

// Default - Auto-selected
import BluetoothHciSocket from "@stoprocent/bluetooth-hci-socket";
// ... or specific driver
import { loadDriver } from "@stoprocent/bluetooth-hci-socket";

Javascript

const BluetoothHciSocket = require('@stoprocent/bluetooth-hci-socket');

There are two ways to use this module:

1. Default (Automatic) Driver Selection

const socket = new BluetoothHciSocket();

This will automatically select the appropriate driver based on your platform and environment:

• UART driver if UART port or force UART is configured
• USB driver on Windows/FreeBSD or if force USB is configured
• Native HCI driver on Linux/Android

2. Explicit Driver Selection

Typescript

import { loadDriver } from "@stoprocent/bluetooth-hci-socket";

const BluetoothHciSocketUart = loadDriver('uart');
const socket = new BluetoothHciSocketUart();

Javascript

const { loadDriver } = require('@stoprocent/bluetooth-hci-socket');

// Choose specific driver
const UartBluetoothHciSocket = loadDriver('uart');
const socket = new UartBluetoothHciSocket();

const UsbBluetoothHciSocket = loadDriver('usb');
const socket = new UsbBluetoothHciSocket();

const NativeBluetoothHciSocket = loadDriver('native');
const socket = new NativeBluetoothHciSocket();

Available driver types:

• 'uart' - UART/Serial driver (works on any OS)
• 'usb' - USB driver (Windows/FreeBSD)
• 'native' - Native driver (Linux/Android)

Prerequisites

• node-gyp requirements

NOTE: node-gyp is only required if the npm cannot find binary for your OS version otherwise the binaries are prebuilt.

UART/Serial (Any OS)

The reason to use this configuration is more universal transport that can work across multiple operating systems. Idea is to use Zephyr HCI over UART firmware and to interface with HCI over UART.

How to use this?

1. You will need for example NRF52 module (e.g. nRF52840 DK or nRF52840 USB) or ESP32-WROOM-32
2. Follow the instructions in the misc/esp32 for ESP32 or misc/nrf52840 for NRF52840.
3. Enjoy BLE on any OS.

Linux

• Bluetooth 4.0 Adapter

Note: the node-usb dependency might fail install, this is ok, because it is an optional optional dependency. Installing libudev-dev via your Linux distribution's package manager will resolve the problem.

Windows

This library needs raw USB access to a Bluetooth 4.0 USB adapter, as it needs to bypass the Windows Bluetooth stack.

A WinUSB driver is required, use Zadig tool to replace the driver for your adapter.

WARNING: This will make the adapter unavailable in Windows Bluetooth settings! To roll back to the original driver go to: Device Manager -> Open Device -> Update Driver Note:

• that one should select "Delete the driver software for this device" as per Zadig instructions if the generation of the system restoral point by Zadig fails if one wishes to use restore system restoral point as an option.

Compatible Bluetooth 4.0 USB Adapter's

Compatible Bluetooth 4.1 USB Adapter's

Actions

Create

var bluetoothHciSocket = new BluetoothHciSocket();

Set Filter

var filter = new Buffer(14);

// ...

bluetoothHciSocket.setFilter(filter);

Note: setFilter is not required if bindRaw is used.

Bind

Raw Channel

bluetoothHciSocket.bindRaw(deviceId); // optional deviceId (integer)

User Channel

bluetoothHciSocket.bindUser(deviceId); // optional deviceId (integer)

Requires the device to be in the powered down state (sudo hciconfig hciX down).

Control Channel

bluetoothHciSocket.bindControl();

Is Device Up

Query the device state.

var isDevUp = bluetoothHciSocket.isDevUp(); // returns: true or false

Note: must be called after bindRaw.

Start/stop

Start or stop event handling:

bluetoothHciSocket.start();

// ...

bluetoothHciSocket.stop();

Note: must be called after bindRaw or bindControl.

Write

var data = new Buffer(/* ... */);

// ...


bluetoothHciSocket.write(data);

Note: must be called after bindRaw or bindControl.

Events

Data

bluetoothHciSocket.on('data', function(data) {
  // data is a Buffer

  // ...
});

Error

bluetoothHciSocket.on('error', function(error) {
  // error is a Error

  // ...
});

Examples

See examples folder for code examples.

Platform Notes

Linux

Force Raw USB mode

Unload btusb kernel module:

sudo rmmod btusb

Set BLUETOOTH_HCI_SOCKET_FORCE_USB environment variable:

sudo BLUETOOTH_HCI_SOCKET_FORCE_USB=1 node <file>.js

FreeBSD

Disable automatic loading of the default Bluetooth stack by putting no-ubt.conf into /usr/local/etc/devd/no-ubt.conf and restarting devd (sudo service devd restart).

Unload ng_ubt kernel module if already loaded:

sudo kldunload ng_ubt

OS X

Disable CSR USB Driver

sudo kextunload -b com.apple.iokit.CSRBluetoothHostControllerUSBTransport

Disable Broadcom USB Driver

sudo kextunload -b com.apple.iokit.BroadcomBluetoothHostControllerUSBTransport

Windows

Force adapter USB VID and PID

Set BLUETOOTH_HCI_SOCKET_USB_VID and BLUETOOTH_HCI_SOCKET_USB_PID environment variables.

Example for USB device id: 050d:065a:

set BLUETOOTH_HCI_SOCKET_USB_VID=0x050d
set BLUETOOTH_HCI_SOCKET_USB_PID=0x065a

node <file>.js