wiki/info/mobile/racecommittee-app-user.md
... ...
@@ -0,0 +1,185 @@
1
+# RaceCommittee App (User Guide)
2
+
3
+[[_TOC_]]
4
+
5
+## Introduction
6
+
7
+This user guide is intended for race officers and other users of the RaceCommittee App. The document assumes that you have been handed a fully configured device (see [[guide for device administrators|wiki/racecommittee-app-administrator]]).
8
+
9
+## Logon
10
+
11
+Each race officer is in charge of managing the races of a course area (Alpha, Bravo, Off-Shore,...). After selecting the active event on the left pane, click on your course area.
12
+
13
+![Logon onto course area](/wiki/images/rcapp/app_login.jpg)
14
+
15
+In the dialog screen choose _"Login as race officer (start vessel)"_. Press **Login**. From now on you will see in the lower right corner the RaceCommittee App icon signaling that you are managing this course area. Using this notification icon you are always able to return back to your race management screen.
16
+
17
+![The notification icon](/wiki/images/rcapp/app_notification_icon.jpg)
18
+
19
+## Race management
20
+
21
+On the race management screen you see all races grouped by their regatta and fleet on the left side. By default the race list is filtered showing only active races. Use the top action bar to switch to "show all races" if you need to see all.
22
+
23
+![Race management screen](/wiki/images/rcapp/app_running.jpg)
24
+
25
+Clicking on a race in the race list opens up the race information screen on the right pane. This screen allows you to umpire a race.
26
+
27
+Clicking the back button on your device or touching the home icon (top left corner) logs you out of the active course area.
28
+
29
+### Scheduling a race
30
+
31
+One of the most important task in the life of a race officer is scheduling her races. Whenever you select a **unschedulded race** the race information screen asks you to select a racing procedure and a start time. By default a start time in the near future is selected.
32
+
33
+![Scheduling a race](/wiki/images/rcapp/app_schedule.jpg)
34
+
35
+When you are satisfied with the start time selected (hint: click on 'Today' to select a different date) and racing procedure, click **'Start'**. As you will see below you are always able to reschedule a race. Therefore the best race officers schedule multiple races at once. After scheduling the first race of the day, just select the next race in the race list and set an estimated start time.
36
+
37
+On the same race information screen you are able to **postpone** an unschedulded race. Click on 'Postpone' and select the postponment flags.
38
+
39
+#### Scheduling a race in the past
40
+
41
+It is perfectly fine to schedule a race into the past. The RaceCommittee App will simulate the race and its startphase up until the present time. When scheduling a race in the past it might happen that the app asks you for additional information regarding the startphase of the selected racing procedure (e.g. setting a startmode flag).
42
+
43
+### Managing the startphase
44
+
45
+Selecting a scheduled race will take you to the startphase race information screen. On this screen you are able to manage the startphase of the race's racing procedure. While the available actions vary between the racing procedures you always see the following:
46
+
47
+* Countdown to start
48
+* Countdown to next flag change
49
+* Currently displayed and removed flags
50
+
51
+![Startphase](/wiki/images/rcapp/app_startphase.jpg)
52
+
53
+Regardless of the racing procedure you're able to **abort** (AP flag) and **reschedule** the race.
54
+
55
+### Managing an on-going race
56
+
57
+While a race is on-going the race information screen shows the running race information screen.
58
+
59
+You are still able to **abort** the race (AP or November flag) and signal a **general recall**. Both actions will unschedule the race, taking you back to the schedule race screen.
60
+
61
+![A running race](/wiki/images/rcapp/app_running.jpg)
62
+
63
+If active for your configuration/regatta you are able to signal an **individual recall** (X-Ray flag). Currently you're not able to enter the competitors violating the starting line. The X-Ray flag will be removed after 4 minutes automatically. You can always remove it before the timer terminates by clicking on "individual recall" again.
64
+
65
+When the race is about to finish (finishing vessel displays blue flag, first finisher crosses the line, last leg,...) click the blue flag to **start the finishing phase**.
66
+
67
+### Finishing a race
68
+
69
+While a race is finishing the race information screen will show you the finishing phase.
70
+
71
+On this screen you're able to **abort** (November flag) the race or **end** the race. To end the race click on the blue flag.
72
+
73
+### Further management activities
74
+
75
+Besides the normal race management workflow described above there are additional management activities which can be executed on a race at any time. See also [Signaling a course change](#coursechange).
76
+
77
+#### Protest time
78
+
79
+If active for your configuration/regatta you can click the **bravo flag** on a fleet's header in the race list to signal the start of the protest time for this fleet.
80
+
81
+![Setting the protest time](/wiki/images/rcapp/app_protesttime.jpg)
82
+
83
+In the dialog window select all races of the fleet whose protest time should be set. By default all already finished races are selected.
84
+
85
+#### Wind
86
+
87
+In the top bar of each race information screen you are able to enter wind data. Click on the yellow link text 'set wind' to open the wind input dialog
88
+
89
+![Wind input dialog](/wiki/images/rcapp/app_wind.jpg)
90
+
91
+Using the GPS receiver of your device the dialog will determine your position. Enter the wind direction and speed and click 'store'.
92
+
93
+## Racing Procedures
94
+<a name="procedures"></a>
95
+
96
+Every time you start a race (e.g. schedule a race for the first time, restarting a race after general recall, ...) you are able to choose the **racing procedure**. The racing procedure defines how the startphase is set up. This may include signaling flags that are triggered at a fixed time and signals you have to choose from.
97
+
98
+### RRS26
99
+
100
+The RRS26 racing procedure should be used for races using the _RRS26 starting sequence_. This sequence is defined as the following:
101
+
102
+1. **5 minutes** before start the warning signal is set. Class flag (as configured) is displayed.
103
+2. **4 minutes** before start the preparatory signal is set. By default you are able to choose between the following flags: Papa, India, Zulu, Black to be displayed.
104
+3. **1 minute** before start the one minute warning is set. The preparatory flag is removed.
105
+4. **At start** the class flag is removed.
106
+
107
+Using the default configuration for the RRS26 racing procedure you are able to signal individual recalls (expect when you've chosen Black as the preparatory signal).
108
+
109
+### Gate Start
110
+
111
+The Gate Start racing procedure should be used for races using a gate (or rabbit or gate launch) start. We've seen some variations of the implementation of a gate start, therefore you should double check with the administration team that the Gate Start racing procedure is correctly configured fitting your regatta's sailing instructions.
112
+
113
+1. At **any time** you are able to configure the following:
114
+ * **Pathfinder:** If enabled for your regatta, you are able to set the pathfinder. You have to enter the pathfinder's sailing identifier.
115
+ * **Gate launch stop time:** Before the race starts, you have to set the gate launch stop time. This time determines how many minutes after the start the gate launch will stop.
116
+ * **Golf down time:** If enabled for your regatta, you have to set the additional golf down time. This time determines how many minutes _after the gate launch has stopped_, the starting line will be closed. If your regatta is configured to not use an additional golf down time, the starting line will close after the gate launch has stopped.
117
+2. **8 minutes** before start the warning signal is set. Class flag (as configured) over Golf is displayed.
118
+3. **4 minutes** before start the preparatory signal is set. Papa flag is displayed.
119
+4. **1 minute** before start the one minute warning is set. Papa flag is removed.
120
+5. **At start** Class flag is removed.
121
+6. After the **gate launch stop** time has expired the golf flag is hoisted to half-mast. The gate launch stops. This step is not yet visualized in the app.
122
+7. After the additional **golf down** time has expired the golf is removed. The starting line is closed. If you're regatta is configured to not use the additional golf down time, the starting line will close after the gate launch stop time is expired.
123
+
124
+By default you are not able to signal individual recalls for the Gate Start racing procedure.
125
+
126
+### ESS Start
127
+
128
+The ESS racing procedure models the starting sequence used at the Extreme Sailing Series.
129
+
130
+1. **4 minutes** before start AP flag is removed.
131
+2. **3 minutes** before start a flag indicating a 3 is displayed.
132
+3. **2 minutes** before start a flag indicating a 2 is displayed. The previous flag is removed.
133
+3. **1 minutes** before start a flag indicating a 1 is displayed. The previous flag is removed.
134
+4. **At start** the one minute flag is removed.
135
+
136
+By default you are able to signal individual recalls for the ESS racing procedure.
137
+
138
+Additionally you are able to enter the **finishing list** on the race finishing information screen. Just drag and drop the available sailors from the right to their correct position on the left. You are able to reorder them as you need. **Be sure to confirm your finishing list after the race is finished**. Click on the 'Confirm Competitors* buttons after you have finished the race.
139
+
140
+### Basic Countdown Start
141
+
142
+Use the Basic Countdown racing procedure whenever all the other procedures do not match your needs. There are no flags used in the starting sequence, it is just a countdown to the scheduled starting time.
143
+
144
+## Signaling a course change
145
+<a name="coursechange"></a>
146
+
147
+There are different ways to signal a course change. Your device has been configured by the [[administration team|wiki/racecommittee-app-administrator]] to select the best method for you.
148
+
149
+### By-Name
150
+
151
+Simple course name selection screen. The available course names are pre-configured by the administration team.
152
+
153
+### By-Marks
154
+
155
+Design the course by defining marks and gates from existing assets provided by the server. You can choose to reuse the last published course design when no course change has occurred.
156
+
157
+### By-Map
158
+
159
+Lorem ipsum.
160
+
161
+## Troubleshooting
162
+
163
+The following sections will help you with some common problems.
164
+
165
+### Race reset
166
+
167
+Whenever a managed race is in a wrong state or you want to redo the race, click 'Reset race' in the race information's top bar. Please read the warning displayed.
168
+
169
+### Connectivity problems
170
+
171
+In the top right corner three dots indicate the connectivity status. If there is a problem with sending or receiving data to/from the server the dots will turn red. Don't panic: since you probably aren't sitting in the range of a Starbuck's WiFi this will happen **often**. Just wait some time and put the device somewhere you expect celluar network coverage. The device will re-try to send data every minute.
172
+
173
+![Connectivity ok](/wiki/images/rcapp/app_conn_ok.jpg) **versus * ![Connectivity bad](/wiki/images/rcapp/app_conn_bad.jpg)
174
+
175
+If the dots stay red contact the administration team or see the [[administration wiki|wiki/racecommittee-app-administrator]].
176
+
177
+### Reload all data
178
+
179
+If the available course areas/regattas/races on your device aren't up to date anymore, e.g. you are missing a regatta, you can try to reload all data from the server. Click your devices menu button or select the options overflow icon (top right corner) and click 'Reload'. This will log you out of your course area.
180
+
181
+### Crashes
182
+
183
+If the app crashes it will try to restart. You'll have to re-logon onto your course area. The previous state of your managed race will be restored, including unsent changes and data.
184
+
185
+If the app crashes over and over again contact the [[administration team|wiki/racecommittee-app-administrator]].
... ...
\ No newline at end of file
wiki/racecommittee-app-user.md
... ...
@@ -1,185 +0,0 @@
1
-# RaceCommittee App (User Guide)
2
-
3
-[[_TOC_]]
4
-
5
-## Introduction
6
-
7
-This user guide is intended for race officers and other users of the RaceCommittee App. The document assumes that you have been handed a fully configured device (see [[guide for device administrators|wiki/racecommittee-app-administrator]]).
8
-
9
-## Logon
10
-
11
-Each race officer is in charge of managing the races of a course area (Alpha, Bravo, Off-Shore,...). After selecting the active event on the left pane, click on your course area.
12
-
13
-![Logon onto course area](/wiki/images/rcapp/app_login.jpg)
14
-
15
-In the dialog screen choose _"Login as race officer (start vessel)"_. Press **Login**. From now on you will see in the lower right corner the RaceCommittee App icon signaling that you are managing this course area. Using this notification icon you are always able to return back to your race management screen.
16
-
17
-![The notification icon](/wiki/images/rcapp/app_notification_icon.jpg)
18
-
19
-## Race management
20
-
21
-On the race management screen you see all races grouped by their regatta and fleet on the left side. By default the race list is filtered showing only active races. Use the top action bar to switch to "show all races" if you need to see all.
22
-
23
-![Race management screen](/wiki/images/rcapp/app_running.jpg)
24
-
25
-Clicking on a race in the race list opens up the race information screen on the right pane. This screen allows you to umpire a race.
26
-
27
-Clicking the back button on your device or touching the home icon (top left corner) logs you out of the active course area.
28
-
29
-### Scheduling a race
30
-
31
-One of the most important task in the life of a race officer is scheduling her races. Whenever you select a **unschedulded race** the race information screen asks you to select a racing procedure and a start time. By default a start time in the near future is selected.
32
-
33
-![Scheduling a race](/wiki/images/rcapp/app_schedule.jpg)
34
-
35
-When you are satisfied with the start time selected (hint: click on 'Today' to select a different date) and racing procedure, click **'Start'**. As you will see below you are always able to reschedule a race. Therefore the best race officers schedule multiple races at once. After scheduling the first race of the day, just select the next race in the race list and set an estimated start time.
36
-
37
-On the same race information screen you are able to **postpone** an unschedulded race. Click on 'Postpone' and select the postponment flags.
38
-
39
-#### Scheduling a race in the past
40
-
41
-It is perfectly fine to schedule a race into the past. The RaceCommittee App will simulate the race and its startphase up until the present time. When scheduling a race in the past it might happen that the app asks you for additional information regarding the startphase of the selected racing procedure (e.g. setting a startmode flag).
42
-
43
-### Managing the startphase
44
-
45
-Selecting a scheduled race will take you to the startphase race information screen. On this screen you are able to manage the startphase of the race's racing procedure. While the available actions vary between the racing procedures you always see the following:
46
-
47
-* Countdown to start
48
-* Countdown to next flag change
49
-* Currently displayed and removed flags
50
-
51
-![Startphase](/wiki/images/rcapp/app_startphase.jpg)
52
-
53
-Regardless of the racing procedure you're able to **abort** (AP flag) and **reschedule** the race.
54
-
55
-### Managing an on-going race
56
-
57
-While a race is on-going the race information screen shows the running race information screen.
58
-
59
-You are still able to **abort** the race (AP or November flag) and signal a **general recall**. Both actions will unschedule the race, taking you back to the schedule race screen.
60
-
61
-![A running race](/wiki/images/rcapp/app_running.jpg)
62
-
63
-If active for your configuration/regatta you are able to signal an **individual recall** (X-Ray flag). Currently you're not able to enter the competitors violating the starting line. The X-Ray flag will be removed after 4 minutes automatically. You can always remove it before the timer terminates by clicking on "individual recall" again.
64
-
65
-When the race is about to finish (finishing vessel displays blue flag, first finisher crosses the line, last leg,...) click the blue flag to **start the finishing phase**.
66
-
67
-### Finishing a race
68
-
69
-While a race is finishing the race information screen will show you the finishing phase.
70
-
71
-On this screen you're able to **abort** (November flag) the race or **end** the race. To end the race click on the blue flag.
72
-
73
-### Further management activities
74
-
75
-Besides the normal race management workflow described above there are additional management activities which can be executed on a race at any time. See also [Signaling a course change](#coursechange).
76
-
77
-#### Protest time
78
-
79
-If active for your configuration/regatta you can click the **bravo flag** on a fleet's header in the race list to signal the start of the protest time for this fleet.
80
-
81
-![Setting the protest time](/wiki/images/rcapp/app_protesttime.jpg)
82
-
83
-In the dialog window select all races of the fleet whose protest time should be set. By default all already finished races are selected.
84
-
85
-#### Wind
86
-
87
-In the top bar of each race information screen you are able to enter wind data. Click on the yellow link text 'set wind' to open the wind input dialog
88
-
89
-![Wind input dialog](/wiki/images/rcapp/app_wind.jpg)
90
-
91
-Using the GPS receiver of your device the dialog will determine your position. Enter the wind direction and speed and click 'store'.
92
-
93
-## Racing Procedures
94
-<a name="procedures"></a>
95
-
96
-Every time you start a race (e.g. schedule a race for the first time, restarting a race after general recall, ...) you are able to choose the **racing procedure**. The racing procedure defines how the startphase is set up. This may include signaling flags that are triggered at a fixed time and signals you have to choose from.
97
-
98
-### RRS26
99
-
100
-The RRS26 racing procedure should be used for races using the _RRS26 starting sequence_. This sequence is defined as the following:
101
-
102
-1. **5 minutes** before start the warning signal is set. Class flag (as configured) is displayed.
103
-2. **4 minutes** before start the preparatory signal is set. By default you are able to choose between the following flags: Papa, India, Zulu, Black to be displayed.
104
-3. **1 minute** before start the one minute warning is set. The preparatory flag is removed.
105
-4. **At start** the class flag is removed.
106
-
107
-Using the default configuration for the RRS26 racing procedure you are able to signal individual recalls (expect when you've chosen Black as the preparatory signal).
108
-
109
-### Gate Start
110
-
111
-The Gate Start racing procedure should be used for races using a gate (or rabbit or gate launch) start. We've seen some variations of the implementation of a gate start, therefore you should double check with the administration team that the Gate Start racing procedure is correctly configured fitting your regatta's sailing instructions.
112
-
113
-1. At **any time** you are able to configure the following:
114
- * **Pathfinder:** If enabled for your regatta, you are able to set the pathfinder. You have to enter the pathfinder's sailing identifier.
115
- * **Gate launch stop time:** Before the race starts, you have to set the gate launch stop time. This time determines how many minutes after the start the gate launch will stop.
116
- * **Golf down time:** If enabled for your regatta, you have to set the additional golf down time. This time determines how many minutes _after the gate launch has stopped_, the starting line will be closed. If your regatta is configured to not use an additional golf down time, the starting line will close after the gate launch has stopped.
117
-2. **8 minutes** before start the warning signal is set. Class flag (as configured) over Golf is displayed.
118
-3. **4 minutes** before start the preparatory signal is set. Papa flag is displayed.
119
-4. **1 minute** before start the one minute warning is set. Papa flag is removed.
120
-5. **At start** Class flag is removed.
121
-6. After the **gate launch stop** time has expired the golf flag is hoisted to half-mast. The gate launch stops. This step is not yet visualized in the app.
122
-7. After the additional **golf down** time has expired the golf is removed. The starting line is closed. If you're regatta is configured to not use the additional golf down time, the starting line will close after the gate launch stop time is expired.
123
-
124
-By default you are not able to signal individual recalls for the Gate Start racing procedure.
125
-
126
-### ESS Start
127
-
128
-The ESS racing procedure models the starting sequence used at the Extreme Sailing Series.
129
-
130
-1. **4 minutes** before start AP flag is removed.
131
-2. **3 minutes** before start a flag indicating a 3 is displayed.
132
-3. **2 minutes** before start a flag indicating a 2 is displayed. The previous flag is removed.
133
-3. **1 minutes** before start a flag indicating a 1 is displayed. The previous flag is removed.
134
-4. **At start** the one minute flag is removed.
135
-
136
-By default you are able to signal individual recalls for the ESS racing procedure.
137
-
138
-Additionally you are able to enter the **finishing list** on the race finishing information screen. Just drag and drop the available sailors from the right to their correct position on the left. You are able to reorder them as you need. **Be sure to confirm your finishing list after the race is finished**. Click on the 'Confirm Competitors* buttons after you have finished the race.
139
-
140
-### Basic Countdown Start
141
-
142
-Use the Basic Countdown racing procedure whenever all the other procedures do not match your needs. There are no flags used in the starting sequence, it is just a countdown to the scheduled starting time.
143
-
144
-## Signaling a course change
145
-<a name="coursechange"></a>
146
-
147
-There are different ways to signal a course change. Your device has been configured by the [[administration team|wiki/racecommittee-app-administrator]] to select the best method for you.
148
-
149
-### By-Name
150
-
151
-Simple course name selection screen. The available course names are pre-configured by the administration team.
152
-
153
-### By-Marks
154
-
155
-Design the course by defining marks and gates from existing assets provided by the server. You can choose to reuse the last published course design when no course change has occurred.
156
-
157
-### By-Map
158
-
159
-Lorem ipsum.
160
-
161
-## Troubleshooting
162
-
163
-The following sections will help you with some common problems.
164
-
165
-### Race reset
166
-
167
-Whenever a managed race is in a wrong state or you want to redo the race, click 'Reset race' in the race information's top bar. Please read the warning displayed.
168
-
169
-### Connectivity problems
170
-
171
-In the top right corner three dots indicate the connectivity status. If there is a problem with sending or receiving data to/from the server the dots will turn red. Don't panic: since you probably aren't sitting in the range of a Starbuck's WiFi this will happen **often**. Just wait some time and put the device somewhere you expect celluar network coverage. The device will re-try to send data every minute.
172
-
173
-![Connectivity ok](/wiki/images/rcapp/app_conn_ok.jpg) **versus * ![Connectivity bad](/wiki/images/rcapp/app_conn_bad.jpg)
174
-
175
-If the dots stay red contact the administration team or see the [[administration wiki|wiki/racecommittee-app-administrator]].
176
-
177
-### Reload all data
178
-
179
-If the available course areas/regattas/races on your device aren't up to date anymore, e.g. you are missing a regatta, you can try to reload all data from the server. Click your devices menu button or select the options overflow icon (top right corner) and click 'Reload'. This will log you out of your course area.
180
-
181
-### Crashes
182
-
183
-If the app crashes it will try to restart. You'll have to re-logon onto your course area. The previous state of your managed race will be restored, including unsent changes and data.
184
-
185
-If the app crashes over and over again contact the [[administration team|wiki/racecommittee-app-administrator]].
... ...
\ No newline at end of file