{"id":13418251,"url":"https://github.com/itemir/dump1090_sdrplus","last_synced_at":"2025-03-15T03:30:46.613Z","repository":{"id":34291028,"uuid":"38182489","full_name":"itemir/dump1090_sdrplus","owner":"itemir","description":"Dump1090_sdrplus is a Mode S decoder for Software Defined Radio (SDR) devices including RTL SDR, HackRF, Airspy and SDRplay.","archived":false,"fork":true,"pushed_at":"2020-09-21T04:37:29.000Z","size":863,"stargazers_count":168,"open_issues_count":3,"forks_count":30,"subscribers_count":25,"default_branch":"master","last_synced_at":"2024-12-09T12:14:47.416Z","etag":null,"topics":["airplane","airspy","hackrf","rtl-sdr","sdr"],"latest_commit_sha":null,"homepage":"","language":"C","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"antirez/dump1090","license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/itemir.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-06-28T01:50:26.000Z","updated_at":"2024-12-02T06:49:37.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/itemir/dump1090_sdrplus","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itemir%2Fdump1090_sdrplus","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itemir%2Fdump1090_sdrplus/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itemir%2Fdump1090_sdrplus/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itemir%2Fdump1090_sdrplus/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/itemir","download_url":"https://codeload.github.com/itemir/dump1090_sdrplus/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243681024,"owners_count":20330152,"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":["airplane","airspy","hackrf","rtl-sdr","sdr"],"created_at":"2024-07-30T22:01:00.126Z","updated_at":"2025-03-15T03:30:46.602Z","avatar_url":"https://github.com/itemir.png","language":"C","funding_links":[],"categories":["C"],"sub_categories":[],"readme":"## Dump1090\\_sdrplus\n\n\u003cimg src='https://raw.githubusercontent.com/itemir/dump1090_sdrplus/master/images/dump1090_sdrplus.png' align='left' width='300' hspace='25' vspace='10'\u003e\n\nDump1090\\_sdrplus is a Mode S decoder (see [ADS-B](https://en.wikipedia.org/wiki/ADS-B)) specifically designed for SDR devices including [RTLSDR](http://www.rtl-sdr.com/), [HackRF One](https://greatscottgadgets.com/hackrf/), [Airspy](http://airspy.com/) and [SDRplay](http://www.sdrplay.com/). It is a fork of Salvatore Sanfilippo's original [dump1090](https://github.com/antirez/dump1090) with support for additional SDR devices.\n\nThe main features are:\n\n* Robust decoding of weak messages, with dump1090 many users observed\n  improved range compared to other popular decoders.\n* Network support: TCP30003 stream (MSG5...), Raw packets, HTTP.\n* Embedded HTTP server that displays currently detected aircrafts on\n  Google Maps. Remember to replace `YOURGOOGLEKEY` in `gmap.html` with\n  your `Maps Javascript API`-enabled [key](https://console.cloud.google.com/apis/credentials) to view it in browser.\n* Single bit errors correction using the 24 bit CRC.\n* Ability to decode DF11, DF17 messages.\n* Ability to decode DF formats like DF0, DF4, DF5, DF16, DF20 and DF21\n  where the checksum is xored with the ICAO address by brute forcing the\n  checksum field using recently seen ICAO addresses.\n* Decode raw IQ samples from file (using --ifile command line switch).\n* Interactive command-line-interfae mode where aircrafts currently detected\n  are shown as a list refreshing as more data arrives.\n* CPR coordinates decoding and track calculation from velocity.\n* TCP server streaming and receiving raw data to/from connected clients\n  (using --net).\n\n### Installation\n\nType in the shell\n    \n    sudo apt-get install librtlsdr0 librtlsdr-dev libhackrf-dev libairspy-dev libsoxr-dev\n\nIf you want to enable SDRPlay, download libraries from http://www.sdrplay.com/linuxdl.php and\n\n    chmod 755 SDRplay_RSP_API-Linux-2.13.1.run\n    ./SDRplay_RSP_API-Linux-2.13.1.run\n    sudo ldconfig\n    make\n\nelse\n\n    make NoSDRplay=1\n\n### Normal usage\n\nTo capture traffic directly from your RTL device and show the captured traffic\non standard output, just run the program without options at all:\n\n    ./dump1090\n\nTo just output hexadecimal messages:\n\n    ./dump1090 --raw\n\nTo run the program in interactive mode:\n\n    ./dump1090 --interactive\n\nTo run the program in interactive mode, with networking support, and connect\nwith your browser to http://localhost:8080 to see live traffic:\n\n    ./dump1090 --interactive --net\n\nIn iteractive mode it is possible to have a less information dense but more\n\"arcade style\" output, where the screen is refreshed every second displaying\nall recently seen aircrafts with some additional information such as\naltitude and flight number, extracted from received Mode S packets.\n\n### Using files as source of data\n\nTo decode data from a file, use:\n\n    ./dump1090 --ifile /path/to/binfile\n\nThe binary file can be created using `rtl_sdr` or `hackrf_transfer` (requires \nconversion). File contents need to be 8-bit unsigned IQ samples at 2 Mhz sample rate.\n\nExample with rtl\\_sdr:\n\n    rtl_sdr -f 1090000000 -s 2000000 -g 50 output.bin\n\nIn the example a gain of 50 is used, simply you should use the highest gain availabe\nfor your tuner. This is not needed when calling dump1090 itself as it is able to \nselect the highest gain supported automatically.\n\nExample with hackrf\\_transfer:\n\n    hackrf_transfer -r output.sb -f 1090000000 -s 2000000 -p 0 -a 0 -l 32 -g 48\n    sox -r 2000000 -c 1 output.sb output.ub\n\nIn the example RX/TX RF amplifier is disabled, IF gain is set to 32dB and baseband\ngain is set to 48dB (80% of maximum). As opposed to RTL SDR devices, HackRF returns\nsigned IQ values, so [SoX](http://sox.sourceforge.net/) is used to convert them to \nunsigned IQ values. \n\nIt is possible to feed the program with data via standard input using\nthe --ifile option with \"-\" as argument.\n\n### Additional options\n\ndump1090 can be called with other command line options to set a different\ngain, frequency, and so forth. For a list of options use:\n\n    ./dump1090 --help\n\n### Reliability\n\nBy default dump1090 tries to fix single bit errors using the checksum.\nBasically the program will try to flip every bit of the message and check if\nthe checksum of the resulting message matches.\n\nThis is indeed able to fix errors and works reliably in my experience,\nhowever if you are interested in very reliable data I suggest to use\nthe --no-fix command line switch in order to disable error fixing.\n\n### Performances and sensibility of detection\n\nIn my limited experience dump1090 was able to decode a big number of messages\neven in conditions where I encountered problems using other programs, however\nno formal test was performed so I can't really claim that this program is\nbetter or worse compared to other similar programs.\n\nIf you can capture traffic that dump1090 is not able to decode properly, drop\nme an email with a download link. I may try to improve the detection during\nmy free time (this is just a hobby project).\n\n### Network server features\n\nBy enabling the networking support with --net dump1090 starts listening\nfor client connections on port 30002 and 30001 (you can change both\nports if you want, see --help output).\n\n### Port 30002\n\nConnected clients are served with data ASAP as they arrive from the device\n(or from file if --ifile is used) in the raw format similar to the following:\n\n    *8D451E8B99019699C00B0A81F36E;\n\nEvery entry is separated by a simple newline (LF character, hex 0x0A).\n\n### Port 30001\n\nPort 30001 is the raw input port, and can be used to feed dump1090 with\ndata in the same format as specified above, with hex messages starting with\na `*` and ending with a `;` character.\n\nSo for instance if there is another remote dump1090 instance collecting data\nit is possible to accumulate the output to a local dump1090 instance doing something\nlike this:\n\n    nc remote-dump1090.example.net 30002 | nc localhost 30001\n\nIt is important to note that what is received via port 30001 is also\nbroadcasted to clients listening to port 30002.\n\nIn general everything received from port 30001 is handled exactly like the\nnormal traffic from RTL devices or from file when --ifile is used.\n\nIt is possible to use dump1090 just as a hub using --ifile with /dev/zero\nas argument as in the following example:\n\n    ./dump1090 --net-only\n\nOr alternatively to see what's happening on the screen:\n\n    ./dump1090 --net-only --interactive\n\nThen you can feed it from different data sources from the internet.\n\n### Port 30003\n\nConnected clients are served with messages in SBS1 (BaseStation) format,\nsimilar to:\n\n    MSG,4,,,738065,,,,,,,,420,179,,,0,,0,0,0,0\n    MSG,3,,,738065,,,,,,,35000,,,34.81609,34.07810,,,0,0,0,0\n\nThis can be used to feed data to various sharing sites without the need to use another decoder.\n\n### Antenna\n\nMode S messages are transmitted at 1090 Mhz. If you have a decent\nantenna you'll be able to pick up signals from aircrafts pretty far from your\nposition, especially if you are outdoor and in a position with a good sky view.\n\nYou can easily build a very cheap antenna following the istructions at:\n\n    http://antirez.com/news/46\n\nWith this trivial antenna I was able to pick up signals of aircrafts 200+ Km\naway from me.\n\nIf you are interested in a more serious antenna check the following\nresources:\n\n* http://gnuradio.org/redmine/attachments/download/246/06-foster-adsb.pdf\n* http://www.lll.lu/~edward/edward/adsb/antenna/ADSBantenna.html\n* http://modesbeast.com/pix/adsb-ant-drawing.gif\n\n### Aggressive mode\n\nWith --aggressive it is possible to activate the *aggressive mode* that is a\nmodified version of the Mode S packet detection and decoding.\nTHe aggresive mode uses more CPU usually (especially if there are many planes\nsending DF17 packets), but can detect a few more messages.\n\nThe algorithm in aggressive mode is modified in the following ways:\n\n* Up to two demodulation errors are tolerated (adjacent entires in the magnitude\n  vector with the same eight). Normally only messages without errors are\n  checked.\n* It tries to fix DF17 messages trying every two bits combination.\n\nThe use of aggressive mode is only advised in places where there is low traffic\nin order to have a chance to capture some more messages.\n\n### Debug mode\n\nThe Debug mode is a visual help to improve the detection algorithm or to\nunderstand why the program is not working for a given input.\n\nIn this mode messages are displayed in an ASCII-art style graphical\nrepresentation, where the individial magnitude bars sampled at 2 Mhz are\ndisplayed.\n\nAn index shows the sample number, where 0 is the sample where the first\nMode S peak was found. Some additional background noise is also added\nbefore the first peak to provide some context.\n\nTo enable debug mode and check what combinations of packets you can\nlog, use --help to obtain a list of available debug flags.\n\nDebug mode includes an optional javascript output that is used to visualize\npackets using a web browser, you can use the file debug.html under the\n'tools' directory to load the generated frames.js file.\n\n### How this program works?\n\nThe code is clearly commented in order to be easy to understand.\nFor the diligent programmer with a Mode S specification on his hands it\nshould be trivial to understand how it works.\n\nThe algorithms I used were obtained basically looking at many messages\nas displayed using a throw-away SDL program, and trying to model the algorithm\nbased on how the messages look graphically.\n\n### How to test the program?\n\nIf you have an RTLSDR device and you happen to be in an area where there\nare aircrafts flying over your head, just run the program and check for signals.\n\nHowever if you don't have an RTLSDR device, or if the presence of aircrafts\nis very limited in your area, you may want to try the sample file distributed\nwith the dump1090 distribution under the \"testfiles\" directory.\n\nJust run it like this:\n\n    ./dump1090 --ifile testfiles/modes1.bin\n\n### What is --strip mode?\n\nIt is just a simple filter that will get raw IQ 8 bit samples in input\nand will output a file missing all the parts of the file where I and Q\nare lower than the specified level for more than 32 samples.\n\nUse it like this:\n\n    cat big.bin | ./dump1090 --snip 25 \u003e small.bin\n\nI used it in order to create a small test file to include inside this\nprogram source code distribution.\n\n### Contributing\n\ndump1090 was written during some free time during xmas 2012, it is a hobby\nproject so I'll be able to address issues and improve it only during\nfree time, however you are encouraged to send pull requests in order to\nimprove the program. A good starting point can be the TODO list included in\nthe source distribution.\n\n### Credits\n\ndump1090 was written by [Salvatore Sanfilippo](https://github.com/antirez) and\nis released under the BSD three clause license. HackRF One support was added by\n[Ilker Temir](https://github.com/itemir). AirSpy support was added by\n[Chris Kuethe](https://github.com/ckuethe). SDRplay support was added by\nthe [SDRplay](https://github.com/SDRplay) team.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitemir%2Fdump1090_sdrplus","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fitemir%2Fdump1090_sdrplus","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitemir%2Fdump1090_sdrplus/lists"}