Blackbox

Just like in real world the Blackbox records different events during the flight to add more details to the flight report. These events include for example when the gear or flaps got retracted. Which events are recorded depends on a configuration file which can be adapted to everybody's needs. This way for example an airline can create one file and give it to all of it's pilots so they all have the same settings.

Configuration

The configuration of the Blackbox is saved in the blackbox.xml file which resides in the Client data folder. This xml file can be freely edited using the following commands.

General structure

The blackbox.xml basically only consists of a couple of event tags which are encapsulated in the blackbox tag. Each of these event tags consists of several attributes describing the event which should be recorded. The following example is the standard blackbox.xml coming with every Client release:

<blackbox>
  <event var="landinglights" value="1" method="equals" multiple="1" text="Landing Lights on" />
  <event var="landinglights" value="0" method="equals" multiple="1" text="Landing Lights off" />
  <event var="gear" value="1" method="equals" multiple="1" text="Gear down" />
  <event var="gear" value="0" method="equals" multiple="1" text="Gear up" />
  <event var="flaps" value="1" method="equals" multiple="1" text="Flaps 100%" />
  <event var="flaps" value="0.5" method="equals" multiple="1" text="Flaps 50%" />
  <event var="flaps" value="0" method="equals" multiple="1" text="Flaps retracted" />
</blackbox>

How to tell the Client when to activate an event

As you can see in the example above each event tag consists of several attributes defining when to activate the event. Let's take the first line as an example:

<event var="landinglights" value="1" method="equals" multiple="1" text="Landing Lights on" />

First of all there is var, defining which Flight Simulator variable is tested. In this case the value is landinglights which means that the Client checks the landing lights status. The next attribute is value. The value of this attribute is the reference for the Client. Together with the method attribute the Client can then test the current status of the variable to see if the event has to be activated. So, the first three attributes can be read as: "If the status of the landing lights equals 1, then activate the event".

There are additional attributes for more control over the event activation. These are multiple and flightstate. If multiple is set to 1, then the event can be activated several times. So in this case each time the landing lights are turned on, the event gets executed. Setting this value to 0 would only allow this event to be activated once. The flightstate attribute restricts the event activation to a single flightstate. So if you only want the event to be activated during take off you could set this to takeoff.

How to tell the Client what to do when the event is activated

The final step is to tell the Client what happens when the event is executed. There are two possibilities: Text output to the log or immediate sound output. If you add the text attribute, this text will be shown in the log on the website.

If you add a sound attribute as well, the defined sound will be immediately played when the event is activated. The Client can play any .wav file which is located in the Client's sound directory. So if you want to publish a blackbox.xml to your pilots don't forget to send them the required sound files. Let's give a little example here: Say you want to play a sound file called 10000.wav which should be played when the airplane climbs above 10,000ft. First you create a folder for all your personal sound files inside your Client sound directory. We call it my_va. The Client sound folder looks like this then:

sounds/my_va/10000.wav

In the blackbox.xml we have to tell the Client to play this sound when the aircraft climbs above 10,000ft the first time.

<event var="altitude" value="10000" method="greater" multiple="0" sound="my_va/10000.wav" />

Overview

This section contains two tables giving you a quick overview over all the variables and options you can add to your own blackbox.xml.

attribute	possible values	standard value
var	altitudeagl altitudestd flaps gear ias landinglights vs	ias
value	depends on variable (see table below)	0
method	less equal greater	equal
multiple	0 1	0
flightstate	boarding taxi takeoff climb cruise descent landed	undefined
text	any text up to 255 characters	undefined
sound	relative path from Client sound directory to .wav file	undefined

Variable	Values	Description
landinglights	0 or 1	Status of the landing lights. 1 = on, 0 = off.
gear	0 or 1	Status of the gear. 1 = down, 0 = up.
flaps	0.0 - 1.0	Status of the flaps. 0 = fully retracted, 1 = fully extended.
ias	0 - 9999	Indicated airspeed (knots).
vs	-9999 - 9999	Vertical speed (fpm).
altitudestd	0 - 999999	Altitude above 1013.25hP (Standard atmosphere).
altitudeagl	0 - 999999	Altitude above ground level.