IVAO Pilot Software[PDF]
- 1 License
- 2 Introduction
- 3 Launching UI application
- 4 User Interface - main panel
- 5 Top bar
- 6 Input/Output Communication Text Aera
- 7 Transponder panel
- 8 Radio panel
- 9 Action button panel
- 9.1 Connection button
- 9.2 ATC popup
- 9.3 The private message popup window (CHAT)
- 9.4 Communication Text displayed inside the simulator
- 9.5 Settings popup window
- 9.6 TCAS button
- 9.7 Datalink ATIS
- 10 Supervisor commands
- 11 See also
- 12 Reference
- 13 Author
The End-User License Agreement ("EULA") is a legal agreement between you and International Virtual Aviation Organisation VZW (“IVAO”).
Please read and comply with the EULA license.
This document will describe the IVAO Pilot Software at his initial version:
- Altitude 1.9.9 BETA
- The Connector software (CONN)
- The User Interface (UI) application
- The Flight Plan System (FPS) Web application
- a 32bit DLL file for Microsoft flight simulator FSX and FSX Steam Edition
- a 32bit DLL file for Lockheed Martin P3D V1, V2 and V3
- a 64bit DLL file for Lockheed Martin P3D V4
- a 32bit XPL file for the Laminar Research flight simulators : X-plane 10 - 32bits
- a 64bit XPL file for the Laminar Research flight simulators : X-plane 10 & 11 - 64bits
The connector (CONN) is the file installed inside your flight simulator that reads and writes flight data of your simulator. It enables also the local network Ethernet connection to allow access to these data by the User Interface (UI).
The connector (CONN) also handles communication with IVAO SHARD servers to:
- send aircraft position to the server
- receive other user aircraft positions to display MTL/CSL inside your simulator
- receive and transmit communication text with other Pilots and ATC
- server information exchange (system messages, answers to pilot text requests, ...)
It manages the connection with the connector (CONN) software connected directly on the same computer or a computer connected via an internal Ethernet network.
- All 64bit versions of Microsoft Windows
- Mac OSX 10.6 and above
- Linux 64bit
The User Interface (UI) main features are:
- Display text communication with other IVAO users
- Manage Communication channels (ATC frequencies, Private communication, ...)
- Manage transponder code
- Display ATC connected around your position
- Retrieve ATIS and weather information
- Give the possibility to have own TCAS
Flight Plan System (FPS)
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
Launching UI application
When your simulator is running and your aircraft is loaded and waiting, start the User Interface.
- Windows : launch pilot_ui/win/64/PilotUI.exe
- MacOS : mount pilot_ui/osx/PilotUI.dmg and start PilotUI.app
- Linux : launch pilot_ui/lin/PilotUI
- IP Address = 127.0.0.1, if you are running both the UI and the simulator on the same computer.
- Password = ivao (lowercase only do not use uppercase IVAO)
User Interface - main panel
- The Top bar which includes Flight Plan check area, MTL selection button and pinned button
- The Input/Output Communication Text Area
- The Output Text scratch pad and the “Auto Unicom” function
- The Transponder Panel
- The Radio Panel
- The Action button Panel (which includes the connection panel)
- The UI is not connected to the CONN application running in your simulator, OR
- The UI may be connected to a cold and dark aircraft
The Top bar contains 3 functions:
- Flight plan check area
- MTL selection button
- Pin button
Flight plan check area
When you click on this banner, the UI (User Interface) will display the default message:
- Your aircraft identification callsign
- The departure airfield ICAO code
- The destination airfield ICAO code
In the example below, the flight plan is checked with your active connection; the callsign used is VAOTDAM and the flight is from ENGM to LROP.
MTL selection button
When you click on the MTL button, a popup MTL window appears:
You can select the new MTL aircraft or MTL variant in the list provided, or you can type the desired aircraft by using your keyboard also.
After selection, you have the choice to select the change by clicking on the CHANGE button or cancel the new selection by clicking on the CANCEL button.
Pin and Unpin UI interface on top
At the right of the top bar, next to the MTL button, you will find the pin icon.
The icon animation is created to make sure that you select the desired configuration:
- If the interface is pinned in front of the screen you will see the white icon like the example below:
- If the interface is not pinned in front of the screen you will see the grey icon like the example below:
Input/Output Communication Text Aera
Communication Text Panel
In the example above, you can see:
- the active frequency is 122.800 – the UNICOM frequency
- one input message from the IVAO Shard Server v0.6
- the answer to a METAR request for LFRB airfield
- 1 auto-information message from the pilot who runs the UI (VAOTDAM>)
- 1 ATC (LFEC_TWR) request to contact
Below you will find all the possible types of messages which can be received by the communication text panel.
Received message on selected frequency
Example: Message sent by AFR88ZW at 18:32 UTC: auto-information message in Unicom
Example: Message sent by LFRR_CTR at 11:38 UTC: clearance from ATC in current frequency
Your messages sent on active frequency
Example: message sent by VAOTDAM at 15:04 UTC: auto-information message on frequency
ATC Request Contact messages
This message invites you to join/connect the ATC frequency in order to make a controlled flight.
Example: Invitation to contact LFEC_TWR ATC received by the pilot:
This message invites you to join/connect the ATC frequency in order to make a controlled flight.
Example: Selcal call received by the pilot.
The messages are displayed in light blue.
Example: METAR information received by the user after a METAR request to the server:
Example: Broadcast message sent by Supervisor IVAO-MA1 for an ATC exam:
Example: Scratch-pad with the text message ready to be sent on the frequency in: “your text shall be written here”.
Specific commands (dot commands)
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.
|.x <Mode_A_Code>||sets your transponder Mode A code to the specified value||.x 2000|
|.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|
|Request a METAR of ICAO code airfield (weather information)||.metar LFRS|
|.taf <ICAO>||Request a TAF of ICAO code airfield (weather information)||.taf KJFK|
|.wallop <Request help message>||Request help in IVAO network from supervisors||.wallop I cannot contact EDDF_APP with my client.|
|.chat <Callsign>||Initiate a private message with a pilot, an ATC, an observer, a supervisor identified by its own Callsing||.chat LEMD_APP|
|.atis <ATC callsing>||get Datalink ATIS from the ATC callsign connected||.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)
The Auto-Unicom Feature
It contains a list of predefined messages for each phase of flight.
The Auto-Unicom feature opens after pressing the "AU" button.
Example: Auto Unicom specific window opens for the first time (all fields empty):
Below the Text panel, there is the Transponder panel (XPDR).
- 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: which starts an IDENT procedure requested by ATC.
On the image above, you can see that the transponder code is 2000 and transponder mode is set to TX mode and the ID button is inactive.
On the image above, you can see that the transponder code is 4641 and transponder mode is set to TX mode and the ID button is inactive.
On the image above, you can see, that the transponder code is 2000 and transponder mode is set to STBY and the ID button is active (it has been pressed for the IDENT procedure requested by an ATC).
Note: When starting the UI, the transponder code is always set to 2000.
- transponder mode = STBY when you are on ground on apron or taxiing.
- transponder mode = TX when you are flying, or taking-off or landing on a runway.
The radio panel displays your current active COM1 and COM2 frequencies, as well as their associated ATC station names (if available).
- 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.
Changing frequency on COM channels
Example: COM1 frequency is tuned to 119.825 MHz which is the LFRR_CTR ATC frequency:
- 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 or frequency including UNICOM (see bottom right image)
Example: 2 possible selection lists on COM1 : on the left without any ATC, on the right with one ATC connected:
It displays only an ATC list in the reception range of your aircraft in function of its position. (you should not contact New York tower if you are in London!)
If you click the COM1 and COM2 frequency to change it, you will have the same list of ATC available.
Example: Below you can select when connected on ground at Budapest LHBP the following ATC:
Switching frequency between COM channels
Example: Before changing COM1 to COM2 frequencies, your radio panel may display two different stations like in the example below:
- LHBP_E_APP selected as primary frequency
- LHCC_CTR selected in standby frequency
After switching COM1 and COM2, by clicking the greyed TX on COM2, you will have this configuration:
Example: the COM2 frequency is selected (122.300) and no ATC is detected on this frequency. Absolutely nobody will hear your text message if you transmit on this frequency:
2 different selectable Receiving COM channels
Example of a secondary text message received on RX only COM (text only mode):
Action button panel
You will find the following buttons:
- Connection button
- ATC selection and information button
- Private message button
- Settings button
- TCAS button
- Datalink ATIS button
Connecting to the network
The popup “CONNECT TO NETWORK” appears and you must fill your information in this window:
- Your own callsign for the IVAO network
- Your own VID given by IVAO (example is 100000)
- Your IVAN password given by IVAO
- Your real name (Name + Surname)
- Your selected IVAO server and its port (use default one = 6809)
- Your voice activation plugin
- Your aircraft representation for other players connected to the network
- Your airline or texture representation of previous aircraft available in the database.
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.
Disconnecting from the network
If you click on the ONLINE button, a disconnect popup is displayed:
- If you click No, you will remain connected to the network.
- If you click Yes, you will be disconnected without delay.
Cockpit sharing connection to IVAO
- The first aircraft shall connect to IVAO as a normal flight with the chosen callsign (Example BAX567)
- The second pilot shall connect as Observer with the same callsign with one more letter ‘M’ as multiplayer. (Example, BAX567M)
Example of a second aircraft connection with BAX567M:
- If there is no ATC station nearby your position, you will find only the UNICOM channel on this popup like the first image on the bottom left.
- If there are ATC stations nearby your position, you will find the UNICOM channel, and all ATC channels listed below sorted by distance like the second image on the bottom right.
- initiate a private chat by clicking on MESSAGES
- set ATC frequency to COM1 by clicking TUNE COM1
- set ATC frequency to COM2 by clicking TUNE COM2
- get ATC ATIS by selecting the REQ. ATIS
The private message popup window (CHAT)
This messages popup window allows you to visualize and exchange private messages with other members of the network.
If you click on the white triangle or inside the selection bar, you will display a list of open channels with you (see image below):
- each line will correspond to one private chat or communication channel
- the communication channel can be established with an active pilot, an active ATC, an observer or an IVAO staff member who are connected to the network.
- the 'X' sign in front of each callsign is the closing communication switch (meaning that if you press the 'X', you will lose all the history of the chat).
- the dot sign in front of each callsign represents the activity of the channel. If the dot colour is light blue, it means that this channel has received one new communication that you have not read yet.
On the example below, we have a chat open with:
- IVAO-DM1 (Observer Staff) (callsing starting with IVAO are HQ IVAO staff people)
- AFR220 (Pilot) (channel has a non read messsage received and is ready to be read)
- BAW8549 (Pilot)
- KIKK_TWR (ATC)
Communication Text displayed inside the simulator
If you fly FSX / P3D, the messages are displayed with a green bar by default.
If you fly X-plane, the messages will be displayed in a transparent window which must be activated first through the following process:
- Activate the window
- Verify that the window is displayed
Settings popup window
The settings popup window is the area to set up your User Interface for specific actions, display or configuration.
There is only one setting available : the tagging setting which 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.
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 parameters you can tune for this TCAS:
- Horizontal Visibility Range located on the top left : Available ranges are 3NM, 5NM, 10NM, 15NM, 20NM or 40NM
- Vertical Visibility Range located on the top right : Available ranges are NORM, ABV, BLW , ALL
The Vertical Visibility Range definition is:
- NORM: traffic at +/- 2700 ft is displayed
- ALL: all traffic within the TCAS range is displayed
- ABV: traffic within the interval (-2700, +9000) ft is displayed
- BLW: traffic within the interval (-9000, +2700) ft is displayed
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.
- First airfield is the departure airfield
- Second airfield is the arrival airfield
- Third airfield is the first alternate airfield
- Fourth airfield is the second alternate airfield
Example: flight plan OJAI to OBBI with 2 alternate airfields OEDF and OTHH:
Example: A flight plan LFMP to LEBL without alternate airfields declared:
Example: Step 1: You want to request any ATC connected on SBXS:
Example: Step 2: After ICAO code validation, the UI will display the ATC list available on this position (here is one ATC station only = SBXS_APP):
Example: Step 3 : After selecting the SBXS_APP position, the UI will display the SBXS_APP ATIS after the separator line.
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.
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:
|.info <Callsign>||request connection information from a member connected as Callsign|
|.kill <Callsign> <Reason message string text>||kill a member connected as Callsign with a reason inserted (reason is mandatory)|
|.broad <Message>||Send a broadcast message to all members|
|.wallop||Send to other supervisors a message for chatting to all supervisors or acknowledge a wallop.|
- Frequency, Transponder Use, ATIS, Traffic collision avoidance system - TCAS, Air traffic control position
- VID 150259 - Creation
DATE OF SUBMISSION
- 00:07, 7 January 2020
- This documentation is copyrighted as part of the intellectual property of the International Virtual Aviation Organisation.
- The content of this documentation is intended for aviation simulation only and must not be used for real aviation operations.