Skip to content

Commit

Permalink
Update Troubleshooting Dashboard Connectivity (#2562)
Browse files Browse the repository at this point in the history
Move out of LabVIEW Dashboard section
Add Advantage Scope
Add more images
Update SmartDashboard
Add more links for changing team number/ip
Add link from DS best practices
  • Loading branch information
sciencewhiz committed Feb 10, 2024
1 parent db756e3 commit a6340f1
Show file tree
Hide file tree
Showing 16 changed files with 70 additions and 66 deletions.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions source/docs/software/dashboards/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@ Dashboards
glass/index
advantagescope.rst
labview-dashboard/index
troubleshooting-dashboard-connectivity.rst
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ The LabVIEW Dashboard is easy to use and provides a lot of features straight out

driver-station-labview-dashboard
using-the-labview-dashboard-with-c++-java-code
troubleshooting-dashboard-connectivity
../troubleshooting-dashboard-connectivity

This file was deleted.

Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
Troubleshooting Dashboard Connectivity
======================================

This document will help explain how to recognize if the Dashboard is not connected to your robot, steps to troubleshoot this condition and a code modification you can make.

Recognizing LabVIEW Dashboard Connectivity
------------------------------------------

.. image:: images/troubleshooting-dashboard-connectivity/labview-dashboard-connection.png
:alt: NT Connection LED on LabVIEW Dashboard front panel

The LabVIEW Dashboard has a NetworkTables Connection indicator on the front panel.

.. image:: images/troubleshooting-dashboard-connectivity/black-diamonds.png
:alt: Highlights black diamonds next to the variables indicating they are not synced to the robot.

On the Variables tab of the Dashboard, the variables are shown with a black diamond when they are not synced with the robot. Once the Dashboard connects to the robot and these variables are synced, the diamond will disappear.

Recognizing SmartDashboard Connectivity
---------------------------------------
.. image:: images/troubleshooting-dashboard-connectivity/smartdashboard-connection.png
:alt: The titlebar of SmartDashboard showing a connection to IP 172.22.11.2

SmartDashboard indicates if it is connected or not in the title bar. It shows the IP address it is connected to. See :ref:`this page <docs/software/dashboards/smartdashboard/smartdashboard-intro:Configuring the Team Number>` for more on configuring the connection.

.. image:: images/troubleshooting-dashboard-connectivity/connection-indicator.png
:alt: Click "View" then "Add..." then Connection indicator to place one on the SmartDashboard.

For more visibility, you can also add a Connection Indicator widget. The connection indicator can be moved or re-sized if the Editable checkbox is checked.

Recognizing Shuffleboard Connectivity
-------------------------------------

.. image:: images/troubleshooting-dashboard-connectivity/shuffleboard-connection.png
:alt: The bottom bar of Shuffleboard showing no connection

Shuffleboard indicates if it is connected or not in the bottom right corner of the application as shown in the image above. See :ref:`page <docs/software/dashboards/shuffleboard/getting-started/shuffleboard-preferences:Setting the Team Number>` for more on configuring the connection.

Recognizing Glass Connectivity
------------------------------

.. image:: images/troubleshooting-dashboard-connectivity/glass-connection.png
:alt: The titlebar of Glass showing a connection to 127.0.0.1

Glass indicates if it is connected or not in the title bar. It shows the IP address it is connected to. See this :ref:`page <docs/software/dashboards/glass/networktables-connection:Establishing NetworkTables Connections>` for more on configuring the connection.

Recognizing AdvantageScope Connectivity
---------------------------------------

.. image:: images/troubleshooting-dashboard-connectivity/advantagescope-connection.png
:alt: The titlebar of AdvantageScope showing a connection to 172.22.11.2

AdvantageScope indicates if it is connected or not in the title bar. It shows the IP address it is connected to, or else the IP address it is attempting to connect to. See the `AdvantageScope Documentation <https://github.com/Mechanical-Advantage/AdvantageScope/blob/main/docs/OPEN-LIVE.md>`__ for more on configuring the connection.

Troubleshooting Connectivity
----------------------------

If the Dashboard does not connect to the Robot (after the Driver Station has connected to the robot) the recommended troubleshooting steps are:

1. Restart the Dashboard (there is no need to restart the Driver Station software)

2. If that doesn't work, restart the Robot Code using the Restart Robot Code button on the Diagnostics tab of the Driver Station

3. If it still doesn't connect, verify that the Team Number / Server is set properly in the Dashboard and that your Robot Code writes a value during initialization or disabled
Original file line number Diff line number Diff line change
Expand Up @@ -75,3 +75,5 @@ Before Each Match
a. In the USB tab in the FRC Driver Station software, drag and drop to assign joysticks as needed.
b. Use the rescan button (F1) if joysticks / controllers do not appear green
c. Use the rescan button (F1) during competition if joystick or controllers become unplugged and then are plugged back in or otherwise turn gray during competition.

6. Ensure your :doc:`Dashboard is connected to the robot </docs/software/dashboards/troubleshooting-dashboard-connectivity>` after your driver station connects to the robot.
2 changes: 1 addition & 1 deletion source/docs/software/wpilib-tools/outlineviewer/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ OutlineViewer is a utility used to view, modify and add to the contents of the N

In Visual Studio Code, press :kbd:`Ctrl+Shift+P` and type ``WPILib`` or click the WPILib logo in the top right to launch the WPILib Command Palette. Select :guilabel:`Start Tool`, then select :guilabel:`OutlineViewer`.

To connect to your robot, open OutlineViewer and slect :guilabel:`options` then :guilabel:`settings` and set the ``Team/IP`` to be your team number. After you click :guilabel:`Apply`, OutlineViewer will connect. If you have trouble connecting to OutlineViewer please see the :ref:`Dashboard Troubleshooting Steps <docs/software/dashboards/labview-dashboard/troubleshooting-dashboard-connectivity:Troubleshooting Dashboard Connectivity>`.
To connect to your robot, open OutlineViewer and slect :guilabel:`options` then :guilabel:`settings` and set the ``Team/IP`` to be your team number. After you click :guilabel:`Apply`, OutlineViewer will connect. If you have trouble connecting to OutlineViewer please see the :doc:`Dashboard Troubleshooting Steps </docs/software/dashboards/troubleshooting-dashboard-connectivity>`.

.. note:: You can use ``localhost`` instead of a team number to point OutlineViewer at a simulated robot, Romi or XRP.

Expand Down
1 change: 1 addition & 0 deletions source/redirects.txt
Original file line number Diff line number Diff line change
Expand Up @@ -293,3 +293,4 @@
"docs/software/pathplanning/system-identification/identification-routine.rst" "docs/software/advanced-controls/system-identification/running-routine.rst"
"docs/software/advanced-controls/geometry/coordinate-systems.rst" "docs/software/basic-programming/coordinate-system.rst"
"docs/software/vscode-overview/importing-gradle-project.rst" "docs/software/vscode-overview/importing-last-years-robot-code.rst"
"docs/software/dashboards/labview-dashboard/troubleshooting-dashboard-connectivity.rst" "docs/software/dashboards/troubleshooting-dashboard-connectivity.rst"

0 comments on commit a6340f1

Please sign in to comment.