Library for wireless advertising packet decoding. Currently supports the following protocols:

• Bluetooth Low Energy (BLE)
• reelyActive RFID

For a live, interactive version of advlib visit reelyactive.github.io/advlib.

This project was published in a scientific paper entitled Low-Power Wireless Advertising Software Library for Distributed M2M and Contextual IoT presented at the 2nd IEEE World Forum on Internet of Things (WF-IoT) in Milan, Italy on December 16th, 2015. See also our presentation BLE as Active RFID from IEEE RFID 2017 for a friendly overview of BLE advertising.

npm install advlib

var advlib = require('advlib');

var rawHexPacket = '421655daba50e1fe0201050c097265656c79416374697665';
var processedPacket = advlib.ble.process(rawHexPacket);

console.log(JSON.stringify(processedPacket, null, " "));

The console output should appear as follows:

{
  type: "ADVA-48",
  value: "fee150bada55",
  advHeader: { 
    type: "ADV_NONCONNECT_IND",
    length: 22,
    txAdd: "random",
    rxAdd: "public" 
  },
  advData: {
    flags: [ "LE Limited Discoverable Mode", "BR/EDR Not Supported" ],
    completeLocalName: "reelyActive" 
  } 
}

Process a raw packet (as a hexadecimal string) with the following command:

advlib.ble.process(rawHexPacket);

The library is organised hierarchically so that the separate elements of a packet can be processed individually. Refer to the index below for details on each element:

• Header
• Address
• Data (GAP)
  • Flags
  • UUID
  • Local Name
  • Tx Power
  • Slave Connection Interval Range
  • Solicitation
  • Service Data
  • Manufacturer Specific Data
  • Generic Data
• Data (GATT)
  • Member Services
  • Standard Services

Complementary to the packet processing hierarchy above is a common folder which contains supporting functions and lookups that are subject to frequent evolution:

• Common
  • Assigned Numbers
  • Manufacturers
  • Utilities

Process a 16-bit header (as a hexadecimal string) with the following command:

advlib.ble.header.process(rawHexHeader);

For reference, the 16-bit header is as follows (reading the hexadecimal string from left to right):

And the advertising packet types are as follows:

For example:

advlib.ble.header.process('4216');

would yield:

{
  rxAdd: "public",
  txAdd: "random",
  type: "ADV_NONCONNECT_IND",
  length: 22
}

Process a 48-bit address (as a hexadecimal string) with the following command:

advlib.ble.address.process(rawHexAddress);

For reference, the 48-bit header is as follows (reading the hexadecimal string from left to right):

This is best illustrated with an example:

advlib.ble.address.process('0123456789ab');

Would yield:

{
  type: "ADVA-48",
  value: "ab8967452301"
}

which can alternatively be represented as ab:89:67:45:23:01.

Process GAP data (as a hexadecimal string) with the following command:

advlib.ble.data.process(rawHexData);

For reference, the structure of the data is as follows:

The Generic Access Profile Data Types are listed on the Bluetooth GAP Assigned Numbers website. The following table lists the Data Types, their names and the section in this document in which they are described.

The following example illustrates the processing of a UUID:

var payload = '17074449555520657669746341796c656572';
advlib.ble.data.process(payload);

For reference, the example payload is interpreted as follows:

Which would return:

{ complete128BitUUIDs: "7265656c794163746976652055554944" }

It is also possible to process just the UUID:

var uuid = '4449555520657669746341796c656572';
advlib.ble.data.gap.uuid.process(uuid);

Which would simply return "7265656c794163746976652055554944".

The following example illustrates the processing of a local name:

var payload = '12097265656c79416374697665';
advlib.ble.data.process(payload);

For reference, the example payload is interpreted as follows:

Which would return:

{ completeLocalName: "reelyActive" }

It is also possible to process just the local name:

var name = '7265656c79416374697665';
advlib.ble.data.gap.localname.process(name);

Which would simply return "reelyActive".

The following example illustrates the processing of flags:

var payload = '020104';
advlib.ble.data.process(payload);

For reference, the example payload is interpreted as follows:

Which would return:

{ flags: [ 'BR/EDR Not Supported' ] }

For reference, the bits of the flags byte are as follows:

It is also possible to process just the flags byte:

var flags = '04';
advlib.ble.data.gap.flags.process(flags);

Which would simply return [ 'BR/EDR Not Supported' ].

The following example illustrates the processing of manufacturer specific data:

var payload = '03ff2805';
advlib.ble.data.process(payload);

For reference, the example payload is interpreted as follows:

Which would return:

{
  manufacturerSpecificData: {
    companyName: 'Lunera Inc.',
    companyIdentifierCode: '2805',
    data: ''
  }
}

The proprietary data of some manufacturers can be further processed. The data for those supported will automatically be processed. See the Manufacturers section for the list of all supported manufacturers.

It is also possible to process just the manufacturer specific data:

var data = '2805';
advlib.ble.data.gap.manufacturerspecificdata.process(data);

Which would return the following:

{
  companyName: 'Lunera Inc.',
  companyIdentifierCode: '0528',
  data: ''
}

The following example illustrates the processing of TX power level:

var payload = '020a7f';
advlib.ble.data.process(payload);

For reference, the example payload is interpreted as follows:

TxPower is a two's complement value which is interpreted as follows:

Which would return:

{ txPower: "127dBm" }

It is also possible to process just the TX power level:

var power = '7f';
advlib.ble.data.gap.txpower.process(power);

Which would return "127dBm".

The following example illustrates the processing of slave connection interval range:

var payload = '051200060c80';
advlib.ble.data.process(payload);

For reference, the example payload is interpreted as follows:

The intervals would be intepreted as follows:

Which would return:

{ slaveConnectionIntervalRange: "00060c80" }

The following example illustrates the processing of a service solicitation UUID:

var payload = '0314d8fe';
advlib.ble.data.process(payload);

For reference, the example payload is interpreted as follows:

Which would return:

{ solicitation16BitUUIDs: "fed8" }

It is also possible to process just the UUID:

var uuid = 'd8fe';
advlib.ble.data.gap.solicitation.process(uuid);

Which would simply return "fed8".

The following example illustrates the processing of service data:

var payload = '09160a181204eb150000';
advlib.ble.data.process(payload);

For reference, the example payload is interpreted as follows:

Which would return:

{
  serviceData: {
    uuid : "180a",
    data : "1204eb150000",
    specificationName: "Device Information"
  }
}

In this case, the service UUID represents one of the GATT Standard Services and is processed as such.

Additional examples for service UUIDs among the GATT Member Services are given in that section below.

It is also possible to process just the service data:

var data = '0a181204eb150000';
advlib.ble.data.gap.servicedata.process(data);

Which would simply return:

{
  uuid: '180a',
  data: '1204eb150000',
  specificationName: 'Device Information'
}

GATT service data is automatically processed when the Service Data GAP Type is present (see Service Data).

Based on the UUID, the serviceData will be parsed as either a member service or a standard service, as applicable. Note that not all services are yet implemented.

Based on a pilot program for members which allows the SIG to allocate a 16-bit Universally Unique Identifier (UUID) for use with a custom GATT-based service defined by the member.

Supports Eddystone (UID, URL, TLM & EID) and the UriBeacon of the Physical Web.

Process UriBeacon data (UUID = 0xfed8).

advlib.ble.data.gatt.services.members.process(advData);

This is best illustrated with an example using the following input:

advData: {
  serviceData: {
    uuid: "fed8",
    data: "00f2027265656c7961637469766507"
  }
}

For reference, the example serviceData.data is interpreted as follows, based on the UriBeacon Advertising Packet Specification:

Which would add the following properties to advData:

serviceData: {
  uuid: "fed8",
  data: "00f2027265656c7961637469766507",
  companyName: "Google​",
  uriBeacon: {
    invisibleHint: false,
    txPower: "-14dBm",
    url: "https://reelyactive.com"
  }
}

Process Eddystone-UID data (UUID = 0xfeaa).

advlib.ble.data.gatt.services.members.process(advData);

This is best illustrated with an example using the following input:

advData: {
  serviceData: {
    uuid: "feaa",
    data: "00128b0ca750095477cb3e770011223344550000"
  }
}

For reference, the example serviceData.data is interpreted as follows, based on the Eddystone-UID specification:

Which would add the following properties to advData:

serviceData: {
  uuid: "feaa",
  data: "00128b0ca750095477cb3e770011223344550000",
  eddystone: {
    type: "UID",
    txPower: "18dBm",
    uid: {
      namespace: "8b0ca750095477cb3e77",
      instance: "001122334455"
    }
  }
}

Process Eddystone-URL data (UUID = 0xfeaa).

advlib.ble.data.gatt.services.members.process(advData);

This is best illustrated with an example using the following input:

advData: {
  serviceData: { 
    uuid: "feaa",
    data: "1012027265656c7961637469766507" 
  }
}

For reference, the example serviceData.data is interpreted as follows, based on the Eddystone-URL specification:

Which would add the following properties to advData:

serviceData: {
  uuid: "feaa",
  data: "1012027265656c7961637469766507",
  eddystone: {
    type: "URL",
    txPower: "18dBm",
    url: "https://reelyactive.com"
  }
}

Process Eddystone-TLM data (UUID = 0xfeaa).

advlib.ble.data.gatt.services.members.process(advData);

This is best illustrated with an example using the following input:

advData: {
  serviceData: { 
    uuid: "feaa",
    data: "20000bb81800000000010000000a"  
  }
}

For reference, the example serviceData.data is interpreted as follows, based on the Eddystone-TLM specification, in this case Unencrypted TLM:

Which would add the following properties to advData:

serviceData: {
  uuid: 'feaa',
  data: '20000bb81800000000010000000a',
  eddystone: {
    type: "TLM",
    version: "00",
    batteryVoltage: "3000mV",
    temperature: "24C",
    advertisingCount: 1,
    uptime: "1s"
  }
}

Consider also the example of Encrypted TLM:

Which would add the following properties to advData:

serviceData: {
  uuid: 'feaa',
  data: '2001112233445566778899aabbcc0123abcd',
  eddystone: {
    type: "TLM",
    version: "01",
    etlm: "112233445566778899aabbcc",
    salt: "0123",
    mic: "abcd"
  }
}

Process Eddystone-EID data (UUID = 0xfeaa).

advlib.ble.data.gatt.services.members.process(advData);

This is best illustrated with an example using the following input:

advData: {
  serviceData: {
    uuid: "feaa",
    data: "30001122334455667788"
  }
}

For reference, the example serviceData.data is interpreted as follows, based on the Eddystone-EID specification:

Which would add the following properties to advData:

serviceData: {
  uuid: "feaa",
  data: "30001122334455667788",
  eddystone: {
    type: "EID",
    txPower: "0dBm",
    eid: "1122334455667788"
  }
}

Supports Estimote beacons that send additional data within a service. Note that Estimote Nearables use Manufacturer Specific Data instead of a service. The first byte of the service data specifies the type, of which there are two observed: location (0x00) and telemetry (0x12).

Process Estimote service data (UUID = 0xfe9a).

advlib.ble.data.gatt.services.members.process(advData);

Consider the following case.

This is best illustrated with an example using the following input:

advData: {
  serviceData: { 
    uuid: "fe9a",
    data: "12ceaac4fd251b1e350020c9010196f002" 
  }
}

Which would add the following property to advData:

serviceData: {
  uuid: "fe9a",
  data: "12ceaac4fd251b1e350020c9010196f002",
  estimote: {
    type: "telemetry",
    id: "ceaac4fd251b1e35",
    subtype: "00",
    accelerationX: 0.5,
    accelerationY: -0.859375,
    accelerationZ: 0.015625,
    statusBytes: [ "01", "96", "f0", "02" ]
  }
}

Supports the Minew S1, E6, E8 and i7 sensor beacons which send data within a service. Note that the service UUID 0xffe1 does not appear to be a valid member service granted by the Bluetooth SIG.

This is best illustrated with an example using the following input:

advData: {
  serviceData: { 
    uuid: "ffe1",
    data: "a1016416dc27fd0c04a03f23ac" 
  }
}

Which would add the following property to advData:

serviceData: {
  uuid: "ffe1",
  data: "a1016416dc27fd0c04a03f23ac",
  minew: {
    frameType: "a1",
    productModel: 1,
    batteryPercent: 100,
    temperature: 22.859375,
    humidity: 39.98828125,
    macAddress: "ac:23:3f:a0:04:0c"
  }
}

This is best illustrated with an example using the following input:

advData: {
  serviceData: { 
    uuid: "ffe1",
    data: "a1026401ff04a03f23ac" 
  }
}

Which would add the following property to advData:

serviceData: {
  uuid: "ffe1",
  data: "a1026401ff04a03f23ac",
  minew: {
    frameType: "a1",
    productModel: 2,
    batteryPercent: 100,
    visibleLight: true,
    macAddress: "ac:23:3f:a0:04:ff"
  }
}

This is best illustrated with an example using the following input:

advData: {
  serviceData: { 
    uuid: "ffe1",
    data: "a1036400d70087fffe5705a03f23ac" 
  }
}

Which would add the following property to advData:

serviceData: {
  uuid: "ffe1",
  data: "a1036400d70087fffe5705a03f23ac",
  minew: {
    frameType: "a1",
    productModel: 3,
    batteryPercent: 100,
    accelerationX: 0.83984375,
    accelerationY: 0.52734375,
    accelerationZ: -0.0078125,
    macAddress: "ac:23:3f:a0:05:57"
  }
}

This is best illustrated with an example using the following input:

advData: {
  serviceData: { 
    uuid: "ffe1",
    data: "a10864d739a03f23ac504c5553" 
  }
}

Which would add the following property to advData:

serviceData: {
  uuid: "ffe1",
  data: "a1036400d70087fffe5705a03f23ac",
  minew: {
    frameType: "a1",
    productModel: 8,
    batteryPercent: 100,
    macAddress: "ac:23:3f:a0:39:d7",
    name: "PLUS"
  }
}

The following GATT Services, assigned in the GATT Specification are identified but not parsed:

• Alert Notification Service
• Automation IO
• Battery Service
• Blood Pressure
• Body Composition
• Bond Management
• Continous Glucose Monitoring
• Current Time Service
• Cycling Power
• Cycling Speed and Cadence
• Device Information
• Environmental Sensing
• Generic Access
• Generic Attribute
• Glucose
• Health Thermometer
• Heart Rate
• Human Interface Device
• Immediate Alert
• Indoor Positioning
• Internet Protocol Support
• Link Loss
• Location and Navigation
• Next DST Change Service
• Phone Alert Status Service
• Pulse Oximeter
• Reference Time Update Service
• Running Speed and Cadence
• Scan Parameters
• TX Power
• User Data
• Weight Scale

Supporting functions and lookups that are subject to frequent evolution are:

• Assigned Numbers
• Manufacturers
• Utilities

The Bluetooth SIG maintains a list of assigned numbers. The advlib currently implements 16-bit UUIDs for Members and Company Identifiers.

The Bluetooth SIG maintains a list of company identifiers. Look up a company name from its 16-bit code.

advlib.ble.common.companyidentifiercodes.companyNames[companyCode];

For example:

advlib.ble.common.companyidentifiercodes.companyNames['000d'];

would yield:

"Texas Instruments Inc."

The Bluetooth SIG maintains a list of 16-bit UUIDs for Members, for members. In other words, this list is accessible to members. Look up a company name from its 16-bit service UUID.

advlib.ble.common.memberservices.companyNames[uuid];

For example:

advlib.ble.common.memberservices.companyNames['feed'];

would yield:

"Tile, Inc."

All functions and lookups which represent manufacturer-proprietary data contained in the Manufacturer Specific Data data type are included here. Each manufacturer is contained in a separate subfolder.

Process Apple-proprietary data from a packet's contained advertiser data.

advlib.ble.common.manufacturers.apple.process(advData);

The first byte of the proprietary data specifies the type:

A specific case of Apple-proprietary data is the iBeacon. Look up a licensee name from its 128-bit iBeacon UUID.

advlib.ble.common.manufacturers.apple.ibeacon.licenseeNames[uuid];

For example:

advlib.ble.common.manufacturers.apple.ibeacon.licenseeNames['f7826da64fa24e988024bc5b71e0893e'];

would yield:

"Kontakt.io"

Process an iBeacon packet from the contained advertiser data.

advlib.ble.common.manufacturers.apple.ibeacon.process(advData);

This is best illustrated with an example using the following input:

advData: {
  manufacturerSpecificData: {
    companyIdentifierCode: "004c",
    data: "0215b9407f30f5f8466eaff925556b57fe6d294c903974"
  }
}

For reference, the iBeacon payload is interpreted as follows:

Which would add the following property to advData:

manufacturerSpecificData: {
  iBeacon: {
    uuid: "b9407f30f5f8466eaff925556b57fe6d",
    major: "294c",
    minor: "9039",
    txPower: "116dBm",
    licenseeName: "Estimote"
  }
}

A specific case of Apple-proprietary data is AirDrop. Process an AirDrop packet from the contained advertiser data.

advlib.ble.common.manufacturers.apple.airdrop.process(advData);

This is best illustrated with an example using the following input:

advData: {
  manufacturerSpecificData: {
    companyIdentifierCode: "004c",
    data: "05120000000000000000011bc238fa0000000000"
  }
}

For reference, the AirDrop payload is interpreted as follows:

Which would add the following property to advData:

manufacturerSpecificData: {
  airdrop: { 
    length: 18,
    data: "0000000000000000011bc238fa0000000000"
  }
}

A specific case of Apple-proprietary data is AirPods. Process an AirPods packet from the contained advertiser data.

advlib.ble.common.manufacturers.apple.airpods.process(advData);

This is best illustrated with an example using the following input:

advData: {
  manufacturerSpecificData: {
    companyIdentifierCode: "004c",
    data: "071901022021880f00000049bcba4477206b0447472c771e53bbeb"
  }
}

For reference, the AirDrop payload is interpreted as follows:

Which would add the following property to advData:

manufacturerSpecificData: {
  airpods: { 
    length: 25,
    data: "01022021880f00000049bcba4477206b0447472c771e53bbeb"
  }
}

A specific case of Apple-proprietary data is AirPlay. Process an AirPlay packet from the contained advertiser data.

advlib.ble.common.manufacturers.apple.airplay.process(advData);

This is best illustrated with an example using the following input:

advData: {
  manufacturerSpecificData: {
    companyIdentifierCode: "004c",
    data: "09060200c0a80030"
  }
}

For reference, the AirPlay payload is interpreted as follows:

Which would add the following property to advData:

manufacturerSpecificData: {
  airplay: { 
    length: 6,
    role: "destination",
    data: "0200c0a80030"
  }
}

A specific case of Apple-proprietary data is Handoff. Process a Handoff packet from the contained advertiser data.

advlib.ble.common.manufacturers.apple.handoff.process(advData);

This is best illustrated with an example using the following input:

advData: {
  manufacturerSpecificData: {
    companyIdentifierCode: "004c",
    data: "0c0e0000041b59594de21ab6fbbb5cf6"
  }
}

For reference, the Handoff payload is interpreted as follows:

Which would add the following property to advData:

manufacturerSpecificData: {
  handoff: { 
    length: 14,
    data: "0000041b59594de21ab6fbbb5cf6"
  }
}

A specific case of Apple-proprietary data is Nearby. Process a Nearby packet from the contained advertiser data.

advlib.ble.common.manufacturers.apple.nearby.process(advData);

This is best illustrated with an example using the following input:

advData: {
  manufacturerSpecificData: {
    companyIdentifierCode: "004c",
    data: "10020100"
  }
}

For reference, the Nearby payload is interpreted as follows:

Which would add the following property to advData:

manufacturerSpecificData: {
  nearby: { 
    length: 2,
    data: "0100"
  }
}

Process StickNFind-proprietary data from a packet's contained advertiser data.

advlib.ble.common.manufacturers.sticknfind.process(advData);

The first byte of the proprietary data specifies the type:

Process Estimote-proprietary data from a packet's contained advertiser data.

advlib.ble.common.manufacturers.estimote.process(advData);

A specific case of Estimote-proprietary data is the Nearable. In the absence of official documentation, advlib assumes that all Estimote-proprietary data represents a Nearable and is interpreted based on experimentally-observed behaviour. Kindly advise or submit a pull request should official documentation be made available.

This is best illustrated with an example using the following input:

advData: {
  manufacturerSpecificData: {
    companyIdentifierCode: "015d",
    data: "012b9e3834cfbfaa710401acc1b202ff3f000353"
}

Which would add the following property to advData:

manufacturerSpecificData: {
  nearable: {
    id: "2b9e3834cfbfaa71",
    temperature: 26.75,
    currentState: "still",
    accelerationX: 0.03125,
    accelerationY: -0.015625,
    accelerationZ: 0.984375,
    currentStateSeconds: 0,
    previousStateSeconds: 3,
    statusBytes: [ "01", "04", "01", "c1", "b2", "53" ]
  }
}

Process an AltBeacon packet from the contained advertiser data.

advlib.ble.common.manufacturers.radiusnetworks.altbeacon.process(advData);

This is best illustrated with an example using the following input:

advData: {
  manufacturerSpecificData: {
    companyIdentifierCode: "0118",
    data: "beac00010203040506070809101112131415161718190069"
  }
}

For reference, the AltBeacon payload is interpreted as follows:

Which would add the following property to advData:

manufacturerSpecificData: {
  altBeacon: {
    id: "0001020304050607080910111213141516171819",
    refRSSI: "0dBm",
    mfgReserved: "69"
  }
}

More info to come.

Process a raw packet (as a hexadecimal string) with the following command:

advlib.reelyactive.process(rawHexPacket);

This is an active work in progress. Expect regular changes and updates, as well as improved documentation! If you'd like to contribute, kindly read our Node.js style guide and contact us or make a pull request.

MIT License

Copyright (c) 2015-2018 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.