This document will describe the IVAO Pilot Software: Altitude version 1.13 and above with Voice Integration, Voice ATIS and Voice Unicom.
Version 1.14 is already in the pipeline, including exciting implementations such as Joystick PTT (Push to Talk), a highly requested feature. To enable us to keep developing our software for modern flight simulation software we regret to advise that 1.13 will be the last version to support X-Planes 8, 9 and 10.
View latest Altitude changelog here 👉 https://virtualsky.ivao.aero/new-year-new-altitude/
View Altitude & MTL FAQ here 👉 https://wiki.ivao.aero/en/home/devops/manuals/faq-pilot-software
Publisher | Simulator | Operating System |
---|---|---|
Microsoft | Microsoft Flight Simulator 2004 | Windows 10 or later |
Microsoft | Microsoft Flight Simulator X & Steam Edition | Windows 10 or later |
Microsoft | Microsoft Flight Simulator 2020 | Windows 10 or later |
Lockheed Martin | Prepar3D V1-6 | Windows 10 or later |
Laminar Research | X-Plane 9 | Windows 10 or later |
Laminar Research | X-Plane 10, 11, 12 | Windows 10 or later, macOS 11 (Big Sur) or later, Linux with GCC libstdc++ version 12 or later (Debian 12.1, Ubuntu 22.04 or Fedora F37 (or later) |
Download altitude from here: https://www.ivao.aero/softdev/software/altitude.asp
Verify Create shortcuts on Desktop is activated. Select Next
The example above shows Altitude being installed for MSFS and X-Plane
Make sure to keep MTL Installer or X-CSL Updater selected, these are required for model matching.
If you have X-Plane, the Installer will try to auto-detect it, if unsuccessful you can set the path manually here
Next are all detected simulators presented.
Starting with Altitude v1.13.03bb the MTL Installer is now included in Altitude Install package.
This is for Microsoft Flight Simulators (FS9, FSX, P3D, MSFS). For X-Plane please use X-CSL Updater.
Extract the IVAO MTL Installer to your desktop then run it.
Select your simulator (it should auto-detect the correct path). Click Select, select All and Install.
We recommend to run the MTL Installer weekly to stay up-to-date with liveries.
If your MLT Installer cannot detect the sime please make sure the proper paths are manually selected in the MTL Installer, especially the ending of the path. Incorrect paths can lead to the MTL library being installed in a wrong folder and thus not be detected by the Simulator and Altitude.
FS9/FSX/P3D should have the main folder selected in the MTL installer. For example:
FS9:
FSX:
P3D:
MSFS should always end with the Packages folder. For example:
MSFS (MS Store Version):
MSFS (Steam Version):
You can check if everything is installed by going to the following directories and ensure you have these folders now:
FS9:
FSX:
P3D:
MSFS:
Starting with Altitude v1.13.03bb the X-CSL Updater is now included in the Altitude Install package.
This is for X-Plane only. For Microsoft Flight Simulators please use MTL Installer.
We recommend to run the X-CSL Updater weekly to stay up-to-date with liveries.
The User Interface (Pilot UI) is an application which runs outside the flight simulator in your operating system.
It manages the connection with the Pilot Core connected directly on the same computer or a computer connected via an internal Ethernet network.
The user Interface (UI) can be run on:
All 64 and 32bit versions of Microsoft Windows
Mac OSX 10.6 and above
Linux 64bit
The User Interface (UI) main features are:
The Flight Plan System is a web application that manages all your flight plans for all your flights in IVAO. You can also utilize SimBrief to automatically file the generated OFP to IVAO.
The flight plan system main features are:
- create your flight plan from scratch
- modify an existing one
- retrieve and old flight plan from your history
- manage your preferred aircraft in a virtual hangar
After the installation 2 shortcuts will be available.
The actual Altitude application you need to start to login to the network.
If you return to the same screen after pressing the Connect button, this might mean that the Pilot Core is not installed correctly or it's not running. If you're using MSFS, you should start the Core manually.
If you're running the UI on another device in your local network. You should use the local IP address of the device running the Flight Simulator.
Once connection is established with your simulator. Altitude will ask you to sign into your IVAO account.
Use your VID and Website Password to login.
The User Interface is purposely minimal and is broken down in the following major sections:
- Top bar which includes Flight Plan check area, MTL selection button and the pin buttton
- Communication area
- Message section
- Transponder section
- Radio section
- Action buttons
If the pilot UI COM1 and COM2 frequencies are set to ---.--- (see image below), this means that:
The Top bar contains 3 functions:
Flight Plan area's purpose is to display the active flight plan received from the Flight Plan Server.
By default without a flight plan or before any connection, the Flight Plan checking panel will display the default text “No Flight Plan” against a red coloured background.
When you click on this banner, the UI (User Interface) will display the default message:
After succesful retrival of your Flight Plan from the IVAO Servers, this area will display the following 3 information based on your Flight Plan:
- Your Callsign
- Departure airfield ICAO code
- Destination airfield ICAO code
Using the format : CALLSIGN ( DEPARTURE - ARRIVAL )
In the example below, the flight plan is checked with your active connection; the callsign used is AAL706 and the flight is from TISX to KMIA.
If you click on this area while you have an active flight plan, your flight plan will be displayed in ICAO text format like in the example below:
Please report any missing model or livery here: https://forum.ivao.aero/threads/tell-us-what-were-missing.366481/
You can change how you appear to other users by clicking the MTL button (Multiplayer Traffic Library). Note that your flightplan aircraft has no affect on the selected MTL, in other words it is very possible to select a MTL that does not match your actual aircraft if it is missing in the library.
If you don't know which MTL to choose you can browse the MTL Catalog
Airline Operator code can be searched here https://www.avcodes.co.uk/airlcodesearch.asp
At the right of the top area next to the MTL button, you will find the pin icon.
This pin icon can be used to force the UI interface to be in front of all other applications on the screen.
The Text Panel displays different types of messages: (see image below):
In the example above, you can see:
The number in parentheses (00) represents the minute of the hour.
Below you will find all the possible types of messages which can be received.
IVAO server system messages from the network (#!>) are displayed in white after a successful connection.
If you have tuned your frequency to an ATC station, the selected ATC station and frequency will be displayed instead of the UNICOM channel like the figure above.
If Altitude detects lower framerate (when using X-plane) a specific message is displayedas shown here:
This message is displayed every 20 seconds if framerate ratio is below 70%.
Text messages from aircraft in your vicinity and same frequency are colored white and structured like this:
Pilot Callsign (minute of the hour) > message
Messages from ATC addressed to you (on the active frequency) are colored green and structured like this:
ATC Callsign (minute of the hour) > message
Messages sent by ATC not addressed to you are colored white.
Example: Message sent by LFRR_CTR at 11:38 UTC
Messages sent by you are colored dark-green and structured like this:
Your Callsign (minute of the hour) > message
Example: message sent by VAOTDAM at 15:04 UTC: auto-information message on frequency
Note: your callsign is automatically sent. No need to type it.
ATC Force Act is received only for you and sent by an active ATC. The message is displayed in orange.
This message invites you to join/connect to the ATC frequency.
Example: Invitation to contact LFEC_TWR ATC received by the pilot:
ATC invitation to contact is received by using an oceanic SELCAL request paired with dual DTMF tune signals. The message is displayed in orange.
This message invites you to join/connect the ATC frequency in order to make a controlled flight.
SELCAL can only be received if tuned to the ATC frequency.
Once ATC sends a SELCAL the pilot will hear a 2-ton sound depending on the SELCAL code as well as a text message.
Below, you can find an example of SELCAL received by the pilot.
Incoming private messages are displayed in grey and starts with [MSG] tag.
When you receive a private message, MSG button also blinks red until you open the message window.
METAR and TAF messages can be received from the network after the server has received a manual request from yourself. Check Dot Commands to see how to request weather information.
The messages are displayed in light blue.
All IVAO Broadcast messages are displayed in red. They are received by all users in the network and these messages can only be sent by IVAO supervisors or administrators.
Example: Broadcast message sent by Supervisor IVAO-MA1 for an ATC exam:
You may use the field below the Text Panel to send messages. This field could also be used as a scratch pad to take notes. The scratch-pad is followed by a SEND button. When you click on SEND, the entire text written in the scratch-pad is sent on the current frequency.
When sending messages on any frequency, you must use standard phraseology in English having regard to the Self announcing procedure and Phraseology text abbreviation. You may use also the onboard Auto-Unicom module to help you make these announcements on the frequency.
Example: Scratch-pad with the text message ready to be sent on the frequency in: “your text shall be written here”.
In the scratchpad or in message tabs, you can also send commands. Commands will not be sent on the current frequency as text but commands will be converted by the User Interface as server requests or UI request.
Available commands are:
Command | Description | Example |
---|---|---|
.x code | sets your squawk code (0-7) | .x 5015 |
.c1 frequency | sets the COM1 frequency to the chosen frequency in the command | .c1 126.450 |
.c2 frequency | sets the COM2 frequency to the chosen frequency in the command | .c2 122.000 |
.metar ICAO .wx ICAO |
Request a METAR of ICAO code airfield (weather information) | .metar LFRS .wx EDDL |
.taf ICAO | Request a TAF of ICAO code airfield (weather information) | .taf KJFK |
.wallop message | Request help from network supervisors Read more | .wallop ABC123 is not responding to force-act |
.chat callsign | Initiate a chat message with anyone using their login callsign | .chat LEMD_APP |
.atis callsign | Fetch ATC ATIS information | .atis SBBR_TWR |
.help | display the onboard command help in the text command window | .help |
Example of METAR command in scratchpad area to be sent by user: (please read article about METAR coding for more information)
Example of a WALLOP call (a wallop call is a message for a supervisor in order to request help)
All commands can be typed on the scratch pad or in any scratch pad of private messages.
The button “AU” is the Auto Unicom feature which is a tool for automating UNICOM messages.
It contains a list of predefined messages for each phase of flight.
When the Button is light grey like the example above, this means Auto Unicom Module is not available. You should connect and file a flight plan in order to activate it.
Please consult to the documentation of Auto Unicom Module to learn more!
Below the Text panel, there is the Transponder panel (XPDR).
In the transponder panel, you will see the following information:
- 4 digits Mode A Transponder code (named squawk code)
- 2 position Transponder Mode
- Mode STDBY ( standby mode)
- Mode TX (transmission mode which is sometimes TA or TA/RA mode in some aicraft)
- ID button: Starts an IDENT procedure when requested by ATC.
In some regions, transponder should be set to TX mode when taxiing. Always follow ATC instructions in this case.
On initial launch your transponder code will be set to 2000. Your transponder should be set to 2000 when there is no active ATC.
To change the transponder code you may use your aircraft's transponder panel or use chat commands
.x squawk code
Note 2 :If you want more information about transponders, please consult the Transponder Use article.
You should set your transponder mode according to your phase of flight.
- STBY when you are on ground on apron or taxiing.
- TX when you are flying, or taking-off or landing on a runway.
Transponder values are in octal, that means there is no 8 or 9 digit.
Below the transponder panel, you will find the radio panel.
The radio panel displays your current active COM1 and COM2 frequencies, as well as their associated ATC station names (if available).
The communication channel (COM) status is indicated by the RX/TX button colour:
- A green RX mark indicates which COM channel is currently used to listen to the network frequency programmed on its channel.
- A grey RX mark indicates that the COM channel is in Standby.
- A green TX mark indicates which COM channel is currently used for communication by text and voice to the ATC and/or UNICOM.
- A grey TX mark indicates that the COM channel is on the standby frequency. You will neither be able to transmit on this frequency by text nor by voice.
Example: COM1 and COM2 are set to 122.800 (UNICOM) and COM1 is the active RX and TX channel with the green marks.
When connected to the network, left-clicking on a frequency in each COM in the Radio Panel opens the Quick Tune panel. This action allows you to quickly pick a frequency for the selected COM from the list of known nearby ATC stations.
If you left-click on the frequency number, you will open a pop-up menu for automatic tuning by selecting a nearby station:
- If there is no nearby ATC station, you will find only the UNICOM frequency (see bottom left image)
- If there are nearby ATC stations, you will find a selection list where you can choose the desired ATC frequency or UNICOM frequency (see bottom right image)
Example: 2 cases of selection list on COM1 : on the left, a selection list without any ATC (only Unicom available), on the right a selection list with one ATC connected:
The ATC list is sorted by ATC distance with UNICOM as first selection.
It displays only an ATC list in the reception range of your aircraft in function of its position. (you should not have the opportunity to contact New York tower if you are in London!)
When you have selected the wanted ATC position in the list, you left-click on it and the UI will display the new frequency in the selected COM channel with its call-sign displayed just below in white colour.
Note that if the frequency colour is light blue like the example below, that means the active frequency compatible with internal voice module. (If the frequency is not light blue, ATC can be in text mode or have issue with his voice system).
Example1: ATC selected on COM1 is LFRS_APP at 124.425 MHz
Example2: ATC selected on COM2 is LFBB_CTR at 125.105 MHz
If the frequency entered in your cockpit does not match with any active ATC in the reception area of your aircraft, no call-sign will be displayed on the communication area(see example below).
Example: the COM1 frequency is 125.050 and the COM2 frequency is 118.805 and no ATC is detected on this frequency (No call-sign is showed on communication channel). Absolutely nobody will hear your text or voice message if you transmit on this frequency:
In this case, no ATC is connected on this frequency or the station is currently too far from your position.
The ATC list displayed is independent of the communication channel. You will have the same list in COM1 and COM2.
Example: Below you can select when connected on ground at Budapest LHBP the following ATC:
Note that when you have tuned to an ATC station, the Selected ATC station will appear on top of the text panel.
By clicking on the TX icon on the frequency panel, you can switch from COM1 to COM2 or from COM2 to COM1.
Example: Before changing COM1 to COM2 frequencies, your radio panel may display two different stations like in the example below:
By clicking the greyed TX on COM2, you will switch from COM1 to COM2 and you will have this configuration:
You can also change the frequency from your cockpit.
NOTE : Pay attention to the 8.33kHz specific frequencies. Some cockpits inside your simulator are not compatible with these new frequencies. Pay attention that changing frequency by using the UI is mandatory in order to join the adequate ATC. We have implemented a translation module, but it has its limitations.
You may have dual RX channels if your simulator and aircraft allows it. You need to click on the second RX button to highlight it in green like in the image below:
NOTE 1 : The second frequency colour (in the example the COM2) is white that means that audio reception is not possible on secondary receiving channel.
NOTE 2 : Dual RX feature is only available for text messages only due to technical limitations. Dual RX voice is not possible today.
Sometimes you may select dual reception inside your cockpit to enable this function.
Example of a secondary text message received on RX only COM (text only mode):
Blue frequency indicates you are connected to the ATC voice channel.
Green RX indicates ready to receive.
Orange RX indicates currently receiving transmission.
Green TX indicates ready to transmit.
Orange TX indicates you are currently transmitting.
Altitude will warn you if your PTT has been pressed more than 30 seconds.
The volume can be set when you click on the area represented by the "red" spot whenever the volume position is. The hint is displayed
The Volume can be lowered and increased by sliding horizontally the mouse from the click area presented above:
The minimum volume position is :
The middle volume position is :
The maximum volume position is :
When you are not connected, the UI displays the first button as OFFLINE in red.
Once connected to the network, the button will change to ONLINE in green.
Click the OFFLINE button to opent he connection window.
If you want the voice to be actived, you shall select the voice setting:
- Tx/Rx : option that enables the internal voice plugin for voice transmission and reception
- Receive Only : option that enable only the internal voice plugin for voice reception
There are also 2 options :
- Hide ADM/SUP Rating : only works for supervisors (do not select this option if you are not a supervisor)
- Connect as Observer : only for monitoring the IVAO network or connecting to the network as second pilot for cockpit sharing.
- Connect as Follow Me : only for Follow Me connection on IVAO. Check the IVAO rules and regulation about follow me usage and your division rules. This option is available only to pilot with a certain knowledge.
If you select the observer session with selecting the adequate option button (see image below), you will be considered to observe the IVAO activity near your aircraft location.
In this situation, pay attention that:
- You can see all nearby traffic (pilots only)
- All IVAO user cannot see your aircraft and your position
- Your connection hours as a Pilot or ATC will be not increasing
- No flight plan is active with your connection.
In the image below, you can see after the connected callsign(here AFR1906) the tag (OBS) which indicates you that you are connected as observer. The second tip is when connected as observer the network will send you, your IVAO ATC rating in a message:
In order to connect as a follow me, you should fulfill the follow-me rules and regulation of IVAO and also the follow-me rules established by your division.
One of these rule is the call-sign format which is ICAOFM00 (the number at the end is the serial number of follow me car of the chosen aerodrome starting with 01).
The MTL aircraft is automatically selected and you can choose one of the possibilities.
If the callsign does not follow the rules, interface will display this error message:
After connection, your user interface will look something like the image below. You can also see that the user interface recognize you as follow me with the tag [FM]:
In the example above, you can see that the follow-me callsign is LFRSFM01 with:
- LFRS = Airfied ICAO call-sign (Nantes in France)
- FM = Follow me tag
- 01 = Serial number starting with 01.
To disconnect from the network, you shall click on the ONLINE green button (see below):
Then a popup window is shown :
If you click No, you will remain connected to the network.
If you click Yes, you will be disconnected without delay.
The first aircraft shall connect to IVAO as a normal flight with the chosen call-sign (Example BAX567)
The second pilot shall connect as Observer with the same call-sign + _OBS. (Example BAX567_OBS)
The second pilots' connection is considered as observer in the IVAO network. His connection hours will not be increased and his connection is never seen by ATC.
You can see a list of online ATC in your vicinity by selecting ATC.
Selecting an ATC station gives you the options to message, tune frequency, or request ATIS information.
The MSG menu contains all private conversations between yourself and other users.
Each time you receive a new private message, a sound is played and the MSG button flashes red.
Clicking on the flashing MSG button opens the mesasges window.
The drop-down menu icon 🔽 at the top lists all your current private conversations.
- each line will correspond to one private chat
- you can chat with any active pilot, ATC, observer, or IVAO staff member.
- you can close a chat by clickin the ✖️ icon.
- A blue dot indicates a new unread message.
In the example above, we have a chat open with:
Selecting a callsign will open the chat conversation.
NOTE 1 : You can initiate a new chat manually by using the command .chat callsign in the messge entry field.
NOTE 2 : When receiving an new message, the UI will switch automatically to the incoming message channel after pressing the MSG button.
The settings window allows you to set your audio devices, VHF effects, icon alerts, and Push-to-talk key.
- Disconnect from simulator : disconnects the PilotUI from the simulator, if no other PilotUI is running on a different machine, this will also result in a disconnect from the network.
- Audio input hardware setting : Set your microphone input
- Audio output hardware setting : Set your output device.
- Enable Audio VHF effect option : left-click on button to enable or disable the VHF effect like microphone clicks, VHF background noise, frequency blocking effect ...
- Enable Icon Alert : left-click on button to enable or disable the blink effect on the pilot client task bar icon.
- Apply button to save the changes into the settings for next PilotUI launch
- Set Push-To-Talk Key option : Click on the button then press the new PTT(Push-To-Talk) key for voice transmission (We advise to select silent key like CTRL, SHIFT or ALT keys).
The default PTT key is the left [CTRL] key on your keyboard :
When pressing the TCAS button, the TCAS window popup will appear.
The TCAS is the onboard Traffic Collision Avoidance System provided by the UI interface.
Example: By default the TCAS system is disabled (STBY mode):
The TCAS modes, selected on the bottom left, are:
- Standby mode - STBY ( TCAS is deactivated )
- Traffic Advisory mode - TA ( This mode alerts the pilot through a collision alert sound only )
- Traffic Advisory and Resolution Advisory mode - TA/RA ( This mode alerts the pilot through collision information and gives resolution clearances that the pilot shall comply with without delay)
Example: After clicking on the STBY button, the TCAS system is set to the TA mode:
Example: After clicking on the TA button, the TCAS system is set to the TA/RA mode:
Note in both images above, traffic is displayed at -200ft from your vertical position (relative altitude)
There are 2 button for display configuration for this TCAS:
The Vertical Visibility Range definition is:
There is one sound mute function available for TCAS by using the bottom right button.
When pressing the D-ATIS button, a new window opens the Datalink ATIS (automatic terminal information service ) feature to manage ATIS messages like in some aircraft systems.
Note : At IVAO we only have text ATIS for the moment, as voiced ATIS is not implemented and ATIS is not associated by a separate frequency today. So the IVAO pilot software implements the Datalink ATIS for all aircraft.
After you pressed the D-ATIS button, the Datalink ATIS window is displayed like the image below, which represents the Datalink ATIS when you do not have any active flight plan or you are disconnected.
After you have been connected to the IVAO server, and the flight plan was correlated with your callsign and flight plan server, the Datalink ATIS will show the windows like in the example below:
Note: At the top, you may find 2 to 4 ICAO airfield codes from your flight plan:
Example: flight plan OJAI to OBBI with 2 alternate airfields OEDF and OTHH:
Example: A flight plan LFMP to LEBL without alternate airfields declared:
If you click on one of the departure, arrival or alternate ICAO codes, there are 2 cases:
Then you cannot request any ATIS from this ICAO airfield. You should check for another ATC position which can take your departure, or start your flight by using auto-information on UNICOM if there is no other ATC station (check METAR for weather information).
After selecting the chosen ATC in the list, the Datalink ATIS will display the ATIS information:
Note that the ATIS of each station is displayed after a separation line "---------------------".
In order to get one ATIS from any desired ATC station, you should write in the scratch-pad area of the Airport ICAO, the desired ATC position:
NOTE : You can browse all the Datalink ATIS data with your mouse central wheel.
If you type the dot command .ATIS on the main frequency scratch-pad, the ATIS will be displayed in the Datalink ATIS area.
After command validation, the D-ATIS button is blinking if there is any output available. The button is blinking until you click and select the D-ATIS window.
After clicking the D-ATIS button, you can read your desired ATIS (see example SBXS_APP).
If there is no ATC station connected on this position, D-ATIS will not blink and there is no input.
On bottom right of the UI interface, you will find:
the current UTC time whic is the official hour to use in the flight plan, flight report in IVAO
the number of hours and minutes counter which compute your connected time online. This counter is displayed only if you are connected on IVAO
Example: UTC time is 15H38 and your online time is 3 minutes.
The messages received on your main frequency, all the private messages and system messages are also received inside your flight simulator.
Open X-Plane and launch a flight, on the top menu bar click on "Plugins" then "IVAO Pilot Client"
Activate the window by clicking on "Toggle message window" Verify that a white dot is displayed before the selection (in the image
Verify that the window is displayed :
There is another option witch is The toggle alert window :
The toggle alert window will open when receiving some alert like the force act and displayed in yellow
The tagging setting is the option that drives the aircraft callsign above or below the MTL / CSL. This setting is not real but it can help to communicate with pilots on the UNICOM frequency.
X-Plane :
FSX :
To customize UI Sounds, put a new .wav file with following name in the subdirectory \sounds where PilotUI.exe is located:
- connect.wav: connected sound
- disconnect.wav: disconnected sound
- freq.wav: incoming frequency message
- freqme.wav: incoming frequency message directed to me
- private.wav: private messsage
- wallop.wav: wallop
- forceact.wav: force ATC notice
- broadcast.wav: broadcast sound
Note 1 : If you want to deactivate one sound (example: incoming message on frequency not for me), with you notepas just create an empty text file and rename or save it as the chosen name above (example: freq.wav)
Note 2 : The sounds sample rate shall be set maximum to 24bit. Altitude is not compatible with 32bit sample rate.
There is one parameter file which is located in main simulator directory:
The file is : IVAO_Pilot_Client.conf
[GENERAL]
AIRCRAFTLABEL=1
DISPLAYSIMMESSAGE=0
MTLVISIBILITYRANGE=50
The available parameter are :
Supervisor commands are implemented in the IVAO Pilot software.
- All wallop messages will be received in a separate private chat named [WALLOP] (see below).
- Each new incoming wallop message will produce a specific sound, different from private messages.
- Every message written in this specific WALLOP tab will automatically send wallops without typing the specific command .wallop
Here is the list of available commands for supervisors:
Command | Description |
.info | Request connection information from a member connected as Callsign |
.kill | Kill a member connected as Callsign with a reason inserted (reason is mandatory) |
.broad | Send a broadcast message to all members |
.wallop | Send to other supervisors a message for chatting to all supervisors or acknowledge a wallop. |
Warning: If you type the .kill command without inserting a reason, an error popup is displayed:
The option Hide SUP/ADMIN Rating is available in the connection window in order to show you as Supervisor online in Webeye.