{"id":26187137,"url":"https://github.com/reelyactive/barnowl-noble","last_synced_at":"2026-03-01T07:34:19.418Z","repository":{"id":275498630,"uuid":"926213147","full_name":"reelyactive/barnowl-noble","owner":"reelyactive","description":"Collect ambient Bluetooth Low Energy device data using the noble Node.js BLE Central module.  We believe in an open Internet of Things.","archived":false,"fork":false,"pushed_at":"2025-11-07T14:36:58.000Z","size":138,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-11-07T16:22:18.770Z","etag":null,"topics":["bluetooth-low-energy","gatt","noble","pareto-anywhere","raddec"],"latest_commit_sha":null,"homepage":"https://www.reelyactive.com/pareto/anywhere/","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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-02-02T20:13:07.000Z","updated_at":"2025-11-07T14:37:02.000Z","dependencies_parsed_at":null,"dependency_job_id":"7f7afdc5-5e6d-4595-ae26-652d41b57639","html_url":"https://github.com/reelyactive/barnowl-noble","commit_stats":null,"previous_names":["reelyactive/barnowl-noble"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/reelyactive/barnowl-noble","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Fbarnowl-noble","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Fbarnowl-noble/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Fbarnowl-noble/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Fbarnowl-noble/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/reelyactive","download_url":"https://codeload.github.com/reelyactive/barnowl-noble/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Fbarnowl-noble/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29964177,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-01T06:55:38.174Z","status":"ssl_error","status_checked_at":"2026-03-01T06:53:04.810Z","response_time":124,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["bluetooth-low-energy","gatt","noble","pareto-anywhere","raddec"],"created_at":"2025-03-11T23:39:16.561Z","updated_at":"2026-03-01T07:34:19.389Z","avatar_url":"https://github.com/reelyactive.png","language":"JavaScript","funding_links":["https://www.buymeacoffee.com/stoprocent"],"categories":[],"sub_categories":[],"readme":"barnowl-noble\n=============\n\n__barnowl-noble__ collects data from ambient Bluetooth Low Energy devices using the noble BLE _Central_ module for Node.js, transforming it into standard developer-friendly JSON that is vendor/technology/application-agnostic.\n\n![Overview of barnowl-noble](https://reelyactive.github.io/barnowl-noble/images/overview.png)\n\n__barnowl-noble__ is a lightweight [Node.js package](https://www.npmjs.com/package/barnowl-noble) that can run on resource-constrained edge devices.  It can [forward data](#pareto-anywhere-integration) to reelyActive's [Pareto Anywhere](https://www.reelyactive.com/pareto/anywhere/) open source middleware suite, and can just as easily be run standalone behind a [barnowl](https://github.com/reelyactive/barnowl) instance, as detailed in the code examples below.\n\n\nbarnowl-noble vs. barnowl-hci\n-----------------------------\n\n__barnowl-noble__ and [barnowl-hci](https://github.com/reelyactive/barnowl-hci) are similar in functionality in that they both collect ambient Blutooth Low Energy data, however each implements a different _role_:\n- __barnowl-noble__ implements the _Central_ role\n- __barnowl-hci__ implements the _Observer_ role\n\nUse __barnowl-noble__ when data must be collected by connecting to peripherals and interacting with their characteristics (see [Supported Services and Peripheral Devices](#supported-services-and-peripheral-devices) below).\n\nUse __barnowl-hci__ when data is to be collected from advertising packets alone.\n\nDo not use __barnowl-noble__ and __barnowl-hci__ on the same Bluetooth adapter simultaneously.\n\n\nPareto Anywhere Integration\n---------------------------\n\nA common application of __barnowl-noble__ is to collect Bluetooth Low Energy device data for [pareto-anywhere](https://github.com/reelyactive/pareto-anywhere) using an onboard BLE radio or adapter.  Simply follow our [Create a Pareto Anywhere startup script](https://reelyactive.github.io/diy/pareto-anywhere-startup-script/) tutorial using the script below:\n\n```javascript\n#!/usr/bin/env node\n\nconst ParetoAnywhere = require('../lib/paretoanywhere.js');\n\n// Edit the options to customise the server\nconst BARNOWL_NOBLE_OPTIONS = {};\n\n// ----- Exit gracefully if the optional dependency is not found -----\nlet BarnowlNoble;\ntry {\n  BarnowlNoble = require('barnowl-noble');\n}\ncatch(err) {\n  console.log('This script requires barnowl-noble.  Install with:');\n  console.log('\\r\\n    \"npm install barnowl-noble\"\\r\\n');\n  return console.log('and then run this script again.');\n}\n// -------------------------------------------------------------------\n\nlet pa = new ParetoAnywhere();\npa.barnowl.addListener(BarnowlNoble, {},\n                       BarnowlNoble.DefaultListener, BARNOWL_NOBLE_OPTIONS);\n```\n\n### Alternative Integration\n\n__barnowl-noble__ also includes a script to forward data to a local [Pareto Anywhere](https://www.reelyactive.com/pareto/anywhere/) instance as UDP raddecs with target localhost:50001.  Start this script with the command:\n\n    npm run forwarder\n\nTo instead forward UDP raddecs to a _remote_ Pareto Anywhere instance, start this script with the command:\n\n    npm run forwarder xxx.xxx.xxx.xxx\n\nwhere xxx.xxx.xxx.xxx is the IP address of the remote instance.\n\n__Note:__ Any GATT data collected by __barnowl-noble__ will be lost using this approach as `protocolSpecificData` is _not_ currently supported in UDP-encoded raddecs.\n\n\nQuick Start\n-----------\n\nClone this repository and install package dependencies with `npm install`.  If installation fails on your system, validate [these installation requirements](#installation-requirements).\n\nThen from the root folder run at any time:\n\n    npm start\n\nIf you observe a permissions error (ex: EPERM), either [assign the necessary privileges](#assigning-privileges) (recommended) or run as root (_not_ recommended).  __barnowl-node__ will set the local Bluetooth radio to scan and print any processed [raddec](https://github.com/reelyactive/raddec) data to the console.\n\n\nSupported Services and Peripheral Devices\n-----------------------------------------\n\n__barnowl-noble__ supports the following Bluetooth services and peripheral devices:\n\n| Service UUID                         | Peripheral devices  |\n|:-------------------------------------|:--------------------|\n| 1c930001-d459-11e7-9296-b8e856369374 | Sensor-Works BluVib |\n\n\nSupported BLE Hardware\n----------------------\n\n__barnowl-noble__ nominally supports any Bluetooth Low Energy device supported by [noble](https://www.npmjs.com/package/@stoprocent/noble).  This includes the onboard BLE radio of many computers such as the Raspberry Pi, modern laptops, etc.  However, _shared_ BLE radios, such as onboard variants, are subject to other processes leveraging their functionality, potentially impacting performance and/or reliability.\n\nFor always-on/high-availability applications, the use of a dedicated BLE radio, such as a USB dongle, is recommended.  The following devices have been validated with __barnowl-noble__:\n\n| Model | Make     | Type                                                     |\n|:------|:---------|:---------------------------------------------------------|\n| BP119 | Feasycom | USB BLE 4.0 adapter (HCI), external antenna, CSR8510A10 chipset |\n\n\nAssigning Privileges\n--------------------\n\nIf required, assign the necessary privileges for Node.js to initiate a HCI scan on the given OS with the command:\n\n    npm run privileges\n\nOn Linux systems (such as the Raspberry Pi) this will run the following command to grant __cap_net_raw__ privileges so that _any_ Linux user may start a scan.\n\n    sudo setcap cap_net_raw+eip $(eval readlink -f `which node`)\n\n\nInstallation Requirements\n-------------------------\n\n__barnowl-noble__ depends on the [noble](https://www.npmjs.com/package/@stoprocent/noble) package which _does not_ support all operating systems.  If your OS _is_ supported but a precompiled binary does not exist, npm will attempt to compile the binary using [node-gyp](https://www.npmjs.com/package/node-gyp) (which may need to be installed).\n\nOn Ubuntu/Debian Linux distributions, if node-gyp throws errors during installation, the _make_ and _g++_ prerequisites for compilation may need to first be installed with `sudo apt install make` and `sudo apt install build-essential` respectively.\n\n\nAcknowledgements\n----------------\n\n__barnowl-noble__ is based on the [@stoprocent/noble](https://www.npmjs.com/package/@stoprocent/noble) open source Node.js package whose maintainer we invite you to consider supporting at [buymeacoffee.com/stoprocent](https://www.buymeacoffee.com/stoprocent).\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) 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%2Fbarnowl-noble","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freelyactive%2Fbarnowl-noble","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freelyactive%2Fbarnowl-noble/lists"}