Checklists
The checklist flow
To start a checklist, speak its trigger phrase. When you start a checklist, all voice commands that aren't associated with it are suspended (their states are restored when the checklist completes).
In addition to the normal response to a challenge, you may say "restart checklist", "say again" or "standby checklist". "standby checklist" resumes the suspended voice commands and awaits "resume checklist" or "continue checklist".
[Checklists] section in options.ini
display_info:
Display possible responses to a checklist item challenge in a message window.
display_fail
If the copilot didn't like how you responded to a challenge (he will say "double check that"), display the reason in a message window (the same message will also be logged in the regular log regardless of this setting).
menu_keybind
A key or key combination (for example, A or SHIFT+F3) that will trigger the checklist menu. The menu lets you skip the current checklist item as well as cancel or skip the whole checklist. Both cancelling and skipping stop the execution of the current checklist. The difference is that cancelling will also reactivate the checklist's trigger voice command.
List of checklists
Response phrase syntax explanation:
Curly brackets denote a multiple choice phrase element, with each choice inside round brackets.
Square brackets denote an optional phrase element.
... means 'match anything'.
Before Start to the Line
Trigger phrases: "before start checklist"
When it's available: If preflight action enabled: when preflight action is finished, otherwise: when the chocks are set.
Cockpit Prep
completed
Gear Pins and Covers
removed
Signs
on auto
on and auto
onanauto
on anauto
ADIRS
nav
Fuel Quantity
<1-100> {(thousand [<1-9> hundred] [kilograms])+(tonnes)}
TO Data
set
Baro REF
[{(cue an h)+(q n h)}] <3-4-digit spelled number> [set]
Before Start below the Line
Trigger phrases: "before start below the line", "below the line"
When it's available: When before start to the line is finished.
Windows / Doors
closed
Beacon
off
on
THR Levers
idle
Parking Brake
off
released
on
set
After start
Trigger phrases: "after start checklist"
When it's available: If after_start action enabled: when after_start action is finished, otherwise: when the engines are started.
Anti-Ice
off
on
engine anti-ice on
ECAM Status
checked
Pitch Trim
<CG value> [percent] [set]
Rudder Trim
zero
Before Takeoff to the Line
Trigger phrases: "before takeoff checklist"
When it's available: When after start checklist is finished.
Flight Controls
checked
Flight Instruments
checked
Briefing
confirmed
Flap Setting
config {(1)+(1 plus f)+(2)+(3)}
V1, Vr, V2 / FLEX Temp
{(V one <3-digit spelled number> V r <3-digit spelled number> V two <3-digit spelled number>)+(<3-digit spelled number> <3-digit spelled number> <3-digit spelled number>)} {(TOGA)+(no flex [temp])+(FLEX [temp] <FLEX temp>)}
ATC
set
ECAM Memo
takeoff no blue
Before Takeoff below the Line
Trigger phrases: "before takeoff below the line", "below the line"
When it's available: If lineup action enabled: when lineup action is finished and before takeoff to the line is finished, otherwise: when before takeoff to the line is finished.
Takeoff RWY
[runway] <runway identifier> [confirmed]
Cabin Crew
advised
TCAS
t a
t a r a
Engine Mode Selector
ignition
normal
Packs
off
on
After Takeoff / Climb
Trigger phrases: "after takeoff climb checklist"
When it's available: 1000 feet above airfield elevation.
Landing Gear
up
Flaps
retracted
Packs
off
on
After Takeoff / Climb below the Line
Trigger phrases: "after takeoff climb below the line", "below the line"
When it's available: When the after takeoff climb checklist to the line is finished.
Baro REF
standard
standard set
Approach
Trigger phrases: "approach checklist"
When it's available: Below 10'000 feet.
Briefing
confirmed
ECAM Status
checked
Seat Belts
off
on
Baro REF
[{(cue an h)+(q n h)}] <3-4-digit spelled number> [set]
Minimum
... set
Engine Mode Selector
ignition
normal
Landing
Trigger phrases: "landing checklist"
When it's available: Below 10'000 feet and IAS below 200 kts.
Cabin Crew
advised
A/THR
off
speed
Auto-brake
low
medium
ECAM Memo
Landing no blue
Parking
Trigger phrases: "parking checklist"
When it's available: On engine shutdown
APU Bleed
off
on
Engines
off
Seat Belts
off
on
External Lights
nav logo on
off
Fuel Pumps
off
Park BRK / Chocks
{(on)+(off)} and {(in)+(out)}
Securing the Aircraft
Trigger phrases: "securing the aircraft checklist"
When it's available: When the parking checklist is finished
ADIRS
off
Oxygen
off
on
APU Bleed
off
on
EMER Exit Lights
arm
off
on
Signs
off
APU and BAT
off
Modifying and creating checklists
Modifying items in default checklists
copilot.checklists.beforeTakeoff:replaceItem {
label = "takeoffSpeedsFlexTemp",
response = VoiceCommand:new "set",
}
copilot.checklists.landing:getItem"autoThrust".response.SPEED:setConfidence(0.8)
Creating checklists
Browse the lua files at copilot\copilot\checklists and copilot\copilot\initChecklists.lua for examples.
The simplest checklist with no validation looks like this:
approachChecklist = Checklist:new(
"approach",
"Approach checklist",
VoiceCommand:new "approach checklist"
)
approachChecklist:appendItem {
label = "briefing",
displayLabel = "Briefing",
response = VoiceCommand:new "confirmed"
}
approachChecklist.trigger:activateOn(copilot.events.aboveTenThousand)
The above checklist will require the following callout file structure:
copilot\sounds\callouts\soundSetName\checklists\approach\
config.lua
announce.wav
completed.wav
briefing.wav
with config.lua that looks like this:
return { "announce", "completed", "briefing" }
Alternatively, you can create a text-to-speech set by creating the file copilot\sounds\callouts\soundSetName\config.lua with the following content:
return { isTTS = true, parent = "TTS", -- inherit all phrases from the default TTS set checklists = { approach = { announce = "approach checklist", completed = "approach checklist completed", briefing = "briefing" } } }
The default checklists can be disabled by setting enable=0 in options.ini or programmatically:
for _, checklist in ipairs(copilot.checklists) do checklist.trigger:disable() end
You can still re-use checklists disabled with enable=0 by loading their files yourself:
require "copilot.checklists.beforeStart" copilot.checklists.beforeStart.trigger:activate()