@csllc/noble-ble v1.0.0

noble-ble

A thin wrapper around @abandonware/noble to standardize its interface. This allows an application using this package to incorporate noble, or another BLE platform manager (see @csllc/rn-ble, etc)

The principles all these wrappers have in common are:

• Common public functional interfaces (methods starting with '_' are considered private and are not expected to be called by the user of this package)
• Promise-based interfaces for consistency (even if the underlying BLE driver is synchronous)
• The wrapper should resolve any lower-level driver gotchas. Case-sensitivity of UUIDs is one example of something that is not standardized among BLE drivers. The user of this wrapper should be able to specify UUIDs and expect them to be handled in a case-insensitive way.
• The wrapper should not fail to npm install even if it does not support the current operating system. The user can call the .isSupported() method at run time to see if BLE services are available
• The wrapper should supply opaque objects like 'peripheral' and 'characteristic' to the user, and the user should reference them when requesting services. For example, the user might request access to a given characterisitic UUID. This wrapper passes back an opaque 'characteristic' object. The user should not need to modify or inspect the returned object, but instead just passes it back when needed (for example, to subscribe to that characteristic).
• There is likely a need for the user to extract certain information about the peripherals or characteristics; implementation of common inspection methods is left for future development.

Logging

For debug purposes, a logging instance can be passed in to the .initialize({logger: myLoggerInstance }) function. This logger should be compatible with a winston instance, and npm-style log levels will be used. For example, outputting an info-level message, we will call: logger.log('info', 'This is some good info');

Example Use

See the examples folder for complete functional examples.

Access to native driver

While the wrapper attempts to abstract away the hardware/lower level driver details, it is not always practical. Using the .driver() method, the user can access the underlying driver.

const Ble = require('@csllc/noble-ble');

var driver = Ble.driver();

if( driver ) {
  driver.doSomethingDriverSpecific();
}