IT Autoflight: Difference between revisions

Jump to navigation Jump to search
no edit summary
No edit summary
No edit summary
Line 6: Line 6:
|developers  = {{usr|it0uchpods}}
|developers  = {{usr|it0uchpods}}
}}
}}
{{TOC limit|3}}


[[File:ITAF155.png|thumb|300px|The latest IT-AUTOFLIGHT GUI. The CWS buttons does indeed work, but it is disabled in the aircraft I took this shot with.]]
[[File:ITAF155.png|thumb|300px|The latest IT-AUTOFLIGHT GUI. The CWS buttons does indeed work, but it is disabled in the aircraft I took this shot with.]]
Line 50: Line 52:
* VNAV Climb/Descend/Hold {{Progressbar|70}}
* VNAV Climb/Descend/Hold {{Progressbar|70}}
* For more information, see the changelog [https://github.com/it0uchpods/IT-AUTOFLIGHT/blob/master/CHANGELOG.txt here]
* For more information, see the changelog [https://github.com/it0uchpods/IT-AUTOFLIGHT/blob/master/CHANGELOG.txt here]
== Installation Instructions ==
=== Installing ===
This guide will teach you how to install IT-AUTOFLIGHT to an aircraft. Every time you see XXX written, replace this text with the name of the aircraft folder.
==== Before you Begin ====
Download the latest version of IT-AUTOFLIGHT V3.0.0 Beta from [https://www.github.com/it0uchpods/IT-AUTOFLIGHT.git here]. Extract the Archive with WinRAR, 7Zip, or similar.
==== Step One ====
* Copy the Systems and Nasal folders from the IT-AUTOFLIGHT folder to the aircraft's folder. The only file which may overwrite another file is the autopilot-dlg.xml file.
* Open the -set file of the aircraft, and find the <systems> area inside <sim></sim>.
* Add the following inside <systems></systems>
<syntaxhighlight lang="xml">
<autopilot>
    <name>IT-AUTOFLIGHT</name>
    <path>Systems/it-autoflight.xml</path>
</autopilot>
</syntaxhighlight>
If you wish to use the IT-AUTOFLIGHT Default Autothrottle, add the following inside <systems></systems>:
<syntaxhighlight lang="xml">
<autopilot>
    <name>IT-AUTOTHRUST</name>
    <path>Systems/it-autothrust.xml</path>
</autopilot>
</syntaxhighlight>
* If you do not add this, the A/T button in the IT-AUTOFLIGHT GUI Dialog will do nothing, and in PITCH mode, the pilot must adjust the throttles accordingly. You do NOT need to add this if your aircraft uses a customized autothrottle, as long as that autothrottle is compatibly with IT-AUTOFLIGHT. See Interfacing section below for more information.
* Find the <nasal> area, which is outside <sim></sim>.
* Add the following inside <nasal></nasal>:
<syntaxhighlight lang="xml">
<itaf>
    <file>Nasal/it-autoflight.nas</file>
</itaf>
</syntaxhighlight>
* Finally, add the following anywhere outside <sim></sim>:
<syntaxhighlight lang="xml">
<it-autoflight>
<config>
<roll>
<umin>-0.50</umin>
<umax>0.50</umax>
<kp>0.05</kp>
<kp-vloc>0.09</kp-vloc>
<ti>10.0</ti>
<td>0.00001</td>
<kp-cws>0.09</kp-cws>
</roll>
<pitch>
<umin>-0.50</umin>
<umax>0.50</umax>
<kp>-0.08</kp>
<ti>10.0</ti>
<td>0.0001</td>
<kp-cws>-0.07</kp-cws>
</pitch>
<cmd>
<roll-kp>-1.9</roll-kp>
<roll-scale>1.5</roll-scale>
<vorloc>-5.0</vorloc>
<alt>0.03</alt>
<vs>0.10</vs>
<fpa>0.30</fpa>
<flch>-4.0</flch>
<gs>0.11</gs>
</cmd>
<autoland>
<kp-roll>0.10</kp-roll>
<kp-pitch>0.07</kp-pitch>
<kp-rudder>-0.3</kp-rudder>
</autoland>
</config>
<settings>
<default-bank-limit>30</default-bank-limit> <!-- Set the Default Bank Limit -->
<enable-cws>0</enable-cws> <!-- Enable/Disable CWS -->
<flare-altitude>30</flare-altitude> <!-- Autoland Flare AGL -->
<land-enable>0</land-enable> <!-- Enable/Disable Autoland -->
<land-flap>0.7</land-flap> <!-- Minimum Flap used for Landing -->
<retard-ft>40</retard-ft> <!-- Enable Thrust Retard -->
<retard-enable>0</retard-enable> <!-- AGL to Thrust Retard -->
<togaspd>170</togaspd> <!-- V2 + 10kts -->
<lat-agl-ft>200</lat-agl-ft> <!-- Set to 999999 if you do not want T/O to change automatically to HDG, or LNAV -->
<reduc-agl-ft>1500</reduc-agl-ft> <!-- Set to 999999 if you do not want TOGA to change automatically to FLCH -->
</settings>
</it-autoflight>
</syntaxhighlight>
* This is the default IT-AUTOFLIGHT Configuration. We will be adjusting this later.
==== Step Two ====
* Open any nasal file. I recommend systems.nas, or a file with the aircraft name.
<syntaxhighlight lang="nasal">
setlistener("/sim/signals/fdm-initialized", func {
    itaf.ap_init();
    var autopilot = gui.Dialog.new("sim/gui/dialogs/autopilot/dialog", "Aircraft/XXX/Systems/autopilot-dlg.xml");
});
</syntaxhighlight>
* Make sure you change XXX to the aircraft's folder name.
==== Complete ====
You have finished installing IT-AUTOFLIGHT. However, I highly suggest to go over the Tuning and Configuration section below, to tune the PIDs to your aircraft, and set up the settings. If you want to connect IT-AUTOFLIGHT to a PFD or MCP, see Interfacing.
=== Tuning and Configuration ===
Coming Soon...
=== Interfacing ===
This section will discuss the inputs and outputs of IT-AUTOFLIGHT. These can be used for PFD/MCP interfacing, or building a custom autothrottle, or any other need for communicating with IT-AUTOFLIGHT. I will also list what types of inputs are allowed. (BOOL, INT, etc.)
==== Inputs: /it-autoflight/input ====
* kts-mach: Switches between Speed (0) and Mach mode (1). BOOL
* ap1: Switches the Autopilot 1 Off (0) and On (1). BOOL
* ap2: Switches the Autopilot 2 Off (0) and On (1). BOOL
* athr: Switches the Autothrottle Off (0) and On (1). BOOL
* cws: Switches the CWS Off (0) and On (1). BOOL
* fd1: Switches the Flight Director 1 Off (0) and On (1). BOOL
* fd2: Switches the Flight Director 2 Off (0) and On (1). BOOL
* spd-kts: Adjusts the Target Airspeed in Knots (100 - 400). DOUBLE (Note: IT-AUTOFLIGHT can use higher/lower Airspeed, but it is not recommended.)
* spd-mach: Adjusts the Target Mach (0.4 - 0.99). DOUBLE (Note: IT-AUTOFLIGHT can use higher/lower Mach, but it is not recommended.)
* hdg: Adjusts the Target Heading in Degrees (1 - 360, or 0 - 359). DOUBLE
* alt: Adjusts the Target Altitude in Feet (0 - 60000). DOUBLE (Note: IT-AUTOFLIGHT can fly higher than 60,000 feet, but it is not recommended.)
* vs: Adjusts the Target Vertical Speed in Feet Per Minute (-6000 - 6000). DOUBLE (Note: IT-AUTOFLIGHT can use higher/lower FPM, but it is not recommended.)
* fpa: Adjusts the Target Flight Path Angle in Degrees (-20.9 - 20.9). FLOAT (Note: IT-AUTOFLIGHT can use higher/lower FPA, but it is not recommended.)
* lat: Changes the roll mode to HDG SEL (0), LNAV (1), VOR/LOC (2), or HDG HLD (3). INT (Note: Mode 4 and Mode 5 exist, but you should not set this value to 4, or 5. Doing so may cause unexpected functionality.)
* lat-arm: Set by IT-AUTOFLIGHT Logic. Do not adjust this property. Use the property "lat" instead, and this property will only be set if the roll mode needs to be armed, and not set active.
* vert: Changes the pitch mode to ALT HLD (0), V/S (1), ILS (2), FLCH (4), FPA (5), or VNAV (8). INT (Note: Mode 3, Mode 6, and Mode 7 exist, but you should not set this value to 3, 6, or 7. Doing so may cause unexpected functionality.)
* prof-arm: Set by IT-AUTOFLIGHT Logic. Do not adjust this property. Set "vert" to (8) instead, and this property will only be set if the VNAV mode needs to be armed, and not set active.
* bank-limit: Adjusts the Target Bank Limit for HDG mode only. (5 - 30) (Note: LNAV and VOR/LOC use automatic bank limits.) When implemented, the auto button will reset this value to it's default setting. For now, use this binding/command:
<syntaxhighlight lang="xml">
<binding>
    <command>nasal</command>
    <script>
    var dbl = getprop("/it-autoflight/settings/default-bank-limit");
    setprop("/it-autoflight/input/bank-limit", dbl);
    </script>
</binding>
</syntaxhighlight>
* trk: Switches between Magentic Heading (0) and True Heading (1). BOOL
* toga: Engage Takeoff or Go Around Mode (1). BOOL (Note: Do not change this value back to (0). The IT-AUTOFLIGHT Logic will do this automatically when necessary.
==== Outputs: /it-autoflight/output ====
Coming soon...


[[Category:Autoflight]]
[[Category:Autoflight]]
2,222

edits

Navigation menu