####################################################################
# #
# RCBpb-20.zip: A Pushback Gauge for FS20002 aircraft #
# #
# By Rob Barendregt 4 febr. 2003 #
# Release 2.0 #
####################################################################


PLEASE, READ THIS MANUAL CAREFULLY BEFORE INSTALLING & USING THIS GAUGE.

IF YOU USE VERSION 1.x OF THIS GAUGE, SEE "SECTION 10: HISTORY" FOR CHANGES



*******************************************************************
This gauge is dedicated to Bill Morad, who made it possible to play
sound files from XML gauges.
Unfortunately Bill died from heart problems on 23 dec. 2002, just
hours after he finished his work on the included robsound.gau file.
*******************************************************************


1. Introduction
===============
Do you recognise this ??
- I push Shift-P to start Pushback, press 1 or 2 for a Left c.q. Right
turn, but the aircraft doesn't make the turn ....
- I want to see the Pushback from SpotPlane View mode ....
- I want to Pushback my aircraft from the gate onto the taxiway,
but I don't know when to start the Left or Right Turn ....

This gauge will solve these problems !!
And adds some nice conversation sounds and click sound too ...

Some background first.

I like to fly the big jets, starting my flights from their position
at the Gate.
Based on the procedure used in the original, well-known Pushback gauge
by the FPDA group, the excellent XML introduction document of Arne Bartels,
and numerous XML gauge examples of standard FS2002 XML gauges, I decided
to make my own Pushback gauge, written in XML.

The advantages of this gauge:
- The Pushback sequence can be performed automatically, by setting the
time it should be pushed straight back, plus the desired turn value.
(0 - 90 degrees, in steps of 15 degrees, Left or Right)
- It uses the standard FS2002 Pushback mechanisme, so you can hear the
engine/environment sounds during Pushback.
- During Pushback, you can change the views or even PAUSE the system
without disturbing the Pushback.
- To support Pushback operation, the cockpit-ground conversation is
made audible.

The gauge can be installed in any panel, as an overlay window activated
by an (included) window toggle icon in your main panel window.
However, in the following cases the Pushback conversation sounds cannot
be used and must be disabled:
- For aircraft using engine(s) with Magnetos (usually small props, like a
Cessna 172).
- If your panel uses the XMLsoundV2.gau file.
See also Section 6.

2. Installation
===============
1. Install all files to the proper FS2002 folders, by extracting all
files in this archive to your main \FS2002 folder with Winzip's
option "use folder names" enabled.
The result will be that:
- File robsound.gau goes to folder ....\FS2002\GAUGES
- File FSsound.dll goes to folder .....\FS2002\MODULES
NOTE: this is version 1.5.1 of FSsound; to my knowledge the latest
version of FSsound at this moment.
- All .xml and .bmp files go to folder ....\FS2002\GAUGES\RCB-GAUGES
- All .wav files go to folder ....\FS2002\SOUND

2. Add the Pushback gauge to the panel of your aircraft(s).

Placing the gauge in your panel is done by adding some lines to the panel.cfg
file of your aircraft, located in the ...\FS2002\AIRCRAFT\"your aircraft"\PANEL
folder. The simplest way of doing that is by using Notepad.
*** MAKE A BACKUP OF YOUR panel.cfg FIRST ***

- In the [Window Titles] section, add the line:

Window**=Pushback panel

where '**' is the next free number.
For the default FS2002 Boeing 747_400 ONLY !!: '**' is 06


- In the [Window00] section, add the line:

gauge**=rcb-gauges!Icon_Pushback, aaa,bbb,12,12

where '**' is the next free number, 'aaa'and 'bbb' are the coordinates
for the Pushback Icon on your panel and 12,12 is the size in pixels.
See also Section 6: Gauge positioning.

For the default FS2002 Boeing 747_400 ONLY !!:
gauge58=rcb-gauges!Icon_Pushback, 128,111,12,12

- After the last [Window..] section, add the lines (use copy/paste):

[Window**]
size_mm=86,64
ident=10005 // The ident used by Icon_Pushback
visible=0 // 0: hidden when aircraft is loaded
position=1 // 1: opens in top-center of screen
gauge00=rcb-gauges!PushbackStates, 0,0,1 // Pushback State gauge
gauge01=rcb-gauges!PushbackDisplay, 0,0,86,64 // Pushback Displaygauge
gauge02=RobSound!Rob-Sound, 0,0,1 // Plays Pushback conversation sounds
//gauge02=rcb-gauges!PushbackSoundOff, 0,0 // Disables Pushback conversation sounds

where '**' is the same number you used in the [Window Titles]

You can open the Pushback window by clicking the Pushback
Icon (the DownArrow) in your main panel window.


3. Pushback timer/counters, buttons and phases
==============================================
The gauge consists of 6 clickable areas (see also their Tooltips):
- A button, to activate Pushback.
This button has an indicator light, giving the phase of pushback:
- RED: Pushback cannot be activated; set your Parking Brakes first.
- OFF: Click button to activate Pushback procedure.
- Flashing GREEN: Waiting for release of the Parking Brakes,
which starts the Pushback.
- GREEN: Pushing back.
- Flashing YELLOW: Pushback finished, set your Parking Brakes.
- YELLOW: Pushback procedure terminating (lasts about 8 seconds)
- A StraightBack Timer.
This countdown Timer (0 - 99 seconds , the middle two digits) is started
when you release the Parking Brakes and determines how long the aircraft
is pushed straight back before the turn sequence starts.
Click to increment or decrement the value.
- A LeftTurn Counter.
This counter (0 - 90 degrees, the left two digits) determines the angle
of the LeftTurn that you want the aircraft to make.
Click to increment or decrement the value.
So, after Pushback, the new heading of the aircraft equals the original
heading PLUS the value you dialled into this LeftTurn Counter.
- A RightTurn Counter.
Same as the LeftTurn Timer, but in opposite direction.
- A LeftTurn arrow.
Sets the LeftTurn Counter directly to 90 degrees (saves 90 mouse clicks :-),
since the is probably the most used turn angle.
After this, you can adjust the angle again by decrementing the LeftTurn Counter.
- A RightTurn arrow.
See LeftTurn arrow.

A few notes:
1. When Pushback is active (GREEN light), you cannot change the Timer/Counter
values anymore.
2. Obviously, the LeftTurn and RightTurn Counters are mutually exclusive.
If you change one, the other is set to 0.
3. When Pushback is active (GREEN light), you can terminate the Pushback
at anytime by setting the Parking Brakes.
4. After setting up the Timer/Counters, and activating the Pushback by clicking
the button, you can change the view mode at any time.
E.g.: Go to SpotPlane view, release the Parking Brakes and observe
the full Pushback in this view. The Pushback conversation will even be
audible in SpotPlane view mode.
You can even PAUSE FS2002 during the Pushback session.
5. After the StraightBack Timer becomes 0 (so before it makes the actual turn),
the aircraft goes straight back another full length.
This "full length" period depends on the aircraft:
- For a Cessna 172: 4 seconds.
- For a Boeing 747-400: 19 seconds.
6. You can use Pushback either with Engines off, or with engines running.
You can also start your engines during pushback operation.
7. When the Pushback is running and the StraightBack Timer becomes 0, you
can dial in another value in this timer. This causes the aircraft to be
pushed straight back (for the specified time) when the turn is completed.

So, by setting the correct values for StraightBack Timer and Left/RightTurn
Counter, you specify:
- When the aircraft starts to turn.
- How many degrees the aircraft turns, either Left or Right.
- How long the aircraft is pushed back after the turn.


4. Pushback Operation and Ground-Cockpit conversation
=====================================================
- Set the Parking Brakes.
The RED light goes off.
NOTE: the default FS2002 key for Set/Release Parking Brakes is . (PERIOD)
- Set the Center Timer and/or the Left/RightTurn Counter.
- Activate the Pushback procedure by clicking the Pushback button.
The GREEN light starts flashing.

Cockpit: "Ground from cockpit"
Ground: "Go ahead"
Cockpit: "Ready for pushback"
Ground: "OK. Steering pin inserted, release brakes"

- The gauge now waits untill you release the Parking Brakes.

Cockpit: "Brakes are released"
Ground (if engine1 is running): "OK. Pushing back"
Ground (if engine1 NOT running: "OK. Pushing back. All engines cleared for startup"

The following Pushback sequence is performed:
- The light goes solid GREEN.
- If the StraightBack Timer was set, it counts down to 0 while the
aircraft is pushed straight back.
- If the LeftTurn or RightTurn Counter was set, the aircraft is pushed
straight back ANOTHER FULL LENGTH, and then turns the angle dialled
into the Counter.
During the turn the Counter indicates the remaining turn angle, and
therefore counts down to 0.
- After the turn is completed, the aircraft is pushed straight back again
for the new time you dialled into the StraightBack Timer (default: 1 second).

Ground: "Set parking brakes"

- The YELLOW light start flashing.
The gauge waits untill you set the Parking Brakes.

- The light goes solid YELLOW, for about 8 seconds.

Cockpit: "Parking brakes are set. Prepare aircraft for taxi and give
handsignal on left side"
Ground: "OK. Towing system removed. Wait for handsignal on left-hand side"

- Now the pushback is terminated, and the light goes off.


5. Frequently Asked Questions
=============================

Q1: I click the Pushback button, but nothing happens.
A1: Are the Parking Brakes set ? (the RED light must be off)

Q2: After I release the Parking Brakes, Pushback starts but immediately stops
and the light starts flashing YELLOW.
A2: You didn't set the StraightBack Timer and/or Left/RightTurn Counter, so
the Pushback is immediately finished :-)

Q3: Can I still use the FS2002 keys (SHift-P, 1, 2) for Pushback ?
A3: Yes. But why should you :-)
As long as you don't use them simultaneously with gauge operation,
because they obviously interfere.

Q4: Can I add the Pushback gauge directly in my main panel ?
A4: Yes you can, but I wouldn't advise it; unless you disable the Pushback
conversation sounds.
Reason: when the panel loads, the robsound.gau file is loaded and
immediately monitors the FS2002 MAGNETO controls. Now, upon initial
load of FS2002, or when you load an aircraft with this Pushback gauge
after using an aircraft with MAGNETOs, the MAGNETOs are probably on,
so all the Pushback conversation sounds are played together.
I solved this by resetting all MAGNETO controls when the Pushback Icon
is clicked.

Q5: When I open the Pushback window via menu View-Instrument panel-Pushback
all the Pushbacks sounds are suddenly played.
A5: Use the Pushback Icon to activate the Pushback panel. See also A4.

Q6: I have other problems with the Pushback conversation sounds.
A6: Disable the Pushback conversation sounds. See Section 7.

Q7: Why doesn't the aircraft immediately starts to turn after the StraigtBack
Timer becomes 0 ? This would make the timing easier...
A7: This gauge uses the standard FS2K2 pushback function. Unfortunately the
"go straight back another full length before turning" is part of this function
and can not be avoided in any way I know of (because FS2K2 only supports
a single "TOGGLE_PUSHBACK" function).
If anybody should know a way to get around this, please inform me ....

Q8: I installed the Pushback Icon (The DownArrow) in my panel.cfg, but the Icon
is not visible after I load the aircraft.
A8: Make sure the coordinates 'aaa' and 'bbb' specify a visible place on the
main panel, i.e. on the main panel bitmap, but not covered by another gauge.
See also Section 6: Gauge positioning.


6. Gauge positioning.
=====================
The Main panel usually consists of a bitmap (a .bmp file) on which the gauges
are positioned through coordinates.
Like: gauge**=rcb-gauges!Icon_Pushback, aaa,bbb,12,12 ,
where 'aaa' is the horizontal, and 'bbb' the vertical positon on the main panel.
The bitmap is a file xxxxx.bmp in the same folder as panel.cfg, and is referenced
in the panel.cfg by something like:

[Window00]
File=xxxxx.bmp

The coordinates 'aaa','bbb' are relative to this panel bitmap, and specify the top-left
corner of the gauge. Coordinates 0,0 indicate the top-left position of the panel.

Most main panel bitmaps cover the entire screen, but some (like the default 747)
only cover the lower part of the screen.
Moreover, the coordinates (and gauge size) also depend on the bitmap resolution.
So, in a 1024*768 pixel bitmap, coordinates 1024,768 specify the bottom-right
corner of the panel.
With this info, look at the coordinates of existing gauges in the [Window00] section
of the panel.cfg file. E.g. a PFD, MFD or Gear switch, and check whether their
coordinates corresponds with the postition you would expect on the panel.

To get the correct coordinates for the Pushback Icon:
- Observe the main panel in FS2K2, and find a free spot.
- Look for a gauge nearby, find this gauge in the panel.cfg file, and use nearby
coordinates for the Pushback Icon.
Remember:
- 'aaa','bbb' specifies the top-left corner of the Pushback Icon.
- Increasing 'aaa' will shift the Icon to the right.
- Increasing 'bbb' will shift the Icon downwards.
- 12,12 (in my example) defines the size of the Icon in pixels, so using 24,24
makes it twice as large.
- Make sure the Icon does not overlap with an existing gauge.

Note: after you edit and save the panel.cfg file, in FS2K2 you must select an
aircraft will another panel and then back again, to ensure that the new panel.cfg
is loaded !


7. Problems with the Pushback conversation sounds
=================================================

If you have problems with the pushback conversation sounds, you can disable
them by changing some lines in the Pushback window in the panel.cfg file:
- Add // before gauge02=RobSound.................
AND
- Remove the // before gauge02=rcb-gauges..........

The Pushback gauge itself will still work.

Some technical background info:
Unfortunately MS doesn't support sounds to be initiated from an XML gauge
like this Pushback gauge.
Bill Morad made a workaround for this problem, based on the monitoring of
(usually) unused FS2002 variables: the variable is "set" by the Pushback gauge,
and is monitored by the Sound gauge. When the variable is "set", the Sound
gauge plays the releated rcb?.wav file for that variable, and resets it.

There exists three versions of this Sound gauge:
- robsound.gau. Designed for and used my o.a. Pushback gauge.
Uses the MAGNETOx controls.
- XMLsound.gau. Uses the TOGGLE_AFTERBURNER controls.
- XMLsoundV2.gau. Uses the MAGNETOx controls and TOGGLE_AFTERBURNER controls.

So, if you have XMLsoundV2.gau in your panel (e.g. in Nick Pike's C4-SST) you
cannot use robsound.gau or XMLsound.gau in that panel.
This would give strange effects, like a sound constantly repeating or two sounds
being played after clicking a gauge.
NOTE: robsound.gau and XMLsound.gau DO NOT conflict.


8. Copyrights and Disclaimer
============================
This gauge is freeware, and is available for your personal use.
It may NOT be sold, re-distributed, or (re-)uploaded to another website
(in ANY shape or form) without my explicite, written permission.

If you want to bundle this gauge with your (freeware !!) panel, you
may do so AFTER my written permission, provided you include this
README file AS-IS, without modification.

IMPORTANT!!: The included file ROBSOUND.GAU was specifically written
for my XML gauges, and may NOT BE REUSED by other XML gauges if you
intend to make those publically available (to prevent the problems
mentioned in Section 6)

And obviously, installing & using this Pushback gauge at your own risk !!


9. Credits
==========
- Arne Bartels, for his great introduction on how-to-make XML gauges.
Without that, I wouldn't have even known where to start ....
- Ron Beal, for his re-recorded Pushback conversation sounds.
- The FPDA group, for their original implementation of the pushback
gauge. The pushback procedure I use is an almost exact copy.
- Daniel Steiner, for his FSsound module.
- Microsoft, for their numerous "example" XML gauges :-)
- All those simmers that sent me a ThankYou note after installing V1 of
this gauge, which inspired me to develop & publish this new version.
- And a special thanks to Bill Morad for his robsound.gau gauge, which
he made for me in (what appeared to be) the last days of his life.


10. History
==========
Rel. 1.0: Initial release

Rel. 1.1: Fixed the "Set Parking Brakes" problem.
Problem: If you have the "Brakes" message disabled in your fs2002.cfg (line show_brake_message=0), the gauge doesn't detect when you set the parking brakes.
Solution: replaced event BRAKE PARKING INDICATION by BRAKE PARKING POSITION.

Rel. 2.0:
- Replaced the Turn "Timers" by Turn heading "Counters".
- Added a click sound when clicking buttons or dials.
- Added clickable pushback arrows in the bitmaps.
- Added extensive description on how-to add the Pushback Icon in the main panel.
As suggested by Simon Binder (Thanks Simon !), you can now set the turn angle
(in degrees, relative to the current heading). When the turn is completed,
the pushback is stopped automatically.
If you want the pushback to continue after the turn, you can dial in a new
interval time in the StraightBack Timer when the aircraft is making the turn.

If you have rel. 1.x already installed:
- Just unzip all files as for initial installation, and click "YES" when
asked to overwrite existing files.
- **IMPORTANT**: update two lines in your panel.cfg file:
gauge00=rcb-gauges!PushbackStates, 0,0,1
gauge02=RobSound!Rob-Sound, 0,0,1
(the gauges must have size 1, so 0,0 should become 0,0,1)


I hope you enjoy using this gauge.
And I'm always open to questions, or suggestions for improvement.
(no guarantee that I will make them though).
But PLEASE, before asking me questions, make sure that the answer can not
be found in this Readme file.

Rob Barendregt, The Netherlands
Email: rc.barendregt@planet.nl

**************************************