vATIS Documentation

vATIS is an intuitive and easy to use ATIS client for the VATSIM network. vATIS was created to simulate the Digital ATIS (D-ATIS) system used by the FAA with the intent to reduce controller workload. Never again will you be interrupted while recording an ATIS; vATIS will automatically update it for you.

Minimum System Requirements

Installation

After you download the vATIS installer file, double-click the executable to launch the installer. You will be prompted to choose an installation location. It is recommended that you leave the default location selected as the local application data folder to avoid any file permission problems.

The Empty Config File option will reset your vATIS configuration file to the default settings. You will lose all configured settings.

When the installation is complete, you will have the option of launching vATIS.

For successful ATIS streaming, you may need to forward port 3293 (UDP) through your router.

Terms and Concepts

Before using vATIS, you should familiarize yourself with a few basic terms and concepts.

  • Facilities

    A facility is the geographical location of the ATIS (e.g. KLAX).

  • Configuration Profiles

    Configuration Profiles are used to save ATIS free text and settings, allowing you to quickly populate vATIS. You can create an unlimited number of configuration profiles per facility. For example, you could create a profile for "West Ops", "East Ops", "Night Ops", etc.

Starting vATIS

To start vATIS, double-click the desktop icon (if you chose to create one during the installation process) or locate vATIS in your programs list.

Each time you launch vATIS, a window with a list of facilities (if you created or imported any) will show. See the Facilities section for details on how to create a facility.

Facilities

Each time you launch vATIS, a facilities list will show (see screenshot below). The first time you run vATIS, the list will be empty. Most users will download and import a facility configuration file created by their ARTCC.

Create a New Facility

To create a new facility, click the New button at the top right of the facility list. You will be prompted to enter a facility ICAO identifier (e.g. KLAX) and a name for the facility (e.g. Los Angeles). After you save the facility, it will be added to the facility list.

Import a Facility Configuration File

To import a pre-configured facility configuration file, click the Import button. A file browser dialog will show allowing you to browse to the location of the facility file (.gz file). Importing a facility configuration file will also import all configuration profiles associated with each facility within the import file.

Export a Facility

You can export a configured facility by highlighting the facility name in the list and clicking the Export button. This is useful if you want to make a backup copy of your facility configurations.

ARTCC Facility Engineers: To export a facility and its configuration profiles to share with your ARTCC, highlight the facility name in the facility listand click the Export button. Choose a location to save the exported file.

Select a Facility

To select a facility, double-click the facility name in the list. The facility and its profile configurations will be loaded and the main vATIS window will become active.

Tour of the Main Screen

  1. Information Status Bar

    The Information Status Bar across the top of the main vATIS window gives an at-a-glance look at the current ATIS situation. From left to right is the current ATIS code (dropdown list with letters A-Z), ZULU clock, wind and altimeter (parsed from the facility's METAR report).

  2. Active Facility

    The Active Facility shows the facility that is currently loaded into vATIS. You can change the facility at any time by clicking the facility identifier button which will open the facilities list. If you choose a difference facility, you will be disconnected from the VATSIM network and the current ATIS you have broadcasting will stop.

  3. Arrival/Departure/Other

    The Arrival/Departure/Other free text field is used to include information pertaining to arrivals, departures or other important information that you want broadcasted in the ATIS. For example, departure runways, approaches in use, etc. You can click the Preview option at the top right of the text field to listen to the voice synthesized version as it would be heard in the ATIS broadcast. This text field allows use of the Text Parsing Rules.

  4. Notams

    The Notams free text field is used to include special notices in the ATIS (e.g. runway closures, etc.). You can click the Preview option at the top right of the text field to listen to the voice synthesized version as it would be heard in the ATIS broadcast. This text field allows use of the Text Parsing Rules.

  5. METAR Report

    The METAR Report bar shows the current METAR report for the loaded facility. The METAR report is only visible when an ATIS code is selected, a configuration profile is loaded and you are connected to the VATSIM network.

  6. Voice Server Configuration

    The Voice Server Configuration area is used to configure the voice server URL and ATIS frequency. These settings are defined per facility and are global to each associated configuration profile.

  7. ATIS Output

    The ATIS Output field shows the text version of the ATIS as it would be received by other network clients who may request the text version of the ATIS.

  8. Function Control Bar

    The Function Control Bar at the bottom of the main vATIS window contain several functions.

    • Connect ATIS: This button will start or stop the broadcast of the voice ATIS. When toggled, the button will turn green and read "Disconnect", signifying that the ATIS is currently streaming on the network.
    • Preview ATIS: This button allows you to listen to the fully synthesized voice ATIS. When toggled, the button will turn green and the ATIS will begin playback through your default audio device. You can stop the playback at any time by clicking the button again.
    • Auto Update: This button allows you to enable auto updating of the ATIS when a new METAR report is received. If enabled, you will receive a notification dialog with the new ATIS code. The button will turn green when auto update is enabled.
    • Refresh ATIS: This button is used to force a refresh of the voice synthesizer to ensure correct information is being broadcasted in the ATIS.
  9. Configuration Profiles

    The Configuration Profile dropdown list shows all configuration profiles that are created within the loaded facility. To select a configuration profile, click the dropdown list and choose a configuration profile by clicking its name. vATIS will populate with the configuration profile data. See the Configuration Profiles section to learn more about creating profiles.

  10. Connect to VATSIM

    The Connect to VATSIM button is used to connect vATIS to the VATSIM network. When clicked, a connection dialog will display. See the Connecting to VATSIM section for information on connecting to the network. When vATIS is connected to the network, the button will turn green and the button text will read "Disconnect". See the Disconnecting from VATSIM section for information on disconnecting from the network.

Connecting to VATSIM

To connect vATIS to the VATSIM network, click the Connect to VATSIM button at the lower right of the main vATIS screen. After you click the button, a connection dialog will appear (see screenshot below).

  • Full Name

    Enter your full name that is associated with your VATSIM account.

  • Rating

    Select your VATSIM rating from the dropdown list.

  • Certificate ID

    Enter your VATSIM Certificate Identification Number (CID).

  • Password

    Enter your VATSIM network password.

  • Server

    Select a VATSIM server from the list. It is recommended you choose a server that is geographically closest to you.

After you click the Connect button, the Connect to VATSIM button on the main vATIS screen will turn green and read "Disconnect". See the Disconnecting from VATSIM section for more information on how to disconnect from the network.

Broadcasting an ATIS

To begin broadcasting an ATIS on the VATSIM network you must first select a configuration profile from the dropdown list at the bottom of the main vATIS screen. If you do not have any configuration profiles created, please read the Configuration Profiles section for information on how to create a configuration profile.

After you have configured the ATIS to your liking (i.e. arrival and departure information, notams, etc), choose an ATIS code from the dropdown list at the top left of the vATIS screen. When you choose an ATIS code, the METAR report for the facility will populate and the synthesized ATIS text will populate in the ATIS output box (just below the METAR report).

You can listen to the synthesized ATIS before broadcasting it on the network by clicking the Preview ATIS button. The button will turn green and the ATIS playback will begin. Click the button again to stop the ATIS playback.

Once you are satisfied with the ATIS, you can begin broadcasting the ATIS by clicking the Connect ATIS button at the bottom left of the vATIS screen. This button will turn green and read "Disconnect" after the button is clicked. The ATIS will start broadcasting and can be received when tuned to the ATIS frequency on the network (if the client is within range of the ATIS).

It is suggested that you toggle the Auto Update button which will enable automatic ATIS updates. When a new METAR report is received, vATIS will notify you of an ATIS update with an audible "ding" sound and the vATIS icon in the taskbar will begin to flash. When you activate the vATIS window, a popup dialog will show with the new ATIS code with a button to acknowledge the update (see notification screenshot). You can disable the popup dialog in the facility configuration settings.

ATIS Update Notifications

VATSIM controllers may subscribe to a vATIS connection to receive notification of a new ATIS.

  • VRC Users

    To subscribe to ATIS updates, send a private chat message to the ATIS connection with the command SUBSCRIBE. vATIS will acknowledge your subscription request and add you to the subscribers list. You will receive a private message from the vATIS connection when a new ATIS is published.

    You can unsubscribe from the ATIS notifications by sending a private chat message to the vATIS connection with the command UNSUBSCRIBE

  • vSTARS and vERAM Users

    The "track" command is used to subscribe to ATIS updates. Refer to the vSTARS or vERAM documentation for more information on how to use the track command.

  • EuroScope Users

    EuroScope users will be notified of an ATIS update with an audible notification sound. The ATIS letter within EuroScope will automatically update.

Facility Configuration

The Facility Configuration window contains additional options for configuring the ATIS facility. To open the facility configuration window, use the key combination CTRL + F.



ATIS Template

The ATIS Template tab has a text field with a template used to format the ATIS. Clicking the Default Template button will restore the ATIS template to the default template. The following variables can be used in the template, in any order.

$FACILITY The ATIS facility name (i.e. the airport name)
$ID The current ATIS letter code
$WX Recommended Variable Inserts the full translated METAR report into the ATIS
$OBSTIME Inserts the observation time as reported in the current METAR report
$WIND The wind, if reported in the current METAR report
$RVR The RVR (runway visibility range), if reported in the current METAR report
$VIS The visibility, if reported in the current METAR report
$PHENOMENA The reported weather phenomena (e.g. rain, snow, hail, etc.), if reported in the current METAR report
$SKY The reported sky conditions, if reported in the current METAR report
$TEMP The reported temperature, if reported in the current METAR report
$DEW The reported dewpoint, if reported in the current METAR report
$ALTIM The reported altimeter, if reported in the current METAR report
$ARRDEP Inserts the text in the Arrival/Departure/Other text field
$NOTAMS Inserts the text in the Notams text field


Configuration Profiles

Configuration Profiles are used to store ATIS options without having to redefine them each time you use vATIS.

To create a Configuration Profile, click the New Profile button at the bottom left of the facility configuration window. A popup dialog to specify a name for the profile will show. When you create a profile, it will automatically become active. You can delete or rename a configuration profile using the respective buttons at the bottom of the facility configuration window.

Any changes you make to vATIS when a configuration profile is selected will be saved to that configuration profile. For example, you could create a configuration profile for "east operations" and input the appropriate information. Then, each time you choose the "east operations" configuration profile, vATIS will automatically populate with the "east operations" data.



Contractons

The second tab in the facility configuration window is where you can define contractions. If you specify a contraction that already exists in the Contraction List, then it will be overridden with the contraction you insert.

Contractions are useful for tricking the voice synthesizer to pronounce words or acronyms the way you want. For example, by default RNAV is synthesized as "area navigation", but you can make vATIS pronounce it as "are-nav".



Miscellaneous Configuration

The third tab in the facility configuration window contains miscellaneous configuration options. These options are global to the active facility and are shared with each configuration profile within the facility.


  • METAR Observation Time

    Specify the normal METAR observation time. For example, if the METAR normal updates at 53 minutes past the hour, then type 53 in the box. If the number in the box does not match the METAR observation time minutes, then the word "special" will be appended after the observation time in the ATIS broadcast.

  • Magnetic Variation

    If specified, the wind in the ATIS broadcast will be adjusted according to the number of degrees (plus or minus) to accommodate magnetic variation. For example, if the wind in the METAR report reads 25015 and you enter -10 in the magnetic variation box, then the voice synthesizer will read the wind as "two four zero at one five".

  • Enable Voice Recorded ATIS

    If this option is checked, you will have the ability to manually record a voice ATIS. This option is useful if you want to use vATIS at a facility that does not use a digital ATIS in the real-world. This option is helpful if you are using a radar client that does not have a built-in ATIS maker (like vERAM or vSTARS).

    See the Voice Recorded ATIS section for more information.

Global Settings

These global settings are vATIS specific and will be applied to every facility and configuration profile.

  • Suppress ATIS Notification Dialog

    If this option is checked, the new ATIS notification dialog will not display when a new ATIS update is available. However, you will still receive the audible "ding" sound.

  • Minimize to System Tray

    If checked, when you minimize vATIS, it will minimize to your system taskbar tray instead of the taskbar. To restore vATIS, double-click the icon in the system tray.

Disconnecting from VATSIM

To disconnect vATIS from the VATSIM network, click the green Disconnect button at the bottom right of the vATIS main window. All text fields will be cleared and if there was an active ATIS being broadcasted, it will be disconnected, too.

Closing the entire vATIS application (without clicking the Disconnect button) will also properly disconnect you from the VATSIM network.

Voice Recorded ATIS

vATIS allows you to manually record an ATIS for siutations where the facility does not use a digitalized ATIS in the real world. Using vATIS for this would be especially beneficial if you are using a radar client that does not have a built-in ATIS maker (e.g. vERAM or vSTARS).

To manually record an ATIS you must first configure the facility to allow recorded ATISes. Open the facility configuration settings (see Facility Configuration for more information), go to the Configuration tab and check the Enable voice recorded ATIS option. Then save and close the configuration settings.

  1. Connect to the VATSIM network and choose an ATIS profile and ATIS code.
  2. Click the Record ATIS button and begin speaking the ATIS. Be sure to leave a few seconds of silence at the end of your ATIS recording so there is not overlap when the ATIS loops.
  3. Click the Record ATIS button to stop the recording process.
  4. Review your recording by clicking the Preview ATIS button. If necessary, you can re-record the ATIS by repeating step 2.
  5. When you are satisfied with your recording, click the Connect ATIS button to begin broadcasting your ATIS on the network.

You may toggle the Auto Update option to automatically notify you of a METAR change to prompt you to record a new ATIS.

Software Updates

Each time you launch vATIS, it will check if there is a newer version available. If there is, you will be prompted to download the update.

If you choose to download the update, vATIS will download the updated installer. When the download is complete, vATIS will close and the installer will open to begin the installation of the new version.

Text Parsing Rules

You can use the following text parsing rules in the Arrival/Departure/Other free text field and the Notams free text field

Taxiways

To parse taxiway names, append an asterisk (*), followed by the taxiway identifier. For example, *E16 would be read as "echo sixteen" by the voice synthesizer.

Numbers

To correctly pronounce numbers, append an asterisk (*) followed by the number. For example, *5058 would be read as "five thousand, fifty-eight" by the voice synthesizer. If the number should be pronounced as a negative value, append a dash after the asterisk. For example, *-8 would be read as "minus eight".

Frequencies

To correctly read frequencies, they must be typed in the full MHz format. Only frequencies 100.000 to 199.999 MHz will be parsed correctly. For example, 127.65 would be read as "one two seven point six five" by the voice synthesizer.

Airport Names

To parse airport identifiers to the airport name, append a plus sign (+) to the ICAO identifier. For example, +KLAX would be read as "Los Angeles International Airport" by the voice synthesizer.

Navaids

To parse navaid identifiers to their name, append a plus sign (+) to the navaid identifier. For example, +GBN would be read as "Gila Bend" by the voice synthesizer.

Contraction List

vATIS is preconfigured to translate and synthesize the following FAA contractions if used in the Arrival/Departure/Other free text field or the Notams free text field.

ACFT AIRCRAFT
ADVS ADVISE
ADVSD ADVISED
ADVZY ADVISORY
ADVZYS ADVISORIES
ALS APPROACH LIGHTING SYSTEM
ALT ALTITUDE
ALTS ALTITUDES
APCH APPROACH
APCHS APPROACHES
APP APPROACH
APPR APPROACH
APPRS APPROACHES
APPS APPROACHES
ARPT AIRPORT
ARR ARRIVAL
ARRS ARRIVALS
ATTN ATTENTION
AUTH AUTHORIZED
AVBL AVAILABLE
BA BRAKING ACTION
BAA BRAKING ACTION ADVISORIES
BC BACKCOURSE
BTWN BETWEEN
CAUT CAUTION
CLNC CLEARANCE
CLR CLEAR
CLRD CLEARED
CLSD CLOSED
CLSGN CALLSIGN
CMSN COMMISSION
CMSND COMMISSIONED
CTC CONTACT
CTL CONTROL
CTLD CONTROLLED
DCMSN DECOMMISSION
DCMSND DECOMMISSIONED
DEP DEPARTURE
DEPS DEPARTURES
DEPTG DEPARTING
DIST DISTANCE
DRCTN DIRECTION
DURG DURING
DURN DURATION
E EAST
EFCT EFFECT
EFF EFFECTIVE
ENE EAST NORTHEAST
EQPT EQUIPMENT
ERN EASTERN
ESE EAST SOUTHEAST
EXP EXPECT
EXPT EXPECT
FLT FLIGHT
FREQ FREQUENCY
FT FEET
GND GROUND
GS GLIDESLOPE
HAZ WX INFO HAZARDOUS WEATHER INFORMATION
HDG HEADING
HDGS HEADINGS
HELI HELICOPTER
HS HOLD SHORT
INBD INBOUND
INTXN INTERSECTION
INVOF IN VICINITY OF
LAHSO LAND AND HOLD SHORT OPERATIONS
LDG LANDING
LGT LIGHT
LGTD LIGHTED
LGTS LIGHTS
LLWS LOW LEVEL WIND SHEAR
LLZ LOCALIZER
LOC LOCALIZER
MOD MODERATE
MULTI MULTIPLE
N NORTH
NA NOT AUTHORIZED
NE NORTHEAST
NERN NORTHEASTERN
NNE NORTH NORTHEAST
NNW NORTH NORTHWEST
NOTAM NOTICE TO AIRMEN
NOTAMS NOTICES TO AIRMEN
NRN NORTHERN
NW NORTHWEST
NWRN NORTHWESTERN
OAT OUTSIDE AIR TEMPERATURE
OPER OPERATE
OPS OPERATIONS
OTS OUT OF SERVICE
OUBD OUTBOUND
PAPI PRECISION APPROACH PATH INDICATOR
PIREP PILOT WEATHER REPORT
PRM PRECISION RUNWAY MONITOR
PROC PROCEDURE
PROG PROGRESS
RMNG REMAINING
RMVL REMOVAL
RQST REQUEST
RQSTD REQUESTED
RWY RUNWAY
RWYS RUNWAYS
S SOUTH
SE SOUTHEAST
SERN SOUTHEASTERN
SFC SURFACE
SIMUL SIMULTANEOUS
SRN SOUTHERN
SSE SOUTH SOUTHEAST
SSW SOUTH SOUTHWEST
SVC SERVICE
SVCS SERVICES
SVR SEVERE
SW SOUTHWEST
SWRN SOUTHWESTERN
TFC TRAFFIC
TFR TEMPORARY FLIGHT RESTRICTION
TODA TAKE OFF DISTANCE AVAILABLE
TURB TURBULENCE
TWY TAXIWAY
TWYS TAXIWAYS
UFN UNTIL FURTHER NOTICE
UNCTLD UNCONTROLLED
UNUSBL UNUSABLE
US UNSERVICEABLE
USBL USABLE
VASI VISUAL APPROACH SLOPE INDICATOR
VCNTY VICINITY
VCTR VECTOR
VCTRS VECTORS
VFY VERIFY
VIS VISUAL
W WEST
WNW WEST NORTHWEST
WRN WESTERN
WSW WEST SOUTHWEST
XPDR TRANSPONDER
XPDRS TRANSPONDERS
XPNDR TRANSPONDER
XPNDRS TRANSPONDERS
XTM EXTREME

Getting Help

If you're having trouble configuring or using vATIS, please post your message in the vATIS Support Forum.