@project-chip/matter-node-ble.js v0.8.1

matter-node-ble.js

Matter BLE support using bleno for Peripheral/Device side and noble (not implemented yet) for Central/Controller side.

This package requires Node 16+

This package implements all needed Interfaces and classes to enable BLE Support for matter.js. It implements a class BluetoothNode which can be used as singleton Ble instance.

Prerquisites and Limitations

The used packages have some limitations and prerequisites. Please check the Readme's of the packages for more details:

• bleno
  • For Linux: also consider https://github.com/abandonware/bleno#running-on-linux
  • Bleno is currently not working on macOS because it can not announce the proper data because of macOS limitations!
• noble
  • Consider Noble prerequisites for your platform: https://github.com/abandonware/noble#prerequisites
  • For Linux: https://github.com/abandonware/noble#running-without-rootsudo-linux-specific
  • When using Device and Controller in parallel: https://github.com/abandonware/noble#bleno-compatibility-linux-specific (NOBLE_MULTI_ROLE might be needed to set)
  • Please also see common issues and solutions: https://github.com/abandonware/noble#common-problems

How to choose the HCI device (Linux)

You can optionally set an options object when instantiating BleNode. this object can have the following properties:

• hciId: HCI ID (number) of the HCI device to use. If not set, ID 0 is used

Building

• npm run build: Build all code and create CommonJS and ES6 variants in dist directory. This will built incrementally and only build the changed files.
• npm run build-clean: Clean the dist directory and build all code from scratch

Testing

• npm run test: Run all tests - TBD