ITRA X-Plane Plugin FBControl
Einleitung
Durch das X-Plane Plugin SDK wird Zugriff auf Kommandos und DatenReferenzen zur Verfügung gestellt.
Durch die Entwicklung des Plugins ist es jetzt möglich mit dem Flightboard 2000 USB
Kommandos an den Flugsimulator X-Plane zu senden und Variablen zu setzen.
Das Plugin unterstützt nur die Windows-Version von X-Plane.
Das X-Plane Plugin kommuniziert über USB mit dem Flightboard. Die Ereignisse an der TastaturMatrix werden vom USB-Controller verarbeitet und entsprechend der Definitionen in der
Konfigurationsdatei werden Kommandos gesendet oder Werte von Variablen gesetzt.
Weitere Informationen finden Sie im Handbuch zum Flightboard 2000 USB.
System-Voraussetzungen
Für die Verwendung der ITRA X-Plane Plugin ist eine X-Plane-Version höher 9.0 notwendig. Es
müssen die aktuellen Treiber für die ITRA-Geräte installiert sein. Für die Verwendung der USBGeräte installieren Sie bitte vor dem Anschluss des Gerätes an den PC das ITRA-USBTreiberpaket.
Speicherort der ITRA X-Plane Plugins:
Das Plugin FBControl.xpl muss manuell aus dem ITRA-Installationsordner in den Plugin-Ordner des
X-Plane kopiert werden, dieses Verzeichnis \Ressources\plugins liegt unterhalb des X-PlaneInstallationsorders.
Speicherort der Konfigurations-Dateien der ITRA X-Plane Plugins
C:\Users\Benutzername\AppData\Roaming\ITRA\X-Plane-Plugins
// Win7
C:\Dokumente und Einstellungen\Benutzername\Anwendungsdaten\ITRA\X-Plane-Plugins // XP
Diese Ordner sind standardmäßig versteckt.
Die Konfigurationsdatei kann z.B. mit dem Editor (Programme -> Zubehör) angezeigt und bearbeitet
werden. Ein entsprechender Link zur Konfigurationsdatei wird bei der Installation im
Programmordner erzeugt.
Die Datei öffnen Sie mit Doppelklick oder über das Kontextmenü der rechten Maustaste.
Wir empfehlen die Benutzung der mitgelieferten Konfigurations-Programme.
Software-Installation
Achtung: Installieren Sie vor dem Anschließen des USB-Gerätes an den PC unbedingt
zuerst das USB-Treiber-Paket. Weitere Einzelheiten befinden sich in der Anleitung zur
Treiberinstallation.
Starten Sie das Setup für die Installation der Plugin-Software.
Nach der Bestätigung der Lizenzbestimmungen
erscheint die Komponenten-Auswahl.
In den nächsten Abfragen können Sie den
Zielordner der Installation und den Menü-Ordner
der Programm-Gruppe ändern. Mit "Fertigstellen"
ist die Client-Installation abgeschlossen.
X-Plane Plugin
In der Programmgruppe ITRA X-Plane-Plugins
befinden sich nach der Installation drei Hilfsprogramme
für das Erstellen und Bearbeiten der FBControlKonfigurationsdatei und Links zum Installationsordner
und zur Konfigurationsdatei.
Sie müssen das Plugin FBControl.xpl aus dem ITRA-Installationsordner in den PluginOrdner des X-Plane kopieren. Dieses Verzeichnis \Ressources\plugins liegt unterhalb des
X-Plane-Installationsorders.
2 DE
Nach dem Starten des X-Plane finden Sie im Menü Plugins einen Menüpunkt
ITRA-FBControl für das Plugin des USB-Controllers.
FBControl-Info zeigt Statusinformationen
wie die Version, den Pfad zur geladenen
Konfigurationsdatei und die
Lizenzinformationen
FBControl-Licence dient der Eingabe der
Lizenzinformationen. Ohne Lizenz ist das
Plugin für 10 Minuten im Demo-Mode.
Über den Plugin Admin kann das FBControl-Plugin deaktiviert und wieder aktiviert werden. Mit
dem erneuten Aktivieren wird auch die Konfigurationsdatei erneut eingelesen, man kann also
Änderungen an der Konfigurations-Datei vornehmen und im X-Plane damit übernehmen.
Deaktivieren Sie das Plugin mit dem Plugin Admin bei der gleichzeitigen Verwendung des
Plugins und der Verwendung der Konfigurationsprogramme, mit denen der Controller
abgefragt wird, da es ansonsten zu Konflikten in der USB-Kommunikation kommen kann.
Aufbau der Konfigurationsdatei
Mit der Konfigurationsdatei werden den Tastatur-Ereignissen des Flightboards Kommandos und
Daten-Referenzen zugewiesen. Die beiden Dateien Commands.txt und DataRefs.txt, in denen
die Zeichenketten für Kommandos und Daten-Referenzen beschrieben sind, befinden sich im XPlane-Unterordner \Ressources\Plugins. Die Zeichenketten werden bei der Definition der
Tasten verwendet. Es werden dort auch Angaben zum Datentyp gemacht, die wichtig beim
Zugriff auf die Daten-Referenzen sind.
Weitere Informationen können Sie auch über die X-Plane-SDK Web-Seite erhalten.
http://www.xsquawkbox.net/xpsdk/mediawiki/Main_Page
DE
3
Bei der Erstellung der Konfigurationsdatei ist darauf zu achten, dass die richtige Zugriffsart auf
die Daten-Referenzen gewählt wird. Hinter dem Referenzstring steht die Angabe zum Typ, ob die
Daten-Referenz änderbar ist und oftmals auch der Wertebereich wie z.B. bool für {0,1},
Aufzählungstyp enum {0,1,2,3} für definierte Zustände, float {-1..1} für Gleitkommawerte
zwischen -1 und 1.
int
float
int[x]
float[x]
Ganzzahl-Variable, auch für boolaen (0,1) verwendet
Gleitkomma-Variable
Integer-Array, es ist über einen Index der Zugriff auf ein Feld-Element möglich
Gleitkomma-Array, es ist über einen Index der Zugriff auf ein Feld-Element
möglich
Der standardmäßig verwendete Dateiname für die Konfigurationsdatei ist ITRA-FBControl.cfg.
Für das Flightboard gibt es die folgende Sektionen in der Konfigurationsdatei
[FB_KEYS]
Z0_S0
Z0_S0_COMMANDMODE
Z0_S0_ARG
Z0_S0_ARRAYINDEX
Z0_S0_REPEAT
Definition der Tastenzuordnungen
-> String-Definition entsprechend der Dateien im Plugin-Ordner
Commands.txt bzw. DataRefs.txt
-> {0 .. 4} Command, DataRef-Integer, DataRef-Float
DataRef-Array-Integer, DataRef-Array-Float
-> Argument für DataRef-Mode
Ganzzahl- bzw. Festkomma-Werte
-> Index des Wertes im DataRef-Feld
-> {0..10} Faktor zum Definieren der Repeatfunktion, 0=aus
1 entspricht ca. 50 ms
10 entspricht ca. 500ms
...
Z7_S15
Z7_S15_COMMANDMODE
Z7_S15_ARG
Z7_S15_ARRAYINDEX
Z7_S15_REPEAT
Mit dem Setup können Sie eine Beispiel-Konfiguration installieren.
4 DE
Programm zum Bearbeiten der Konfigurationsdatei
FBControl Key Command Editor
Mit dem Key Command Editor können der Tastatur-Matrix des USB-Controllers
Kommandos und Set-Befehle für Daten-Referenzen zugeordnet werden. Zu
jeder Taste kann zusätzlich eine Wiederholrate eingestellt werden.
Zuerst müssen alle Programme deaktiviert werden, die mit dem USB-Controller kommunizieren.
Sie können eine bereits bestehende
Konfiguration laden oder mit einer
leeren Matrix beginnen und diese dann
speichern.
Die Abfrage der Tasten erfolgt, indem
die entsprechende Taste gedrückt wird
und anschließend mit der Maus die
Schaltfläche
UCP-Taste lesen
geklickt wird. Es öffnet sich die
zugehörige Eingabe-Maske.
Sie können aber auch mit der Maus in der Matrix das gewünschte Feld doppelklicken, um die
Eingabemaske zu öffnen.
Es werden Zeile und Spalte angezeigt sowie bereits definierte Ereignisse. Bei einfachen
Kommandos sind keine weiteren Argumente notwendig, es kann eine Wiederholrate eingestellt
werden.
Für das Setzen von Integer- und
Gleitkomma-Variablen ist ein Wert,
auf den die Variable gesetzt
werden soll einzugeben. Wenn die
Variable in einem Datenfeld (Array)
ist, dann bestimmt der Index die
Stelle des zu ändernden Wertes.
Der Index beginnt üblicherweise mit 0, z.B. für die erste Maschine, das Bug-Rad usw. Das
Beispiel zeigt das Setzen des Gemisch-Hebels der 2. Maschine auf 50%
Für einige Kommandos existieren
nur Ein- und Aus-Kommandos.
Manchmal soll aber über eine
Taste ein Wechsel realisiert
werden. Wenn beim Argument
eines
Setz-Befehls
ein
X
eingetragen wird, so wird im Plugin
ein Wechsel zwischen 0 und 1
realisiert.
Der Standard-Abfragezyklus des Plugins beträgt 50ms.
Die Belegung der Matrix kann mit Druckvorschau auch als Liste angezeigt werden. Diese Liste
kann dann ausgedruckt werden.
DE
5
ITRA X-Plane Plugin FBControl
Introduction
The X-Plane Plugin SDK realizes the access to commands and data
references.
With the development of this plugin it is possible to set values and send commands to the XPlane flight simulator with the Flightboard 2000 USB.
The Plugin provides only the Windows version of X-Plane.
The X-Pane Plugin communicates over USB with the Flightboard USB-Controller. The events
from the keyboard matrix are processed by the USB controller and depending on the
configuration file are sent commands to the simulator or values are set.
Additional information you can get from the manuals of the Flightboard.
System requirements
For the usage of the ITRA X-Plane Plugins it is necessary to use a version above 9.0. You have
also to install the actual drivers for the ITRA devices. Please install first the ITRA USB Driver
Package before connecting the USB devices to the PC.
Installation folder of ITRA X-Plane Plugins:
It is necessary to copy the plugin FBControl.xpl from the ITRA installation folder to the plugin folder of
X-Plane. This is found in \Ressources\plugins
Location of configuration files of ITRA X-Plane Plugins
C:\Users\Benutzername\AppData\Roaming\ITRA\X-Plane-Plugins
C:\ Documents and Settings\username\AppData\ITRA\X-Plane-Plugins
These folders are hidden by default.
// Win7
// XP
You can modify the configuration file manually with an editor. A link to the configuration file is
created in the program folder by the setup.
You can open the file with double click or with the context menu of the right mouse button.
We recommend the usage of the supplied configuration programs.
6 EN
Software-Installation
Attention: Please install first the USB Driver Package before connecting the controller to
the PC. Additional information you will find in the installation instruction.
In order to install the software run the installation setup file.
You have to accept the license agreement.
You can select/deselect the parts of the installation
Then you can select the installation folder and the
menu group of the installation.
The installation will be finished.
X-Plane Plugin
After the installation in the program group ITRA – XPlane-Plugins there are found a link to the manual, a
program for creating or modifying the FBControl
configuration file and links to the installation folder and
the configuration file.
You have to copy the Plugin FBControl.xpl from the ITRA installation folder to the Plugin
folder of X-Plane. The folder \Ressources\plugins is located in the root folder of X-Plane
installation.
If X-Plane is running you will find in the menu Plugins for the Plugin a new menu entry.
EN
7
ITRA-FBControl for the Plugin of ITRA USB-Controllers
FBControl-Info shows status information like
version number, path to the configuration file
and licence information.
With FBControl-Licence you can put the
licence information to the plugin. Without a
licence the plugin runs 10 minutes in DemoMode.
With the Plugin-Admin the FBControl-Plugin may deactivated and again activated. With this the
configuration file is read again. So you can modify the configuration and activates these changes
in X-Plane.
Please deactivate the plugin with the Plugin Admin, if you are using the plugin and the
configuration programs that are requesting the controller at the same time, because this
may generate conflicts in the USB controller communication.
Structure of the configuration file
With the configuration file you can assign commands and data references to the keys of the
flightboard. The both files Commands.txt and DateRefs.txt are found in the folder
\Ressources\Plugins and describe the X-Plane commands and data references. The string
definition is used to define these keys. You can also see the definition of the data type. This is
important for accessing the data references.
Additional information you will find at the X-Plane SDK web page.
http://www.xsquawkbox.net/xpsdk/mediawiki/Main_Page
8 EN
It is important to use the right access mode to the data references if you create the configuration
file. Next to the reference string you find the type of the reference, if the value is writable and
sometimes the range of values, e.g. bool for {0,1}, enumeration enum {0,1,2,3} for defined
conditions, float {-1..1} for float values between -1 und 1.
int
float
int[x]
float[x]
Integer value, also for boolaen (0,1) used
Float value
Integer Array, with an index it is possible to select one integer array value
Float Array, with an index it is possible to select one flat array value
The default file name of the configuration file is ITRA-FBControl.cfg.
In the configuration file of the Plugin the following sections is defined:
[FB_KEYS]
Z0_S0
Z0_S0_COMMANDMODE
Z0_S0_ARG
Z0_S0_ARRAYINDEX
Z0_S0_REPEAT
Key definitions
-> The Command/DataRef strings are defined and described in the
Plugin files Commands.txt, DataRefs.txt
-> {0 .. 4} Command, DataRef-Integer, DataRef-Float
DataRef-Array-Integer, DataRef-Array-Float
-> Argument for DataRef-Mode, integer or float
-> Index of Value in DataRef Arrays
-> {0..10} factor that defines the repeat function, 0=off
1 complies to 50 ms
10 complies to 500ms
...
Z8_S15
Z8_S15_COMMANDMODE
Z8_S15_ARG
Z8_S15_ARRAYINDEX
Z8_S15_REPEAT
You can install an example configuration file.
EN
9
Program to modify the configuration file
FBControl Key Event Editor
With the Key Command Editor it is possible to define X-Plane commands and
X-Plane Set commands for data references to the keyboard matrix of the USBController. For every event a repeat rate is possible.
All programs that are communicating with the USB-Controller must be closed.
You
can
load
an
existing
configuration file or you can begin
with a clear matrix and save it at the
end.
Now a key of the controller matrix is
pressed and then you can request
this controller event with Read UCPKey. The associated input mask will
open.
The input mask opens also with a
double click in the matrix field.
Row and column are displayed and also already defined events. For simple commands are no
additional data necessary, you can select a repeat rate.
If you have to set integer and float
values you have to define this value,
if the value is in a data array you
must also define the position in the
array with the Array Index. The index
normally begins at 0, e.g. for the first
machine, the nose wheel, etc. The
example shows how to set the
mixture lever of the second machine to 50%.
For some commands are only On
and Off functions available. With an X
in the argument field of a set
command the plugin will realize a
toggle function between 0 and 1.
The default request time of the Plugin is 50ms.
You can show a list of the defined matrix with Print preview and then print this list.
10 EN
© Copyright 2024 ExpyDoc
