{"id":22859993,"url":"https://github.com/reelyactive/advlib-ble","last_synced_at":"2026-03-03T14:35:57.201Z","repository":{"id":57148364,"uuid":"294706545","full_name":"reelyactive/advlib-ble","owner":"reelyactive","description":"Open source library for decoding ambient Bluetooth Low Energy (BLE) advertising packets.  We believe in an open Internet of Things.","archived":false,"fork":false,"pushed_at":"2025-02-20T02:32:40.000Z","size":196,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-21T03:05:35.484Z","etag":null,"topics":["advlib","ble","bluetooth-library","bluetooth-low-energy","node-js","packet-decoding","pareto-anywhere"],"latest_commit_sha":null,"homepage":"https://www.reelyactive.com/ambient-data/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/reelyactive.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null}},"created_at":"2020-09-11T13:44:17.000Z","updated_at":"2025-02-20T02:32:44.000Z","dependencies_parsed_at":"2023-01-22T01:49:35.398Z","dependency_job_id":null,"html_url":"https://github.com/reelyactive/advlib-ble","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Fadvlib-ble","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Fadvlib-ble/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Fadvlib-ble/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Fadvlib-ble/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/reelyactive","download_url":"https://codeload.github.com/reelyactive/advlib-ble/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247033813,"owners_count":20872532,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["advlib","ble","bluetooth-library","bluetooth-low-energy","node-js","packet-decoding","pareto-anywhere"],"created_at":"2024-12-13T09:08:37.539Z","updated_at":"2026-03-03T14:35:52.167Z","avatar_url":"https://github.com/reelyactive.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"advlib-ble\n==========\n\nWireless 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](https://github.com/reelyactive/advlib) library.\n\n![Overview of advlib-ble](https://reelyactive.github.io/advlib-ble/images/overview.png)\n\n__advlib-ble__ is a lightweight [Node.js package](https://www.npmjs.com/package/advlib-ble) that implements the Core Bluetooth Specification and can be extended with libraries to decode service data and manufacturer-specific data outside of this specification.\n\n| Library | Decodes |\n|:--------|:--------|\n| [advlib-ble-services](https://github.com/reelyactive/advlib-ble-services) | Service Data |\n| [advlib-ble-manufacturers](https://github.com/reelyactive/advlib-ble-manufacturers) | Manufacturer-Specific Data |\n| [advlib-ble-gatt](https://github.com/reelyactive/advlib-ble-gatt) | GATT Protocol-Specific Data |\n\n\nInstallation\n------------\n\n    npm install advlib-ble\n\n\nHello advlib-ble!\n-----------------\n\n```javascript\nconst advlib = require('advlib-ble');\n\nconst LIBRARIES = [ require('advlib-ble-services'),\n                    require('advlib-ble-manufacturers'),\n                    require('advlib-ble-gatt' ];\n\nlet packet = 'c21d04acbe55daba16096164766c6962206279207265656c79416374697665';\nlet processedPacket = advlib.process(packet, LIBRARIES);\n\nconsole.log(processedPacket);\n```\n\nWhich should yield the following console output:\n\n    { rxAdd: \"random\",\n      txAdd: \"random\",\n      type: \"ADV_NONCONN_IND\",\n      length: 29,\n      advA: \"bada55beac04\",\n      name: \"advlib by reelyActive\" }\n\n\nOptions\n-------\n\n__advlib-ble__ supports the following options for its process function:\n\n| Property               | Default | Description                         | \n|:-----------------------|:--------|:------------------------------------|\n| ignoreProtocolOverhead | false   | Ignore BLE-specific properties (txAdd, length, type, advA, etc.) |\n| isPayloadOnly          | false   | Interpret data as the optional PDU payload only (i.e. without header or advertiser address) |\n| indices                | []      | URI-lookup indices such as Sniffypedia |\n\nFor example, to ignore the Bluetooth Low Energy protocol overhead:\n\n```javascript\nlet packet = 'c21d04acbe55daba16096164766c6962206279207265656c79416374697665';\nlet options = { ignoreProtocolOverhead: true };\nlet processedPacket = advlib.process(packet, [], options);\n```\n\nWhich should yield the following console output:\n\n    { name: \"advlib by reelyActive\" }\n\nIf only the payload is available, the example above would be handled as follows:\n\n```javascript\nlet payload = '16096164766c6962206279207265656c79416374697665';\nlet options = { isPayloadOnly: true };\nlet processedPayload = advlib.process(packet, [], options);\n```\n\nWhich should again yield the following console output:\n\n    { name: \"advlib by reelyActive\" }\n\nFor example, to append implicit URIs using the Sniffypedia index:\n\n```javascript\nlet packet = '401490a3a947507b02011a0aff4c0010050a10b4f1e2';\nlet options = { indices: [ require('sniffypedia') ] };\nlet processedPacket = advlib.process(packet, [], options);\n```\n\nWhich should yield the following console output:\n\n    { uri: \"https://sniffypedia.org/Organization/Apple_Inc/\" }\n\n\nContributing\n------------\n\nDiscover [how to contribute](CONTRIBUTING.md) to this open source project which upholds a standard [code of conduct](CODE_OF_CONDUCT.md).\n\n\nSecurity\n--------\n\nConsult our [security policy](SECURITY.md) for best practices using this open source software and to report vulnerabilities.\n\n\nLicense\n-------\n\nMIT License\n\nCopyright (c) 2015-2025 [reelyActive](https://www.reelyactive.com)\n\nPermission 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:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR \nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, \nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE \nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER \nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, \nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN \nTHE SOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freelyactive%2Fadvlib-ble","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freelyactive%2Fadvlib-ble","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freelyactive%2Fadvlib-ble/lists"}