Skip to content

Commit aae151e

Browse files
ValastiriValastiri
committed
refactor: update and new dir for hoppie docs
1 parent a17adfc commit aae151e

File tree

10 files changed

+308
-6
lines changed

10 files changed

+308
-6
lines changed

‎docs/fbw-a32nx/feature-guides/.pages

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ nav:
33
- Custom AP: autopilot-fbw.md
44
- Custom FMS: cFMS.md
55
- Custom Hydraulics: custom-hydraulics.md
6+
- Hoppie ACARS (CPDLC): hoppie
67
- ...
78
- flyPadOS 2 EFB: flypados2
89
- flyPadOS 3 EFB: flypados3

‎docs/fbw-a32nx/feature-guides/flypados2/online-atc.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,4 @@ Go back to the ATC page and see the list of the currently available ATC stations
3636

3737
### Using Hoppie ACARS
3838

39-
See documentation for [Hoppie ACARS](../hoppie.md)
39+
See documentation for [Hoppie ACARS](../hoppie/index.md)

‎docs/fbw-a32nx/feature-guides/flypados2/settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -211,7 +211,7 @@ Settings for integrations with various data and information sources.
211211
- See [next chapter](#simbrief-integration).
212212
- Hoppie User ID:
213213
- Unique logon code that is used to identify the user for the Hoppie ACARS communication.
214-
- See [Create a logon code](../hoppie.md#create-a-logon-code) in our documentation for Hoppie ACARS.
214+
- See [Create a logon code](../hoppie/index.md#create-a-logon-code) in our documentation for Hoppie ACARS.
215215

216216
### simBrief Integration
217217

‎docs/fbw-a32nx/feature-guides/flypados3/settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@ Settings for integrations with various data and information sources.
243243
- See [next chapter](#simbrief-integration)
244244
- Hoppie User ID:
245245
- Unique logon code that is used to identify the user for the Hoppie ACARS communication.
246-
- See [Create a logon code](../hoppie.md#create-a-logon-code) in our documentation for Hoppie ACARS.
246+
- See [Create a logon code](../hoppie/index.md#create-a-logon-code) in our documentation for Hoppie ACARS.
247247

248248
### SimBrief Integration
249249

‎docs/fbw-a32nx/feature-guides/hoppie/.pages

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
nav:
2+
- Overview: index.md
3+
- ...

‎docs/fbw-a32nx/feature-guides/hoppie/example-flight.md

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
# Example Flight
2+
3+
This chapter shows an example how a normal flight on VATSIM is handled with PDC and CPDLC.
4+
5+
{==
6+
7+
It is important to call the controller on an initial call per voice and monitor the frequency after a CPDLC logon.
8+
9+
==}
10+
11+
The CPDLC system is only a convenience to relax the voice frequency. Time critical instructions will be given via voice.
12+
13+
## Departure Clearance
14+
15+
After preparation of the aircraft an IFR clearance is required which can be requested via DCL (Departure Clearance).
16+
17+
The request page can be found in the MCDU ATC COMM menu page 2:
18+
19+
!!! note "MCDU ATC COMM Menu"
20+
!!! block ""
21+
![atc-menu-p1](../../assets/feature-guides/hoppie/atc-menu-p1.png){align=center width=48% loading=lazy}
22+
![atc-menu-p2](../../assets/feature-guides/hoppie/atc-menu-p2-dcl.png){align=center width=48% loading=lazy}
23+
24+
The DEPART REQ page requires the current ATC station code and the current ATIS. Providing a gate and freetext is optional.
25+
26+
!!! note "Departure Request"
27+
!!! block ""
28+
![DEPART REQ](../../assets/feature-guides/hoppie/mcdu-dcl.png "DCL"){align=center width=48% loading=lazy}
29+
![DEPART REQ Filled](../../assets/feature-guides/hoppie/mcdu-dlc-filled.png "DCL"){align=center width=48% loading=lazy}
30+
31+
The `ATC FLT NBR` and `FROM/TO` is taken from the INIT A page. So it is important that the INIT A page is set up before requesting the IFR clearance.
32+
33+
Freetext can and should be used to provide additional information to the controller. E.g. the inability for specific SIDs or the request of a dedicated SID.
34+
35+
Press `REQ DISPL` to transfer the request to the DCDU.
36+
37+
You can then check the message in the DCDU and send it by pressing the button next to `SEND*`
38+
39+
!!! note "DCDU Departure Request"
40+
!!! block ""
41+
![dcdu-dcl-before-send](../../assets/feature-guides/hoppie/dcdu-dcl-before-send.png){align=center width=48% loading=lazy}
42+
![dcdu-dcl-after-send](../../assets/feature-guides/hoppie/dcdu-dcl-after-send.png){align=center width=48% loading=lazy}
43+
44+
The controller sends the clearance with all relevant information.
45+
This information includes usually the departure runway, the SID, the assigned squawk code and a startup time.
46+
47+
!!! note "Received Clearance"
48+
!!! block ""
49+
![Received clearance](../../assets/feature-guides/hoppie/dcdu-clearance.png "Clearance"){align=center width=48% loading=lazy}
50+
![Received clearance](../../assets/feature-guides/hoppie/dcdu-clearance-p2.png "Clearance"){align=center width=48% loading=lazy}
51+
52+
It is required to confirm or deny a clearance. A denied clearance requires a voice communication with the delivery controller.
53+
54+
!!! note "Confirmed Clearance"
55+
![Confirmed clearance](../../assets/feature-guides/hoppie/dcdu-clearance-wilco.png "Confirmed clearance"){loading=lazy}
56+
57+
## Enroute CPDLC
58+
59+
Usually it is only possible to use CPDLC on ATC CTR (Center or Radar stations) or for clearance (DEL) stations.
60+
61+
It is not provided on ground (TWR, GND), approach (APP) or departure (DEP) stations. Due to the long delays in the communication via CPDLC this type of communication would be too slow for these stations.
62+
63+
### Station Handover / Notification
64+
65+
If the responsible ATC sector provides CPDLC a Notification is required. This Notification requests a logon at the defined ATC station.
66+
67+
{==
68+
69+
Before a Notification request is sent a check-in via voice mandatory, otherwise will the request be rejected.
70+
71+
==}
72+
73+
!!! note "Notifying fictional station FBWA"
74+
![Notification](../../assets/feature-guides/hoppie/mcdu-notif.png "Notification"){loading=lazy}
75+
76+
A logon can fail due to several reasons. One is that the controller does not provide CPDLC and the request times out after five minutes.
77+
An other reason can be that the request is rejected by ATC. A failed notification is indicated via a "NOTIF FAILED"
78+
79+
!!! note "Failed notification to fictional station FBWA"
80+
![Failed notification](../../assets/feature-guides/hoppie/mcdu-notif-failed.png "Failed notification"){loading=lazy}
81+
82+
To understand the reason for the failed notification check the the message record.
83+
84+
!!! note "Message record of failed notification to fictional station FBWA"
85+
![MSG RECORD](../../assets/feature-guides/hoppie/mcdu-msglog.png "MSG RECORD"){loading=lazy}
86+
87+
After a successful logon a "CURRENT ATC" message is shown on the DCDU which indicates the responsible ATC station.
88+
89+
!!! note "Successful connection to fictional station FBWA"
90+
![Logged on to ATC](../../assets/feature-guides/hoppie/dcdu-current-atc.png "Logged on to ATC"){loading=lazy}
91+
92+
### Enroute Instructions from Controller to Pilot
93+
94+
The ATC controller can send instructions to the pilot at any time. Most of the instructions or requests require an answer from the pilot via the buttons on the DCDU.
95+
96+
Find some examples below.
97+
98+
#### Climb Instruction
99+
100+
!!! note "Climb instruction"
101+
![Climb instruction](../../assets/feature-guides/hoppie/dcdu-climb.png "Climb instruction"){loading=lazy}
102+
103+
Possible responses usually are `WILCO` ("will comply"), `STDBY` ("standby") or `UNABLE` ("unable to comply").
104+
105+
If you select STBY the message will be marked with `STDBY` and you can respond with `WILCO` or `UNABLE` after we have checked our ability to comply.
106+
107+
![Standby Response](../../assets/feature-guides/hoppie/stdby.png "Standby Response"){loading=lazy}
108+
109+
#### Frequency Change
110+
111+
A frequency change can be given via CPDLC. This message contains the next station and the frequency. It is required to set the frequency in the radio and to confirm the message.
112+
113+
!!! note "Instruction to contact ATC station via voice"
114+
![Contact next station](../../assets/feature-guides/hoppie/dcdu-contact.png "Contact next station"){loading=lazy}
115+
116+
If the next ATC station provides CPDLC we can notify this next station which would log us off the current station when accepted. See [Station Handover / Notification](#station-handover-notification).
117+
118+
## Logoff From Station
119+
120+
You can logoff from the current station if the next station does not provide CPDLC.
121+
122+
![Logoff / Disconnect](../../assets/feature-guides/hoppie/dcdu-logoff.png "Logoff / Disconnect"){loading=lazy}

‎docs/fbw-a32nx/feature-guides/hoppie/index.md

Lines changed: 176 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
# Hoppie ACARS
2+
3+
!!! warning "Requires credentials with Hoppie service"
4+
5+
??? warning "Development in Progress (Click to Open)"
6+
The Hoppie ACARS system is a complex system and we have decided to develop and release it step-by-step. So please be aware that not all features are available in the early releases and that we will add additional functionality over time.
7+
8+
!!! danger ""
9+
This page will be current for Stable version 0.8.0. Any changes to our development branch will be noted with the appropriate flag or indicator. Please be aware of any
10+
differences when using our CPDLC implementation.
11+
12+
The current version has the following features:
13+
14+
- Logon/Logoff
15+
- Handover
16+
- Station identifier
17+
- Controller to pilot: All Instructions
18+
- Automatic D-ATIS
19+
- Departure Clearance (DCL)
20+
- Oceanic Clearance (OCL)
21+
- Realistic datalink communication simulation (VHF+VDL3)
22+
- Pilot requests: Vert & Lat requests, Text
23+
24+
The currently planned future releases are adding these features:
25+
26+
- Datalink Status
27+
- Other pilot requests: E.g. "When can we expect..."
28+
- Emergency
29+
- Controller report-requests and automatic preparation of pilot replies
30+
- FPL changes for Lat requests
31+
- Flight Monitoring for conditional reports
32+
33+
This plan might change at any time.
34+
35+
## Hoppie System
36+
37+
The Hoppie system is developed by Jeroen "Hoppie" Hoppenbrouwers which provides text-based communication between aircraft, virtual airlines and virtual ATC stations. It provides multiple communication protocols to communicate between different stations. The system is used by controllers on VATSIM and IVAO.
38+
39+
[Hoppie Homepage](http://www.hoppie.nl/pub/){target=new}
40+
41+
The A32NX implements the TELEX and CPDLC communication between ATC stations and the aircraft.
42+
43+
!!! note "[CPDLC](https://skybrary.aero/articles/controller-pilot-data-link-communications-cpdlc){target=new} stands for Controller Pilot Data Link Communication."
44+
45+
It allows communication between ATC stations and the aircraft without the use of voice, but it is still required that the pilot monitors the voice frequency.
46+
47+
CPDLC is used to send requests to the ATC station or from the ATC station requesting flight information or issuing instructions to the pilot.
48+
49+
Additionally PDC (Pre-Departure Clearance, also DCL) is used to request an IFR-clearance from ATC via text.
50+
51+
The A32NX MCDU and DCDU provide the interface for communication to and from the Hoppie system to communicate with the ATC stations.
52+
53+
!!! warning "CPDLC Availability"
54+
Unfortunately not all controllers provide the CPDLC option. See [Find online stations](#find-online-stations).
55+
56+
Also the Hoppie network is unfortunately not always reliable. Repeat your request via voice when in doubt. See [Troubleshooting](#troubleshooting).
57+
58+
### Create a logon code
59+
60+
Every pilot needs a unique logon code that is used to identify the communication. This code needs to be requested on the website of Hoppie: [Logon request](http://www.hoppie.nl/acars/system/register.html){target=new}
61+
62+
The resulting code needs to be stored and hidden from other users.
63+
64+
It is suggested to define if the logon code is used on VATSIM or IVAO. The default configuration assumes a connection to the VATSIM network.
65+
The configuration can be set [here](http://www.hoppie.nl/acars/system/account.html){target=new}
66+
67+
The logon code will be deleted after three months without any logon. A single logon renews the lifetime of the code.
68+
69+
## Configuration of the A32NX
70+
71+
It is required to configure the A32NX to use the Hoppie system. All configuration entries are set in the Settings-pages of the EFB.
72+
73+
### ATSU/AOC
74+
75+
The Hoppie logon code needs to be set in the [EFB Settings ATSU/AOC](../flypados3/settings.md#atsuaoc) page.
76+
77+
![ATSU/AOC](../../assets/feature-guides/hoppie/efb-settings-atsu-aoc-page.png "ATSU/AOC page"){loading=lazy}
78+
79+
The logon code needs to be set in "Hoppie User ID".
80+
81+
### Turning on Hoppie ACARS
82+
83+
!!! tip ""
84+
Please ensure that the Hoppie toggle is set to `Enabled` within the EFB. This can be found on the EFB Settings page under ATSU/AOC. (*Not pictured above*).
85+
86+
This is important to ensure that a connection is established.
87+
88+
Once the above toggle is set appropriately, the Hoppie ACARS system will log you in automatically provided the following items are complete:
89+
90+
- Logon code is entered.
91+
- A flight number is set.
92+
- The weather source is set to VATSIM or IVAO.
93+
- See [EFB Settings ATSU/AOC](../flypados3/settings.md#atsuaoc).
94+
95+
## Oceanic clearance
96+
97+
It is also possible to request an Oceanic Clearance (OCL) from ATC.
98+
99+
!!! note "MCDU ATC COMM Menu"
100+
!!! block ""
101+
![atc-menu-p1](../../assets/feature-guides/hoppie/atc-menu-p1.png){align=center width=48% loading=lazy}
102+
![atc-menu-p2-ocl](../../assets/feature-guides/hoppie/atc-menu-p2-ocl.png){align=center width=48% loading=lazy}
103+
104+
The OCEANIC REQ page requires you to be on the last station before an oceanic route. You need to enter your planned entry point, time at entry point, speed and flight level.
105+
106+
In the example below this would be station `EGGX` (Shanwick Oceanic FIR) and the entry point would be `ETIKI` for NAT D.
107+
108+
You would ask for the oceanic clearance about 30min before reaching the entry point.
109+
110+
!!! note "Oceanic Request"
111+
!!! block ""
112+
![OCEANIC REQ](../../assets/feature-guides/hoppie/mcdu-ocl.png "OCL"){align=center width=48% loading=lazy}
113+
![OCEANIC REQ Filled](../../assets/feature-guides/hoppie/mcdu-olc-filled.png "OCL"){align=center width=48% loading=lazy}
114+
115+
!!! note "Oceanic Clearance Request and ATC Response"
116+
!!! block ""
117+
![dcdu-ocl-req](../../assets/feature-guides/hoppie/dcdu-ocl-req.png){align=center width=48% loading=lazy}
118+
![dcdu-ocl-clearance](../../assets/feature-guides/hoppie/dcdu-ocl-clearance.png){align=center width=48% loading=lazy}
119+
120+
Fifteen (15) minutes after passing the entry point you need to set your squawk to 2000. You will receive a new squawk when entering a domestic sector again.
121+
122+
## ATIS Auto Update
123+
124+
To receive ATIS information and setup auto update of specific ATIS go to the ATC COMM menu and click on `ATIS`.
125+
126+
The source for your ATIS information can be configured in the EFB Settings page: [EFB ATSU-AOC Options](../flypados3/settings.md#atsuaoc)
127+
128+
!!! note "MCDU ATC COMM Menu"
129+
!!! block ""
130+
![atc-menu-p1](../../assets/feature-guides/hoppie/atc-menu-p1.png){align=center width=48% loading=lazy}
131+
![atc-menu-p2-atis](../../assets/feature-guides/hoppie/atc-menu-p2-atis.png){align=center width=48% loading=lazy}
132+
133+
From the `ATIS Menu` page you can request ATIS information directly by pushing the right side LSK next to `REQ SEND*`. You also can CLR, change and add additional airports (example formats see screenshots).
134+
135+
You can chose to automatically update ATIS information by pressing the LSK R4 `AUTO UPDATE`and then configure the auto updates on the next page.
136+
137+
!!! note "ATIS and Auto Update"
138+
!!! block ""
139+
![mcdu-atis-menu](../../assets/feature-guides/hoppie/mcdu-atis-menu.png){align=center width=48% loading=lazy}
140+
![mcdu-atis-autoupdate](../../assets/feature-guides/hoppie/mcdu-atis-autoupdate.png){align=center width=48% loading=lazy}
141+
<br/>
142+
![mcdu-atis-menu-2](../../assets/feature-guides/hoppie/mcdu-atis-menu-2.png){align=center width=48% loading=lazy}
143+
![mcdu-atis-menu-3](../../assets/feature-guides/hoppie/mcdu-atis-menu-3.png){align=center width=48% loading=lazy}
144+
<br/>
145+
![mcdu-atis-4](../../assets/feature-guides/hoppie/mcdu-atis-4.png){align=center width=48% loading=lazy}
146+
![mcdu-atis-details](../../assets/feature-guides/hoppie/mcdu-atis-details.png){align=center width=48% loading=lazy}
147+
148+
Pressing the LSK R6 allows you to automatically print ATIS information to the printer.
149+
150+
## Troubleshooting
151+
152+
Sometimes the ATC station does not respond to PDC or CPDLC messages. This mostly happens because of ATC controllers not responding, an issue in the Hoppie network or potentially an issue with the A32NX.
153+
154+
This chapter will give you some hints to check what the actual cause of the issue is.
155+
156+
### Find online stations
157+
158+
It is possible to find all currently online stations. This is helpful to check if the responsible ATC station provides CPDLC or PDC.
159+
A complete list can be found [here](http://www.hoppie.nl/acars/system/online.html){target=new}.
160+
161+
### Find sent and received messages
162+
163+
It can be helpful to check if messages are sent to the Hoppie network. The Hoppie website shows all sent and received messages to and from a specific call sign.
164+
165+
The link follows the the following syntax:
166+
167+
```
168+
http://www.hoppie.nl/acars/system/callsign.html?network=<NETWORK>&callsign=<CALLSIGN>
169+
```
170+
171+
Example: [http://www.hoppie.nl/acars/system/callsign.html?network=VATSIM&callsign=FBW291](http://www.hoppie.nl/acars/system/callsign.html?network=VATSIM&callsign=FBW291){target=new}
172+
173+
- &lt;NETWORK&gt;: Needs to be set as IVAO or VATSIM, depending on the used network.
174+
- &lt;CALLSIGN&gt;: Is the used callsign of the A32NX in the Hoppie network. It is the same as the callsign on the init-page of the MCDU.
175+
176+

‎docs/fbw-a32nx/feature-guides/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ It is not a complete collection of all features but a growing list which is exte
1212
| [Flight Management System](cFMS.md) |
1313
| [Free Text](freetext.md) |
1414
| [Fuel and Weight](loading-fuel-weight.md) |
15-
| [Hoppie ACARS](hoppie.md) |
15+
| [Hoppie ACARS](hoppie/index.md) |
1616
| [MCDU Keyboard Support](mcdu-keyboard.md) |
1717
| [MCDU Web Interface](web-mcdu.md) |
1818
| [Nose Wheel and Tiller Operation](nw-tiller.md) |

‎docs/pilots-corner/a32nx-briefing/flight-deck/front/dcdu.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The Datalink Ctl and Display Unit (DCDU) is used by the pilots to communicate wi
1616

1717
In addition to the DCDU, the MCDU is used to prepare a request.
1818

19-
See our detailed documentation on [Hoppie ACARS](../../../../fbw-a32nx/feature-guides/hoppie.md)
19+
See our detailed documentation on [Hoppie ACARS](../../../../fbw-a32nx/feature-guides/hoppie/index.md)
2020

2121
---
2222

‎docs/release-notes/v080.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ This entire implementation is a realistic realisation of the ATS 623 standard.
108108

109109
![dcdu after send](../fbw-a32nx/assets/feature-guides/hoppie/dcdu-dcl-after-send.png){loading=lazy}
110110

111-
[Hoppie ACARS Operation Guide](../fbw-a32nx/feature-guides/hoppie.md){.md-button}
111+
[Hoppie ACARS Operation Guide](../fbw-a32nx/feature-guides/hoppie/index.md){.md-button}
112112

113113
## TCAS
114114

0 commit comments

Comments
 (0)