diff --git a/README.md b/README.md index 3921d3b..4767fe4 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,21 @@ altitude/speed/model/route details and a proximity LED alert. ![Eiswolfs Flightradar screenshot](images/radar.jpg) +## Getting Started + +### 🚀 Option 1: Quick Web Installation (Recommended) +You can flash the firmware directly from your browser to your CYD display without installing any development tools: +1. Connect your "Cheap Yellow Display" to your computer using a USB cable. +2. Open the **[Flightradar Web Flasher](https://github.io)** (requires Google Chrome, Microsoft Edge, or Opera). +3. Click the **Install** button, select your USB/COM port, and follow the on-screen instructions. + +### 🛠️ Option 2: Manual Compilation (For Developers) +1. Open and compile the project using PlatformIO (`platform = espressif32`, `board = esp32dev`, `framework = arduino`). +2. Insert a FAT32-formatted microSD card into your display. +3. On first boot: Calibrate the touchscreen and configure your Wi-Fi via the built-in on-screen keyboard. + +--- + ## Features - **Live radar screen** – circular radar view, sized to the full screen width, with a rotating green sweep line - **Real ADS-B data** via the free [adsb.fi](https://adsb.fi) API, refreshed every 8 seconds @@ -66,6 +81,7 @@ currently see. Any saved network can be removed again at any time via the red "X", freeing up a slot for a new one. + ## ✈️ Flight Options — every function in detail All the functions below are found under **Menu → Flight Options**. @@ -118,34 +134,7 @@ See the dedicated section above: [WiFi Manager](#-wifi-manager-up-to-3-saved-net - Flight data is re-fetched from [adsb.fi](https://adsb.fi) every **8 seconds**. - Altitude color coding is fixed: **green** < 10,000 ft, **yellow** 10,000–30,000 ft, **red** > 30,000 ft. - Radar radius is switchable between **10 / 25 / 50 / 100 km**. + ## Hardware - ESP32-2432S028 ("Cheap Yellow Display", CYD) – ILI9341 2.8" 240x320 touch TFT -- microSD card (FAT32) for settings, WiFi credentials, and lookup tables -- No GPS, no speaker required – uses IP geolocation and the onboard RGB LED - -### Pinout used -| Function | Pins | -|---|---| -| TFT (VSPI) | MISO=12, MOSI=13, SCLK=14, CS=15, DC=2, BL=21 | -| Touch (XPT2046) | CLK=25, CS=33, MOSI=32, MISO=39, IRQ=36 | -| microSD (HSPI) | CLK=18, MISO=19, MOSI=23, CS=5 | -| RGB LED (active-low) | R=4, G=16, B=17 | - -## Getting started -1. Flash with PlatformIO (`platform = espressif32`, `board = esp32dev`, `framework = arduino`) -2. Insert a FAT32-formatted microSD card -3. On first boot: touch-calibrate the screen, then select your WiFi network and enter the password using the on-screen keyboard -4. The radar screen appears automatically once WiFi and location are ready - -## Data sources -- Aircraft positions: [adsb.fi](https://adsb.fi) (free, no API key) -- Aircraft model lookups: [hexdb.io](https://hexdb.io) (free, community-maintained, rate-limited) -- Location: [ip-api.com](https://ip-api.com) (free IP geolocation) - -## Disclaimer -Aircraft model and seat-count data are estimates from community databases and -local lookup tables, not live/official figures. This project is for hobby use -and is not intended for navigation or safety-critical purposes. - -## License -MIT (or add your preferred license here) +- microSD card slot