Skip to content

Commit

Permalink
small API page fixes (flybywiresim#1071)
Browse files Browse the repository at this point in the history
  • Loading branch information
@frankkopp
frankkopp authored Jan 1, 2025
1 parent 86d8786 commit 4f3c6d4
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 31 deletions.
57 changes: 28 additions & 29 deletions docs/aircraft/a32nx/a32nx-api/a32nx-flightdeck-api.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: FlyByWire A32NX API - A32NX Flight Deck API
title: A32NX Flight Deck API
description: Documentation for the FlyByWire A32NX FlightDeck API.
hide:
- navigation
Expand Down Expand Up @@ -152,7 +152,6 @@ Flight Deck: [EXT LT Panel](../../../pilots-corner/a32nx/a32nx-briefing/flight-

!!! warning "Doing it this way might break any third-party software trying to read the status of the lights through SIMCONNECT."


### Interior Lights Panel

Flight Deck: [INT LT Panel](../../../pilots-corner/a32nx/a32nx-briefing/flight-deck/ovhd/int-lt.md)
Expand Down Expand Up @@ -686,33 +685,33 @@ Flight Deck: [ILCP Panel](../../../pilots-corner/a32nx/a32nx-briefing/flight-dec

Flight Deck: [Autobrake and Gear Panel](../../../pilots-corner/a32nx/a32nx-briefing/flight-deck/front/autobrake-gear.md)

| Function | API Usage | Values | Read/Write | Type | Remark |
|:----------------------|:--------------------------------|:---------|:-----------|:-----------------|:-----------------------------------|
| Gear lever | GEAR_UP | - | - | SIMCONNECT EVENT | |
| | GEAR_DOWN | - | - | SIMCONNECT EVENT | |
| | GEAR HANDLE POSITION | 0|1 | R/W | SIMCONNECT VAR | |
| | | | | | |
| LDG GEAR Annunciators | GEAR LEFT POSITION | 0..100 | R | SIMCONNECT VAR | |
| | GEAR CENTER POSITION | 0..100 | R | SIMCONNECT VAR | |
| | GEAR RIGHT POSITION | 0..100 | R | SIMCONNECT VAR | |
| | | | | | |
| AUTO BRK LO/MED/MAX | A32NX_AUTOBRAKES_ARMED_MODE | 0..3 | R | Custom LVAR | 0=DIS, 1=LO, 2=MED, 3=MAX |
| | A32NX_AUTOBRAKES_ARMED_MODE_SET | -1..3 | W | Custom LVAR | -1=techn. 0=DIS, 1=LO,2=MED, 3=MAX |
| | A32NX_AUTOBRAKES_ACTIVE | 0|1 | R | Custom LVAR | 0=not braking, 1=braking |
| | A32NX_AUTOBRAKES_DECEL_LIGHT | 0|1 | R | Custom LVAR | 0=off, 1=on |
| | A32NX.AUTOBRAKE_SET | 1..4 | | Custom EVENT | 1=DIS, 2=LO, 3=MED, 4=MAX |
| | A32NX.AUTOBRAKE_SET_DISARM | - | - | Custom EVENT | |
| | A32NX.AUTOBRAKE_SET_LO | - | - | Custom EVENT | |
| | A32NX.AUTOBRAKE_SET_MED | - | - | Custom EVENT | |
| | A32NX.AUTOBRAKE_SET_MAX | - | - | Custom EVENT | |
| | A32NX.AUTOBRAKE_BUTTON_LO | - | - | Custom EVENT | |
| | A32NX.AUTOBRAKE_BUTTON_MED | - | - | Custom EVENT | |
| | A32NX.AUTOBRAKE_BUTTON_MAX | - | - | Custom EVENT | |
| | | | | | |
| BRK FAN | A32NX_BRAKE_FAN_BTN_PRESSED | 0|1 | R/W | Custom LVAR | |
| | | | | | |
| A/SKID & N/W STRG | ANTISKID_BRAKES_TOGGLE | - | - | SIMCONNECT EVENT | |
| | ANTISKID BRAKES ACTIVE | 0|1 | R/W | SIMCONNECT VAR | |
| Function | API Usage | Values | Read/Write | Type | Remark |
|:----------------------|:--------------------------------|:---------|:-----------|:-----------------|:--------------------------|
| Gear lever | GEAR_UP | - | - | SIMCONNECT EVENT | |
| | GEAR_DOWN | - | - | SIMCONNECT EVENT | |
| | GEAR HANDLE POSITION | 0|1 | R/W | SIMCONNECT VAR | |
| | | | | | |
| LDG GEAR Annunciators | GEAR LEFT POSITION | 0..100 | R | SIMCONNECT VAR | |
| | GEAR CENTER POSITION | 0..100 | R | SIMCONNECT VAR | |
| | GEAR RIGHT POSITION | 0..100 | R | SIMCONNECT VAR | |
| | | | | | |
| AUTO BRK LO/MED/MAX | A32NX_AUTOBRAKES_ARMED_MODE | 0..3 | R | Custom LVAR | 0=DIS, 1=LO, 2=MED, 3=MAX |
| | A32NX_AUTOBRAKES_ARMED_MODE_SET | 0..3 | W | Custom LVAR | 0=DIS, 1=LO,2=MED, 3=MAX |
| | A32NX_AUTOBRAKES_ACTIVE | 0|1 | R | Custom LVAR | 0=not braking, 1=braking |
| | A32NX_AUTOBRAKES_DECEL_LIGHT | 0|1 | R | Custom LVAR | 0=off, 1=on |
| | A32NX.AUTOBRAKE_SET | 0..3 | | Custom EVENT | 0=DIS, 1=LO, 2=MED, 3=MAX |
| | A32NX.AUTOBRAKE_SET_DISARM | - | - | Custom EVENT | |
| | A32NX.AUTOBRAKE_SET_LO | - | - | Custom EVENT | |
| | A32NX.AUTOBRAKE_SET_MED | - | - | Custom EVENT | |
| | A32NX.AUTOBRAKE_SET_MAX | - | - | Custom EVENT | |
| | A32NX.AUTOBRAKE_BUTTON_LO | - | - | Custom EVENT | |
| | A32NX.AUTOBRAKE_BUTTON_MED | - | - | Custom EVENT | |
| | A32NX.AUTOBRAKE_BUTTON_MAX | - | - | Custom EVENT | |
| | | | | | |
| BRK FAN | A32NX_BRAKE_FAN_BTN_PRESSED | 0|1 | R/W | Custom LVAR | |
| | | | | | |
| A/SKID & N/W STRG | ANTISKID_BRAKES_TOGGLE | - | - | SIMCONNECT EVENT | |
| | ANTISKID BRAKES ACTIVE | 0|1 | R/W | SIMCONNECT VAR | |

### ISIS

Expand Down
4 changes: 2 additions & 2 deletions docs/aircraft/a380x/a380x-api/a380x-flight-deck-api.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Find the developer documentation of Custom Events and Custom LVars of the A380X:
[//]: # (- [Custom Events](https://github.com/flybywiresim/aircraft/blob/master/fbw-a380x/docs/a380-events.md){target=new})


## "How to read the tables"
## How to read the tables

- **Function**: The name of the switch or button on the panel.
- **API Usage**: The name of the API variable or event.
Expand All @@ -32,7 +32,7 @@ To shorten the length of the table, we use the following placeholders for the AP
- `{SIDE}`: Replace with `L` for left, `R` for right (and sometimes `C` for Center).
- `{NUM}`: Replace with `1` for the first, `2` for the second, `3` for the third, `4` for the fourth.

### "API Var and Event Types"
### API Var and Event Types

| Type | Description |
|----------------------|-----------------------------------------------------------------------------------------------------------------------|
Expand Down

0 comments on commit 4f3c6d4

Please sign in to comment.