159
edits
(→Add to an Aircraft: better/corrected config description) |
|||
Line 40: | Line 40: | ||
= Add to an Aircraft = | = Add to an Aircraft = | ||
Add the | == Instrument List == | ||
Add the device to your plane by adding it to the sim/instrumentation section (usually in a separate instrumentation.xml file). | |||
Example: | |||
<PropertyList> | |||
<sim> | |||
<instrumentation> | |||
'''<mk-viii>''' | |||
'''<name>mk-viii</name>''' | |||
'''<number>0</number>''' | |||
'''</mk-viii>''' | |||
</instrumentation> | |||
</sim> | |||
</PropertyList> | |||
Usually planes only have a single GPWS installed - so using multiple instances wouldn't be too common. | |||
== <Plane>-set.xml file == | |||
Configuration parameters are stored in a different section. | |||
Add the following XML template to the instrumentation section of the plane's ...-set.xml file. | |||
Do not mix up this section with the one above (section above was ''within'' the <sim> tag, this section is ''outside'' the <sim> tag). | |||
'''Notes''': | '''Notes''': | ||
* The values in the <tt><configuration-module></tt> section (below) list the module's default. You can omit specific <tt><category-''n''></tt> lines unless you need to change the default. | * The values in the <tt><configuration-module></tt> section (below) list the module's default. You can omit specific <tt><category-''n''></tt> lines unless you need to change the default. | ||
* All configuration categories require valid settings. If you do explicitly configure a category to change the default, you must provide a valid value. See sections below for valid options. | * All configuration categories require valid settings. If you do explicitly configure a category to change the default, you must provide a valid value. See sections below for valid options. | ||
* Do ''not'' omit the <serviceable>true</serviceable> part... | |||
=== XML Template === | === XML Template === | ||
<instrumentation> | <PropertyList> | ||
<nowiki><!--</nowiki> here: other data from ...-set.xml <nowiki>--></nowiki> | |||
<instrumentation> | |||
<mk-viii> <nowiki><!--</nowiki> http://wiki.flightgear.org/index.php/GPWS <nowiki>--></nowiki> | |||
<serviceable>true</serviceable> <nowiki><!--</nowiki> EGPWS_ENABLE <nowiki>--></nowiki> | |||
<configuration-module> | |||
<category-1> 0 </category-1> <nowiki><!--</nowiki> [[#Aircraft Mode Select|AIRCRAFT_MODE_TYPE_SELECT]] <nowiki>--></nowiki> | |||
<category-3> 2 </category-3> <nowiki><!--</nowiki> [[#Position Input Select|POSITION_INPUT_SELECT]] <nowiki>--></nowiki> | |||
<category-4> 13 </category-4> <nowiki><!--</nowiki> [[#Altitude Callouts|ALTITUDE_CALLOUTS]] <nowiki>--></nowiki> | |||
<category-5> 0 </category-5> <nowiki><!--</nowiki> [[#Audio Menu Select|AUDIO_MENU_SELECT]] <nowiki>--></nowiki> | |||
<category-6> 1 </category-6> <nowiki><!--</nowiki> [[#Terrain Collision Warning|TERRAIN_DISPLAY_SELECT]] <nowiki>--></nowiki> | |||
<category-7> 124 </category-7> <nowiki><!--</nowiki> [[#Options Select|OPTIONS_SELECT_GROUP_1]] <nowiki>--></nowiki> | |||
<category-8> 2 </category-8> <nowiki><!--</nowiki> [[#Radio Altitude Input Select|RADIO_ALTITUDE_INPUT_SELECT]] <nowiki>--></nowiki> | |||
<category-9> 3 </category-9> <nowiki><!--</nowiki> [[#Navigation Input Select|NAVIGATION_INPUT_SELECT]] <nowiki>--></nowiki> | |||
<category-10> 6 </category-10> <nowiki><!--</nowiki> [[#Attitude Input Select|ATTITUDE_INPUT_SELECT]] <nowiki>--></nowiki> | |||
<category-13> 7 </category-13> <nowiki><!--</nowiki> [[#Input and Output Configuration|INPUT_OUTPUT_DISCRETE_TYPE_SELECT]] <nowiki>--></nowiki> | |||
<category-14> 0 </category-14> <nowiki><!--</nowiki> [[#Audio Output Level|AUDIO_OUTPUT_LEVEL]] <nowiki>--></nowiki> | |||
</configuration-module> | |||
<inputs> <nowiki><!--</nowiki> [[#Module I/O|Module I/O]] <nowiki>--></nowiki> | |||
<arinc429> | |||
<decision-height-ncd> false </decision-height-ncd> | |||
<decision-height> 200 </decision-height> | |||
</arinc429> | |||
</inputs> | |||
<speaker> <nowiki><!--</nowiki> [[#Speaker Configuration|Speaker Configuration]] <nowiki>--></nowiki> | |||
<max-dist> 2 </max-dist> <nowiki><!--</nowiki> Max. distance where speaker is heard <nowiki>--></nowiki> | |||
<reference-dist> 1 </reference-dist> <nowiki><!--</nowiki> Distance to pilot <nowiki>--></nowiki> | |||
<volume> 0.4 </volume> <nowiki><!--</nowiki> Volume at reference distance <nowiki>--></nowiki> | |||
</speaker> | |||
</mk-viii> | |||
</instrumentation> | |||
</PropertyList> | |||
The example above provides the decision height as a fixed value. Since this value is an input, you can also provide this value at run-time instead - e.g. depending on whether an ILS or visual approach is flown. | |||
=== Unimplemented Categories === | === Unimplemented Categories === | ||
Line 90: | Line 119: | ||
<category-16> 0 </category-16> <nowiki><!--</nowiki> UNDEFINED_INPUT_SELECT_2 <nowiki>--></nowiki> | <category-16> 0 </category-16> <nowiki><!--</nowiki> UNDEFINED_INPUT_SELECT_2 <nowiki>--></nowiki> | ||
<category-17> 0 </category-17> <nowiki><!--</nowiki> UNDEFINED_INPUT_SELECT_3 <nowiki>--></nowiki> | <category-17> 0 </category-17> <nowiki><!--</nowiki> UNDEFINED_INPUT_SELECT_3 <nowiki>--></nowiki> | ||
== Electric Power == | |||
The mk-viii module needs (virtual) electric power. The module also simulates the behavior of the original hardware device when applying over or under voltage - i.e. it withstands short periods of too low or high voltage (within certain limits). Supply a nominal value of 28 volts. Usually you'll provide power via Nasal by connecting the module to the electrical bus simulation. If you're plane doesn't provide such a simulation you can also configure a fixed value (i.e. '''28''') to the following property: | |||
/systems/electrical/outputs/''<name>''[''<num>''] | |||
where ''<name>'' and ''<num>'' match the values you specified in the instrument list, e.g. for ''<name>=mk-viii and ''<num>''=0 | |||
/systems/electrical/outputs/mk-viii[0] | |||
= Configuration = | = Configuration = |
edits