LibEFB - A bag of flight utilities

This library provides utilities to support the flight planning and air navigation. The lib is written in Rust and intended to be integrated into EFB applications via one of its language binding (see bindings/).

[!NOTE] This library is still in the early stage of development with the first milestone to allow a full pre-flight planning. For more, checkout the roadmap.

Getting Started

The efb crate provides the core library. The center piece of this library is the Flight Management System (FMS). It integrates and interfaces with all sub-systems that are used for flight planning and execution. The following example just shows the very basics that we can enter into the FMS to get started:

use std::fs::read_to_string;
use std::path::Path;

use efb::prelude::*;

fn main() -> Result<(), Error> {
    let mut fms = FMS::new();

    // Read a ARINC 424 file downloaded from https://www.openflightmaps.org
    let records = read_to_string(Path::new("arinc_ed.pc")).unwrap_or_default();

    // Read the German navigation data from the ARINC 424 record
    let ed = NavigationData::try_from_arinc424(&records)?;
    fms.modify_nd(|nd| nd.append(ed))?;

    // Decode a route from EDDH to EDHF with winds at 20 kt from 290° and
    // cruising speed of 107 kt and an altitude of 2500 ft.
    fms.decode("29020KT N0107 A0250 EDDH N2 N1 DCT EDHF".to_string())?;

    // Now we could define an aircraft and continue with our planning
    // but for now we'll just print the route
    println!("{}", fms.print(40)); // the line length is set to 40 character

    Ok(())
}

Running this example with a proper ARINC 424 file, we get the following output:

----------------------------------------
-- ROUTE
----------------------------------------

TO          HDG           DIST      ETE
N2         354 °M       3.2 NM     113 s

TO          HDG           DIST      ETE
N1         354 °M       7.5 NM     266 s

TO          HDG           DIST      ETE
EDHF       298 °M      19.6 NM     806 s

DIST                             30.3 NM
ETE                               1185 s

The library can be used from other languages through the different bindings. For more on a specific binding and its usage, refer to the READMEs of the bindings.

📝 Git Hooks

There is a pre-commit hook in .githooks. Either copy it to .git/hooks or configure git to use hooks from this directory:

git config core.hooksPath .githooks

The hook requires Ruby (pre-installed on macOS and most Linux distributions). Verify Ruby is installed ruby --version.

🚀 Roadmap

In a first stage, the library should be extended to allow proper flight planning by adding the following feature:

• Add runway analysis to planning
• Add missions with multiple flights
• Add Python bindings to allow easy scripted planning
• Add measurement trait and refactor core types
• Extend printer to render HTML
• Add AIXM parser
• Add NOTAMS to FMS
• Add vertical flight profile to FMS
• Add book to outline how the FMS and planning is used from the user perspective

Once those feature are available and flight planning can be conducted with this library, the goal is to move on to add feature that will be needed in flight:

• Create concept to provide geo-referenced VFR approach charts
• Add position input to FMS
• Add airspace alerts to FMS
• Add location info to FMS
• Create concept to gather weather data and METAR
• Add initial airport information with frequencies and RWYs
• Add landing field analysis for EMER
• Add wake turbulence predictor