From 2d2abb5eb446a7e38837321158ce885193a5c857 Mon Sep 17 00:00:00 2001 From: Miriam Sinton-Remes Date: Thu, 1 Aug 2024 20:59:24 -0400 Subject: [PATCH 1/9] De-emphasized phones for app updates --- .../updating/ds_app/Updating-the-DS-App.rst | 207 +++++++------- .../updating/rc_app/Updating-the-RC-App.rst | 262 +++++++++--------- 2 files changed, 233 insertions(+), 236 deletions(-) diff --git a/docs/source/ftc_sdk/updating/ds_app/Updating-the-DS-App.rst b/docs/source/ftc_sdk/updating/ds_app/Updating-the-DS-App.rst index 73e4e82f..8bac9141 100644 --- a/docs/source/ftc_sdk/updating/ds_app/Updating-the-DS-App.rst +++ b/docs/source/ftc_sdk/updating/ds_app/Updating-the-DS-App.rst @@ -5,61 +5,55 @@ The Driver Station App is one of the Apps provided with the *FIRST* Tech Challenge :doc:`Software Development Kit (SDK) `. 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 ` 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 - ` - 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! @@ -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 @@ -110,23 +104,23 @@ 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) @@ -134,52 +128,84 @@ of the programming language/environment used to program robot Team Code. 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 ` 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 + ` + 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 Phone Simply click the blue Update rectangle (green arrow) – done! @@ -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 @@ -230,23 +256,23 @@ 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) @@ -254,39 +280,10 @@ of the programming language/environment used to program robot Team Code. 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 westsiderobotics@verizon.net diff --git a/docs/source/ftc_sdk/updating/rc_app/Updating-the-RC-App.rst b/docs/source/ftc_sdk/updating/rc_app/Updating-the-RC-App.rst index 7ffdd300..7882ef49 100644 --- a/docs/source/ftc_sdk/updating/rc_app/Updating-the-RC-App.rst +++ b/docs/source/ftc_sdk/updating/rc_app/Updating-the-RC-App.rst @@ -10,8 +10,8 @@ communicates with the Driver Station App to control the robot. This page shows how to update the Robot Controller (RC) app on these devices: -- An approved Android RC smartphone - REV Control Hub +- An approved Android RC smartphone Blocks / OnBot Java vs Android Studio ------------------------------------- @@ -71,134 +71,6 @@ These instructions are for independently updating the RC App in situations where such an independent update is supported - i.e. Blocks or OnBot Java development. Expand the following instructions that apply to your Robot Controller hardware: -.. dropdown:: Robot Controller (RC) app on Android phone - - Here are 2 methods to update the RC app on a Robot Controller (RC) - phone: - - 1. REV Hardware Client (RHC) - 2. “Side loading” with APK - - .. note:: - The Manage page, under Program and Manage, on a computer or Driver - Station device, **does not** offer updating an RC app on a connected - Robot Controller phone. - - .. dropdown:: Method 1 - REV Hardware Client - Windows computers only - - Plug the RC 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 RC 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 - ` - the required DS update file was previously downloaded. - - The RHC app will recognize the phone, as shown here: - - .. figure:: images/080-RHC-recognize-RC-phone.png - :alt: Recognizing the Phone - :width: 80% - :align: center - - Recognizing the Phone - - If the phone is not recognized, ensure that the phone has :doc:`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. - - 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/082-RHC-update-RC-phone.png - :alt: Update Status of Phone - :width: 80% - :align: center - - Update Status of Phone - - Simply click the blue Update rectangle (green arrow) – done! - - The update was fast, because you had already downloaded the RC app to - the RHC. That was noted with ’(Already Downloaded)“, to the left of the - blue Update rectangle. - - You could have selected an **older** version of the RC app, in the - drop-down list just above the blue Update rectangle. - - After install, drag the RC app icon from the menu to the phone’s home - screen. - - You may now unplug the RC phone from the computer, and close the RHC - app. The updated RC app is ready to use. - - .. dropdown:: Method 2 - Side-load - - Here you will work directly with the Android Package or **APK file** to - install the RC 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 - navigate to the `SDK github - repository `__. - - .. figure:: images/050-FTC-repo.png - :alt: SDK GitHub Repo - :width: 80% - :align: center - - SDK GitHub Repo - - At the right side under “Releases”, click the “Latest” icon (yellow - oval, above). - - In the next page, scroll down slightly in the “Latest” section, to the - short list of “Assets”. Click on the file - “FtcRobotController-release.apk”, to download it to your computer. - - .. figure:: images/090-github-assets-RC.png - :alt: SDK GitHub Releases - :width: 80% - :align: center - - SDK GitHub Releases - - At this time, you could rename the file to reflect its current version - number. For example, ``FtcRobotController-release-8.0.apk`` or simply - ``RC-8.0-release.apk``. This distinguishes the file from other versions - that might be stored later on that RC phone. - - 2. Transfer the APK file from the computer to the RC phone’s Downloads - (or Download) folder. Use a USB data cable (not a charge-only cable). - When complete, you may unplug the RC phone from the computer. - - 3. Uninstall the existing (obsolete) RC app, by dragging its icon to a - Trash/Uninstall icon. Or, touch and hold the RC icon for “App info”, - then choose Uninstall. - - 4. On the RC phone, 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) - - use the basic file manager in Settings/Storage: touch 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 RC app. - - After install, drag the RC app icon from the app menu to the RC phone’s - home screen. - - Done! The updated RC app is now ready to use. - .. dropdown:: Robot Controller (RC) app on REV Control Hub Here are 3 methods to update the RC app on a REV Control Hub: @@ -300,14 +172,14 @@ Expand the following instructions that apply to your Robot Controller hardware: When the completion message appears, the updated RC app is ready to use. - .. dropdown:: Method 3 - Manage page on DS phone or Driver Hub + .. dropdown:: Method 3 - Manage page on Driver Hub or DS phone This method can be used if your computer is unavailable or unable to connect via Wi-Fi to the Control Hub. For example, your desktop computer might have only a wired (Ethernet) network port, lacking Wi-Fi. But this method does require the RC APK file to be stored in the - Download (or Downloads) folder on the DS phone or Driver Hub. That’s + Download (or Downloads) folder on the Driver Hub or DS phone. That’s correct: **Robot Controller APK** stored on the **Driver Station** device. @@ -345,6 +217,134 @@ Expand the following instructions that apply to your Robot Controller hardware: When the completion message appears, the updated RC app is ready to use. +.. dropdown:: Robot Controller (RC) app on Android phone + + Here are 2 methods to update the RC app on a Robot Controller (RC) + phone: + + 1. REV Hardware Client (RHC) + 2. “Side loading” with APK + + .. note:: + The Manage page, under Program and Manage, on a computer or Driver + Station device, **does not** offer updating an RC app on a connected + Robot Controller phone. + + .. dropdown:: Method 1 - REV Hardware Client - Windows computers only + + Plug the RC 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 RC 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 + ` + the required DS update file was previously downloaded. + + The RHC app will recognize the phone, as shown here: + + .. figure:: images/080-RHC-recognize-RC-phone.png + :alt: Recognizing the Phone + :width: 80% + :align: center + + Recognizing the Phone + + If the phone is not recognized, ensure that the phone has :doc:`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. + + 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/082-RHC-update-RC-phone.png + :alt: Update Status of Phone + :width: 80% + :align: center + + Update Status of Phone + + Simply click the blue Update rectangle (green arrow) – done! + + The update was fast, because you had already downloaded the RC app to + the RHC. That was noted with ’(Already Downloaded)“, to the left of the + blue Update rectangle. + + You could have selected an **older** version of the RC app, in the + drop-down list just above the blue Update rectangle. + + After install, drag the RC app icon from the menu to the phone’s home + screen. + + You may now unplug the RC phone from the computer, and close the RHC + app. The updated RC app is ready to use. + + .. dropdown:: Method 2 - Side-load + + Here you will work directly with the Android Package or **APK file** to + install the RC 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 + navigate to the `SDK github + repository `__. + + .. figure:: images/050-FTC-repo.png + :alt: SDK GitHub Repo + :width: 80% + :align: center + + SDK GitHub Repo + + At the right side under “Releases”, click the “Latest” icon (yellow + oval, above). + + In the next page, scroll down slightly in the “Latest” section, to the + short list of “Assets”. Click on the file + “FtcRobotController-release.apk”, to download it to your computer. + + .. figure:: images/090-github-assets-RC.png + :alt: SDK GitHub Releases + :width: 80% + :align: center + + SDK GitHub Releases + + At this time, you could rename the file to reflect its current version + number. For example, ``FtcRobotController-release-8.0.apk`` or simply + ``RC-8.0-release.apk``. This distinguishes the file from other versions + that might be stored later on that RC phone. + + 2. Transfer the APK file from the computer to the RC phone’s Downloads + (or Download) folder. Use a USB data cable (not a charge-only cable). + When complete, you may unplug the RC phone from the computer. + + 3. Uninstall the existing (obsolete) RC app, by dragging its icon to a + Trash/Uninstall icon. Or, touch and hold the RC icon for “App info”, + then choose Uninstall. + + 4. On the RC phone, 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) + - use the basic file manager in Settings/Storage: touch 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 RC app. + + After install, drag the RC app icon from the app menu to the RC phone’s + home screen. + + Done! The updated RC app is now ready to use. + Other descriptions of updating the RC app are `at REV Robotics’ excellent documentation site `__. From 7aa665596907cf30fe68cd4d948ef6cc78228a6e Mon Sep 17 00:00:00 2001 From: Miriam Sinton-Remes Date: Mon, 2 Sep 2024 15:14:28 -0400 Subject: [PATCH 2/9] Added references to the Control Hub for the color sensors config --- .../configuring_color_sensor/configuring-color-sensor.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/hardware_and_software_configuration/configuring/configuring_color_sensor/configuring-color-sensor.rst b/docs/source/hardware_and_software_configuration/configuring/configuring_color_sensor/configuring-color-sensor.rst index e99e2218..0823fd68 100644 --- a/docs/source/hardware_and_software_configuration/configuring/configuring_color_sensor/configuring-color-sensor.rst +++ b/docs/source/hardware_and_software_configuration/configuring/configuring_color_sensor/configuring-color-sensor.rst @@ -19,10 +19,10 @@ configuration screen for this I2C bus. | -The Expansion Hub has four independent I2C buses, labeled "0" through "3". In this example, since you connected the Color Sensor to the port labeled "0", it resides on I2C Bus 0. +The Control Hub or Expansion Hub has four independent I2C buses, labeled "0" through "3". In this example, since you connected the Color Sensor to the port labeled "0", it resides on I2C Bus 0. 2. Look at the **I2C Bus 0** screen. There should already be a sensor -configured for this bus. The Expansion Hub has its own built-in +configured for this bus. The Control Hub or Expansion Hub has its own built-in inertial measurement unit (IMU) sensor. This sensor can be used to determine the orientation of a robot, as well as measure the accelerations on a robot. @@ -32,7 +32,7 @@ accelerations on a robot. | -The built-in IMU is internally connected to I2C Bus 0 on each Expansion Hub. Whenever you configure an Expansion Hub using the Robot Controller, the app automatically configures the IMU for I2C Bus 0. You will need to add another I2C device for this bus to be able to configure the color sensor. +The built-in IMU is internally connected to I2C Bus 0 on each Control Hub or Expansion Hub. Whenever you configure a Control Hub or Expansion Hub using the Robot Controller, the app automatically configures the IMU for I2C Bus 0. You will need to add another I2C device for this bus to be able to configure the color sensor. 3. Press the **Add** button to add another I2C device to this bus. From a4f907c41e56a648bdfaafc42171d72b591559de Mon Sep 17 00:00:00 2001 From: Miriam Sinton-Remes Date: Mon, 2 Sep 2024 15:18:27 -0400 Subject: [PATCH 3/9] Added references to the Control Hub for sensors in blocks --- .../blocks/using_sensors/Using-Sensors-(Blocks).rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/programming_resources/tutorial_specific/blocks/using_sensors/Using-Sensors-(Blocks).rst b/docs/source/programming_resources/tutorial_specific/blocks/using_sensors/Using-Sensors-(Blocks).rst index 26696607..73407d5f 100644 --- a/docs/source/programming_resources/tutorial_specific/blocks/using_sensors/Using-Sensors-(Blocks).rst +++ b/docs/source/programming_resources/tutorial_specific/blocks/using_sensors/Using-Sensors-(Blocks).rst @@ -114,14 +114,14 @@ determine if the button on the sensor is currently pressed or not. | -The Expansion Hub digital ports contain two digital pins per port. When -you use a 4-wire JST cable to connect a REV Robotics Touch sensor to an +The Control Hub or Expansion Hub digital ports contain two digital pins per port. When +you use a 4-wire JST cable to connect a REV Robotics Touch sensor to a Control Hub or Expansion Hub digital port, the Touch Sensor is wired to the second of the two digital pins within the port. The first digital pin of the 4-wire cable remains disconnected. For example, if you connect a Touch Sensor to the "0,1" digital port of -the Expansion Hub, the Touch Sensor will be connected to the second pin +the Control Hub or Expansion Hub, the Touch Sensor will be connected to the second pin (labeled "1") of the port. The first pin (labeled "0") will stay disconnected. From a630dc39d655402a449ce2ea8eeaf560e0ccc5b3 Mon Sep 17 00:00:00 2001 From: Miriam Sinton-Remes Date: Mon, 2 Sep 2024 15:28:39 -0400 Subject: [PATCH 4/9] Added links to documentation for Control and Driver hubs --- .../blocks_reference/Blocks-Reference-Material.rst | 12 ++++++++++++ .../OnBot-Java-Reference-Info.rst | 12 ++++++++++++ 2 files changed, 24 insertions(+) diff --git a/docs/source/programming_resources/tutorial_specific/blocks/blocks_reference/Blocks-Reference-Material.rst b/docs/source/programming_resources/tutorial_specific/blocks/blocks_reference/Blocks-Reference-Material.rst index 929a373e..4a1f7413 100644 --- a/docs/source/programming_resources/tutorial_specific/blocks/blocks_reference/Blocks-Reference-Material.rst +++ b/docs/source/programming_resources/tutorial_specific/blocks/blocks_reference/Blocks-Reference-Material.rst @@ -39,8 +39,20 @@ The technology forum can be found at the following address: - https://ftc-community.firstinspires.org +REV Robotics Control Hub Documentation +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +`REV Robotics Control Hub Getting Started +Guide `__ + REV Robotics Expansion Hub Documentation ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ `REV Robotics Expansion Hub Getting Started Guide `__ + +REV Robotics Driver Hub Documentation +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +`REV Robotics Driver Hub Getting Started +Guide `__ diff --git a/docs/source/programming_resources/tutorial_specific/onbot_java/onbot_java_reference/OnBot-Java-Reference-Info.rst b/docs/source/programming_resources/tutorial_specific/onbot_java/onbot_java_reference/OnBot-Java-Reference-Info.rst index 76a82a7b..3a52b5ed 100644 --- a/docs/source/programming_resources/tutorial_specific/onbot_java/onbot_java_reference/OnBot-Java-Reference-Info.rst +++ b/docs/source/programming_resources/tutorial_specific/onbot_java/onbot_java_reference/OnBot-Java-Reference-Info.rst @@ -38,10 +38,22 @@ The technology forum can be found at the following address: - http://ftc-community.firstinspires.org +REV Robotics Control Hub Documentation +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +`REV Robotics Control Hub Getting Started +Guide `__ + REV Robotics Expansion Hub Documentation ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ `REV Robotics Expansion Hub Getting Started Guide `__ +REV Robotics Driver Hub Documentation +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +`REV Robotics Driver Hub Getting Started +Guide `__ + From 94e1a80142934f07d9fcb76a250449543f7860da Mon Sep 17 00:00:00 2001 From: Miriam Sinton-Remes Date: Mon, 2 Sep 2024 15:32:42 -0400 Subject: [PATCH 5/9] Added references to the Control Hub for OBJ and AS sensor pages --- .../using_sensors/Using-Sensors-(Android-Studio).rst | 8 ++++---- .../using_sensors/Using-Sensors-(OnBot-Java).rst | 8 ++++---- 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/source/programming_resources/tutorial_specific/android_studio/using_sensors/Using-Sensors-(Android-Studio).rst b/docs/source/programming_resources/tutorial_specific/android_studio/using_sensors/Using-Sensors-(Android-Studio).rst index 11d5ed2a..d424759f 100644 --- a/docs/source/programming_resources/tutorial_specific/android_studio/using_sensors/Using-Sensors-(Android-Studio).rst +++ b/docs/source/programming_resources/tutorial_specific/android_studio/using_sensors/Using-Sensors-(Android-Studio).rst @@ -39,7 +39,7 @@ Touch Sensor ~~~~~~~~~~~~ The REV Robotics Touch Sensor can be connected to a digital port on the -Expansion Hub. The Touch Sensor is HIGH (returns TRUE) when it is not +Control Hub or Expansion Hub. The Touch Sensor is HIGH (returns TRUE) when it is not pressed. It is pulled LOW (returns FALSE) when it is pressed. .. image:: images/REVTouchSensor.jpg @@ -47,14 +47,14 @@ pressed. It is pulled LOW (returns FALSE) when it is pressed. | -The Expansion Hub digital ports contain two digital pins per port. When -you use a 4-wire JST cable to connect a REV Robotics Touch sensor to an +The Control Hub or Expansion Hub digital ports contain two digital pins per port. When +you use a 4-wire JST cable to connect a REV Robotics Touch sensor to a Control Hub or Expansion Hub digital port, the Touch Sensor is wired to the second of the two digital pins within the port. The first digital pin of the 4-wire cable remains disconnected. For example, if you connect a Touch Sensor to the "0,1" digital port of -the Expansion Hub, the Touch Sensor will be connected to the second pin +the Control Hub or Expansion Hub, the Touch Sensor will be connected to the second pin (labeled "1") of the port. The first pin (labeled "0") will stay disconnected. diff --git a/docs/source/programming_resources/tutorial_specific/onbot_java/using_sensors/Using-Sensors-(OnBot-Java).rst b/docs/source/programming_resources/tutorial_specific/onbot_java/using_sensors/Using-Sensors-(OnBot-Java).rst index f485a3ca..e917caed 100644 --- a/docs/source/programming_resources/tutorial_specific/onbot_java/using_sensors/Using-Sensors-(OnBot-Java).rst +++ b/docs/source/programming_resources/tutorial_specific/onbot_java/using_sensors/Using-Sensors-(OnBot-Java).rst @@ -38,7 +38,7 @@ Touch Sensor ~~~~~~~~~~~~ The REV Robotics Touch Sensor can be connected to a digital port on the -Expansion Hub. The Touch Sensor is HIGH (returns TRUE) when it is not +Control Hub or Expansion Hub. The Touch Sensor is HIGH (returns TRUE) when it is not pressed. It is pulled LOW (returns FALSE) when it is pressed. .. image:: images/REVTouchSensor.jpg @@ -46,14 +46,14 @@ pressed. It is pulled LOW (returns FALSE) when it is pressed. | -The Expansion Hub digital ports contain two digital pins per port. When -you use a 4-wire JST cable to connect a REV Robotics Touch sensor to an +The Control Hub or Expansion Hub digital ports contain two digital pins per port. When +you use a 4-wire JST cable to connect a REV Robotics Touch sensor to a Control Hub or Expansion Hub digital port, the Touch Sensor is wired to the second of the two digital pins within the port. The first digital pin of the 4-wire cable remains disconnected. For example, if you connect a Touch Sensor to the "0,1" digital port of -the Expansion Hub, the Touch Sensor will be connected to the second pin +the Control Hub or Expansion Hub, the Touch Sensor will be connected to the second pin (labeled "1") of the port. The first pin (labeled "0") will stay disconnected. From 4c3e74006ec550fa529e94a5a5f486d12ccbdd29 Mon Sep 17 00:00:00 2001 From: Miriam Sinton-Remes Date: Mon, 2 Sep 2024 15:47:53 -0400 Subject: [PATCH 6/9] Added references to the Control Hub in PID/PIDF pages --- .../pid_coefficients/pid-coefficients.rst | 18 +++++++++--------- .../pidf_coefficients/pidf-coefficients.rst | 18 +++++++++--------- 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/source/programming_resources/shared/pid_coefficients/pid-coefficients.rst b/docs/source/programming_resources/shared/pid_coefficients/pid-coefficients.rst index a4a96a54..35ac19f9 100644 --- a/docs/source/programming_resources/shared/pid_coefficients/pid-coefficients.rst +++ b/docs/source/programming_resources/shared/pid_coefficients/pid-coefficients.rst @@ -1,7 +1,7 @@ Changing PID Coefficients ========================== -The REV Robotics Expansion Hub allows a user to change the PID +The REV Robotics Control Hub and REV Robotics Expansion Hub allow a user to change the PID coefficients used for closed loop motor control. The PID coefficients are channel and mode specific. Note that the Modern Robotics and Hitechnic DC motor controllers do not support adjustable PID @@ -14,9 +14,9 @@ setPIDCoefficients method of the DcMotorEx class to change the values. This method is not available with the standard DcMotor class. Note that changes made to the PID coefficients do not persist if you -power cycle the REV Robotics Expansion Hub. If you need your changes to +power cycle the REV Robotics Control Hub or REV Robotics Expansion Hub. If you need your changes to the PID to persist, you should consider modifying your op mode to store -state information on the Android phone. The Android Developer website +state information on the Control Hub or Android phone. The Android Developer website has a tutorial on how to save data from your app onto an Android device `here `__ @@ -32,9 +32,9 @@ has a tutorial on how to save data from your app onto an Android device /** * Created by tom on 9/26/17. - * This assumes that you are using a REV Robotics Expansion Hub + * This assumes that you are using a REV Robotics Control Hub or REV Robotics Expansion Hub * as your DC motor controller. This op mode uses the extended/enhanced - * PID-related functions of the DcMotorEx class. The REV Robotics Expansion Hub + * PID-related functions of the DcMotorEx class. The REV Robotics Control Hub or REV Robotics Expansion Hub * supports the extended motor functions, but other controllers (such as the * Modern Robotics and Hitechnic DC Motor Controllers) do not. */ @@ -51,7 +51,7 @@ has a tutorial on how to save data from your app onto an Android device public void runOpMode() { // get reference to DC motor. - // since we are using the Expansion Hub, + // since we are using the Control Hub or Expansion Hub, // cast this motor to a DcMotorEx object. motorExLeft = (DcMotorEx)hardwareMap.get(DcMotor.class, "left_drive"); @@ -98,10 +98,10 @@ methods of the DcMotorControllerEx class: /** * Created by tom on 9/26/17. - * This assumes that you are using a REV Robotics Expansion Hub + * This assumes that you are using a REV Robotics Control Hub or REV Robotics Expansion Hub * as your DC motor controller. This op mode uses the extended/enhanced * PID-related functions of the DcMotorControllerEx class. - * The REV Robotics Expansion Hub supports the extended motor controller + * The REV Robotics Control Hub or REV Robotics Expansion Hub supports the extended motor controller * functions, but other controllers (such as the Modern Robotics and * Hitechnic DC Motor Controllers) do not. */ @@ -124,7 +124,7 @@ methods of the DcMotorControllerEx class: waitForStart(); // get a reference to the motor controller and cast it as an extended functionality controller. - // we assume it's a REV Robotics Expansion Hub (which supports the extended controller functions). + // we assume it's a REV Robotics Control Hub or REV Robotics Expansion Hub (which supports the extended controller functions). DcMotorControllerEx motorControllerEx = (DcMotorControllerEx)motorLeft.getController(); // get the port number of our configured motor. diff --git a/docs/source/programming_resources/shared/pidf_coefficients/pidf-coefficients.rst b/docs/source/programming_resources/shared/pidf_coefficients/pidf-coefficients.rst index 9b8edd71..3099b573 100644 --- a/docs/source/programming_resources/shared/pidf_coefficients/pidf-coefficients.rst +++ b/docs/source/programming_resources/shared/pidf_coefficients/pidf-coefficients.rst @@ -1,7 +1,7 @@ Changing PIDF Coefficients =========================== -The REV Robotics Expansion Hub allows a user to change the PIDF +The REV Robotics Control Hub or REV Robotics Expansion Hub allows a user to change the PIDF coefficients used for closed loop motor control. The PIDF coefficients are specific to each channel (motor port) and to each RunMode. @@ -12,9 +12,9 @@ uses the setPIDFCoefficients method of the DcMotorEx class to change the values. This method is not available with the standard DcMotor class. Note that changes made to the PIDF coefficients do not persist if you -power cycle the REV Robotics Expansion Hub. If you need your changes to +power cycle the REV Robotics Control Hub or REV Robotics Expansion Hub. If you need your changes to persist, consider modifying your OpMode to store state information on -the Android phone. The Android Developer website has a tutorial on how +the Control Hub Android phone. The Android Developer website has a tutorial on how to save data from your app onto an Android device `here `__ @@ -30,9 +30,9 @@ to save data from your app onto an Android device /** * Created by Tom on 9/26/17. Updated 9/24/2021 for PIDF. - * This assumes that you are using a REV Robotics Expansion Hub + * This assumes that you are using a REV Robotics Control Hub or REV Robotics Expansion Hub * as your DC motor controller. This OpMode uses the extended/enhanced - * PIDF-related functions of the DcMotorEx class. The REV Robotics Expansion Hub + * PIDF-related functions of the DcMotorEx class. The REV Robotics Control Hub or REV Robotics Expansion Hub * supports the extended motor functions, but other controllers (such as the * deprecated Modern Robotics and Hitechnic DC Motor Controllers) do not. */ @@ -52,7 +52,7 @@ to save data from your app onto an Android device public void runOpMode() { // Get reference to DC motor. - // Since we are using the Expansion Hub, + // Since we are using the Control Hub or Expansion Hub, // cast this motor to a DcMotorEx object. motorExLeft = (DcMotorEx)hardwareMap.get(DcMotor.class, "left_drive"); @@ -99,10 +99,10 @@ way to adjust the PIDF coefficients is to use the extended/enhanced /** * Created by Tom on 9/26/17. Updated 9/24/2021 for PIDF. - * This assumes that you are using a REV Robotics Expansion Hub + * This assumes that you are using a REV Robotics Control Hub or REV Robotics Expansion Hub * as your DC motor controller. This OpMode uses the extended/enhanced * PIDF-related functions of the DcMotorControllerEx class. - * The REV Robotics Expansion Hub supports the extended motor controller + * The REV Robotics Control Hub or REV Robotics Expansion Hub supports the extended motor controller * functions, but other controllers (such as the deprecated Modern Robotics * and Hitechnic DC Motor Controllers) do not. */ @@ -128,7 +128,7 @@ way to adjust the PIDF coefficients is to use the extended/enhanced waitForStart(); // Get a reference to the motor controller and cast it as an extended functionality controller. - // We assume it's a REV Robotics Expansion Hub, which supports the extended controller functions. + // We assume it's a REV Robotics Control Hub or REV Robotics Expansion Hub, which supports the extended controller functions. DcMotorControllerEx motorControllerEx = (DcMotorControllerEx)motorLeft.getController(); // Get the port number of our configured motor. From 9484ad4a1ab220c1288089dc89ca68a64594c0f3 Mon Sep 17 00:00:00 2001 From: Miriam Sinton-Remes Date: Mon, 2 Sep 2024 15:48:38 -0400 Subject: [PATCH 7/9] Fixed a typo --- .../shared/pidf_coefficients/pidf-coefficients.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/programming_resources/shared/pidf_coefficients/pidf-coefficients.rst b/docs/source/programming_resources/shared/pidf_coefficients/pidf-coefficients.rst index 3099b573..f9882a3e 100644 --- a/docs/source/programming_resources/shared/pidf_coefficients/pidf-coefficients.rst +++ b/docs/source/programming_resources/shared/pidf_coefficients/pidf-coefficients.rst @@ -14,7 +14,7 @@ values. This method is not available with the standard DcMotor class. Note that changes made to the PIDF coefficients do not persist if you power cycle the REV Robotics Control Hub or REV Robotics Expansion Hub. If you need your changes to persist, consider modifying your OpMode to store state information on -the Control Hub Android phone. The Android Developer website has a tutorial on how +the Control Hub or Android phone. The Android Developer website has a tutorial on how to save data from your app onto an Android device `here `__ From bfc405c24e49a16573984c2de9ce47f54ab3513f Mon Sep 17 00:00:00 2001 From: Miriam Sinton-Remes Date: Tue, 3 Sep 2024 10:50:03 -0400 Subject: [PATCH 8/9] Swapped the control hub and phone sections for creating a config --- .../getting_started/getting-started.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/source/hardware_and_software_configuration/configuring/getting_started/getting-started.rst b/docs/source/hardware_and_software_configuration/configuring/getting_started/getting-started.rst index 06059533..cc7704d5 100644 --- a/docs/source/hardware_and_software_configuration/configuring/getting_started/getting-started.rst +++ b/docs/source/hardware_and_software_configuration/configuring/getting_started/getting-started.rst @@ -1,9 +1,8 @@ Getting Started =============== - -Getting a Smartphone Robot Controller Ready -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +Creating a Configuration +~~~~~~~~~~~~~~~~~~~~~~~~ Before you can communicate with the motor, servo and sensors that are connected to the Control Hub or Expansion Hub, you first must create a @@ -11,6 +10,13 @@ configuration file on your Robot Controller, so that the Robot Controller will know what hardware is available on the Control Hub's or Expansion Hub's external ports. +Getting the Control Hub Ready +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +If you are using a Control Hub, you do not need to make any additional +connections. You simply need to make sure that the Control Hub is +powered on and paired to the DRIVER STATION. + Connecting an Android Smartphone to an Expansion Hub ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -75,12 +81,6 @@ Expansion Hub) with the Robot Controller app. Controller app might not reliably connect to this Expansion Hub the next time you turn your system on. -Getting the Control Hub Ready -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -If you are using a Control Hub, you do not need to make any additional -connections. You simply need to make sure that the Control Hub is -powered on and paired to the DRIVER STATION. Creating a Configuration File Using the DRIVER STATION ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ From 50d33de7e1750e9f4db9c973618dc06e05ea84bb Mon Sep 17 00:00:00 2001 From: Miriam Sinton-Remes Date: Wed, 18 Sep 2024 11:01:57 -0400 Subject: [PATCH 9/9] Updated the webcam page for phones --- .../configuring-uvc-camera.rst | 20 ++++++++++--------- .../configuring/index.rst | 2 +- 2 files changed, 12 insertions(+), 10 deletions(-) diff --git a/docs/source/hardware_and_software_configuration/configuring/configuring_uvc_camera/configuring-uvc-camera.rst b/docs/source/hardware_and_software_configuration/configuring/configuring_uvc_camera/configuring-uvc-camera.rst index 1345557b..076e81d3 100644 --- a/docs/source/hardware_and_software_configuration/configuring/configuring_uvc_camera/configuring-uvc-camera.rst +++ b/docs/source/hardware_and_software_configuration/configuring/configuring_uvc_camera/configuring-uvc-camera.rst @@ -4,11 +4,11 @@ Configuring an External UVC Camera and a Powered USB Hub Introduction ------------ -Game rules and in the Game Manual Part 1 have been modified to allow the -use of USB Video Class (UVC) Compatible Cameras for computer -vision-related tasks. Teams have the option of using an externally -connected camera instead of the Android smartphone’s built-in camera for -computer vision tasks. +The Competition Manual allows the use of USB Video Class (UVC) compatible +cameras for computer vision-related tasks. See rule R715 for the full details. +Teams who are using an Android smartphone as their ROBOT CONTROLLER have the +option of using an externally connected camera instead of the built-in camera +for computer vision tasks. The advantage of using an external camera is that the camera can be mounted in a location that is convenient for vision-related tasks while @@ -56,11 +56,13 @@ Note that the Modern Robotics Core Power Distribution Module cannot be used for this task since its data transfer speed is not fast enough to work with the USB-connected webcam. -Also note that rule c(iii) permits the use of a powered USB hub to make -this connection. If a team uses a powered USB hub, the power to operate -the USB hub can only come from either of the following sources: +Also note that the Competition Manual permits the use of a powered USB +hub to make this connection. See rule R617 for the full details. If a +team uses a powered USB hub, the power to operate the USB hub can only +come from either of the following sources: -1. An externally connected USB 5V Battery Pack. +1. An externally connected COTS USB Battery Pack in compliance with the + Competition Manual. See rule R602 for the full details. 2. The 5V DC Aux power port of a REV Robotics Expansion Hub (note that this requires advanced skills to implement). diff --git a/docs/source/hardware_and_software_configuration/configuring/index.rst b/docs/source/hardware_and_software_configuration/configuring/index.rst index ad36a316..4ced685e 100644 --- a/docs/source/hardware_and_software_configuration/configuring/index.rst +++ b/docs/source/hardware_and_software_configuration/configuring/index.rst @@ -12,8 +12,8 @@ such that you may use them in your own projects. configuring_servo/configuring-servo configuring_color_sensor/configuring-color-sensor configuring_digital_touch_sensor/configuring-digital-touch-sensor - configuring_uvc_camera/configuring-uvc-camera configuring_external_webcam/configuring-external-webcam + configuring_uvc_camera/configuring-uvc-camera configuring_dual_hubs/configuring-dual-hubs managing_esd/managing-esd saving_config/saving-config \ No newline at end of file