{"id":22859987,"url":"https://github.com/reelyactive/barnowl-huawei","last_synced_at":"2025-10-25T22:07:19.262Z","repository":{"id":69136490,"uuid":"397713494","full_name":"reelyactive/barnowl-huawei","owner":"reelyactive","description":"Collect ambient Bluetooth Low Energy packets from Huawei access points for real-time location and sensing. We believe in an open Internet of Things.","archived":false,"fork":false,"pushed_at":"2022-03-22T00:46:45.000Z","size":19,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-07T03:49:27.303Z","etag":null,"topics":["barnowl","ble","bluetooth-low-energy","huawei","pareto-anywhere","raddec","rtls"],"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}},"created_at":"2021-08-18T19:26:53.000Z","updated_at":"2022-03-13T02:49:20.000Z","dependencies_parsed_at":null,"dependency_job_id":"ce12b1cf-4a70-4245-8801-fa5faf626fbd","html_url":"https://github.com/reelyactive/barnowl-huawei","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%2Fbarnowl-huawei","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Fbarnowl-huawei/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Fbarnowl-huawei/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Fbarnowl-huawei/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/reelyactive","download_url":"https://codeload.github.com/reelyactive/barnowl-huawei/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246436954,"owners_count":20777125,"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":["barnowl","ble","bluetooth-low-energy","huawei","pareto-anywhere","raddec","rtls"],"created_at":"2024-12-13T09:08:36.437Z","updated_at":"2025-10-25T22:07:19.211Z","avatar_url":"https://github.com/reelyactive.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"barnowl-huawei\n==============\n\n__barnowl-huawei__ converts Bluetooth Low Energy decodings from Huawei access points into software-developer-friendly JSON: a real-time stream of [raddec](https://github.com/reelyactive/raddec/) objects which facilitate any and all of the following applications:\n- RFID: _what_ is present, based on the device identifier?\n- RTLS: _where_ is it relative to the receiving devices?\n- M2M: _how_ is its status, based on any payload included in the packet?\n\n__barnowl-huawei__ is a lightweight [Node.js package](https://www.npmjs.com/package/barnowl-huawei) that can run on resource-constrained edge devices as well as on powerful cloud servers and anything in between.  It is typically run behind a [barnowl](https://github.com/reelyactive/barnowl) instance which is included in the [Pareto Anywhere](https://www.reelyactive.com/pareto/anywhere/) open source middleware suite.\n\n\nInstallation\n------------\n\n    npm install barnowl-huawei\n\n\nQuick Start\n-----------\n\nClone this repository, install package dependencies with `npm install`, and then from the root folder run at any time:\n\n    npm start\n\n__barnowl-huawei__ will listen for UDP packets from Huawei APs on localhost:50010 and print any processed [raddec](https://github.com/reelyactive/raddec) data to the console.\n\n\nHello barnowl-huawei!\n---------------------\n\nThe following code will listen to _simulated_ hardware and output packets to the console:\n\n```javascript\nconst BarnowlHuawei = require('barnowl-huawei');\n\nlet barnowl = new BarnowlHuawei();\n\nbarnowl.addListener(BarnowlHuawei.TestListener, {});\n\nbarnowl.on('raddec', function(raddec) {\n  console.log(raddec);\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: 2,\n  rssiSignature: [\n    {\n      receiverId: \"24a52cffffff\",\n      receiverIdType: 2,\n      rssi: -72,\n      numberOfDecodings: 1\n    }\n  ],\n  packets: [ '000755daba50e1fe02011a03ff7d02' ],\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-huawei__ 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\nSupported Listener Interfaces\n-----------------------------\n\nThe following listener interfaces are supported.\n\n### UDP\n\n```javascript\nbarnowl.addListener(BarnowlHuawei.UdpListener, { path: \"0.0.0.0:50010\" });\n```\n\n### Test\n\nProvides a steady stream of simulated Huawei packets for testing purposes.\n\n```javascript\nbarnowl.addListener(BarnowlHuawei.TestListener, {});\n```\n\n\nHuawei Bluetooth Service Profile Parameters\n-------------------------------------------\n\nUse the following Bluetooth Scanning parameters for the Huawei AP/AC:\n\n| Property                           | Value                    | \n|:-----------------------------------|:-------------------------|\n| Monitoring surrounding BLE devices | ON                       |\n| Monitoring mode                    | Transparent transmission |\n| Data reporting                     | ON                       |\n| Data reporting time                | Real-time                |\n\nFor the IPv4 address/port parameter, specify the IP address of the server running __barnowl-huawei__ and port 50010.\n\n\nSupported Decoding Options\n--------------------------\n\nEach listener interface supports _decodingOptions_ with the following properties:\n\n| Property           | Default | Description                         | \n|:-------------------|:--------|:------------------------------------|\n| timestampOnArrival | true    | Override any timestamp included in the inbound packet with the time at which it is received by barnowl-huawei |\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[![Known Vulnerabilities](https://snyk.io/test/github/reelyactive/barnowl-huawei/badge.svg)](https://snyk.io/test/github/reelyactive/barnowl-huawei)\n\n\nLicense\n-------\n\nMIT License\n\nCopyright (c) 2021-2022 [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-huawei","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freelyactive%2Fbarnowl-huawei","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freelyactive%2Fbarnowl-huawei/lists"}