{"id":22859979,"url":"https://github.com/reelyactive/barnowl-reel","last_synced_at":"2026-02-16T07:31:41.868Z","repository":{"id":57189189,"uuid":"144009280","full_name":"reelyactive/barnowl-reel","owner":"reelyactive","description":"Collect ambient Bluetooth Low Energy packets from reelyActive reelceivers for real-time location and sensing.  We believe in an open Internet of Things.","archived":false,"fork":false,"pushed_at":"2025-02-05T23:06:23.000Z","size":170,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-11-04T03:19:05.353Z","etag":null,"topics":["barnowl","pareto-anywhere","raddec","reel","reelceiver","reelyactive","rtls"],"latest_commit_sha":null,"homepage":"https://www.reelyactive.com/products/gateways/","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}},"created_at":"2018-08-08T12:17:10.000Z","updated_at":"2025-02-05T23:06:27.000Z","dependencies_parsed_at":"2025-04-14T10:52:03.983Z","dependency_job_id":"933b8ce1-37fb-41ca-9946-46e5e72bf16d","html_url":"https://github.com/reelyactive/barnowl-reel","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/reelyactive/barnowl-reel","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Fbarnowl-reel","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Fbarnowl-reel/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Fbarnowl-reel/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Fbarnowl-reel/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/reelyactive","download_url":"https://codeload.github.com/reelyactive/barnowl-reel/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Fbarnowl-reel/sbom","scorecard":{"id":768420,"data":{"date":"2025-08-11","repo":{"name":"github.com/reelyactive/barnowl-reel","commit":"e4f7ba709195a74650df2028e8eb451f00ad0711"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.9,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Security-Policy","score":10,"reason":"security policy file detected","details":["Info: security policy file detected: SECURITY.md:1","Info: Found linked content: SECURITY.md:1","Info: Found disclosure, vulnerability, and/or timelines in security policy: SECURITY.md:1","Info: Found text in security policy: SECURITY.md:1"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}}]},"last_synced_at":"2025-08-23T01:32:24.309Z","repository_id":57189189,"created_at":"2025-08-23T01:32:24.309Z","updated_at":"2025-08-23T01:32:24.309Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29502934,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-16T05:57:17.024Z","status":"ssl_error","status_checked_at":"2026-02-16T05:56:49.929Z","response_time":115,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5: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":["barnowl","pareto-anywhere","raddec","reel","reelceiver","reelyactive","rtls"],"created_at":"2024-12-13T09:08:35.469Z","updated_at":"2026-02-16T07:31:41.851Z","avatar_url":"https://github.com/reelyactive.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"barnowl-reel\n============\n\n__barnowl-reel__ converts RF decodings from [reelyActive reels](https://www.reelyactive.com/technology/reel/) into standard developer-friendly JSON that is vendor/technology/application-agnostic.\n\n![Overview of barnowl-reel](https://reelyactive.github.io/barnowl-reel/images/overview.png)\n\n__barnowl-reel__ is a lightweight [Node.js package](https://www.npmjs.com/package/barnowl-reel) that can run on resource-constrained edge devices as well as on powerful cloud servers and anything in between.  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\nQuick Start\n-----------\n\nClone this repository and install package dependencies with `npm install`.  Then from the root folder run at any time:\n\n    npm start\n\n__barnowl-reel__ will listen for reel UDP packets on port 50000 and output (flattened) __raddec__ JSON to the console.\n\n\nHello barnowl-reel!\n-------------------\n\nThe following code will listen to _simulated_ hardware and output packets to the console:\n\n```javascript\nconst BarnowlReel = require('barnowl-reel');\n\nlet barnowl = new BarnowlReel();\n\nbarnowl.addListener(BarnowlReel.TestListener, {});\n\nbarnowl.on(\"raddec\", function(raddec) {\n  console.log(raddec);\n});\n\nbarnowl.on(\"infrastructureMessage\", function(message) {\n  console.log(message);\n});\n```\n\nAs output you should see a stream of [raddec](https://github.com/reelyactive/raddec/) objects similar to the following:\n\n```javascript\n{\n  transmitterId: \"fee150bada55\",\n  transmitterIdType: 3,\n  rssiSignature: [\n    {\n      receiverId: \"001bc50940810000\",\n      receiverIdType: 1,\n      rssi: -83,\n      numberOfDecodings: 1\n    },\n    {\n      receiverId: \"001bc50940810001\",\n      receiverIdType: 1,\n      rssi: -91,\n      numberOfDecodings: 1\n    }\n  ],\n  packets: [ '421655daba50e1fe0201050c097265656c79416374697665' ],\n  timestamp: 1547693457133\n}\n```\n\nRegardless of the underlying RF protocol and hardware, the [raddec](https://github.com/reelyactive/raddec/) specifies _what_ (transmitterId) is _where_ (receiverId \u0026 rssi), as well as _how_ (packets) and _when_ (timestamp).\n\n\nIs that owl you can do?\n-----------------------\n\nWhile __barnowl-reel__ may suffice standalone for simple real-time applications, its functionality can be greatly extended with the following software packages:\n- [advlib](https://github.com/reelyactive/advlib) to decode the individual packets from hexadecimal strings into JSON\n- [barnowl](https://github.com/reelyactive/barnowl) to combine parallel streams of RF decoding data in a technology-and-vendor-agnostic way\n\nThese packages and more are bundled together as the [Pareto Anywhere](https://www.reelyactive.com/pareto/anywhere) open source middleware suite, which includes several __barnowl-x__ listeners.\n\n\n\nSupported Listener Interfaces\n-----------------------------\n\nThe following listener interfaces are supported.\n\n### UDP\n\n```javascript\nbarnowl.addListener(BarnowlReel.UdpListener, { path: '0.0.0.0:50000' });\n```\n\n### Serial\n\nManually install the [serialport](https://www.npmjs.com/package/serialport) package, taking care to first meet any [prerequisites for the target platform](https://www.npmjs.com/package/serialport#installation-instructions):\n\n    npm install serialport\n\n```javascript\nbarnowl.addListener(BarnowlReel.SerialListener, { path: 'auto' });\n```\n\nNote that __barnowl-reel v0.2__ is adapted to work with serialport v10.x.  If errors are encountered, try forcing an install of serialport 10 with `npm install serialport@10.4.0`\n\nOn Ubuntu, it may be necessary to add the user to the _dialout_ group in order to have the necessary permissions to access the device, which can be accomplished with the command `sudo usermod -a -G dialout $USER` and made to take effect by logging out and back in to the user account.\n\n### Event\n\nListen for reel data as an EventEmitter's \"data\" events.  Either Buffer or hexadecimal string data is accepted.\n\n```javascript\nbarnowl.addListener(BarnowlReel.EventListener,\n                    { path: eventEmitterInstance });\n```\n\n### Test\n\nProvides a steady stream of simulated reel packets for testing purposes.\n\n```javascript\nbarnowl.addListener(BarnowlReel.TestListener, {});\n```\n\n\nPareto Anywhere Integration\n---------------------------\n\n__barnowl-reel__ includes a script to forward serial/USB data to a local [Pareto Anywhere](https://www.reelyactive.com/pareto/anywhere/) instance as UDP raddecs with target localhost:50001.  Manually install the serialport dependency with `npm install serialport` and then start this script with the command:\n\n    npm run serial-forwarder\n\nTo instead forward UDP raddecs to a _remote_ Pareto Anywhere instance, start this script with the command:\n\n    npm run serial-forwarder xxx.xxx.xxx.xxx\n\nwhere xxx.xxx.xxx.xxx is the IP address of the remote instance.\n\n\nSupported Decoding Options\n--------------------------\n\nEach listener interface supports _decodingOptions_ with the following properties:\n\n| Property        | Default | Description                         | \n|:----------------|:--------|:------------------------------------|\n| maxReelLength   | 254     | Ignore packets that (spuriously) exceed the given reel length |\n| minPacketLength | 0       | Ignore radio packets with less than the given number of bytes length |\n| maxPacketLength | 255     | Ignore radio packets with more than the given number of bytes length |\n\nFor example, the decoding options for a UDP listener expecting a single reelceiver and BLE packets would be specified as follows:\n\n```javascript\nlet options = { maxReelLength: 1, minPacketLength: 8, maxPacketLength: 39 };\nbarnowl.addListener(BarnowlReel.UdpListener,\n                    { path: '0.0.0.0:50000', decodingOptions: options });\n```\n\nIn most cases, explicit _decodingOptions_ are not required.  In cases where the reel serial data stream is susceptible to corruption, explicit _decodingOptions_ can limit occurrences of spurious/missed packets.\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) 2014-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-reel","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freelyactive%2Fbarnowl-reel","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freelyactive%2Fbarnowl-reel/lists"}