Self inspect changes for version 10.3

docs/source/hardware_and_software_configuration/self_inspect/new-self-inspect.rst

@@ -0,0 +1,192 @@
+*FIRST* Tech Challenge Self-Inspect
+===================================
+
+Introduction
+------------
+
+This page describes the Self Inspect screens in the FTC Driver Station
+(DS) app and the FTC Robot Controller (RC) app.
+
+A Self Inspect screen provides a snapshot of device status, as it
+relates to FTC rules for the control system. 
+These rules are described in the Competition Manual which can be found on the
+`Current Game and Season Materials page <https://ftc-resources.firstinspires.org/files/ftc/game>`_ on the *FIRST* Website.
+
+.. tip:: An `Inspection Checklist PDF <https://www.firstinspires.org/sites/default/files/uploads/resource_library/ftc/inspection-checklist.pdf>`_ 
+   is available to help teams self-inspect their ROBOT before their event. Teams are strongly encouraged to self-inspect prior to their event.
+
+The Self Inspect screen is provided only as a quick, handy reference to
+help teams confirm that certain control system elements are up-to-date
+and properly configured.
+
+Each inspection screen updates automatically, with or without a Restart
+Robot. This allows quick verification that issues have been resolved.
+
+The challenge is to maximize useful information in a small screen. The
+Self Inspect layout and graphics evolve with FTC requirements; this page
+clarifies some of the brief but meaningful captions.
+
+Field Inspection
+----------------
+
+Field inspection is concerned with software app versions and configuration, as will as robot operation on the field.
+Teams must bring both their driver station (with gamepads) and robot (with battery) to field inspection and be prepared to turn them on, connect the devices, and operate the robot on a field.
+
+The Self Inspection reports may be reviewed in Field Inspection at an FTC tournament, but is **not** a comprehensive or official standard of compliance with FTC rules.
+With the robot and driver station turned on and connected the field inspector will likely go through the **Inspection Checklist** form (on paper or a tablet)
+They will check both the **Driver Station Inspection Report** and the **Robot Controller Inspection Report**, both of which can be displayed from the DS.
+Many FTC events will scan the QR Code that is displayed on the RC Inspection Report.
+
+Version Information
+-------------------
+
+The Competition Manual lists the minimum recommended versions of firmware, Android Operating System, and FTC Apps.
+Teams may choose to run older versions without affecting their ROBOT inspection status. 
+This avoids the situation of trying to upgrade a device at a competition at the last minute where a mistake might leave the robot inoperable.
+
+.. note::
+  The images in this page show Version 10.3 of the FTC apps.
+  This page only shows a Driver Hub paired with a Control Hub, there may be slight differences if a phone is used as a driver station or robot controller.
+  See the :doc:`old self-inspect<self-inspect>` page for screen images for app versions 10.2 or earlier.
+
+*FIRST* recommends but does not require that teams use the most recent versions of firmware, Android Operating System, and FTC Apps.
+Current versions have the latest bug fixes and enhancements. For example, version 1.1.6 of the **Control Hub Android OS** has a fix related to Wi-Fi.
+
+Each FTC season new major versions the FTC Apps are released. The INTO THE DEEP major version is 10, and the DECODE major version is 11.
+If the game has AprilTags, the SDK will include :doc:`localization<../../apriltag/vision_portal/apriltag_localization/apriltag-localization>` information for those tags that lets you determine the robot's position on the field.
+As the season progresses, minor releases will include bug fixes and some enhancements. e.g. 11.1, 11.2, etc.
+
+Regardless of the versions selected, it is highly recommended that the installed ROBOT CONTROLLER
+App and DRIVER STATION App versions match major and minor values to ensure compatibility as not
+all software versions are compatible with each other.
+
+.. caution::
+   FIELD STAFF will not be able to provide comprehensive support to teams with software older than the recommended version. 
+
+Driver Station Self Inspection Report
+-------------------------------------
+
+The following is a screen shot of a DS Self Inspection Report with the Driver Hub rotated so that the screen is in portrait mode so all items on the report are visible on one screen without scrolling.
+
+.. figure:: images/newDS.png
+   :align: center
+   :width: 85%
+   :alt: Driver station self inspection report
+
+   All items are good
+
+-  Item 1 The three dots are a menu with two choices: ``Disconnect from Wi-Fi Direct`` and ``Disable Bluetooth``. 
+   Neither is likely needed for a Driver Hub paired to a Control Hub, they are mostly for phones that could be used as a driver station or robot controller.
+   ``Disconnect from Wi-Fi Direct`` does work, but sometimes the apps re-pair automatically.
+   ``Disable Bluetooth`` shouldn't be needed unless Bluetooth was somehow enabled on the DS.
+-  Item 2 ``Manufacturer`` should be **REV Robotics** for a REV Driver Hub. 
+-  Item 3 ``Model`` should be **Driver Hub**.
+-  Item 4 ``Driver Hub OS Version`` is probably 1.2.0.
+-  Item 5 ``Android Version`` is probably 10 for a Driver Hub. 
+-  Item 6 shows the ``Battery Level`` of the device being reported. Fun
+   fact: the green color of the percentage value changes towards
+   **orange** as the charge level goes down.
+-  Item 7 ``Bluetooth`` should be **Disabled**.
+-  Item 8 ``Location services`` should be **Enabled**, but appears only on devices running
+   **Android 8** or higher. This is an SDK/Android technology requirement, not an FTC rule.
+-  Item 9 ``Wi-Fi Enabled`` must be **Yes** as it means the DS device’s Wi-Fi radio is **ON**.
+-  Item 10 ``Standard Wi-Fi Connected`` must be **Yes** to indicate the Driver Hub is connected to a standard Wi-Fi source, such as a Control Hub.
+-  Item 11 shows the ``Driver Station Name`` meets FTC format requirements. It should be your team number plus -DS, example 99999-DS.
+   See the Competition Manual for device naming rules.
+-  Item 12 shows the ``Robot Controller Name``. It will show **None** if not connected. It will show an error if team number portion of the Robot Controller and Driver Station names do not match.
+   It does not check whether the RC name matches FTC format requirements. See the Robot Controller Self Inspection Report.
+-  Item 13 Apps Installed ``Robot Controller`` should be **Not installed**. This verifies that the Driver Station device does **not** also have a Robot Controller app
+   installed. Only one FTC app should be installed on each device. It's possible to accidentally install both apps, but this usually causes the apps to not work properly.
+-  Item 14 Apps Installed ``Driver Station`` should indicate the version number of the Driver Station App. *FIRST* recommends but does not require that teams use the currently available version.
+   An invalid or future device system date can result in an invalid inspection item here with a message that "The Driver Station app is obsolete".
+   Correcting the date on the device should fix the invalid inspection item.
+
+==================================
+
+Here’s a report from a Driver Station with some items **rejected** by Self Inspect.
+Problems are indicated by a red circle exclamation mark icon, or an orange triangle exclamation mark icon.
+
+This was a driver hub that was firmware reset. This reset the DS version to 7 and restored all system and DS app settings to defaults.
+Then the `REV Hardware Client <https://docs.revrobotics.com/rev-hardware-client>`_ was used to update the DS version 10.3. 
+Then the FTCRobotController app was also deployed to the DS device from Android Studio.
+
+.. figure:: images/newDSerrors.png   
+   :align: center
+   :width: 85%
+   :alt: Driver station self inspection report
+
+   Self Inspect with issues!
+
+-  Item 10 rejects ``Standard Wi-Fi Connected`` for being **No**.
+   The DS is not yet connected to a robot. You should fix the Driver Station Name before connecting the devices.
+-  Item 11 rejects ``Driver Station Name`` for not meeting FTC format requirements. **Android_a301** is an example of a DS name for a brand new DS. 
+   Go into the DS App Settings and set the Driver Station Name as per the rules in the Competition Manual. e.g. Team number plus -DS: **99999-DS**.
+-  Item 12 rejects ``Robot Controller Name`` because it doesn't match with the DS Name. The value of **None** is because the DS is not connected to a RC.
+   This item doesn't check the RC name format is valid, only that the team number portion of the RC Name matches the team number portion of the DS Name.
+-  Item 13 rejects the presence of an RC app installed on this DS device. Uninstall the RC App from the driver station device.
+
+As you correct each problem the inspection report should refresh and show the current status.
+
+.. tip::
+   Touching a red circle exclamation mark icon or an orange triangle exclamation mark icon on a self-inspect screen should temporarily display a message related to the problem.
+
+Robot Controller Self Inspection Report
+---------------------------------------
+
+Now we change to **Robot Controller** Self Inspect report.
+This is normally viewed from the Driver Station by selecting the **Inspect Robot Controller** menu option on the Inspection Reports DS screen.
+FYI - if you connect an external monitor to the Control Hub's HDMI port and a mouse to a USB port you can view the RC Inspection report directly from the Control Hub.
+
+.. figure:: images/newRC.png   
+   :align: center
+   :width: 85%
+   :alt: Robot controller self inspection report
+
+   All items are good, except RC Password
+
+-  Item 1 The three dots are a menu with one choice: ``Disable Bluetooth``. 
+   It shouldn't be needed unless Bluetooth was somehow enabled on the Control Hub.
+-  Item 2 ``Manufacturer`` should be **REV Robotics** for a REV Control Hub. 
+-  Item 3 ``Model`` should be **Control Hub v1.0**.
+-  Item 4 ``Control Hub OS Version`` should be at least 1.1.6. *FIRST* recommends but does not require that teams use the currently available version.
+-  Item 5 ``Android Version`` is probably 7.1.2 for a Control Hub.
+-  Item 6 ``Hub Firmware`` lists the hub addresses and firmware levels. This
+   example shows one Control Hub, but an Expansion Hub can also be listed here. A
+   check mark indicates all firmware is up-to-date based on the current version of the RC app. 
+   *FIRST* recommends but does not require that teams use the currently available version.
+-  Item 7 shows the ``Battery Level`` of the device being reported.
+-  Item 8 ``Bluetooth`` should be **Disabled**.
+-  Item 9 ``RC Password`` appears only in RC Self Inspect. This inspection item has failed the FTC requirement for a Control Hub
+   password different than the factory default (“password”). Go to the Program and Manage page, select Manage and then update the RC password.
+   You will have to re-pair the DS to the RC and enter the new password to reconnect.
+-  Item 10 ``Wi-Fi Enabled`` must be **Yes** as it means the DS device’s Wi-Fi radio is **ON**.
+-  Item 11 ``Standard Wi-Fi Connected`` must be **Yes**.
+-  Item 12 shows the ``Robot Controller Name`` meets FTC format requirements. It should be your team number plus -RC, example 99999-RC.
+   See the Competition Manual for device naming rules.
+-  Item 13 Apps Installed ``Robot Controller`` should show the RC app version. *FIRST* recommends but does not require that teams use the currently available version.
+-  Item 14 ``Matches DS Version`` should be **Yes**, though a minor version difference is probably OK such as 10.1 vs 10.2.
+-  Item 15 Apps Installed ``Driver Station`` should be **Not installed**, this verifies that the Robot Controller device does **not** also have a Driver Station app installed.
+   Only one FTC app should be installed on each device. It's possible to accidentally install both apps, but this usually causes the apps to not work properly.
+-  Item 16 At the bottom of the RC inspection report is a QR Code that can be scanned during field inspection to fill in many of the field inspection checklist items.
+
+.. figure:: images/newRcQrCode.png   
+   :align: center
+   :width: 85%
+   :alt: Self Inspect QR code
+
+   The field inspector may scan the QR Code during field inspection
+
+Summary
+-------
+
+The Self Inspect screen is a quick, handy reference to help teams
+confirm that certain control system elements are up-to-date and properly
+configured.
+
+Self Inspect may be reviewed in Field Inspection at an FTC tournament,
+but is **not** a comprehensive or official standard of compliance with
+FTC rules.
+
+Each inspection screen updates automatically, with or without a Restart
+Robot. This allows quick verification that issues have been resolved.
+

docs/source/hardware_and_software_configuration/self_inspect/self-inspect.rst

@@ -1,17 +1,20 @@
-*FIRST* Tech Challenge Self-Inspect
-===================================
+Old Self-Inspect
+================
 
 Introduction
 ------------
 
-This page describes the Self Inspect screens in the FTC Driver Station
+This page describes the older Self Inspect screens in the FTC Driver Station
 (DS) app and the FTC Robot Controller (RC) app.
+See the :doc:`new self-inspect<new-self-inspect>` page for screen images for version 10.3 or better.
 
 A Self Inspect screen provides a snapshot of device status, as it
-relates to FTC rules for the control system. These rules are described
-in each season’s `Game Manual
-1 <https://www.firstinspires.org/resource-library/ftc/game-and-season-info>`__,
-and many are summarized in that manual’s **Field Inspection Checklist**.
+relates to FTC rules for the control system. 
+These rules are described in the Competition Manual which can be found on the
+`Current Game and Season Materials page <https://ftc-resources.firstinspires.org/files/ftc/game>`_ on the *FIRST* Website.
+
+.. tip:: An `Inspection Checklist PDF <https://www.firstinspires.org/sites/default/files/uploads/resource_library/ftc/inspection-checklist.pdf>`_ 
+   is available to help teams self-inspect their ROBOT before their event. Teams are strongly encouraged to self-inspect prior to their event.
 
 The Self Inspect screen is provided only as a quick, handy reference to
 help teams confirm that certain control system elements are up-to-date
@@ -27,8 +30,9 @@ Self Inspect layout and graphics evolve with FTC requirements; this page
 clarifies some of the brief but meaningful captions.
 
 .. note::
-  These images show Version 7.0 of the FTC apps. Please refer to Game Manual 
-  Part 1 for the correct allowed software system versions.
+  These images show Version 7.0 of the FTC apps. Please refer to Competition Manual 
+  for allowed software system versions. These images are valid up to version 10.2 of the FTC apps.
+  See the :doc:`new self-inspect<new-self-inspect>` page for screen images for version 10.3 or better.
 
 Device Pairing
 --------------

docs/source/index.rst

@@ -67,6 +67,7 @@ and :doc:`gracious_professionalism/gp` to see why.
    programming_resources/shared/control_system_intro/The-FTC-Control-System 
    control_hard_compon/index
    hardware_and_software_configuration/index
+   hardware_and_software_configuration/self_inspect/new-self-inspect
    hardware_and_software_configuration/self_inspect/self-inspect
    programming_resources/index
 

docs/source/tech_tips/tech-tips.rst

@@ -1709,7 +1709,7 @@ Just click to expand the Tech Tip you'd like to read.
    your hardware configuration the Self-Inspect screens may be formatted
    differently or have different options listed, so :ref:`there is a handy
    reference on ftc-docs
-   <hardware_and_software_configuration/self_inspect/self-inspect:*FIRST* Tech Challenge Self-Inspect>`
+   <hardware_and_software_configuration/self_inspect/new-self-inspect:*FIRST* Tech Challenge Self-Inspect>`
    that can help you understand the Self-Inspect tool. Make sure you’re ready
    for inspection!