Wondering what’s next for npm?Check out our public roadmap! »

    advlib-ble

    1.0.0 • Public • Published

    advlib-ble

    Wireless advertising packet decoding library for Bluetooth Low Energy. advlib-ble can be used standalone or, more commonly, as a processor module of the protocol-agnostic advlib library.

    advlib-ble is a lightweight Node.js package that implements the Core Bluetooth Specification and can be extended with libraries to decode service data and manufacturer-specific data outside of this specification.

    Library Decodes
    advlib-ble-services Service Data
    advlib-ble-manufacturers Manufacturer-Specific Data

    Installation

    npm install advlib-ble
    

    Hello advlib-ble!

    const advlib = require('advlib-ble');
     
    const LIBRARIES = [ require('advlib-ble-services'),
                        require('advlib-ble-manufacturers') ];
     
    let packet = 'c21d04acbe55daba16096164766c6962206279207265656c79416374697665';
    let processedPacket = advlib.process(packet, LIBRARIES);
     
    console.log(processedPacket);

    Which should yield the following console output:

    { rxAdd: "random",
      txAdd: "random",
      type: "ADV_NONCONN_IND",
      length: 29,
      advA: "bada55beac04",
      name: "advlib by reelyActive" }
    

    Options

    advlib-ble supports the following options for its process function:

    Property Default Description
    ignoreProtocolOverhead false Ignore BLE-specific properties (txAdd, length, type, advA, etc.)

    For example, to ignore the Bluetooth Low Energy protocol overhead:

    let packet = 'c21d04acbe55daba16096164766c6962206279207265656c79416374697665';
    let options = { ignoreProtocolOverhead: true };
    let processedPacket = advlib.process(packet, [], options);

    Which should yield the following console output:

    { name: "advlib by reelyActive" }
    

    License

    MIT License

    Copyright (c) 2015-2020 reelyActive

    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.

    Install

    npm i advlib-ble

    DownloadsWeekly Downloads

    1

    Version

    1.0.0

    License

    MIT

    Unpacked Size

    42.9 kB

    Total Files

    13

    Last publish

    Collaborators

    • avatar