Skip to content

Commit 7ffe7a4

Browse files
miriamsruvidyadharantexasdiaz
authored
De-emphasizing phones (#294)
* De-emphasized phones for app updates * Added references to the Control Hub for the color sensors config * Added references to the Control Hub for sensors in blocks * Added links to documentation for Control and Driver hubs * Added references to the Control Hub for OBJ and AS sensor pages * Added references to the Control Hub in PID/PIDF pages * Swapped the control hub and phone sections for creating a config * Updated the webcam page for phones * Added Driver Hubs when talking about using Android * Updated webcam page for Control Hubs * Started the updates for adding an Expansion Hub to a Control Hub * Used DH screenshots on the saving config page * Updated instructions for configuring android * Updated blocks instruction for running OpModes * Updated OpMode instructions for OBJ * Updated OpMode instructions in AS * Removed MR and Hitechnic * Moved ESD to its own section * Added a booklet for ESD --------- Co-authored-by: Uday Vidyadharan <[email protected]> Co-authored-by: Danny Diaz <[email protected]>
1 parent ae31755 commit 7ffe7a4

File tree

67 files changed

+785
-583
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

67 files changed

+785
-583
lines changed

docs/source/booklets/index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Control System
1515
Manufacturing
1616
---------------
1717
- `3D Printing Guide <https://ftc-docs-cdn.ftclive.org/booklets/en/3d_printing.pdf>`_
18+
- `Electrostatic Discharge <https://ftc-docs-cdn.ftclive.org/booklets/en/esd.pdf>`_
1819

1920
Programming Resources
2021
---------------------

docs/source/conf.py

+1
Original file line numberDiff line numberDiff line change
@@ -321,6 +321,7 @@
321321
('booklets/sdk', "sdk.tex", 'SDK Guide', author, "manual"), # SDK
322322
('robot_building/rev/PowerPlay/part1/index', "rob_building_rev_p1.tex", 'Part 1 - Basic \'Bot Guide for REV', author, "manual"), # REV Bot Building Power Play P1
323323
('manufacturing/3d_printing/index', '3d_printing.tex', '3D Printing Guide', author, "manual"), # 3D Printing
324+
('hardware_and_software_configuration/configuring/managing_esd/managing-esd', 'esd.tex', 'Managing Electrostatic Discharge', author, "manual"), # ESD
324325
]
325326

326327

docs/source/ftc_sdk/updating/ds_app/Updating-the-DS-App.rst

+102-105
Original file line numberDiff line numberDiff line change
@@ -5,61 +5,55 @@ The Driver Station App is one of the Apps provided with the *FIRST* Tech
55
Challenge :doc:`Software Development Kit (SDK) </ftc_sdk/overview/index>`. The Driver
66
Station App is the major interface for robot configuration, gamepad support,
77
self-inspect, Team code selection and execution, and others. This app runs
8-
on an approved Android Smartphone or the REV Driver Hub.
8+
on the REV Driver Hub or an approved Android smartphone.
99

1010
This page shows how to update the Driver Station (DS) app on these
1111
devices:
1212

13-
- An approved Android DS phone
1413
- REV Driver Hub
14+
- An approved Android DS phone
1515

1616
These methods for updating the Driver Station App are the same regardless
1717
of the programming language/environment used to program robot Team Code.
1818

19-
.. dropdown:: Updating Driver Station (DS) app on Android smartphone
19+
.. dropdown:: Updating Driver Station (DS) app on REV Driver Hub
2020

21-
There are 2 methods to update the DS app on a DS phone:
21+
Here are 3 methods to update the DS app on a REV Driver Hub:
2222

23-
1. REV Hardware Client (RHC)
24-
2. “Side loading” with APK
23+
#. REV Hardware Client (RHC)
24+
#. "Side loading” with APK
25+
#. Software Manager on REV Driver Hub
2526

2627
.. dropdown:: Method 1 - REV Hardware Client (RHC) - Windows computers only
2728

28-
Plug the DS phone directly into the computer with RHC installed and
29-
open. Use a USB data cable, not a charge-only cable. Make sure the
30-
“Hardware” tab is active, at top left. The DS app on the phone does
31-
**not** need to be open.
29+
Plug the REV Driver Hub directly into the Windows computer with RHC
30+
installed and open. Use a USB-C data cable. Make sure the “Hardware” tab
31+
is active, at top left. The DS app on the Driver Hub does **not** need
32+
to be open.
3233

3334
Here the computer does not need to be connected to the internet, since
3435
:doc:`in Updating the REV Hardware Client
3536
</ftc_sdk/updating/hardware_client/Updating-REV-Hardware-Client>`
3637
the required DS update file was previously downloaded.
3738

38-
The RHC app will recognize the phone, as shown here:
39+
The RHC app will recognize the Driver Hub, as shown here:
3940

40-
.. figure:: images/030-RHC-recognize-phone.png
41-
:alt: Recognizing the Phone
41+
.. figure:: images/070-RHC-recognize-DH.png
42+
:alt: Recognizing the Driver Hub
4243
:width: 80%
4344
:align: center
4445

45-
Recognizing the Phone
46-
47-
If the phone is not recognized, ensure that the phone has :doc:`developer
48-
options
49-
</programming_resources/tutorial_specific/android_studio/enabling_developer_options/Enabling-Developer-Options>`
50-
enabled. If necessary, click the "Scan for Devices" button in the
51-
lower-left of the REV Hardware Client app to force the RHC to rescan
52-
devices.
46+
Recognizing the Driver Hub
5347

54-
Once recognized, click on that phone’s large icon/rectangle. The RHC app
55-
now displays the update status of the DS app, if any.
48+
Once recognized, click on the Driver Hub’s large icon/rectangle. The RHC app now displays
49+
the update status of the DS app, if any.
5650

57-
.. figure:: images/040-RHC-update-DS-phone.png
58-
:alt: Update Status of Phone
51+
.. figure:: images/075-RHC-update-DH.png
52+
:alt: Updating the Driver Hub
5953
:width: 80%
6054
:align: center
6155

62-
Update Status of Phone
56+
Updating the Driver Hub
6357

6458
Simply click the blue Update rectangle (green arrow) – done!
6559

@@ -70,16 +64,16 @@ of the programming language/environment used to program robot Team Code.
7064
You could have selected an **older** version of the DS app, in the
7165
drop-down list just above the blue Update rectangle.
7266

73-
After install, drag the DS app icon from the app menu to the phone’s
74-
home screen.
67+
After install, drag the DS app icon from the app menu to the Driver
68+
Hub’s home screen, if needed.
7569

76-
You may now unplug the DS phone from the computer, and close the RHC
70+
You may now unplug the Driver Hub from the computer, and close the RHC
7771
app. The updated DS app is ready to use.
7872

7973
.. dropdown:: Method 2 - Side-load APK
8074

8175
Here you will work directly with the Android Package or **APK file** to
82-
install the DS app on the Android phone. Any computer can be used, PC or
76+
install the DS app on the Driver Hub. Any computer can be used, PC or
8377
Mac, old or new. This method is sometimes called “side-loading”.
8478

8579
1. Connect your computer to the internet, open a web browser, and
@@ -110,76 +104,108 @@ of the programming language/environment used to program robot Team Code.
110104
At this time, you could rename the file to reflect its current version
111105
number. For example, ``FtcDriverStation-release-8.0.apk`` or simply
112106
``DS-8.0-release.apk``. This distinguishes the file from other versions
113-
that might be stored later on that DS phone.
107+
that might be stored later on that Driver Hub.
114108

115-
2. Transfer the APK file from the computer to the DS phone’s Downloads
116-
(or Download) folder. Use a USB data cable (not a charge-only cable).
117-
When complete, you may unplug the DS phone from the computer.
109+
2. Transfer the APK file from the computer to the Driver Hub’s Downloads
110+
folder. Use a USB-C data cable. When complete, you may unplug the
111+
Driver Hub from the computer.
118112

119-
3. Uninstall the existing (obsolete) DS app, by dragging its icon to a
113+
3. Uninstall the existing (obsolete) DS app, by dragging its icon to the
120114
Trash/Uninstall icon. Or, touch and hold the DS icon for “App info”,
121115
then choose Uninstall.
122116

123-
4. On the DS phone, navigate to the Downloads folder. This can be done
117+
4. On the Driver Hub, navigate to the Downloads folder. This can be done
124118
in several ways:
125119

126-
- at the main app menu (swipe up), touch the Files icon or the
127-
Downloads icon (if present)
120+
- at the main app menu (swipe up), touch the Files icon, then three
121+
bars at top left
128122

129-
- use the basic file manager in Settings/Storage, then Explore or Files
123+
- use the basic file manager in Settings/Storage, then touch Files
130124

131125
- use a third-party app such as FX File Explorer (from the Google Play
132126
Store)
133127

134128
Touch the APK filename that you transferred. Respond to the prompts, to
135129
install the updated DS app.
136130

137-
After install, drag the DS app icon from the menu to the phone’s home
138-
screen.
131+
After install, drag the DS app icon from the menu to the Driver Hub’s
132+
home screen, if needed.
139133

140134
Done! The updated DS app is now ready to use.
141135

142-
.. dropdown:: Updating Driver Station (DS) app on REV Driver Hub
136+
.. dropdown:: Method 3 - Software Manager
143137

144-
Here are 3 methods to update the DS app on a REV Driver Hub:
138+
The REV Driver Hub has a built-in app called the Software Manager, which
139+
can automatically update the DS app (and other related software). It
140+
requires only an internet connection.
145141

146-
#. REV Hardware Client (RHC)
147-
#. "Side loading” with APK
148-
#. Software Manager on REV Driver Hub
142+
5. Close all apps, and open the Driver Hub’s Wi-Fi menu (in Settings, or
143+
swipe down twice from top of home screen). Temporarily connect the
144+
Driver Hub to the internet via Wi-Fi.
145+
146+
6. Open the Software Manager app at the Driver Hub home screen (left
147+
image, below).
148+
149+
.. figure:: images/910-DH-double.png
150+
:alt: REV Software Manager
151+
:width: 80%
152+
:align: center
149153

150-
The first two methods are essentially the same as above, for updating on a
151-
DS phone.
154+
REV Software Manager
155+
156+
7. The Software Manager will automatically check for any updates needed,
157+
and display the results (right image, above). Click the grey box to
158+
update the Driver Station (DS) app, if needed.
159+
160+
8. When all is complete, “Forget” the Wi-Fi network used for internet
161+
access.
162+
163+
Done! Now the Driver Hub is updated and ready for use.
164+
165+
.. dropdown:: Updating Driver Station (DS) app on Android smartphone
166+
167+
There are 2 methods to update the DS app on a DS phone:
168+
169+
1. REV Hardware Client (RHC)
170+
2. “Side loading” with APK
152171

153172
.. dropdown:: Method 1 - REV Hardware Client (RHC) - Windows computers only
154173

155-
Plug the REV Driver Hub directly into the Windows computer with RHC
156-
installed and open. Use a USB-C data cable. Make sure the “Hardware” tab
157-
is active, at top left. The DS app on the Driver Hub does **not** need
158-
to be open.
174+
Plug the DS phone directly into the computer with RHC installed and
175+
open. Use a USB data cable, not a charge-only cable. Make sure the
176+
“Hardware” tab is active, at top left. The DS app on the phone does
177+
**not** need to be open.
159178

160179
Here the computer does not need to be connected to the internet, since
161180
:doc:`in Updating the REV Hardware Client
162181
</ftc_sdk/updating/hardware_client/Updating-REV-Hardware-Client>`
163182
the required DS update file was previously downloaded.
164183

165-
The RHC app will recognize the Driver Hub, as shown here:
184+
The RHC app will recognize the phone, as shown here:
166185

167-
.. figure:: images/070-RHC-recognize-DH.png
168-
:alt: Recognizing the Driver Hub
186+
.. figure:: images/030-RHC-recognize-phone.png
187+
:alt: Recognizing the Phone
169188
:width: 80%
170189
:align: center
171190

172-
Recognizing the Driver Hub
191+
Recognizing the Phone
173192

174-
Once recognized, click on the Driver Hub’s large icon/rectangle. The RHC app now displays
175-
the update status of the DS app, if any.
193+
If the phone is not recognized, ensure that the phone has :doc:`developer
194+
options
195+
</programming_resources/tutorial_specific/android_studio/enabling_developer_options/Enabling-Developer-Options>`
196+
enabled. If necessary, click the "Scan for Devices" button in the
197+
lower-left of the REV Hardware Client app to force the RHC to rescan
198+
devices.
176199

177-
.. figure:: images/075-RHC-update-DH.png
178-
:alt: Updating the Driver Hub
200+
Once recognized, click on that phone’s large icon/rectangle. The RHC app
201+
now displays the update status of the DS app, if any.
202+
203+
.. figure:: images/040-RHC-update-DS-phone.png
204+
:alt: Update Status of Phone
179205
:width: 80%
180206
:align: center
181207

182-
Updating the Driver Hub
208+
Update Status of Smartphone
183209

184210
Simply click the blue Update rectangle (green arrow) – done!
185211

@@ -190,16 +216,16 @@ of the programming language/environment used to program robot Team Code.
190216
You could have selected an **older** version of the DS app, in the
191217
drop-down list just above the blue Update rectangle.
192218

193-
After install, drag the DS app icon from the app menu to the Driver
194-
Hub’s home screen, if needed.
219+
After install, drag the DS app icon from the app menu to the phone’s
220+
home screen.
195221

196-
You may now unplug the Driver Hub from the computer, and close the RHC
222+
You may now unplug the DS phone from the computer, and close the RHC
197223
app. The updated DS app is ready to use.
198224

199225
.. dropdown:: Method 2 - Side-load APK
200226

201227
Here you will work directly with the Android Package or **APK file** to
202-
install the DS app on the Driver Hub. Any computer can be used, PC or
228+
install the DS app on the Android phone. Any computer can be used, PC or
203229
Mac, old or new. This method is sometimes called “side-loading”.
204230

205231
1. Connect your computer to the internet, open a web browser, and
@@ -230,63 +256,34 @@ of the programming language/environment used to program robot Team Code.
230256
At this time, you could rename the file to reflect its current version
231257
number. For example, ``FtcDriverStation-release-8.0.apk`` or simply
232258
``DS-8.0-release.apk``. This distinguishes the file from other versions
233-
that might be stored later on that Driver Hub.
259+
that might be stored later on that DS phone.
234260

235-
2. Transfer the APK file from the computer to the Driver Hub’s Downloads
236-
folder. Use a USB-C data cable. When complete, you may unplug the
237-
Driver Hub from the computer.
261+
2. Transfer the APK file from the computer to the DS phone’s Downloads
262+
(or Download) folder. Use a USB data cable (not a charge-only cable).
263+
When complete, you may unplug the DS phone from the computer.
238264

239-
3. Uninstall the existing (obsolete) DS app, by dragging its icon to the
265+
3. Uninstall the existing (obsolete) DS app, by dragging its icon to a
240266
Trash/Uninstall icon. Or, touch and hold the DS icon for “App info”,
241267
then choose Uninstall.
242268

243-
4. On the Driver Hub, navigate to the Downloads folder. This can be done
269+
4. On the DS phone, navigate to the Downloads folder. This can be done
244270
in several ways:
245271

246-
- at the main app menu (swipe up), touch the Files icon, then three
247-
bars at top left
272+
- at the main app menu (swipe up), touch the Files icon or the
273+
Downloads icon (if present)
248274

249-
- use the basic file manager in Settings/Storage, then touch Files
275+
- use the basic file manager in Settings/Storage, then Explore or Files
250276

251277
- use a third-party app such as FX File Explorer (from the Google Play
252278
Store)
253279

254280
Touch the APK filename that you transferred. Respond to the prompts, to
255281
install the updated DS app.
256282

257-
After install, drag the DS app icon from the menu to the Driver Hub’s
258-
home screen, if needed.
283+
After install, drag the DS app icon from the menu to the phone’s home
284+
screen.
259285

260286
Done! The updated DS app is now ready to use.
261287

262-
.. dropdown:: Method 3 - Software Manager
263-
264-
The REV Driver Hub has a built-in app called the Software Manager, which
265-
can automatically update the DS app (and other related software). It
266-
requires only an internet connection.
267-
268-
1. Close all apps, and open the Driver Hub’s Wi-Fi menu (in Settings, or
269-
swipe down twice from top of home screen). Temporarily connect the
270-
Driver Hub to the internet via Wi-Fi.
271-
272-
2. Open the Software Manager app at the Driver Hub home screen (left
273-
image, below).
274-
275-
.. figure:: images/910-DH-double.png
276-
:alt: REV Software Manager
277-
:width: 80%
278-
:align: center
279-
280-
REV Software Manager
281-
282-
3. The Software Manager will automatically check for any updates needed,
283-
and display the results (right image, above). Click the grey box to
284-
update the Driver Station (DS) app, if needed.
285-
286-
4. When all is complete, “Forget” the Wi-Fi network used for internet
287-
access.
288-
289-
Done! Now the Driver Hub is updated and ready for use.
290-
291288
Questions, comments and corrections to [email protected]
292289

0 commit comments

Comments
 (0)