viz1090/README.md
nathan 2f8ce3447d misc cleanup
Former-commit-id: 747cd4fac34c15f1c7d404abb90a37ccdda8d208
2020-06-10 11:28:52 -07:00

4.6 KiB

viz1090

This is work in progress There are a lot of missing pieces in this implementation so far:

  • A proper map system yet. Eventually map data should be pulled from Mapbox or similar.
  • In-application menus or configuration yet.
  • Theming/colormaps (important as this is primarily intended to be eye candy!)
  • Integration with handheld features like GPS, battery monitors, buttons/dials, etc.
  • Android build is currently broken

BUILDING

Tested and working on Ubuntu 18.04, Raspbian Stretch / Buster, Windows Subsystem for Linux (with Ubuntu 18.04)

  1. Install build essentials
sudo apt-get install build-essentials
  1. Install SDL and RTL-SDR libararies
sudo apt-get install libsdl2-dev libsdl2-ttf-dev libsdl2-gfx-dev librtlsdr-dev
Note: On Raspbian the SDL2 package requires X to be running. See the Raspberry Pi section for notes on running from the terminal and other improvements.
  1. Download and build spidr
cd ~
git clone https://www.github.com/nmatsuda/spidr
cd spidr
make clean; make
  1. Download and process map data Until more comprehensive map source (e.g., Mapbox) is integrated, viz1090 uses the lat/lon SVG files from https://www.mccurley.org

The getmap.sh pulls the svg file for the contiguous 48 US states and produces a binary file for viz1090 to read.

sudo apt install python3 python3-pip
pip3 install lxml numpy
./getmap.sh
  1. (optional for Windows)

As WSL does not have an X server built in, you will need to install a 3rd party X server, such as https://sourceforge.net/projects/vcxsrv/

* run Xlaunch from the start menu
* Uncheck "Use Native openGL"
* Open the Ubuntu WSL terminal
* Specify the X display to use
```
export DISPLAY=:0
```
* Start viz1090 as described below.

RUNNING

  1. Start dump1090 (http://www.github.com/MalcolmRobb/dump1090) locally in network mode:
dump1090 --net
  1. Run viz1090
./viz1090 --fullsceen --lat [your latitude] --lon [your longitude]

viz1090 will open an SDL window set to the resolution of your screen.

RUNTIME OPTIONS

| --server [domain name or ip] | Specify a dump1090 server | | --port [port number] | Specify dump1090 server port | | --metric | Display metric units | | --lat | Specify your latitude in degrees | | --lon | Specify your longitiude in degrees | | --screensize [width] [height] | Specify a specific resolution to pass to SDL_RenderSetLogicalSize, otherwise use resolution of display | | --uiscale [scale] | Scale up UI elements by integer amounts for high resolution screen | | --fullscreen | Render fullscreen rather than in a window |

HARDWARE NOTES

This software was originally intended for Raspberry Pi devices, and it is currently optimized for the Raspberry Pi 4 with the following configuration:

If running as a front end only, with a separate dump1090 server, the best option is to use an Android phone, such as the Pixel 2, which significantly outperforms a Raspberry Pi 4.

viz1090 has been tested on other boards such as the UP Core and UP Squared, but these boards have poor performance compared to a Raspberry Pi 4, along with worse software and peripheral support, so they are not recommended. viz1090 with a low resolution map will run on these boards or even a Raspberry Pi Zero, so these remain options with some tradeoffs.

Of course, a variety of other devices work well for this purpose - all of the development so far has been done on a touchscreen Dell XPS laptop.

Credits

viz1090 is largely based on dump1090 (Malcom Robb, Salvatore Sanfilippo)