Skip to content

Commit 76387c7

Browse files
refactor: remove experimental references from documentation
* refactor: clean experimental references from documentation * update faq.md * start of update a32nx-flightdeck-api.md * update resources.md * fbw-a32nx directory updates * archive exp.md * update config's redirects * update pilots-corner directory * update simbridge directory * remove experimental version on terr on nd api * lauvaan review * add admonition to FWS information * update installation.md release notes link * change installation.md release note link to be internal * bring back exp.md in redacted form --------- Co-authored-by: sleinmaster <[email protected]>
1 parent be5cea1 commit 76387c7

File tree

17 files changed

+189
-192
lines changed

17 files changed

+189
-192
lines changed

archive/exp.md

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,140 @@
1+
# Experimental Version
2+
3+
The Experimental version is a test version to find problems, issues and to improve functionality based on your feedback. It is <span style=color:red>**not**</span> meant to be used for **daily use or serious flights with** an Online ATC service.
4+
5+
{--
6+
7+
Currently, experimental is geared toward testing the initial version of VNAV with additional features added at the development team's discretion - [see below](#implemented-features-for-testing). Please use the appropriate discord thread to report any issues - [How to Report Issues](#how-to-report-issues).
8+
9+
--}
10+
11+
!!! danger "Do not expect support for the experimental version - use at own risk!"
12+
Please ensure that you have at least read this page and the known issues before reporting issues in the appropriate threads on our Discord server.
13+
14+
We ask that you understand that we may not offer support for any experimental issues due to the nature of this version. We will happily answer questions, time permitting.
15+
16+
## Implemented Features for Testing
17+
18+
### Flight Warning System (FWS)
19+
20+
We are testing the new FWS (Flight Warning System) which replaces the previous provisional system.
21+
See technical details in the respective
22+
[GitHub Pull Request #4872](https://github.com/flybywiresim/a32nx/pull/4872){target=new}.
23+
24+
![fws-init-ecam](../docs/pilots-corner/assets/beginner-guide/starting-aircraft/fws-init-ecam.png){loading=lazy width=50%}
25+
26+
Summary:
27+
28+
This PR is the first step on the way to our new flight warning system, written nearly entirely in Rust and using an accurate simulation of the underlying data acquisition and warning logic. The new system is made up of two simulated Flight Warning Computers, replacing some foundational logic pieces that were previously written in JavaScript. The vast majority of warnings on the EWD still have the same conditions as previously and have not been touched, but will be eventually moved over to the new flight warning computers one by one.
29+
30+
The new Flight Warning Computers are also hooked into the electrical and failure system, so the alerts that are now
31+
powered by the FWS truly won't work when both FWCs are unpowered or have failed.
32+
33+
### SimBridge
34+
35+
The following are features in testing that require the use of SimBridge:
36+
37+
- [Terrain Display](../docs/simbridge/simbridge-feature-guides/terrain.md) - **Now Available on the Development Version**
38+
- Remote MCDU (Web MCDU) - **Now Available on the Development Version**
39+
- [Setup and Configuration Guide](../docs/simbridge/simbridge-feature-guides/remote-displays/remote-mcdu.md)
40+
- [Usage Guide](../docs/simbridge/simbridge-feature-guides/remote-displays/remote-mcdu.md)
41+
- [Company Routes](../docs/simbridge/simbridge-feature-guides/coroute.md) - **Now Available on the Development Version**
42+
43+
!!! tip "SimBridge Information"
44+
- Learn about SimBridge and further status of various features, please - [Read Here](../docs/simbridge/index.md).
45+
- [SimBridge setup and configuration guide](../docs/simbridge/install-configure/configuration.md).
46+
47+
### Pause at Top of Descent (TOD)
48+
49+
- New setting in located in the EFB under Realism - Pause at Top of Descent (TOD).
50+
- This is configurable by distance between 0 - 50 NM before TOD.
51+
- When enabled, flight will pause at the specified distance before TOD.
52+
- If the TOD point shifts before your present position, or AP mode reverts to CRZ, this will pause the simulation.
53+
54+
Note: This may not be the final iteration of this feature, nor how it operates. The option to toggle top of descent in the EFB settings may be changed or moved into its own dedicated flyPad page or section in the future.
55+
56+
---
57+
58+
## Released Into Development Version
59+
60+
Features in testing that have been released into Development but not Stable will be listed here. This list will be pruned with every Stable release.
61+
62+
- VNAV version 1
63+
- flyPad OS 3
64+
- GSX Integration
65+
- Simbridge
66+
- Company Routes
67+
- Terrain Display
68+
- RMP Navigation Tuning
69+
- VOR/DME NAV Auto-tuning
70+
- Fine-Tuned Engine Parameters
71+
72+
---
73+
74+
## Known Issues
75+
76+
### EFCS
77+
78+
!!! info ""
79+
We are keeping these known issues here until dedicated EFCS information is available.
80+
81+
- Improve direct and alternate law: Direct law is not scaled down based on Flaps/Slats configuration, thus can be very sensitive at high speeds, Alternate law still uses TAS for
82+
the C* law, this is incorrect and will result in issues if no ADR is available.
83+
- V_stall warn AoAs need to be tuned, currently they are just the same as alpha_prot.
84+
- In some situations, AP might not be available in alternate law, even though it should be. This is due to how the AP commands are currently executed, which requires the normal
85+
laws to be active (IRL this is different). Will take some time to fix this, not planned currently.
86+
- The electrical bus connections are not quite correct yet, the ELAC/SEC 2 s have rather complex logic for power supply switching, which is not done yet.
87+
88+
### Pause at TOD Issues
89+
90+
- Since the feature is linked to vertical guidance, having an inaccurate T/D or missing T/D may not pause the simulation.
91+
92+
!!! warning "Sim Limitations"
93+
Note that while aircraft simulation is suspended (i.e., fuel consumption, airspeed, altitude, physics), environmental simulation will continue (Notably Live Weather, Live Traffic/AI Traffic). Consequences of this include that TCAS TA/RAs will still be issued and if there is a significant change in the weather over time (say a few hours), your vertical descent profile and performance figures may no longer be accurate, which means that the actual T/D point may now have shifted from the originally calculated value.
94+
95+
The timestamp issued in the pause pop-up shows your real local system's time (localized to your locale) to help mitigate against this problem.
96+
97+
This is considered a sim limitation, as the pause event we utilize does not affect the MSFS world environment. Along this line of thinking, we speculate that without historical live weather and traffic, it would not be possible to inject or restore the state that the world was in when the pause was initiated (the time slider in the weather toolbar only affects lighting and will still reflect live wind and weather data).
98+
99+
Flying using a weather preset and without AI/live traffic avoids this limitation entirely, but would also be a compromise in other ways.
100+
101+
### Vertical Guidance Issues
102+
103+
- There has been a large number of reports indicating that the T/D was placed too late. This will be investigated this further, but we ask you to please check your arrival routing for any odd path drawings. These are not unusual, for the speed predictions of VNAV do not affect the LNAV path computations yet, which causes certain turns to be drawn at a larger radius than what will actually be flown. Consequently, VNAV will calculate a profile with more track mileage than what is realistically available and place the T/D too late.
104+
- There is a problem with manually inserted constraints right now, where they are ignored or treated wrongly. Be aware of this and, if possible, advise if you have added any constraints manually when reporting an issue with the profile calculation. This is crucial in helping us identify and reproduce your issue.
105+
- LNAV does not use VNAV speed predictions yet. This means that an approach path will not be forecasted properly. Furthermore, the T/D (Top of Descent) could be misplaced, since the system expects more track miles.
106+
- The descent guidance does not use the speed margins properly yet. The aircraft does not speed up to catch a profile below it.
107+
- The linear deviation indication (green "yoyo") on the PFD might jump around during the descent. This effect is particularly noticeable when new waypoints are sequenced.
108+
- Layout inaccuracies in the MCDU, mostly on the PERF page.
109+
- Predicted speed changes in the descent might seem to show up erratically. The same for the level off arrow while in descent mode.
110+
- Fuel predictions in the MCDU are not very accurate.
111+
- Descent guidance is sensitive to QNH changes. This is partially due to an inaccuracy in MSFS' atmospheric model.
112+
- Winds are not yet considered for all phases of flight.
113+
114+
## How to Report Issues
115+
116+
<!--
117+
!!! warning
118+
We are not taking issue reports at this time.
119+
-->
120+
121+
!!! warning
122+
Please read the above Known Issues list and also use the search of Discord to see if your issue has already been reported.
123+
124+
At this time, please only report issues via our Discord in the following locations:
125+
126+
[General - Experimental Issue Reports [SUPPORT NOT GUARANTEED]](https://discord.com/channels/738864299392630914/785976111875751956){target=new .md-button}
127+
128+
[FMS - Experimental Issue Forum [SUPPORT NOT GUARANTEED]](https://discord.com/channels/738864299392630914/1046906298815488100){target=new .md-button}
129+
130+
{--
131+
132+
Support or immediate solutions for your issues is **not guaranteed**. We will collect all issues to fix and improve features in testing continuously.
133+
134+
--}
135+
136+
**Do not open any issues on GitHub for the Experimental Version!**
137+
138+
### Download and Install
139+
140+
See [Installation Guide](../docs/fbw-a32nx/installation.md#downloads).

docs/dev-corner/dev-guide/resources.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,12 @@ The main GitHub repository for the A32NX aircraft is:
88

99
**[https://github.com/flybywiresim/a32nx](https://github.com/flybywiresim/a32nx){target=new}**
1010

11-
The Development version of the FlyByWire A32NX is done in the master branch. Whenever something is merged into the master branch, an automatic build process builds the newest Development version and uploads it to our CDN, so users can download the latest Development version via the FlyByWire Installer.
11+
The Development version of the FlyByWire A32NX is done in the master branch. Whenever something is merged into the master branch, an automatic build process builds the newest
12+
Development version and uploads it to our CDN, so users can download the latest Development version via the FlyByWire Installer. We have a very strict development, review and
13+
QA process for for this version.
1214

1315
The Stable version is a snapshot (in git terms, a [Tag](https://github.com/flybywiresim/a32nx/tags){target=new}) of the development branch.
1416

15-
The experimental version is built in the branch [experimental](https://github.com/flybywiresim/a32nx/tree/experimental){target=new}. It is regularly manually updated with the latest commits from the master branch, but its focus is on the development of special larger features like the custom fly-by-wire and autopilot system or the custom flight management system (cFMS).
16-
17-
While the development on the master branch (Development version) follows a very strict development, review and QA process, the development in the experimental branch is less strict and developers can relatively freely commit changes. This is why the Experimental version has a higher risk of bugs and issues and is only meant for testing and not supported on Discord.
18-
1917
The FlyByWire project has other repositories for subprojects like api, msfs-rs, installer, website, docs, etc. Find them [here](https://github.com/orgs/flybywiresim/repositories){target=new}.
2018

2119
## Support from the FlyByWire Team on Discord

docs/fbw-a32nx/a32nx-api/a32nx-flightdeck-api.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ hide:
99
[Clickable Flight Deck](../../pilots-corner/a32nx-briefing/flight-deck/index.md){ .md-button }
1010

1111
!!! note ""
12-
The below table might lag behind the current developments of the A32NX. It is based on the A32NX Development version, and we try to keep it updated as good as possible. Some variables/events are only available in the Experimental version of A32NX and are marked as such.
12+
The below table might lag behind the current developments of the A32NX. It is based on the A32NX Development version, and we try to keep it updated as best as possible.
1313

1414
You can help us keep this up to date and improve this by reporting any errors or omissions on our [:fontawesome-brands-discord:{: .discord } - **Discord**](https://discord.gg/flybywire){target=new} in the **#a32nx-support** channel or by creating an issue report here: [Docs Issues](https://github.com/flybywiresim/docs/issues){target=new}.
1515

@@ -661,10 +661,10 @@ Flight Deck: [Chrono Panel](../../pilots-corner/a32nx-briefing/flight-deck/front
661661

662662
Flight Deck: [ND Panel](../../pilots-corner/a32nx-briefing/flight-deck/front/nd.md)
663663

664-
| Function | API Usage | Values | Read/Write | Type | Remark |
665-
|:---------------|:-------------------------|:---------|:-----------|:------------|:-------------------------------|
666-
| TERR ON ND L | A32NX_EFIS_TERR_L_ACTIVE | 0&#124;1 | R/W | Custom LVAR | Currently only in Experimental |
667-
| TERR ON ND R | A32NX_EFIS_TERR_R_ACTIVE | 0&#124;1 | R/W | Custom LVAR | Currently only in Experimental |
664+
| Function | API Usage | Values | Read/Write | Type | Remark |
665+
|:-------------|:-------------------------|:---------|:-----------|:------------|:-------|
666+
| TERR ON ND L | A32NX_EFIS_TERR_L_ACTIVE | 0&#124;1 | R/W | Custom LVAR | |
667+
| TERR ON ND R | A32NX_EFIS_TERR_R_ACTIVE | 0&#124;1 | R/W | Custom LVAR | |
668668

669669
### DCDU
670670

docs/fbw-a32nx/faq.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
Just make sure to search for existing issues first before creating a new one.
3535

3636
??? info "Q: Why is my version not the same as what I see others using?"
37-
We have three versions: Stable, Development, and Experimental.
37+
We have two versions: Stable and Development.
3838

3939
**Stable**
4040

@@ -44,8 +44,9 @@
4444

4545
The Development build is updated daily and is a constant work in progress and although we test each update thoroughly, minor issues may occur from time to time. See [Downloads](installation.md#downloads).
4646

47-
??? info "Q: What is the Experimental Version?"
48-
Please read more [here](support/exp.md).
47+
[//]: # (??? info "Q: What is the Experimental Version?")
48+
49+
[//]: # ( Please read more [here]&#40;support/exp.md&#41;.)
4950

5051
---
5152

docs/fbw-a32nx/fbw-versions.md

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -25,22 +25,7 @@ This version will not always be up-to-date, but we work hard at ensuring its com
2525

2626
### "Experimental Version"
2727

28-
This version is similar to the development version, but contains custom systems in earlier development phases.
29-
30-
We use this version to find problems, issues and to improve functionality based on your feedback. It is not meant to be used for daily use or when you try to do a serious flight on VATSIM.
31-
32-
!!! warning
33-
34-
The Experimental version has a less strict QA process and is used for actual QA testing. Bugs and Issues are to be expected.
35-
36-
!!! danger ""
37-
Before using this version, please read the [Experimental Version Support Page](support/exp.md) to see what is currently being tested.
38-
39-
The experimental version will be updated regularly and also with the latest changes to the Development version. Expect updates about once a week (not guaranteed).
40-
41-
!!! danger "Do not expect support for the experimental version - use at own risk!"
42-
43-
We ask that you understand that we may not offer support for any experimental issues due to the nature of this version. We will happily answer questions, time permitting.
28+
We have discontinued our Experimental Version. Latest features and testing will be on the Development Version of the aircraft.
4429

4530
## Version Comparison
4631

docs/fbw-a32nx/feature-guides/cFMS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ It is important to note that the weather radar is not available yet with the lat
9696
We believe the benefits that cFMS provides outweigh the temporary lack of WX functionality. Weather will still prove to be a challenge due to the lack of a native SDK API. We have posted about it on the MSFS forums, where it currently sits at the top of the wishlist, and Asobo are investigating how to best improve their API.
9797

9898
[Read more about the weather and terrain API.](https://forums.flightsimulator.com/t/implement-weather-and-terrain-api-s-for-aircraft-developers-to-implement-accurate-radar-predictive-windshear-egpws-and-metar-wind-uplink/442016){target=new}
99-
**Please note again that terrain radar is being tested in our Experimental version.**
99+
**Please note again that terrain radar is available on our Stable and Development Versions.**
100100

101101
## Flight Path Rendering
102102

docs/fbw-a32nx/feature-guides/flypados3/settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ Settings for integrations with various 3rd party applications
227227
</div>
228228

229229
!!! warning ""
230-
This feature is only available in the [Development Version](../../fbw-versions.md#development-version-recommended) and [Experimental Version](../../fbw-versions.md#experimental-version)
230+
This feature is only available in the [Development Version](../../fbw-versions.md#development-version-recommended)
231231

232232
#### GSX Integration
233233
These options are separate to provide you with the flexibility to choose what to sync with GSX and what not to sync.

docs/fbw-a32nx/feature-guides/gsxintegration/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ description: A guide to the GSX Integration provided in the development version.
1111
## Description
1212

1313
!!! warning "Please Note"
14-
This guide covers GSX Integration and the features available in the latest FlyByWire [Development Version](../../fbw-versions.md#development-version-recommended) and [Experimental Version](../../fbw-versions.md#experimental-version).
14+
This guide covers GSX Integration and the features available in the latest FlyByWire [Development Version](../../fbw-versions.md#development-version-recommended).
1515

1616
If you use the FlyByWire Stable version, you might not have these features available.
1717

0 commit comments

Comments
 (0)