From 133e9307eddda0f6f8e51334ac26572aaa84b154 Mon Sep 17 00:00:00 2001 From: Jason Daming Date: Sun, 8 Dec 2024 16:38:26 -0600 Subject: [PATCH] Reorganize dashboards for inclusion of Elastic (#2858) --- source/docs/software/dashboards/dashboard-intro.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/source/docs/software/dashboards/dashboard-intro.rst b/source/docs/software/dashboards/dashboard-intro.rst index aaa938f218..f673aabffa 100644 --- a/source/docs/software/dashboards/dashboard-intro.rst +++ b/source/docs/software/dashboards/dashboard-intro.rst @@ -12,7 +12,7 @@ Take caution to carefully consider what *needs* to be on this dashboard and if t This dashboard is designed for debugging code and analyzing data from the robot. It supports the monitoring of a wide variety of information simultaneously, prioritizing function and utility over simplicity or ease of use. This functionality often includes complex data visualization and graphing across extended periods. In scenarios where there is an overwhelming amount of data to review, real-time analysis becomes challenging. The capability to examine past data and replay it proves to be extremely beneficial. While some dashboards may log data transmitted to them, :ref:`on-robot telemetry ` using the ``DataLog`` class simplifies the process. -## Specific Dashboards (oldest to newest) +## Included Dashboards (oldest to newest) .. note:: SmartDashboard and Shuffleboard have a long history of aiding FRC teams. However, they do not have a person to maintain them so are not receiving bug fixes or improvements. Notably, Shuffleboard may experience performance issues on some machines under certain scenarios. PRs from external contributors will be reviewed. @@ -24,12 +24,12 @@ This dashboard is designed for debugging code and analyzing data from the robot. :ref:`Glass ` (Programming) - robot data visualization tool. Its GUI is extremely similar to that of the :ref:`Simulation GUI `. In its current state, it is meant to be used as a programmer's tool rather than a proper dashboard in a competition environment, with a focus on high performance real time plotting. -:ref:`AdvantageScope ` (Programming) - robot diagnostics, log review/analysis, and data visualization application. It reads the WPILib Data Log (``.wpilog``) and Driver Station Log (``.dslog`` / ``.dsevents``) file formats, plus live robot data viewing. +:ref:`AdvantageScope ` (Programming / Third Party) - robot diagnostics, log review/analysis, and data visualization application. It reads the WPILib Data Log (``.wpilog``) and Driver Station Log (``.dslog`` / ``.dsevents``) file formats, plus live robot data viewing. -## Third Party Dashboards +:ref:`Elastic ` (Driver / Third Party) - simple and modern Shuffleboard alternative made by Team 353. It is meant to serve as a dashboard for competition but can also be used for testing. It features draggable and resizable card widgets. -[FRC Web Components](https://github.com/frc-web-components/frc-web-components) (Driver) - A web-based dashboard that can be installed as a standalone application, or as a JavaScript package for custom dashboard solutions. +## External Dashboards (All Third Party) -[Elastic](https://github.com/Gold872/elastic-dashboard) (Driver) - simple and modern Shuffleboard alternative made by Team 353. It is meant to serve as a dashboard for competition but can also be used for testing. It features draggable and resizable card widgets. +[FRC Web Components](https://github.com/frc-web-components/frc-web-components) (Driver) - A web-based dashboard that can be installed as a standalone application, or as a JavaScript package for custom dashboard solutions. [QFRCDashboard](https://github.com/Q-FRC/Dashboard) (Driver) - described as reliable, high-performance, low-footprint dashboard. QFRCDashboard has been specifically designed to use as few resources as possible.