Skip to content

Commit

Permalink
Update OutlineViewer documentation and pictures (#2548)
Browse files Browse the repository at this point in the history
Deduplicate documentation. Fixes #2488
  • Loading branch information
sciencewhiz committed Jan 25, 2024
1 parent 201c595 commit d2129b6
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 8 deletions.
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
Expand Up @@ -73,13 +73,9 @@ If the display of the value is not appearing, verify that the team number is cor
Verifying Program using OutlineViewer
-------------------------------------

You can verify that the robot program is generating SmartDashboard values by using the OutlineViewer program. This is a Java program, ``OutlineViewer.jar``, that is located in ``~/wpilib/YYYY/tools`` (where YYYY is the year and ~ is ``C:\Users\Public`` on Windows).
You can verify that the robot program is generating SmartDashboard values by using the :doc:`OutlineViewer program </docs/software/wpilib-tools/outlineviewer/index>`.

OutlineViewer is downloaded as part of the WPILib Offline Installer. For more information, see the :ref:`Windows/macOS/Linux installation guides <docs/zero-to-robot/step-2/wpilib-setup:WPILib Installation Guide>`. 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`, and then select :guilabel:`OutlineViewer`.

In the "Server Location" box, enter your team number with no leading zeroes. Then, click ``Start``.

Look at the second row in the table, the value ``SmartDashboard/Counter`` is the variable written to the SmartDashboard via NetworkTables. As the program runs you should see the value increasing (``41.0`` in this case). If you don't see this variable in the OutlineViewer, look for something wrong with the robot program or the network configuration.
Expand the SmartDashboard row. The value ``Counter`` is the variable written to the SmartDashboard via NetworkTables. As the program runs you should see the value increasing (``1398.0`` in this case). If you don't see this variable in the OutlineViewer, look for something wrong with the robot program or the network configuration.

.. image:: /docs/software/wpilib-tools/outlineviewer/images/outlineviewer.png
:alt: Using OutlineViewer to view the NetworkTables data used by the program.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions source/docs/software/wpilib-tools/outlineviewer/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ 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 set the ``Server Location`` to be your team number. After you click start, 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 :ref:`Dashboard Troubleshooting Steps <docs/software/dashboards/labview-dashboard/troubleshooting-dashboard-connectivity:Troubleshooting Dashboard Connectivity>`.

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

.. image:: images/outlineviewer.png

Expand Down

0 comments on commit d2129b6

Please sign in to comment.