From 85636501f52fb3ea2fd58b059e868b279afb2700 Mon Sep 17 00:00:00 2001 From: nathan Date: Fri, 6 Mar 2020 21:49:40 -0800 Subject: [PATCH] some readme updates and cleanup Former-commit-id: bdb8d4c516a0aafed3c0fd709d52ab6ede543e25 Former-commit-id: c3f75db4e56a1549f2037a88cb9d91d5ff4ed154 --- README.md | 141 +++++++++++++++++------------------------------------- 1 file changed, 43 insertions(+), 98 deletions(-) diff --git a/README.md b/README.md index 1c9e999..76c7da5 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -#spidr1090 +#map1090 -###INSTALLATION +###BUILDING Tested and working on Ubuntu 18.04, Raspbian Stretch, Buster @@ -19,20 +19,30 @@ cd spidr make clean; make ``` -3. Download and build dump1090 -``` -cd ~ -git clone http://www.github.com/MalcolmRobb/dump1090) -cd dump1090 -make clean; make +3. Download and process map data +Until more comprehensive map source (e.g., Mapbox) is integrated, map1090 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 map1090 to read. -4. Run ``` -~/dump1090/dump1090 --net -cd spidr +./getmap.sh +``` + +###RUNNING + +1. Start dump1090 (http://www.github.com/MalcolmRobb/dump1090) locally in network mode: +``` +dump1090 --net +``` + +2. Run map1090 +``` ./view1090 --fullsceen +``` -### Runtime Options +map1090 will open an SDL window set to the resolution of your screen. + +###RUNTIME OPTIONS --server [domain name or ip] Specify a dump1090 server. Renamed from the view1090 "--net-bo-ip-addr" argument --port [port number] Specify dump1090 server port. Renamed from the view1090 "--net-bo-port" argument @@ -42,94 +52,29 @@ cd spidr --uiscale [scale] Scale up UI elements by integer amounts for high resolution screen --fullscreen Render fullscreen rather than in a window +###HARDWARE NOTES + +map1090 is designed to be portable and work on a variety of systems, however it is intended to be used on a handheld device. + +The software was originally develped for Raspberry Pi devices, and it is currently optimized for the Raspberry Pi 4 with the following configuration: + +* Raspberry Pi 4 +* A display: + * [Pimoroni HyperPixel 4.0 Display] (https://shop.pimoroni.com/products/hyperpixel-4) \*best overall, but requires some rework to use battery monitoring features of the PiJuice mentioned below + * [Waveshare 5.5" AMOLED] (https://www.waveshare.com/5.5inch-hdmi-amoled.htm) \*this is very good screen but the Google Pixel 2 phone mentioned below has a very similar display for the same price (along with everything else you need in a nice package) + * [Waveshare 4.3" HDMI(B)] (https://www.waveshare.com/wiki/4.3inch_HDMI_LCD_(B)) + * [Adafruit 2.8" Capacitive Touch] (https://www.adafruit.com/product/2423) +* A battery hat, such as: + * [PiJuice Battery Hat] (https://uk.pi-supply.com/products/pijuice-standard) \*I2C pins must be reworked to connect to the Hyperpixel nonstandard I2C breakout pins, unfortunately + * [MakerFocus UPS Hat] (https://www.amazon.com/Makerfocus-Raspberry-2500mAh-Lithium-Battery/dp/B01MQYX4UX) +* Any USB SDR receiver: + * [Noelec Nano V3] (https://www.nooelec.com/store/nesdr-nano-three.html) + * Stratux V2 \*very low power but hard to find -### TODO -* build for ios and android -* menu system (toggles for UI elements) -* map system (automatically load open source) -* separate fully from view1090 (which interface?) +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. +map1090 has been tested on other boards such as the UP Core and UP Squared, but these boards have significantly poorer performance than the Raspberry Pi 4 with less software and peripheral support, so they are not recommended. With low resolution maps the software will run on these boards or even a Raspberry Pi Zero, so these remain options with some tradeoffs. -###HARDWARE +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. -Right now, Pixel 2 is $109 on Amazon (https://www.amazon.com/Google-Pixel-64-Black-Refurbished/dp/B0787V183F). -This significantly outperforms a rpi4. - - -best option seems to be pi4 + pijuice zero (w/ rewired i2c) + hyperpixel 4. RTLSDR (stratux) sticks down or needs u shaped adapter. -For future tuner, need to test audio phat w/ little speaker, i2c knob, etc. - - -Notes: -Pi 3b+ and below are a little underpowerd for unoptimized map drawing -Pi 4 is smooth, may have USB issues with RTLSDR? -Up squared is good, but large -Up Core may be fine but bad connection options? - -PiJuice is by far best battery option. FCC/CE certified! - -Need to test stratux low power dongles. 987Mhz? - -Waveshare 4.3" HDMI(B) and 5.5" AOLED are both very good, a little too large for handheld. Uses a lot of power, around 500ma for the 4.3", the AMOLED scales by the overal screen brightness. -Pimoroni Hyperpixel 4.0 is the right size, but takes over default I2C pins so conflicts with PiJuice, unless some pin remapping. Also lower power, around 150ma -Adafruit PiTFT 2.8" capacitive touch is ok, but a little small. Not sure about power draw. Docs claim no multitouch? - - -####Pi Zero Version -Part | Link | Cost ---- | --- | --- -Raspberry Pi Zero W | | $10 -Adafruit 2.4" PiTFT Hat| (https://www.adafruit.com/product/2455) | $35 -NooElec Nano3 SDR | | $28 -Adafruit GPS Hat | (https://www.adafruit.com/product/2324) | $45 -Antenna | | -USB Jack | | -MicroSD Card | | -| | Total: $118+ - -####Battery Options -(https://en.wikipedia.org/wiki/List_of_battery_sizes) -Portrait Orientation: -18500 Batteries (18mm x 50mm), ~1000-2000mAh ea. -The Pi Zero configuration consumes are 500mAh - -Landscape Orientation -18650 batteries (18mm x 65mm). ~2200-3500mAh ea. -Adafruit pack + PowerBoost Charger, ~$40 -Anker PowerCore 10000, ~$25 - -Other options -external recharger (maybe cheaper and smaller?) along with 18500/18650 - -Some 18500 / 18650 include current protection inside, such as: -http://www.ebay.com/itm/2-x-Panasonic-NCR-18500-2000mAh-LI-ION-RECHARGEABLE-BATTERY-PCB-button-top-case-/391378348412?epid=1830264923&hash=item5b1ff7a97c:g:ePgAAOSwFqJWswnj, -otherwise would require external protection circuit to be used in parallel. - - - -####Pi 3 Version -This gets you a slightly bigger screen, and slightly better performance using the SDR Smart rather than the Nano 3, but requires a ton of annoying port/header clipping and desoldering. - -Part | Link | Cost ---- | --- | --- -Raspberry Pi 3 | | $35 -Adafruit 2.8" PiTFT Hat| https://www.adafruit.com/product/2423 | $45 -NooElec SDR Smart | | $20 -GlobalSat MicroGPS Dongle | (https://www.amazon.com/GlobalSat-ND-105C-Micro-USB-Receiver/dp/B00N32HKIW/ref=sr_1_3?ie=UTF8&qid=1505829420&sr=8-3&keywords=gps+dongle) | $30 -Antenna | | -USB Jack | | -MicroSD Card | | -| | Total: $130+ - - -alt screen https://www.amazon.com/3-5inch-RPi-LCD-Directly-pluggable-Displaying/dp/B01N48NOXI/ref=sr_1_26?ie=UTF8&qid=1505871836&sr=8-26&keywords=pi+3.5%22+tft, $30 instead of 45, larger, not cap touch - -####Battery Options - -Recommended: PiJuice - - -18650 batteries (18mm x 65mm). ~2200mAH ea. -Adafruit pack + PowerBoost Charger, ~$40 -http://www.ebay.com/itm/3-7-volts-6400-mAh-1S2P-18650-Li-Ion-Battery-Pack-PCB-protected-Panasonic-Cells-/221923032745?hash=item33aba4bea9:g:0-IAAOSw14xWLSr2