Skip to content

Commit

Permalink
De-emphasizing phones (#294)
Browse files Browse the repository at this point in the history
* 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]>
  • Loading branch information
3 people authored Feb 3, 2025
1 parent ae31755 commit 7ffe7a4
Show file tree
Hide file tree
Showing 67 changed files with 785 additions and 583 deletions.
1 change: 1 addition & 0 deletions docs/source/booklets/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Control System
Manufacturing
---------------
- `3D Printing Guide <https://ftc-docs-cdn.ftclive.org/booklets/en/3d_printing.pdf>`_
- `Electrostatic Discharge <https://ftc-docs-cdn.ftclive.org/booklets/en/esd.pdf>`_

Programming Resources
---------------------
Expand Down
1 change: 1 addition & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -321,6 +321,7 @@
('booklets/sdk', "sdk.tex", 'SDK Guide', author, "manual"), # SDK
('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
('manufacturing/3d_printing/index', '3d_printing.tex', '3D Printing Guide', author, "manual"), # 3D Printing
('hardware_and_software_configuration/configuring/managing_esd/managing-esd', 'esd.tex', 'Managing Electrostatic Discharge', author, "manual"), # ESD
]


Expand Down
207 changes: 102 additions & 105 deletions docs/source/ftc_sdk/updating/ds_app/Updating-the-DS-App.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,61 +5,55 @@ The Driver Station App is one of the Apps provided with the *FIRST* Tech
Challenge :doc:`Software Development Kit (SDK) </ftc_sdk/overview/index>`. The Driver
Station App is the major interface for robot configuration, gamepad support,
self-inspect, Team code selection and execution, and others. This app runs
on an approved Android Smartphone or the REV Driver Hub.
on the REV Driver Hub or an approved Android smartphone.

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

- An approved Android DS phone
- REV Driver Hub
- An approved Android DS phone

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

.. dropdown:: Updating Driver Station (DS) app on Android smartphone
.. dropdown:: Updating Driver Station (DS) app on REV Driver Hub

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

1. REV Hardware Client (RHC)
2. “Side loading” with APK
#. REV Hardware Client (RHC)
#. "Side loading” with APK
#. Software Manager on REV Driver Hub

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

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

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

The RHC app will recognize the phone, as shown here:
The RHC app will recognize the Driver Hub, as shown here:

.. figure:: images/030-RHC-recognize-phone.png
:alt: Recognizing the Phone
.. figure:: images/070-RHC-recognize-DH.png
:alt: Recognizing the Driver Hub
:width: 80%
:align: center

Recognizing the Phone

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

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

.. figure:: images/040-RHC-update-DS-phone.png
:alt: Update Status of Phone
.. figure:: images/075-RHC-update-DH.png
:alt: Updating the Driver Hub
:width: 80%
:align: center

Update Status of Phone
Updating the Driver Hub

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

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

After install, drag the DS app icon from the app menu to the phone’s
home screen.
After install, drag the DS app icon from the app menu to the Driver
Hub’s home screen, if needed.

You may now unplug the DS phone from the computer, and close the RHC
You may now unplug the Driver Hub from the computer, and close the RHC
app. The updated DS app is ready to use.

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

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

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

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

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

4. On the DS phone, navigate to the Downloads folder. This can be done
4. On the Driver Hub, navigate to the Downloads folder. This can be done
in several ways:

- at the main app menu (swipe up), touch the Files icon or the
Downloads icon (if present)
- at the main app menu (swipe up), touch the Files icon, then three
bars at top left

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

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

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

After install, drag the DS app icon from the menu to the phone’s home
screen.
After install, drag the DS app icon from the menu to the Driver Hub’s
home screen, if needed.

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

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

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

#. REV Hardware Client (RHC)
#. "Side loading” with APK
#. Software Manager on REV Driver Hub
5. Close all apps, and open the Driver Hub’s Wi-Fi menu (in Settings, or
swipe down twice from top of home screen). Temporarily connect the
Driver Hub to the internet via Wi-Fi.

6. Open the Software Manager app at the Driver Hub home screen (left
image, below).

.. figure:: images/910-DH-double.png
:alt: REV Software Manager
:width: 80%
:align: center

The first two methods are essentially the same as above, for updating on a
DS phone.
REV Software Manager

7. The Software Manager will automatically check for any updates needed,
and display the results (right image, above). Click the grey box to
update the Driver Station (DS) app, if needed.

8. When all is complete, “Forget” the Wi-Fi network used for internet
access.

Done! Now the Driver Hub is updated and ready for use.

.. dropdown:: Updating Driver Station (DS) app on Android smartphone

There are 2 methods to update the DS app on a DS phone:

1. REV Hardware Client (RHC)
2. “Side loading” with APK

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

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

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

The RHC app will recognize the Driver Hub, as shown here:
The RHC app will recognize the phone, as shown here:

.. figure:: images/070-RHC-recognize-DH.png
:alt: Recognizing the Driver Hub
.. figure:: images/030-RHC-recognize-phone.png
:alt: Recognizing the Phone
:width: 80%
:align: center

Recognizing the Driver Hub
Recognizing the Phone

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

.. figure:: images/075-RHC-update-DH.png
:alt: Updating the Driver Hub
Once recognized, click on that phone’s large icon/rectangle. The RHC app
now displays the update status of the DS app, if any.

.. figure:: images/040-RHC-update-DS-phone.png
:alt: Update Status of Phone
:width: 80%
:align: center

Updating the Driver Hub
Update Status of Smartphone

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

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

After install, drag the DS app icon from the app menu to the Driver
Hub’s home screen, if needed.
After install, drag the DS app icon from the app menu to the phone’s
home screen.

You may now unplug the Driver Hub from the computer, and close the RHC
You may now unplug the DS phone from the computer, and close the RHC
app. The updated DS app is ready to use.

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

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

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

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

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

4. On the Driver Hub, navigate to the Downloads folder. This can be done
4. On the DS phone, navigate to the Downloads folder. This can be done
in several ways:

- at the main app menu (swipe up), touch the Files icon, then three
bars at top left
- at the main app menu (swipe up), touch the Files icon or the
Downloads icon (if present)

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

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

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

After install, drag the DS app icon from the menu to the Driver Hub’s
home screen, if needed.
After install, drag the DS app icon from the menu to the phone’s home
screen.

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

.. dropdown:: Method 3 - Software Manager

The REV Driver Hub has a built-in app called the Software Manager, which
can automatically update the DS app (and other related software). It
requires only an internet connection.

1. Close all apps, and open the Driver Hub’s Wi-Fi menu (in Settings, or
swipe down twice from top of home screen). Temporarily connect the
Driver Hub to the internet via Wi-Fi.

2. Open the Software Manager app at the Driver Hub home screen (left
image, below).

.. figure:: images/910-DH-double.png
:alt: REV Software Manager
:width: 80%
:align: center

REV Software Manager

3. The Software Manager will automatically check for any updates needed,
and display the results (right image, above). Click the grey box to
update the Driver Station (DS) app, if needed.

4. When all is complete, “Forget” the Wi-Fi network used for internet
access.

Done! Now the Driver Hub is updated and ready for use.

Questions, comments and corrections to [email protected]

Loading

0 comments on commit 7ffe7a4

Please sign in to comment.