Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/devbender/dump1090-ipfs-pubsub
Publish your dump1090 data streams to IPFS so we can create a decentralized free to access peer to peer ADS-B traffic network.
https://github.com/devbender/dump1090-ipfs-pubsub
ads-b dump1090 ipfs ipfs-api
Last synced: 6 days ago
JSON representation
Publish your dump1090 data streams to IPFS so we can create a decentralized free to access peer to peer ADS-B traffic network.
- Host: GitHub
- URL: https://github.com/devbender/dump1090-ipfs-pubsub
- Owner: devbender
- License: gpl-3.0
- Created: 2022-01-28T03:00:15.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2022-04-10T21:20:55.000Z (almost 3 years ago)
- Last Synced: 2024-12-20T23:42:10.286Z (about 1 month ago)
- Topics: ads-b, dump1090, ipfs, ipfs-api
- Language: Python
- Homepage:
- Size: 105 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# IPFS pubsub dump1090
Publish your dump1090 data streams to IPFS so we can create a decentralized, free to access peer to peer ADS-B traffic network.
This python script (package soon) grabs the SBS-1 TCP output of any dump1090 (usually on port 30003) and aggregates these messages:
* __MSG:1__ ES Callsign
* __MSG:2__ ES Surface Position
* __MSG:3__ ES Airborne Position
* __MSG:4__ ES Airborne Velocity
The agregated data is published via Pubsub to IPFS to the specified topics in the file __ipfs_pub_dump1090.py__ in a newline-delimited JSON (NDJSON) format once per second. Example output:
```
{"icao": "AA7B33", "csg": "SWA317", "ts": 1645374580, "alt": 27275, "lat": 28.81928, "lon": -94.51193, "spd": 463, "trk": 143, "vrt": 1536, "gnf": 0}
{"icao": "AB3655", "csg": "UAL2118", "ts": 1645374580, "alt": 38000, "lat": 27.69746, "lon": -96.37498, "spd": 382, "trk": 208, "vrt": 0, "gnf": 0}
{"icao": "A05AD1", "csg": "UCA4296", "ts": 1645374580, "alt": 11550, "lat": 30.30537, "lon": -95.45584, "spd": 299, "trk": 324, "vrt": 1344, "gnf": 0}
{"icao": "AAA0D1", "csg": "N784QS", "ts": 1645374580, "alt": 43000, "lat": 28.87775, "lon": -95.639, "spd": 386, "trk": 233, "vrt": 0, "gnf": 0}
{"icao": "A0BF31", "csg": "N1471E", "ts": 1645374580, "alt": 800, "lat": 29.46629, "lon": -95.14562, "spd": 90, "trk": 109, "vrt": 128, "gnf": 0}
```
The output only contains the data of aircrafts that have updated information since the last send period. Aircraft aggregated data is cached for 30 seconds and dropped after if no update is received.
__NOTE: At the moment only ADS-B SBS-1 data is supported, more coming soon!__
## Requirements
* An up and running dump1090 instance
* A local IPFS node with pubsub enabled (--enable-pubsub-experiment flag)
* Python requests: `pip3 install requests`
## Defining a location-based topic nomenclature
The idea of this project is that you can subscribe to specific topics depending on your location so you can get the aggregated output off all nearby receivers. To achieve this I defined a preliminary topic nomenclature (until a better idea arises).
The prefix defines the type of data: "ADSB", "UAT", "MLAT", or "FLARM" followed by a dash then the IATA airport code of the nearest largest airport.
Example topic names:
* __ADSB-MIA:__ ADS-B data near Miami Airport
* __UAT-HOU:__ UAT data near William P. Hobby
* __MLAT-FLL:__ MLAT data near Ft. Lauderdale Airport
* __FLARM-JFK:__ FLARM data near JFK Airport
## To run
Clone the repo preferably to your home directory.
```
git clone https://github.com/devbender/ipfs_pubsusb_dump1090
```
Then cd into the repo directory and modify the __ipfs_pub_dump1090.py__ and add the topic names to where your data will be published according to the specified nomenclature (see examples above).
```
TOPICS = []
```
More than one topic can be specified if you wish to publish to more than one IATA code at the time for airports that are relatively close, for example MIA an FLL that are 20 miles apart:
```
TOPICS = ['ADSB-MIA', 'ADSB-FLL']
```
Modify the __ipfs-dump1090.service__ unit file with your current user and the path to the repo. You can skip this step if you are running via raspberry pi default user `pi` and cloned to the home directory.
```
[Service]
User=pi
ExecStart=/usr/bin/python3 /home/pi/ipfs_pubsusb_dump1090/ipfs_pub_dump1090.py
```
Copy the unit file to __/etc/systemd/system/__:
```
sudo cp ipfs-dump1090.service /etc/systemd/system/
```
To start:
```
sudo systemctl start ipfs-dump1090.service
```
Confirm its running:
```
sudo systemctl status ipfs-dump1090.service
```
To enable auto start:
```
sudo systemctl enable ipfs-dump1090.service
```
Test the output:
```
ipfs pubsub sub
```
## Credits
Copyright (C) 2022 by Juan Benitez
Distributed under GPLv3