List of errors/omissions and suggestions for the latest Simulation Variables SDK documentation

Version: SDK 0.9.0

Frequency: Once, but many

Severity: High

Bug description:

FAILURE ACTIVE is in the Vars Index, but is not documented

FAILURE VALUE is in the Vars Index, but is not documented

CIRCUIT NAVCOM ON1, CIRCUIT NAVCOM ON2, CIRCUIT NAVCOM ON3, CIRCUIT NAVCOM ON4 as shown in the Vars index respectively should read:

 CIRCUIT NAVCOM1 ON

 CIRCUIT NAVCOM2 ON

 CIRCUIT NAVCOM3 ON

 CIRCUIT NAVCOM4 ON

CIRCUIT_COM_ON is incorrectly documented and should read CIRCUIT COM ON (no underscores)

ELECTRICAL LINE CONNECTION ON is not in the Vars index

ELECTRICAL LINE BREAKER PULLED is not in the Vars index

LIQUID DROPPING TANK CURRENT VOLUME is in Vars Index, but not documented

LIQUID DROPPING TANK TOTAL CAPACITY VOLUME description should read ‘The total volume of the liquid that can be stored in all the Tanks combined.’ (…not the total weight…)

LIQUID DROPPING TANK TOTAL CURRENT VOLUME description should read ‘The total volume of the liquid stored in all the Tanks combined.’ (…not the total weight…)

PNEUMATICS AREAS MIN TEMPERATURE description should read ‘The minimum temperature in all the controlled Areas of the aircraft.’ (not maximum)

PNEUMATICS CABIN ALTITUDE description might better read ‘The current pressure altitude of the aircraft cabin.’ ?

PNEUMATICS CABIN ALTITUDE RATE description might better read ‘The rate at which the cabin pressure altitude changes.’ ?

PNEUMATICS FAN STATUS is documented, but not in Vars Index

PNEUMATICS FAN TARGET STATUS is documented, but not in Vars Index

PNEUMATICS FAN SWITCH is documented, but not in Vars Index

PNEUMATICS TARGET CABIN ALTITUDE description might better read ‘The target pressure altitude of the aircraft cabin…’ ?

All AIRCRAFT RADIO NAVIGATION VARIABLES / TCAS . All definitions are missing Descriptions and Units, except for TCAS INTRUDER BEARING (9 incomplete documentations)

Suggestions/Questions:

Consider adding ‘Cable Break’ to the Enum List for TOW CABLE RELEASE REASON . It’s one of the most common causes of premature release when winching a glider.

(In)Consistency

Some Vars that require 2 indexes are documented as requiring a comma between the indexes, while others require a second colon.

Eg:

 PNEUMATICS PACK FLOW MODE VALUE:name1,name2 (comma separator)

 WEAR AND TEAR CHECK PROGRESSION:id:index (colon separator)

Are these inconsistencies deliberate (correct), or documentation typos?

Should YOKE X INIDICATOR be defined as YOKE X INDICATOR ?

Should YOKE Y INIDICATOR be defined as YOKE Y INDICATOR ?

Hey! Thanks for taking the time to let us know about these minor issues. They will all be fixed in the next update. :slight_smile:

For your questions:

Consider adding ‘Cable Break’ to the Enum List for TOW CABLE RELEASE REASON . It’s one of the most common causes of premature release when winching a glider.

This is a feature request and should probably be posted as such independent of this topic, since I have no control over the features available and can only document what’s implemented.

Some Vars that require 2 indexes are documented as requiring a comma between the indexes, while others require a second colon.

There are details on how to use SImVars in RPN here: Simulation Variables
However, I agree that the information isn’t clear, and so I’ll be updating all the SimVars to more clearly label the parameters they take (if any) and also that section to be clearer.

Should YOKE X INIDICATOR be defined as YOKE X INDICATOR ?

Both are valid! The first was an uncaught typo in the code, and the second is an alias, correctly written (same for the Y axis version)

Thanks again for the feedback!

This topic has been automatically closed after 60 days of inactivity since it was marked as fixed.

If there is important new information about this same report, you can use the “Request reopen” button below to ask the moderation team to review it again.
For other issues or broader discussion, please open a new topic in the appropriate category.