{"id":22859930,"url":"https://github.com/reelyactive/barnowl-tcpdump","last_synced_at":"2025-03-31T08:22:41.723Z","repository":{"id":57189188,"uuid":"145304887","full_name":"reelyactive/barnowl-tcpdump","owner":"reelyactive","description":"Collect ambient WiFi packets as standard JSON radio decodings, using tcpdump. We believe in an open Internet of Things.","archived":false,"fork":false,"pushed_at":"2024-04-22T13:39:22.000Z","size":120,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-09T05:39:19.716Z","etag":null,"topics":["barnowl","pareto-anywhere","raddec","rtls","tcpdump","wifi"],"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":"2018-08-19T13:19:39.000Z","updated_at":"2024-09-12T12:11:23.000Z","dependencies_parsed_at":"2025-02-06T12:42:51.494Z","dependency_job_id":"b247b776-8238-4c27-b210-9c0ab2925ada","html_url":"https://github.com/reelyactive/barnowl-tcpdump","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-tcpdump","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Fbarnowl-tcpdump/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Fbarnowl-tcpdump/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/reelyactive%2Fbarnowl-tcpdump/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/reelyactive","download_url":"https://codeload.github.com/reelyactive/barnowl-tcpdump/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246436841,"owners_count":20777102,"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","pareto-anywhere","raddec","rtls","tcpdump","wifi"],"created_at":"2024-12-13T09:08:28.409Z","updated_at":"2025-03-31T08:22:41.698Z","avatar_url":"https://github.com/reelyactive.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"barnowl-tcpdump\n===============\n\n__barnowl-tcpdump__ converts ambient wireless packets collected from hardware capable of running [tcpdump](https://www.tcpdump.org/) into standard developer-friendly JSON that is vendor/technology/application-agnostic.\n\n![Overview of barnowl-tcpdump](https://reelyactive.github.io/barnowl-tcpdump/images/overview.png)\n\n__barnowl-tcpdump__ is a lightweight [Node.js package](https://www.npmjs.com/package/barnowl-tcpdump) that can run on resource-constrained edge devices.  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\nGetting Started\n---------------\n\nLearn \"owl\" about the __raddec__ JSON data output:\n-  [reelyActive Developer's Cheatsheet](https://reelyactive.github.io/diy/cheatsheet/)\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-tcpdump__ will attempt to spawn a tcpdump and output (flattened) __raddec__ JSON to the console.\n\n\nHello barnowl-tcpdump!\n----------------------\n\nThe following code will listen to _simulated_ hardware and output packets to the console:\n\n```javascript\nconst BarnowlTcpdump = require('barnowl-tcpdump');\n\nlet barnowl = new BarnowlTcpdump();\n\nbarnowl.addListener(BarnowlTcpdump.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\n\nSupported Listener Interfaces\n-----------------------------\n\nThe following listener interfaces are supported.\n\n### Spawn\n\nAttempts to spawn a tcpdump process, first configuring the interface in monitor mode.\n\n```javascript\nlet options = { exitOnClose: false };\n\nbarnowl.addListener(BarnowlTcpdump.SpawnListener, options);\n```\n\nThe SpawnListener supports the following options:\n- __exitOnClose__: exit the entire process should the spawned tcpdump close (default: _false_)\n\n### Test\n\nProvides a steady stream of simulated reel packets for testing purposes.\n\n```javascript\nbarnowl.addListener(BarnowlTcpdump.TestListener, {});\n```\n\n\nIs that owl you can do?\n-----------------------\n\nWhile __barnowl-tcpdump__ may suffice standalone for simple real-time applications, its functionality can be greatly extended with the following software package:\n- [barnowl](https://github.com/reelyactive/barnowl) to combine parallel streams of RF decoding data in a technology-and-vendor-agnostic way\n\nThis package 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\nPareto Anywhere Integration\n---------------------------\n\n__barnowl-tcpdump__ 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\nInstall __Pareto Anywhere__ _and_ __barnowl-tcpdump__ by following a step-by-step tutorial on our [reelyActive Developers](https://reelyactive.github.io/) site:\n- [Run Pareto Anywhere on a PC](https://reelyactive.github.io/diy/pareto-anywhere-pc/)\n- [Run Pareto Anywhere on a Pi](https://reelyactive.github.io/diy/pareto-anywhere-pi/)\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) 2018-2024 [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-tcpdump","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freelyactive%2Fbarnowl-tcpdump","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freelyactive%2Fbarnowl-tcpdump/lists"}