Detached fork of Mictronics readsb and by extension dump1090-fa by mutability
This is a detached fork of https://github.com/Mictronics/readsb
It’s continually under development, expect bugs, segfaults and all the good stuff :)
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS”
see the LICENSE file for details
I’d recommend this script to automatically install it:
Or build the package yourself:
sudo apt updatesudo apt install --no-install-recommends --no-install-suggests -y \git build-essential debhelper libusb-1.0-0-dev \librtlsdr-dev librtlsdr0 pkg-config fakeroot \libncurses-dev zlib1g-dev zlib1g libzstd-dev libzstd1git clone --depth 20 https://github.com/wiedehopf/readsb.gitcd readsbexport DEB_BUILD_OPTIONS=noddebsdpkg-buildpackage -b -Prtlsdr -ui -uc -ussudo dpkg -i ../readsb_*.deb
Or check here for more build instructions and other useful stuff:
For macOS / OS X check build and general info, check further down
readsb connects to a listening server.
Sending beast data (beast_out):
--net-connector 192.168.2.22,30004,beast_out
Receiving beast data (beast_in);
--net-connector 192.168.2.28,30005,beast_in
Selectively forwards beast messages if the received data hasn’t been forwarded in the last 125 ms (or --net-beast-reduce-interval).
Data not related to the physical aircraft state are only forwarded every 500 ms (4 * --net-beast-reduce-interval).The messages of
this output are normal beast messages and compatible with every program able to receive beast messages.
This is used by some aggregators to aggregate ADS-B data, an example net connector would be:
--net-connector=feed.airplanes.live,30004,beast_reduce_plus_out,uuid=0033062d-e17e-4389-91a9-79ebb967fb4c
The uuid is optional, if none is given, the uuid from —uuid-file is used, if that isn’t present no uuid is sent.
The beast_reduce_out net-connector will never send an uuid.
The aggregator enables —net-receiver-id and —net-ingest on their readsb server, it’s made to work with beast_reduce_plus_out.
dpkg-buildpackage -b.dpkg-buildpackage -b --build-profiles=rtlsdrYou can probably just run “make”. By default “make” builds with no specific library support. See below.
Binaries are built in the source directory; you will need to arrange to
install them (and a method for starting them) yourself.
“make RTLSDR=yes” will enable rtl-sdr support and add the dependency on
librtlsdr.
On Raspbian 32 bit, mostly rpi2 and older you might want to use this to compile if you’re running into CPU issues:
make AIRCRAFT_HASH_BITS=11 RTLSDR=yes OPTIMIZE="-Ofast -mcpu=arm1176jzf-s -mfpu=vfp"
In general if you want to save on CPU cycles, you can try building with these options:
make AIRCRAFT_HASH_BITS=11 RTLSDR=yes OPTIMIZE="-O3 -march=native"
Or even more aggressive but could cause unexpected behaviour:
make AIRCRAFT_HASH_BITS=11 RTLSDR=yes OPTIMIZE="-Ofast -march=native"
The difference of using -Ofast or -O3 over the default of -O2 is likely very minimal.
-march=native also usually makes little difference but it might, so it’s worth a try.
If required, edit /etc/default/readsb to set the service options, device type, network ports etc.
For rtl-sdr devices a software gain algorithm is the default, it’s optimized for ADS-B.
On the command line it’s activated using --gain=auto an is silent by default.--gain=auto-verbose can be used to enable log messages for gain changes.
To tweak the internals, more parameters can be passed:
--gain=auto-verbose,<lowestGain>,<noiseLowThreshold>,<noiseHighThreshold>,<loudThreshold>
The defaults are:
--gain=auto-verbose,0,25,31,243
The thresholds are numbers 0 to 256, tweaking them requires some understanding of how it works.
One option would be to change the noise thresholds up or down and then observe the log.
There should be no need to tweak these parameters.
Use this utility independent of readsb:
https://github.com/wiedehopf/adsb-wiki/wiki/RTL-Bias-Tee
One of this forks main uses is to be the backend of a global map.
For that purpose it’s used in conjunction with tar1090 with some extra options to cope with the number of aircraft and also record a history of flight paths: https://github.com/wiedehopf/tar1090#0800-destroy-sd-card
Websites using this software:
Projects that use or have used data generated by this software:
History function as used by several online aggregators using tar1090.
Warning: the following will generate several thousand files a day and can use significant amounts of
disk space depending on your data source.
The following command line options need to be added to for example the decoder options in /etc/default/readsb
--write-globe-history /var/globe_history --heatmap 30
To increase time resolution to maximum, you can add --json-trace-interval=0.1 which will add every
position received to traces. The heatmap interval can also be reduced from the default of 30
seconds, i wouldn’t recommend less than 5 seconds for that though.
Aggregators will generally use --write-json-globe-index as well but that’s not necessary if you don’t have more than 500 concurrent planes.
/var/globe_history needs to be a directory writeable by the user readsb.sudo mkdir /var/globe_history and sudo chown readsb /var/globe_history are useful for that.
You should also download
wget -O /usr/local/share/tar1090/aircraft.csv.gz https://github.com/wiedehopf/tar1090-db/raw/csv/aircraft.csv.gz
and add this command line option (for exaple via /etc/default/readsb):
--db-file /usr/local/share/tar1090/aircraft.csv.gz
This will obviously write data to the hard drive, be aware of that.
The data format is subject to change, don’t expect this to be stable.
Be aware of that when upgrading either tar1090 or readsb to a new commit.
If you’re using —write-json-globe-index, it’s also recommended to use —tar1090-use-api
It will use the readsb API to get data, it’s less requests and usually more efficient,
for details see the file nginx-readsb-api.conf
(this needs adding to your existing nginx tar1090 configuration, this is only for people who really know their stuff anyway)
If configuring this stuff seems complicated, consider just using the sdr-enthusiasts ultrafeeder
container. Just don’t configure feeds for aggregated data or if you don’t want to feed data from
there.
If you don’t want readsb to read data from the SDR, you’ll also need to change the receiver options line to something like this:
RECEIVER_OPTIONS="--net-only --net-connector 192.168.2.7,30005,beast_in"
If you have another dump1090/readsb running on the same machine, you’ll also need to change all the ports to avoid conflicts.
For current reference please see the speed_check function.
hex
SQ means same quality (ADS-B vs MLAT and stuff)
LQ means lower quality
fail / ok
ok means speed check passed (displayed only with cpr-focus)
A means airborne and S means surface.
reliable is my reliability counter
every good position increases each aircrafts position reliability,
if it gets to zero, speed check is no longer applied and it’s allowed to “JUMP”,
“JUMP” is also allowed if we haven’t had a position for 2 minutes.
tD is the trackDifference
170 or 180 means the new position goes in the opposite direction of the ground track broadcast by the aircraft.
then we have actual distance / allowed distance.
the allowed distance i tweak depending on the trackDifference
high trackDifference makes the allowed distance go slightly negative
as i don’t want aircraft to jump backwards.
elapsed time
actual / allowed speed (allowed speed based on allowed distance)
old —> new
lat, lon -> lat, lon
oh if you want that display:
—debug=S
you’ll have to update, just disabled the MLAT speed check from displayign stuff … because usually it’s not interesting
Thank you to https://github.com/ind006/readsb_macos/ for all the shims needed to make this work.
readsb should be (largely) compatible with macOS, on both Intel and ARM architectures.
You may need to modify the Makefile to point at where on your mac you have the standard libs and includes installed.
This in turn depends on whether you’re using macports or homebrew for those libs and includes. The Makefile has paths
pre-set for homebrew.
These packages are needed, possibly more:
brew install git librtlsdr libusb ncurses
Build using:
make -j4 RTLSDR=yes
You can run it from the command line (try screen -S readsb and run it in there, press ctrl-A to detach the terminal)
Example command line:
./readsb --quiet --net --device-type rtlsdr --gain auto# add console table of planes for a quick test:--interactive# optionally add coordinates:--lat -33.874 --lon 151.206# add --interactive for testing, it will show a list of planes in the terminal# optional output of json and other regularly updated files:--write-json-every 0.5 --write-json=/tmp/readsb_run# optional database info--db-file ~/tar1090/aircraft.csv.gz# optional listen ports:--net-ri-port 30001 --net-ro-port 30002 --net-sbs-port 30003 --net-bi-port 30004,30104 --net-bo-port 30005# optional sending of data to an aggregator:--net-connector feed.flyrealtraffic.com,30004,beast_reduce_plus_out,7817bd08-f226-11ef-ba9e-072eee452592
For a graphical interface, the tar1090 webinterface is recommended: https://github.com/wiedehopf/tar1090
The install script won’t work so i’d recommend the following basic webserver configuration:
git clone https://github.com/wiedehopf/tar1090 ~/tar1090wget -O ~/tar1090/aircraft.csv.gz https://github.com/wiedehopf/tar1090-db/raw/csv/aircraft.csv.gz
For nginx this would look something like this (replace USER appropriately):
location /tar1090/data/ {alias /tmp/readsb_run/;add_header Cache-Control "no-cache";location /tar1090/data/traces/ {gzip off;add_header Content-Encoding "gzip";add_header Cache-Control "no-cache";}}location /tar1090/globe_history/ {alias /home/USER/readsb_history/;gzip off;add_header Content-Encoding "gzip";add_header Cache-Control "no-cache";}location /tar1090 {alias /home/USER/tar1090/html/;add_header Cache-Control "no-cache";}
An easy way to add some traces when selecting a plane:
Add --write-globe-history=/home/USER/readsb_history to the readsb command line.
You can also serve this folder as /tar1090/globe_history but that’s only required for the history going back further
than 24h.
The classical tar1090 uses traces created via a shell script and served at /tar1090/chunks but running that shell
script is probably a hassle, so just use the above.
might be out of date, check the command on a freshly compiled version
Usage: readsb [OPTION...]readsb Mode-S/ADSB/TIS ReceiverBuild options:General options:--cpr-focus=<hex> show CPR details for this hex--db-file=<file.csv.gz> Default: "none" (as of writing a compatiblefile is available here:https://github.com/wiedehopf/tar1090-db/tree/csv)--db-file-lt Write long type to aircraft.json as field desc--debug=<flags> Debug mode (verbose), n: network, P: CPR, S: speedcheck--device-type=<type> Select SDR type--filter-DF=<type> When displaying decoded ModeS messages on stdoutonly show this DF type--fix Enable CRC single-bit error correction (default)--forward-mlat Allow forwarding of received mlat results tooutput ports--freq=<hz> Set frequency (default: 1090 MHz)--gain=<db> Set gain (default: max gain. Use -10 forauto-gain)--gnss Show altitudes as GNSS when available--heatmap=<interval in seconds>Make Heatmap, each aircraft at most every intervalseconds (creates historydir/heatmap.bin and exitafter that)--heatmap-dir=<dir> Change the directory where heatmaps are saved(default is in globe history dir)--interactive Interactive mode refreshing data on screen.Implies --throttle--interactive-ttl=<sec> Remove from list if idle for <sec> (default:60)--jaero-timeout=<n> How long in minutes JAERO positions remain validand on the map in tar1090 (default:33)--json-location-accuracy=<n>Accuracy of receiver location in json metadata:0=no location, 1=approximate, 2=exact--json-reliable=<n> Minimum position reliability to put it into json(default: 1, globe options will default set thisto 2, disable speed filter: -1, max: 4)--json-trace-hist-only=1,2,3,8Don't write recent(1), full(2), either(3) tracesto /run, only archive via write-globe-history (8:irregularly write limited traces to run, subjectto change)--json-trace-interval=<seconds>Interval after which a new position willguaranteed to be written to the trace and the jsonposition output (default: 30)--lat=<lat> Reference/receiver surface latitude--leg-focus=<hex> show leg marking details for this hex--lon=<lon> Reference/receiver surface longitude--max-range=<dist> Absolute maximum range for position decoding (innm, default: 300)--metric Use metric units--mlat Display raw messages in Beast ASCII mode--modeac Enable decoding of SSR Modes 3/A & 3/C--modeac-auto Enable Mode A/C if requested by a Beastconnection--no-fix Disable CRC single-bit error correction--no-fix-df Disable CRC single-bit error correction on the DFtype to produce more DF17 messages (disablingreduces CPU usage)--no-interactive Disable interactive mode, print to stdout--onlyaddr Show only ICAO addresses--position-persistence=<n> Position persistence against outliers(default: 4), incremented by json-reliable minus1--preamble-threshold=<40-400>lower threshold --> more CPU usage (default: 58,pi zero / pi 1: 75, hot CPU 42)--quiet Disable output (default)--range-outline-hours=<hours>Make the range outline retain data for the last Xhours (float, default: 24.0)--raw Show only messages hex values--receiver-focus=<receiverId>only process messages from receiverId--show-only=<addr> Show only messages by given ICAO on stdout--snip=<level> Strip IQ file removing samples < level--stats With --ifile print stats at exit. No other output--stats-every=<sec> Show and reset stats every <sec> seconds--stats-range Collect/show range histogram--trace-focus=<hex> show traceAdd details for this hex--write-globe-history=<dir>Extended Globe History--write-json=<dir> Periodically write json output to <dir>--write-json-binCraft-only=<n>Use only binary binCraft format for globe files(1), for aircraft.json as well (2)--write-json-every=<sec> Write json output and update API json everysec seconds (default 1)--write-json-globe-index Write specially indexed globe_xxxx.json files(for tar1090)--write-json-gzip Write aircraft.json also as aircraft.json.gz--write-prom=<filepath> Periodically write prometheus output to<filepath>--write-receiver-id-json Write receivers.json--write-state=<dir> Write state to disk to have traces and outlineafter a restart--write-state-only-on-exit Don't continously update state.Network options:--net Enable networking--net-api-port=<port> TCP API listen port (in contrast to otherlisteners, only a single port is allowed) (updatefrequency controlled by write-json-everyparameter) (default: 0)--net-beast-reduce-filter-alt=<pressure altitude in ft>beast-reduce: remove aircraft which are abovealtitude--net-beast-reduce-filter-dist=<distance in nmi>beast-reduce: remove aircraft which are furtherthan distance from the receiver--net-beast-reduce-interval=<seconds>BeastReduce position update interval, longer meansless data (default: 0.125, valid range: 0.000 -14.999)--net-beast-reduce-out-port=<ports>TCP BeastReduce output listen ports (default: 0)--net-bi-port=<ports> TCP Beast input listen ports (default: 0)--net-bind-address=<ip> IP address to bind to (default: Any; Use127.0.0.1 for private)--net-bo-port=<ports> TCP Beast output listen ports (default: 0)--net-buffer=<n> TCP buffer size 64Kb * (2^n) (default: n=2, 256Kb)--net-connector=<ip,port,protocol>Establish connection, can be specified multipletimes (e.g. 127.0.0.1,23004,beast_out) Protocols:beast_out, beast_in, raw_out, raw_in, sbs_in,sbs_in_jaero, sbs_out, sbs_out_jaero, sbs_out_priovrs_out, json_out, asterix_out, asterix_in,gpsd_in (one failover ip/address,port can be specified:primary-address,primary-port,protocol,failover-address,failover-port)--net-connector-delay=<seconds>Outbound re-connection delay (default: 30)--net-garbage=<ports> timeout receivers, output messages from timed outreceivers as beast on <ports>--net-heartbeat=<rate> TCP heartbeat rate in seconds (default: 60 sec; 0to disable)--net-ingest primary ingest node--net-json-port=<ports> TCP json position output listen ports, sendsone line with a json object containing aircraftdetails for every position received (default: 0)--net-json-port-include-nopositionTCP json position output: include aircraft withoutposition (state is sent for aircraft for everyDF11 with CRC if the aircraft hasn't sent aposition in the last 10 seconds and intervalallowing)--net-json-port-interval=<seconds>Set minimum interval between outputs per aircraftfor TCP json output, default: 0.0 (everyposition)--net-only Enable just networking, no RTL device or fileused--net-receiver-id forward receiver ID--net-ri-port=<ports> TCP raw input listen ports (default: 0)--net-ro-interval=<rate> TCP output flush interval in seconds (maximuminterval between two network writes of accumulateddata)(default: 0.05, valid values 0.005 - 1.0)--net-ro-port=<ports> TCP raw output listen ports (default: 0)--net-ro-size=<size> TCP output flush size (maximum amount ofinternally buffered data before writing tonetwork) (default: 1200)--net-sbs-in-port=<ports> TCP BaseStation input listen ports (default:0)--net-sbs-jaero-in-port=<ports>TCP SBS Jaero input listen ports (default: 0)--net-sbs-jaero-port=<ports>TCP SBS Jaero output listen ports (default: 0)--net-sbs-port=<ports> TCP BaseStation output listen ports (default: 0)--net-sbs-reduce Apply beast reduce logic and interval to SBSoutputs--net-ao-port=<ports> TCP ASTERIX output listen ports (default: 0)--net-ai-port=<ports> TCP ASTERIX input listen ports (default: 0)--net-asterix-reduce Apply beast reduce logic and interval to ASTERIXoutputs--net-verbatim Forward messages unchanged--net-vrs-interval=<seconds>TCP VRS json output interval (default: 5.0)--net-vrs-port=<ports> TCP VRS json output listen ports (default: 0)--uuid-file=<path> path to UUID fileModes-S Beast options, use with --device-type modesbeast:--beast-baudrate=<baud> Override Baudrate (default rate 3000000 baud)--beast-crc-off Turn OFF CRC checking--beast-df045-on Turn ON DF0/4/5 filter--beast-df1117-on Turn ON DF11/17-only filter--beast-fec-off Turn OFF forward error correction--beast-mlat-off Turn OFF MLAT time stamps--beast-modeac Turn ON mode A/C--beast-serial=<path> Path to Beast serial device (default/dev/ttyUSB0)GNS HULC options, use with --device-type gnshulc:--beast-serial=<path> Path to GNS HULC serial device (default/dev/ttyUSB0)ifile-specific options, use with --ifile:--ifile=<path> Read samples from given file ('-' for stdin)--iformat=<type> Set sample format (UC8, SC16, SC16Q11)--throttle Process samples at the original capture speedHelp options:-?, --help Give this help list--usage Give a short usage message-V, --version Print program version