Skip to content

Tommy131/OwO-FlightAssistant

Repository files navigation

OwO! FlightAssistant

中文说明 (Chinese)

Flutter Platform License

OwO! FlightAssistant is a modular flight-companion app for desktop and mobile simulator workflows. The current frontend integrates flight monitoring, checklist execution, map visualization, airport/METAR search, flight log analysis, and middleware health diagnostics for both MSFS 2020/2024 and X-Plane 11/12.

Feature Overview

1) Home Dashboard & Simulator Session

General Info Aircraft Info Airport Info
Home General Home Aircraft Home Airport
  • Connect/disconnect simulator sessions from the home workflow.
  • Track key airborne and ground data in a compact status dashboard.
  • Display airport and aircraft context in one unified entry page.

2) Airport Search & Operational Briefing

Airport Search Briefing Generator Briefing Details
Airport Search Briefing Generator Briefing Details
  • Search ICAO airports with suggestion support and favorites persistence.
  • Load airport details + METAR through the middleware API.
  • Generate and review operation briefing cards and history records.

3) Checklist, Monitor, and Toolbox

Checklist Monitor (Charts) Monitor (Landing Gear) Toolbox
Checklist Monitor Charts Monitor Landing Gear Toolbox
  • Execute multi-phase SOP checklists (A320/B737/Generic).
  • Observe live monitor panels (charts, heading, systems, landing gear).
  • Use utility tools and aviation reference cards from Toolbox.

4) Map Module (Layers, Weather, Airports)

Layer Panel Airport Types Airport Info Weather Radar
Map Layers Map Airport Types Map Airport Info Map Radar
  • Multi-provider map backgrounds (OpenStreetMap, Esri, Carto variants).
  • Airport rendering by category and airport detail panels.
  • RainViewer weather radar overlay timeline support.

5) Flight Logs & Analysis

Logs List Track View Quality Report Danger Test
Flight Logs Flight Track Flight Quality Danger Test
Black Box Black Box (Danger Alert)
Black Box Black Box Danger
  • Store and replay flight sessions with timeline and track analysis.
  • Provide quality scoring and safety-oriented danger testing.
  • Inspect black-box style event data for post-flight review.

6) Settings & Middleware Diagnostics

Middleware Settings Map Module Settings Global Settings
Middleware Settings Map Module Settings Settings
  • Configure HTTP and WebSocket middleware endpoints.
  • Run integrated connectivity diagnosis (backend / websocket / simulator state).
  • Tune map module data behaviors and app-level preferences.

Supported Devices, Platforms, and Simulators

Device Layout Support

  • Mobile layout: width < 650
  • Tablet layout: width 650 - 1241
  • Desktop layout: width >= 1242

Flutter Targets in This Repository

  • Windows desktop: first-class experience and recommended for simulator operations
  • Android / iOS: available targets for mobile companion usage
  • Web: scaffolded and buildable for browser usage

Simulators

  • Microsoft Flight Simulator (2020 / 2024)
  • X-Plane (11 / 12)

Project Architecture (Frontend)

lib/
├── core/                    # App shell, localization, theme, module registry
├── modules/
│   ├── home/                # Home dashboard + simulator controls
│   ├── checklist/           # SOP checklist module
│   ├── map/                 # Interactive map + layers + weather
│   ├── airport_search/      # ICAO search, airport details, METAR
│   ├── monitor/             # Live monitor widgets and charts
│   ├── briefing/            # Flight briefing generation and history
│   ├── flight_logs/         # Flight logs and analysis views
│   ├── toolbox/             # Utility toolbox
│   └── http/                # Middleware endpoint settings + diagnostics
└── main.dart

Module registration entry: lib/modules/modules_register_entry.dart.

Installation & Usage

Prerequisites

  • Flutter SDK ^3.9.2
  • A running middleware backend instance (default: http://127.0.0.1:18080)
  • Optional simulator runtime:
    • MSFS 2020/2024
    • X-Plane 11/12

Install

git clone <your-fork-or-repo-url>
cd owo_flight_assistant
flutter pub get

Run (Recommended: Windows Desktop)

flutter run -d windows

Alternative targets:

flutter run -d android
flutter run -d ios
flutter run -d chrome

Basic Usage Flow

  1. Open Settings → Middleware Settings, set backend host/port if not default.
  2. Go to Home, connect simulator session.
  3. Use Checklist, Map, Monitor, and Airport Search modules during flight.
  4. Review post-flight insights in Flight Logs.

Open-Source Repositories / Packages Used

Core framework and state:

Networking and simulator channels:

Mapping and geo:

Storage, files, and desktop runtime:

UI and utilities:

API Interfaces Used by Frontend

Default middleware endpoints:

  • HTTP base URL: http://127.0.0.1:18080
  • WebSocket base URL: ws://127.0.0.1:18081/api/v1/simulator/ws

Main API routes consumed:

  • GET /health
  • GET /api/v1/version
  • GET /api/v1/airport/{icao}
  • GET /api/v1/airport-layout/{icao}
  • GET /api/v1/metar/{icao}
  • GET /api/v1/airport-list
  • GET /api/v1/airport-suggest?q={query}&limit={n}
  • GET /api/v1/airports?min_lat=&max_lat=&min_lon=&max_lon=&limit=
  • POST /api/v1/simulator/state
  • POST /api/v1/simulator/connect
  • POST /api/v1/simulator/data
  • POST /api/v1/simulator/disconnect
  • GET /api/v1/simulator/ws

Third-party map/weather data services:

Open-Source License

This project is licensed under:

  • Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International
  • See LICENSE for full terms.

Developer Information

Disclaimer

This software is for simulator training, learning, and research purposes only. Do not use it for real-world flight operations.