Skip to content

Commit

Permalink
Improve documentation for Phoenix diagnostics
Browse files Browse the repository at this point in the history
  • Loading branch information
jwbonner committed Jan 7, 2025
1 parent 5bb9b16 commit 4de6911
Show file tree
Hide file tree
Showing 9 changed files with 34 additions and 10 deletions.
6 changes: 1 addition & 5 deletions docsSite/docs/getting-started/connect-live.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,10 @@ The following sources of live data are supported by AdvantageScope:

- **NetworkTables 4:** This is WPILib's primary networking protocol. See the [WPILib documentation](https://docs.wpilib.org/en/stable/docs/software/networktables/index.html) for more details.
- **NetworkTables 4 (AdvantageKit):** This mode is designed for use with robot code running AdvantageKit, which publishes to the `AdvantageKit` table in NetworkTables.
- **Phoenix Diagnostics:** This mode uses HTTP to connect to a Phoenix [diagnostic server](https://pro.docs.ctr-electronics.com/en/latest/docs/installation/running-diagnostics.html), which allows for data streaming from CTRE CAN devices with [Phoenix 6](https://pro.docs.ctr-electronics.com/en/latest/). This is similar to the [plotting feature](https://pro.docs.ctr-electronics.com/en/latest/docs/tuner/plotting.html) in Phoenix Tuner.
- **Phoenix Diagnostics:** This mode uses HTTP to connect to a Phoenix [diagnostic server](https://pro.docs.ctr-electronics.com/en/latest/docs/troubleshooting/running-diagnostics.html), which allows for data streaming from CTRE CAN devices with [Phoenix 6](https://pro.docs.ctr-electronics.com/en/latest/). This is similar to the [plotting feature](https://pro.docs.ctr-electronics.com/en/latest/docs/tuner/plotting.html) in Phoenix Tuner. See [this page](/more-features/phoenix-diagnostics) for more information.
- **PathPlanner 2023:** Legacy, this mode connects using the `PathPlannerServer` protocol used for telemetry by PathPlanner 2023. The connection is always initiated on port 5811. Note that PathPlanner 2024 and later publish telemetry data using NetworkTables, so the **NetworkTables 4** mode should be used.
- **RLOG Server:** This protocol is supported by AdvantageKit as an alternative to NetworkTables. The connection is initiated on port 5800 by default.

:::warning
The Phoenix Diagnostics live mode may experience issues as a result of Phoenix updates. If this mode does not function properly, update to the latest version of AdvantageScope. If the issue persists, please [open an issue](https://github.com/Mechanical-Advantage/AdvantageScope/issues) to let us know.
:::

### Live Mode

When NetworkTables is used as the live source, the following live modes can be selected:
Expand Down
2 changes: 1 addition & 1 deletion docsSite/docs/more-features/custom-assets.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 4
sidebar_position: 5
---

# Custom Assets
Expand Down
2 changes: 1 addition & 1 deletion docsSite/docs/more-features/export.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 3
sidebar_position: 4
---

import Image1 from './img/export-1.png';
Expand Down
2 changes: 1 addition & 1 deletion docsSite/docs/more-features/gltf-convert.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 5
sidebar_position: 6
---

# Converting Onshape & STEP Files to glTF
Expand Down
Binary file added docsSite/docs/more-features/img/phoenix-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docsSite/docs/more-features/img/phoenix-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docsSite/docs/more-features/nt-publishing.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 7
sidebar_position: 8
---

# Publishing NetworkTables Data
Expand Down
28 changes: 28 additions & 0 deletions docsSite/docs/more-features/phoenix-diagnostics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
sidebar_position: 3
---

# Phoenix Diagnostics

AdvantageScope supports live-streaming of signals from Phoenix 6 devices with **no setup in user code**. This enables easy debugging and tuning of Phoenix devices using the familiar interface and full power of AdvantageScope:

- Flexible visualization options, including support for multiple axes and discrete fields
- Live preview of all values in the sidebar for easy browsing
- Support for plotting and signal preview from multiple devices simultaneously
- Decoding of enum values as human-readable strings (control modes, bridge status, CANcoder magnet state, etc)
- Integrated sidebar tooltips with descriptions and units for each signal
- Hierarchical organization of signals, grouped by CAN bus, device, and signal type

:::tip
To connect, select "Phoenix Diagnostics" from the list of [live sources](/getting-started/connect-live#live-source) in the preferences menu. Then, click "Connect to Robot" or "Connect to Simulator" from the menu bar as normal.
:::

![Line graph screenshot](./img/phoenix-1.png)

AdvantageScope's 📊 [Statistics](/tab-reference/statistics) tab also enables advanced analysis of Phoenix signals, with support for histograms, custom ranges, and derived fields for relative and absolute error measurements:

![Statistics screenshot](./img/phoenix-2.png)

:::note
This feature may occasionally experience issues as a result of Phoenix updates. We recommend using the latest version of AdvantageScope to minimize issues. Otherwise, please [open an issue](https://github.com/Mechanical-Advantage/AdvantageScope/issues) to let us know about any problems.
:::
2 changes: 1 addition & 1 deletion docsSite/docs/more-features/zebra.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_position: 6
sidebar_position: 7
---

# Loading Zebra MotionWorks™ Data
Expand Down

0 comments on commit 4de6911

Please sign in to comment.