Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/reelyactive/barnowl-tcpdump
Collect ambient WiFi packets as standard JSON radio decodings, using tcpdump. We believe in an open Internet of Things.
https://github.com/reelyactive/barnowl-tcpdump
barnowl pareto-anywhere raddec rtls tcpdump wifi
Last synced: 9 days ago
JSON representation
Collect ambient WiFi packets as standard JSON radio decodings, using tcpdump. We believe in an open Internet of Things.
- Host: GitHub
- URL: https://github.com/reelyactive/barnowl-tcpdump
- Owner: reelyactive
- License: mit
- Created: 2018-08-19T13:19:39.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-04-22T13:39:22.000Z (8 months ago)
- Last Synced: 2024-11-12T17:51:31.885Z (about 1 month ago)
- Topics: barnowl, pareto-anywhere, raddec, rtls, tcpdump, wifi
- Language: JavaScript
- Homepage: https://www.reelyactive.com/pareto/anywhere/
- Size: 117 KB
- Stars: 1
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
barnowl-tcpdump
===============
__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.
__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.
Getting Started
---------------
Learn "owl" about the __raddec__ JSON data output:
- [reelyActive Developer's Cheatsheet](https://reelyactive.github.io/diy/cheatsheet/)
Quick Start
-----------
Clone this repository, install package dependencies with `npm install`, and then from the root folder run at any time:
npm start
__barnowl-tcpdump__ will attempt to spawn a tcpdump and output (flattened) __raddec__ JSON to the console.
Hello barnowl-tcpdump!
----------------------
The following code will listen to _simulated_ hardware and output packets to the console:
```javascript
const BarnowlTcpdump = require('barnowl-tcpdump');
let barnowl = new BarnowlTcpdump();
barnowl.addListener(BarnowlTcpdump.TestListener, {});
barnowl.on("raddec", function(raddec) {
console.log(raddec);
});
barnowl.on("infrastructureMessage", function(message) {
console.log(message);
});
```
Supported Listener Interfaces
-----------------------------
The following listener interfaces are supported.
### Spawn
Attempts to spawn a tcpdump process, first configuring the interface in monitor mode.
```javascript
let options = { exitOnClose: false };
barnowl.addListener(BarnowlTcpdump.SpawnListener, options);
```
The SpawnListener supports the following options:
- __exitOnClose__: exit the entire process should the spawned tcpdump close (default: _false_)
### Test
Provides a steady stream of simulated reel packets for testing purposes.
```javascript
barnowl.addListener(BarnowlTcpdump.TestListener, {});
```
Is that owl you can do?
-----------------------
While __barnowl-tcpdump__ may suffice standalone for simple real-time applications, its functionality can be greatly extended with the following software package:
- [barnowl](https://github.com/reelyactive/barnowl) to combine parallel streams of RF decoding data in a technology-and-vendor-agnostic way
This 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.
Pareto Anywhere Integration
---------------------------
__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:
npm run forwarder
Install __Pareto Anywhere__ _and_ __barnowl-tcpdump__ by following a step-by-step tutorial on our [reelyActive Developers](https://reelyactive.github.io/) site:
- [Run Pareto Anywhere on a PC](https://reelyactive.github.io/diy/pareto-anywhere-pc/)
- [Run Pareto Anywhere on a Pi](https://reelyactive.github.io/diy/pareto-anywhere-pi/)
Contributing
------------
Discover [how to contribute](CONTRIBUTING.md) to this open source project which upholds a standard [code of conduct](CODE_OF_CONDUCT.md).
Security
--------
Consult our [security policy](SECURITY.md) for best practices using this open source software and to report vulnerabilities.
License
-------
MIT License
Copyright (c) 2018-2024 [reelyActive](https://www.reelyactive.com)
Permission 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:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.