Skip to content

Commit

Permalink
docs: A380X API Page (flybywiresim#1047)
Browse files Browse the repository at this point in the history
* Added A380X API page

* Updates to page

* Updates to file list

* Updates to page

* Lights done

* Signs done

* ADIRS done

* Oxygen done

* fire done

* fuel done

* AIR panel

* ANTI ICE and CALLS panel

* EFIS panel

* FCU panel

* BRAKE and Gear Panel

* ISIS Panel

* Several Panels

* Complete API

* Improved type naming

* Imported GitHub pages to documentation

* Removed outdated page for hardware in A32NX. Harmonized API pages.

* Cross-linking files and various fixes and improvements

* Fixing ext pwr new variables a380x
  • Loading branch information
frankkopp authored Dec 16, 2024
1 parent 5d79706 commit 32ad4e6
Show file tree
Hide file tree
Showing 85 changed files with 1,283 additions and 185 deletions.
8 changes: 5 additions & 3 deletions docs/FILE_LIST.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,8 @@
- [X] [FlyByWire Aircraft Overview](aircraft/index.md)
- [X] [FlyByWire A32NX Overview](aircraft/a32nx/index.md)
- [X] [A32NX Flight Deck API](aircraft/a32nx/a32nx-api/a32nx-flightdeck-api.md)
- [X] [Common Hardware Controllers and Setup](aircraft/a32nx/a32nx-api/hardware.md)
- [X] [FlyByWire A32NX API](aircraft/a32nx/a32nx-api/index.md)
- [X] [A32NX Developer API](aircraft/a32nx/a32nx-api/lvars-events.md)
- [X] [A32NX Developer API](aircraft/a32nx/a32nx-api/a32nx-systems-api)
- [X] [Audio Configuration](aircraft/a32nx/feature-guides/audio.md)
- [X] [Custom Autopilot / Fly-By-Wire](aircraft/a32nx/feature-guides/autopilot-fbw.md)
- [X] [Custom Camera Views](aircraft/a32nx/feature-guides/camera-views.md)
Expand All @@ -27,6 +26,9 @@
- [X] [Profile](aircraft/a32nx/feature-guides/gsxintegration/profile.md)
- [X] [FlyByWire A380X Overview](aircraft/a380x/index.md)
- [X] [INOP System](aircraft/a380x/inop.md)
- [X] [A380X Flight Deck API](aircraft/a380x/a380x-api/a380x-flight-deck-api.md)
- [X] [A380X Developer API](aircraft/a380x/a380x-api/a380x-systems-api.md)
- [X] [FlyByWire A380X API](aircraft/a380x/a380x-api/index.md)
- [X] [Flight Planning](aircraft/a380x/feature-guides/flight-planning.md)
- [X] [Overview](aircraft/a380x/feature-guides/index.md)
- [X] [Fuel and Weight](aircraft/a380x/feature-guides/loading-fuel-weight.md)
Expand Down Expand Up @@ -253,7 +255,7 @@
- [X] [Glareshield Side Panels](pilots-corner/a380x/a380x-briefing/flight-deck/glareshield/glare-side.md)
- [X] [Glareshield Underside](pilots-corner/a380x/a380x-briefing/flight-deck/glareshield/glare-underside.md)
- [X] [Center Right Panel](pilots-corner/a380x/a380x-briefing/flight-deck/main-panel/center-right.md)
- [X] [Display Unit Control Panel](pilots-corner/a380x/a380x-briefing/flight-deck/main-panel/efis-reconf.md)
- [X] [Display Unit Control Panel](pilots-corner/a380x/a380x-briefing/flight-deck/main-panel/ducp)
- [X] [Engine Warning Display (EWD)](pilots-corner/a380x/a380x-briefing/flight-deck/main-panel/ewd.md)
- [X] [Gravity Gear Panel](pilots-corner/a380x/a380x-briefing/flight-deck/main-panel/gravity-gear.md)
- [X] [Integrated Standby Instrument System (ISIS)](pilots-corner/a380x/a380x-briefing/flight-deck/main-panel/isis.md)
Expand Down
3 changes: 1 addition & 2 deletions docs/TODO_README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,8 @@ is good enough for now but might be improved in the future.
- [X] [Wheel Chocks and GSE Safety Cones](aircraft/a32nx/feature-guides/wheel-chocks-cones.md)
- [X] [GSX Integration](aircraft/a32nx/feature-guides/gsxintegration/index.md)
- [X] [API](aircraft/a32nx/a32nx-api/index.md)
- [X] [Common Hardware](aircraft/a32nx/a32nx-api/hardware.md)
- [X] [FlyByWire A32NX API - A32NX Flight Deck API](aircraft/a32nx/a32nx-api/a32nx-flightdeck-api.md)
- [X] [FlyByWire A32NX LVAR Events](aircraft/a32nx/a32nx-api/lvars-events.md)
- [X] [FlyByWire A32NX LVAR Events](aircraft/a32nx/a32nx-api/a32nx-systems-api)
- [X] [A380X](aircraft/a380x/index.md)
- [X] [Overview](aircraft/a380x/index.md)
- [X] [Feature Guides](aircraft/a380x/feature-guides/index.md)
Expand Down
1 change: 0 additions & 1 deletion docs/aircraft/a32nx/a32nx-api/.pages
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
nav:
- Overview: index.md
- Common Hardware: hardware.md
- ...
31 changes: 31 additions & 0 deletions docs/aircraft/a32nx/a32nx-api/a32nx-systems-api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
title: A32NX Developer API
description: Documentation for the FlyByWire A32NX FlightDeck API.
---

# A32NX Developer API

Flight-Deck API Documentation: [Flight-Deck API](a32nx-flight-deck-api)

In addition to the above documentation, all custom variables and custom events are documented by our developers on our project's GitHub: [:fontawesome-brands-github:{: .github } - **Docs section on GitHub**](https://github.com/flybywiresim/aircraft/tree/master/fbw-a32nx/docs){target=new}

- [Original Page on Github for Custom LVARs](https://github.com/flybywiresim/aircraft/blob/master/fbw-a32nx/docs/a320-simvars.md){target=new}
- [Original Page on Github for Custom Events](https://github.com/flybywiresim/aircraft/blob/master/fbw-a32nx/docs/a320-events.md){target=new}

## Templates

- **SPAD.neXt:** [flybywire-aircraft-a320-neo.xml](https://github.com/flybywiresim/aircraft/tree/master/fbw-a32nx/docs/SPAD.neXt){target=new}
- **FSUIPC:** [flybywire-aircraft-a320-neo.evt](https://github.com/flybywiresim/aircraft/tree/master/fbw-a32nx/docs/FSUIPC){target=new}

!!! note "The GitHub pages have been imported below for your convenience."

## Developer SimVars Documentation

{{ external_markdown('https://raw.githubusercontent.com/flybywiresim/aircraft/refs/heads/master/fbw-a32nx/docs/a320-simvars.md', '') }}

## Developer Input Events Documentation

{{ external_markdown('https://raw.githubusercontent.com/flybywiresim/aircraft/refs/heads/master/fbw-a32nx/docs/a320-events.md', '') }}



89 changes: 0 additions & 89 deletions docs/aircraft/a32nx/a32nx-api/hardware.md

This file was deleted.

8 changes: 4 additions & 4 deletions docs/aircraft/a32nx/a32nx-api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,15 +51,15 @@ The FlyByWire A32NX also requires specific variables to control its advanced fea

Flight-Deck Documentation: [Flight-Deck API](a32nx-flightdeck-api.md)

Developer Documentation: [A32NX API Documentation](lvars-events.md)
Developer Documentation: [A32NX API Documentation](a32nx-systems-api)

The most common software solutions are:

- [SPAD.neXt](https://www.spadnext.com/home.html){target=new}
- [Axis and Ohs](https://www.axisandohs.com/){target=new}
- [FSUIPC](http://www.fsuipc.com/){target=new}
- [Axis and Ohs](https://axisandohs.weebly.com/){target=new}
- [Mobiflight](https://www.mobiflight.com/en/index.html){target=new}
- [SPAD.neXt](https://www.spadnext.com/home.html){target=new}

For SPAD.neXt we have some example configurations for common hardware controllers: [Common hardware with SPAD](hardware.md)



Expand Down
20 changes: 0 additions & 20 deletions docs/aircraft/a32nx/a32nx-api/lvars-events.md

This file was deleted.

Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed docs/aircraft/a32nx/assets/api-guide/stream-deck.png
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/aircraft/a380x/.pages
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ nav:
# - support
# - INOP Systems: inop.md
- Feature Guides: feature-guides
# - API and Hardware: a32nx-api
- A380X APIs: a380x-api
5 changes: 5 additions & 0 deletions docs/aircraft/a380x/a380x-api/.pages
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
nav:
- Overview: index.md
- A380X Flight Deck API: a380x-flight-deck-api.md
- A380X Developer API: a380x-systems-api.md
- ...
Loading

0 comments on commit 32ad4e6

Please sign in to comment.