From bb5423db628613e95f8c71dd640c9ad0fc402210 Mon Sep 17 00:00:00 2001 From: Sean Krueger <71362472+skrueger-ftc@users.noreply.github.com> Date: Thu, 26 Oct 2023 16:14:01 +0000 Subject: [PATCH 1/9] Modernize Control Systems page --- .../power-and-electronics/control-system.rst | 41 +++++++++++-------- 1 file changed, 23 insertions(+), 18 deletions(-) diff --git a/source/docs/power-and-electronics/control-system.rst b/source/docs/power-and-electronics/control-system.rst index 65ebf471..43d50281 100644 --- a/source/docs/power-and-electronics/control-system.rst +++ b/source/docs/power-and-electronics/control-system.rst @@ -3,11 +3,11 @@ Control Systems =============== -The FTC control system is based on using Android phones as a ":term:`Robot Controller`" and a ":term:`Driver Station`." The ":term:`Robot Controller`" phone is mounted on the robot and connected by a USB cable to a special "Hub", which in turn is connected to motors, servos, and sensors. +The FTC control system is based around a “:term:`Robot Controller`” and a “:term:`Driver Station`.” The “:term:`Robot Controller`” is mounted on the robot and connected to a special “Hub”, which in turn is connected to motors, servos, and sensors. The :term:`Robot Controller` is linked to the :term:`Driver Station` through WiFi Direct. -The two major manufacturers of control hubs for FTC are Modern Robotics and REV; however, nearly all teams are shifting over to REV because it is cheaper, simpler, and more reliable. +REV Robotics is the sole manufacturer of legal FTC control systems. The REV Expansion Hub connects to motors, servos, sensors, and a :term:`Robot Controller`. A REV Control Hub has the functionality of an Expansion Hub but with a built in :term:`Robot Controller`. -More information about the FTC Control system can be found below: +More information about the FTC Control System can be found below: - `Official control system Wiki on GitHub `_ - `REV Control System Documentation `_ @@ -15,35 +15,40 @@ More information about the FTC Control system can be found below: There are two possible control systems that can be run on an FTC robot legally: +- REV Control Hub + REV Expansion Hub - :term:`RC Phone ` + REV Expansion Hub(s) -- REV Control Hub + REV Expansion Hub as it is less expensive and more reliable than the older Modern Robotics -RC Phone + REV Expansion Hub(s) -------------------------------- +.. important:: Beginning in the 2024-2025 season, :term:`RC Phones ` will no longer be legal to use as a Robot Controller. Teams will be required to use a REV Control Hub as their :term:`Robot Controller`. + +REV Control Hub + REV Expansion Hub +----------------------------------- .. warning:: It is of vital importance to update the firmware on REV Expansion hubs to at least version 1.8.2. It includes better protection against disconnects and improves program performance. See the `REV Expansion Hub firmware update docs`_. -This is the standard control system for teams starting out in FTC. The REV Expansion Hub is reliable, as long as proper strain relief and wiring is carried out. This includes the :term:`USB Retention Mount`, as well as 3D printing :term:`XT30` stress relief mounts. +This is the standard control system for teams starting out in FTC. -The Expansion Hub connects to the :term:`Robot Controller` phone through the mini USB port, and the :term:`RC ` phone is linked to the DS (:term:`Driver Station`) phone through WiFi Direct. For more information on setting up the Expansion Hub and configuring the robot, head to `REV Robotics' Technical Resources Expansion Hub Guide `_. +The Expansion Hub connects to the Control Hub through either the RS-485 port on both hubs or a USB-A port on the Control Hub to the mini USB port on the Expansion Hub. In either case, proper strain relief and cable management should be used. -- `USB Retention Mount `_ -- `XT30 Stress Relief `_ -- `REV Robotics Technical Resources `_ +For more information on setting up the Control Hub and configuring the robot, head to `REV Robotics' Technical Resources Control Hub Guide ` -.. image:: images/control-system/exh-wiring-diagram.jpg - :alt: A diagram of the RC Phone + Expansion Hub(s) control system +.. image:: images/control-system/ch-wiring-diagram.png + :alt: A diagram of the Control Hub + Expansion Hub control system :width: 100% -REV Control Hub + REV Expansion Hub ------------------------------------ +RC Phone + REV Expansion Hub(s) +------------------------------- .. warning:: It is of vital importance to update the firmware on REV Expansion hubs to at least version 1.8.2. It includes better protection against disconnects and improves program performance. See the `REV Expansion Hub firmware update docs`_. -Note: The Control Hub will be legal for all teams from the 2020-2021 FTC season onwards. In 2019-2020, the Control Hub was not legal for all teams as it was undergoing a pilot program. +The Expansion Hub connects to the :term:`Robot Controller` phone through the mini USB port. The REV Expansion Hub is reliable, as long as proper strain relief and wiring is carried out. This includes the :term:`USB Retention Mount`, as well as 3D printing :term:`XT30` stress relief mounts. -.. image:: images/control-system/ch-wiring-diagram.png - :alt: A diagram of the Control Hub + Expansion Hub control system +For more information on setting up the Expansion Hub and configuring the robot, head to `REV Robotics' Technical Resources Expansion Hub Guide `_. + +- `USB Retention Mount `_ +- `XT30 Stress Relief `_ + +.. image:: images/control-system/exh-wiring-diagram.jpg + :alt: A diagram of the RC Phone + Expansion Hub(s) control system :width: 100% .. _REV Expansion Hub firmware update docs: https://docs.revrobotics.com/duo-control/managing-the-control-system/updating-firmware From 4eb5496c23df6c74d0e1e9a15c317e172df23cab Mon Sep 17 00:00:00 2001 From: Sean Krueger <71362472+skrueger-ftc@users.noreply.github.com> Date: Thu, 26 Oct 2023 16:27:56 +0000 Subject: [PATCH 2/9] Use straight quotations --- source/docs/power-and-electronics/control-system.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/docs/power-and-electronics/control-system.rst b/source/docs/power-and-electronics/control-system.rst index 43d50281..e28a5c11 100644 --- a/source/docs/power-and-electronics/control-system.rst +++ b/source/docs/power-and-electronics/control-system.rst @@ -3,7 +3,7 @@ Control Systems =============== -The FTC control system is based around a “:term:`Robot Controller`” and a “:term:`Driver Station`.” The “:term:`Robot Controller`” is mounted on the robot and connected to a special “Hub”, which in turn is connected to motors, servos, and sensors. The :term:`Robot Controller` is linked to the :term:`Driver Station` through WiFi Direct. +The FTC control system is based around a ":term:`Robot Controller`" and a ":term:`Driver Station`." The :term:`Robot Controller` is mounted on the robot and connected to a special "Hub", which in turn is connected to motors, servos, and sensors. The :term:`Robot Controller` is linked to the :term:`Driver Station` through WiFi Direct. REV Robotics is the sole manufacturer of legal FTC control systems. The REV Expansion Hub connects to motors, servos, sensors, and a :term:`Robot Controller`. A REV Control Hub has the functionality of an Expansion Hub but with a built in :term:`Robot Controller`. From 1b52cc0da0bc30697b318855cb4652a30cbbcb5c Mon Sep 17 00:00:00 2001 From: Sean Krueger <71362472+skrueger-ftc@users.noreply.github.com> Date: Thu, 26 Oct 2023 18:11:32 +0000 Subject: [PATCH 3/9] fixup: Some minor grammar changes --- source/docs/power-and-electronics/control-system.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/docs/power-and-electronics/control-system.rst b/source/docs/power-and-electronics/control-system.rst index e28a5c11..49659a26 100644 --- a/source/docs/power-and-electronics/control-system.rst +++ b/source/docs/power-and-electronics/control-system.rst @@ -3,9 +3,9 @@ Control Systems =============== -The FTC control system is based around a ":term:`Robot Controller`" and a ":term:`Driver Station`." The :term:`Robot Controller` is mounted on the robot and connected to a special "Hub", which in turn is connected to motors, servos, and sensors. The :term:`Robot Controller` is linked to the :term:`Driver Station` through WiFi Direct. +The FTC control system is based around a ":term:`Robot Controller`" and a ":term:`Driver Station`". The :term:`Robot Controller` is mounted on the robot and connected to a special "Hub", which in turn is connected to motors, servos, and sensors. The :term:`Robot Controller` is linked to the :term:`Driver Station` through WiFi Direct. -REV Robotics is the sole manufacturer of legal FTC control systems. The REV Expansion Hub connects to motors, servos, sensors, and a :term:`Robot Controller`. A REV Control Hub has the functionality of an Expansion Hub but with a built in :term:`Robot Controller`. +REV Robotics is the sole manufacturer of legal FTC control systems. The REV Expansion Hub connects to motors, servos, sensors, and a :term:`Robot Controller`. A REV Control Hub has the functionality of an Expansion Hub but with a built-in :term:`Robot Controller`. More information about the FTC Control System can be found below: @@ -18,7 +18,7 @@ There are two possible control systems that can be run on an FTC robot legally: - REV Control Hub + REV Expansion Hub - :term:`RC Phone ` + REV Expansion Hub(s) -.. important:: Beginning in the 2024-2025 season, :term:`RC Phones ` will no longer be legal to use as a Robot Controller. Teams will be required to use a REV Control Hub as their :term:`Robot Controller`. +.. important:: Beginning in the 2024-2025 season, an :term:`RC Phone ` will no longer be legal to use as a Robot Controller. Teams will be required to use a REV Control Hub as their :term:`Robot Controller`. REV Control Hub + REV Expansion Hub ----------------------------------- From fe2283a3e9603b5683f10fb88150d388fb01f413 Mon Sep 17 00:00:00 2001 From: Sean Krueger <71362472+skrueger-ftc@users.noreply.github.com> Date: Thu, 26 Oct 2023 18:21:42 +0000 Subject: [PATCH 4/9] fixup: Use FTC Docs instead of github wiki --- source/docs/power-and-electronics/control-system.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/docs/power-and-electronics/control-system.rst b/source/docs/power-and-electronics/control-system.rst index 49659a26..fba93fc1 100644 --- a/source/docs/power-and-electronics/control-system.rst +++ b/source/docs/power-and-electronics/control-system.rst @@ -9,7 +9,7 @@ REV Robotics is the sole manufacturer of legal FTC control systems. The REV Expa More information about the FTC Control System can be found below: -- `Official control system Wiki on GitHub `_ +- `Official Control System docs on FTC Docs `_ - `REV Control System Documentation `_ - `Official troubleshooting guide `_ From f6684078070fa6a67ad4be518a9cdcf09f36752a Mon Sep 17 00:00:00 2001 From: Sean Krueger <71362472+skrueger-ftc@users.noreply.github.com> Date: Thu, 26 Oct 2023 19:45:02 +0000 Subject: [PATCH 5/9] fixup: Additional grammar changes --- source/docs/power-and-electronics/control-system.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/docs/power-and-electronics/control-system.rst b/source/docs/power-and-electronics/control-system.rst index fba93fc1..e11081af 100644 --- a/source/docs/power-and-electronics/control-system.rst +++ b/source/docs/power-and-electronics/control-system.rst @@ -3,9 +3,9 @@ Control Systems =============== -The FTC control system is based around a ":term:`Robot Controller`" and a ":term:`Driver Station`". The :term:`Robot Controller` is mounted on the robot and connected to a special "Hub", which in turn is connected to motors, servos, and sensors. The :term:`Robot Controller` is linked to the :term:`Driver Station` through WiFi Direct. +The FTC control system is based around a ":term:`Robot Controller`" and a ":term:`Driver Station`". The :term:`Robot Controller` is mounted on the robot and are connected to special "Hub(s)", which in turn connect to motors, servos, and sensors. The :term:`Robot Controller` is linked to the :term:`Driver Station` through WiFi Direct. -REV Robotics is the sole manufacturer of legal FTC control systems. The REV Expansion Hub connects to motors, servos, sensors, and a :term:`Robot Controller`. A REV Control Hub has the functionality of an Expansion Hub but with a built-in :term:`Robot Controller`. +REV Robotics is the sole manufacturer of legal FTC control systems. The REV Expansion Hub connects to motors, servos, sensors, and a :term:`Robot Controller`. A REV Control Hub has the same functionality of an Expansion Hub but with a built-in :term:`Robot Controller`. More information about the FTC Control System can be found below: @@ -27,7 +27,7 @@ REV Control Hub + REV Expansion Hub This is the standard control system for teams starting out in FTC. -The Expansion Hub connects to the Control Hub through either the RS-485 port on both hubs or a USB-A port on the Control Hub to the mini USB port on the Expansion Hub. In either case, proper strain relief and cable management should be used. +The Control Hub connects to the Expansion Hub through either a RS-485 port on both hubs or a USB-A port on the Control Hub to the mini USB port on the Expansion Hub. In either case, proper strain relief and cable management should be used. For more information on setting up the Control Hub and configuring the robot, head to `REV Robotics' Technical Resources Control Hub Guide ` From d5e07be4f3b7d167cc6df6a7b8bb4d62ababf913 Mon Sep 17 00:00:00 2001 From: Sean Krueger <71362472+skrueger-ftc@users.noreply.github.com> Date: Fri, 27 Oct 2023 15:22:47 +0000 Subject: [PATCH 6/9] fixup: Make link actually hyperlink --- source/docs/power-and-electronics/control-system.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/docs/power-and-electronics/control-system.rst b/source/docs/power-and-electronics/control-system.rst index e11081af..1902ea34 100644 --- a/source/docs/power-and-electronics/control-system.rst +++ b/source/docs/power-and-electronics/control-system.rst @@ -29,7 +29,7 @@ This is the standard control system for teams starting out in FTC. The Control Hub connects to the Expansion Hub through either a RS-485 port on both hubs or a USB-A port on the Control Hub to the mini USB port on the Expansion Hub. In either case, proper strain relief and cable management should be used. -For more information on setting up the Control Hub and configuring the robot, head to `REV Robotics' Technical Resources Control Hub Guide ` +For more information on setting up the Control Hub and configuring the robot, head to `REV Robotics' Technical Resources Control Hub Guide `_. .. image:: images/control-system/ch-wiring-diagram.png :alt: A diagram of the Control Hub + Expansion Hub control system From 18eb2e0c1decc0f5f70d5ea98f962407a89c6b3f Mon Sep 17 00:00:00 2001 From: Sean Krueger <71362472+skrueger-ftc@users.noreply.github.com> Date: Sat, 28 Oct 2023 10:35:14 -0500 Subject: [PATCH 7/9] fixup: Resolve suggested change Co-authored-by: Noah Andrews --- source/docs/power-and-electronics/control-system.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/docs/power-and-electronics/control-system.rst b/source/docs/power-and-electronics/control-system.rst index 1902ea34..e51de956 100644 --- a/source/docs/power-and-electronics/control-system.rst +++ b/source/docs/power-and-electronics/control-system.rst @@ -5,7 +5,7 @@ Control Systems The FTC control system is based around a ":term:`Robot Controller`" and a ":term:`Driver Station`". The :term:`Robot Controller` is mounted on the robot and are connected to special "Hub(s)", which in turn connect to motors, servos, and sensors. The :term:`Robot Controller` is linked to the :term:`Driver Station` through WiFi Direct. -REV Robotics is the sole manufacturer of legal FTC control systems. The REV Expansion Hub connects to motors, servos, sensors, and a :term:`Robot Controller`. A REV Control Hub has the same functionality of an Expansion Hub but with a built-in :term:`Robot Controller`. +REV Robotics is the sole manufacturer of legal FTC control system components. The REV Expansion Hub connects to motors, servos, sensors, and a :term:`Robot Controller`. A REV Control Hub has the same functionality of an Expansion Hub but with a built-in :term:`Robot Controller`. More information about the FTC Control System can be found below: From 29e74b9eb5325378e4c3bc129eaf4992fe227d7a Mon Sep 17 00:00:00 2001 From: abidingabi Date: Wed, 1 Nov 2023 22:24:59 -0400 Subject: [PATCH 8/9] Wording nits --- source/docs/power-and-electronics/control-system.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/source/docs/power-and-electronics/control-system.rst b/source/docs/power-and-electronics/control-system.rst index e51de956..d7b42b03 100644 --- a/source/docs/power-and-electronics/control-system.rst +++ b/source/docs/power-and-electronics/control-system.rst @@ -3,7 +3,7 @@ Control Systems =============== -The FTC control system is based around a ":term:`Robot Controller`" and a ":term:`Driver Station`". The :term:`Robot Controller` is mounted on the robot and are connected to special "Hub(s)", which in turn connect to motors, servos, and sensors. The :term:`Robot Controller` is linked to the :term:`Driver Station` through WiFi Direct. +The FTC control system is based around a ":term:`Robot Controller`" and a ":term:`Driver Station`". The :term:`Robot Controller` is mounted on the robot. It is either embedded within or connected to special "Hub(s)", which in turn connect to motors, servos, and sensors. The :term:`Robot Controller` is linked to the :term:`Driver Station` through WiFi Direct. REV Robotics is the sole manufacturer of legal FTC control system components. The REV Expansion Hub connects to motors, servos, sensors, and a :term:`Robot Controller`. A REV Control Hub has the same functionality of an Expansion Hub but with a built-in :term:`Robot Controller`. @@ -27,7 +27,7 @@ REV Control Hub + REV Expansion Hub This is the standard control system for teams starting out in FTC. -The Control Hub connects to the Expansion Hub through either a RS-485 port on both hubs or a USB-A port on the Control Hub to the mini USB port on the Expansion Hub. In either case, proper strain relief and cable management should be used. +The Control Hub connects to the Expansion Hub through either a RS-485 connection, or a USB-A (Control Hub side) to mini-USB (Expansion Hub-side) connection. In either case, proper strain relief and cable management should be used. For more information on setting up the Control Hub and configuring the robot, head to `REV Robotics' Technical Resources Control Hub Guide `_. @@ -40,7 +40,7 @@ RC Phone + REV Expansion Hub(s) .. warning:: It is of vital importance to update the firmware on REV Expansion hubs to at least version 1.8.2. It includes better protection against disconnects and improves program performance. See the `REV Expansion Hub firmware update docs`_. -The Expansion Hub connects to the :term:`Robot Controller` phone through the mini USB port. The REV Expansion Hub is reliable, as long as proper strain relief and wiring is carried out. This includes the :term:`USB Retention Mount`, as well as 3D printing :term:`XT30` stress relief mounts. +The Expansion Hub connects to the :term:`Robot Controller` phone through its mini USB port. The REV Expansion Hub is reliable, as long as proper strain relief and wiring is carried out. This includes the :term:`USB Retention Mount`, as well as 3D printing :term:`XT30` stress relief mounts. For more information on setting up the Expansion Hub and configuring the robot, head to `REV Robotics' Technical Resources Expansion Hub Guide `_. From 134516ea026d243e939e57811a843a3076699dd9 Mon Sep 17 00:00:00 2001 From: abidingabi Date: Wed, 1 Nov 2023 22:30:18 -0400 Subject: [PATCH 9/9] More wording nits --- source/docs/power-and-electronics/control-system.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/source/docs/power-and-electronics/control-system.rst b/source/docs/power-and-electronics/control-system.rst index d7b42b03..ab48fdae 100644 --- a/source/docs/power-and-electronics/control-system.rst +++ b/source/docs/power-and-electronics/control-system.rst @@ -3,13 +3,13 @@ Control Systems =============== -The FTC control system is based around a ":term:`Robot Controller`" and a ":term:`Driver Station`". The :term:`Robot Controller` is mounted on the robot. It is either embedded within or connected to special "Hub(s)", which in turn connect to motors, servos, and sensors. The :term:`Robot Controller` is linked to the :term:`Driver Station` through WiFi Direct. +The FTC control system is based around a ":term:`Robot Controller`" and a ":term:`Driver Station`". The :term:`Robot Controller` is mounted on the robot. It is either embedded within or connected to special "Hub(s)", which in turn connect to motors, servos, and sensors. The :term:`Robot Controller` is linked to the :term:`Driver Station` through WiFi or WiFi Direct. REV Robotics is the sole manufacturer of legal FTC control system components. The REV Expansion Hub connects to motors, servos, sensors, and a :term:`Robot Controller`. A REV Control Hub has the same functionality of an Expansion Hub but with a built-in :term:`Robot Controller`. More information about the FTC Control System can be found below: -- `Official Control System docs on FTC Docs `_ +- `Official Control System Documentation on FTC Docs `_ - `REV Control System Documentation `_ - `Official troubleshooting guide `_