Package Exports

barnowl-hci

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (barnowl-hci) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

barnowl-hci

Interface the Bluetooth Host Controller Interface to barnowl open source software. We believe in an open Internet of Things.

Installation

npm install barnowl-hci

Hello barnowl-hci!

The following code will listen to simulated hardware and output packets to the console:

const BarnowlHci = require('barnowl-hci');

let barnowl = new BarnowlHci();

barnowl.addListener(BarnowlHci.TestListener, {});

barnowl.on("raddec", function(raddec) {
  console.log(raddec);
});

barnowl.on("infrastructureMessage", function(message) {
  console.log(message);
});

Supported Listener Interfaces

The following listener interfaces are supported.

Socket

Listen on a local Bluetooth HCI interface. Check the bluetooth-hci-socket package for prerequisites specific to the target platform. Note that not all platforms are supported. It may be required to grant additional user privileges, or else run as super user (at your own risk).

barnowl.addListener(BarnowlHci.SocketListener, {});

Test

Provides a steady stream of simulated reel packets for testing purposes.

barnowl.addListener(BarnowlHci.TestListener, {});

License

MIT License

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.