Add Robot Simulator and AdvantageScope documentation#159
Conversation
Co-authored-by: TaylerUva <8679670+TaylerUva@users.noreply.github.com>
…placeholder note Co-authored-by: TaylerUva <8679670+TaylerUva@users.noreply.github.com>
TaylerUva
left a comment
There was a problem hiding this comment.
There is some redundant content. Changing headings and order may help reduce redundancy. Quick reference should be at the top
| - **Test Without Hardware**: Run and debug your code without needing the actual robot | ||
| - **Rapid Iteration**: Make code changes and test them immediately without deploying to hardware | ||
| - **Safe Testing**: Test dangerous or complex scenarios without risking damage to the robot | ||
| - **Physics Simulation**: Simulates robot physics including drivetrain movement, motor behavior, and sensor readings |
There was a problem hiding this comment.
| - **Physics Simulation**: Simulates robot physics including drivetrain movement, motor behavior, and sensor readings |
| - During early development before the robot is built | ||
| - Testing autonomous routines and path following | ||
| - Debugging sensor logic and state machines | ||
| - Training new programmers without requiring robot access |
There was a problem hiding this comment.
| - Training new programmers without requiring robot access |
|
|
||
| ### When to Use AdvantageScope: | ||
| - Debugging robot behavior during testing | ||
| - Verifying swerve offsets (swoffsets) |
There was a problem hiding this comment.
| - Verifying swerve offsets (swoffsets) |
| | Feature | Robot Simulator (Sim) | AdvantageScope | | ||
| |---------|----------------------|----------------| | ||
| | **Purpose** | Runs robot code without hardware | Visualizes and analyzes robot data | | ||
| | **Built Into** | WPILib / VS Code | Standalone application | |
There was a problem hiding this comment.
| | **Built Into** | WPILib / VS Code | Standalone application | |
| | **Purpose** | Runs robot code without hardware | Visualizes and analyzes robot data | | ||
| | **Built Into** | WPILib / VS Code | Standalone application | | ||
| | **Primary Use** | Testing code execution and logic | Viewing telemetry and debugging | | ||
| | **3D Visualization** | Basic physics simulation | Advanced 3D robot visualization | |
There was a problem hiding this comment.
| | **3D Visualization** | Basic physics simulation | Advanced 3D robot visualization | | |
| | **Visualization** | Raw NetworkTables Data | Advanced 3D robot visualization | |
|
|
||
| #### 4. Visualize Your Data | ||
| 1. Navigate to the **3D Field** tab to see your robot on the field | ||
| 2. Use the **Swerve** tab to view swerve drive states (if applicable) |
There was a problem hiding this comment.
| 2. Use the **Swerve** tab to view swerve drive states (if applicable) |
| #### 3. Connect to the Robot | ||
| 1. Click on the **connection icon** in the top-left corner | ||
| 2. Select **Robot** or **Team Number** as the connection type | ||
| 3. Enter your team number (e.g., `3255`) | ||
| - AdvantageScope will automatically calculate the robot's IP address: `10.TE.AM.2` (e.g., `10.32.55.2` for team 3255) | ||
| - Alternatively, you can manually enter the IP address | ||
| 4. Click **Connect** | ||
| 5. You should see a green indicator when connected successfully |
There was a problem hiding this comment.
Incorrect - see this page:
https://docs.advantagescope.org/overview/live-sources/
There was a problem hiding this comment.
Corrected connection instructions to use "Live Sources" → "NetworkTables" in the left sidebar with team number/IP entry. Commit 1ed06ab.
|
|
||
| #### 4. View Live Robot Data | ||
| 1. Navigate to the **3D Field** tab to see your robot's live position | ||
| 2. Use the **Swerve** tab to verify swerve module alignment and offsets |
There was a problem hiding this comment.
| 2. Use the **Swerve** tab to verify swerve module alignment and offsets |
| **Direct IP Connection**: | ||
| - Robot over USB: `172.22.11.2` | ||
| - Robot over WiFi: `10.TE.AM.2` (e.g., `10.32.55.2`) | ||
|
|
||
| **mDNS Connection**: | ||
| - Use `roboRIO-3255-FRC.local` (replace 3255 with your team number) | ||
| - May not work on all networks |
There was a problem hiding this comment.
| **Direct IP Connection**: | |
| - Robot over USB: `172.22.11.2` | |
| - Robot over WiFi: `10.TE.AM.2` (e.g., `10.32.55.2`) | |
| **mDNS Connection**: | |
| - Use `roboRIO-3255-FRC.local` (replace 3255 with your team number) | |
| - May not work on all networks |
| **Team Number Connection** (Recommended): | ||
| - Enter your team number: `3255` | ||
| - AdvantageScope automatically resolves to: `10.32.55.2` |
There was a problem hiding this comment.
Incorrect - see this page:
https://docs.advantagescope.org/overview/live-sources/
There was a problem hiding this comment.
Corrected connection instructions to use "Live Sources" → "NetworkTables" in the left sidebar. Removed incorrect connection options section. Commit 1ed06ab.
…ope opening method, correct connection instructions, remove redundant sections Co-authored-by: TaylerUva <8679670+TaylerUva@users.noreply.github.com>
Moved Quick Reference to the top and removed redundant horizontal rules and content throughout the document. Commit 1ed06ab. Screenshot: https://github.com/user-attachments/assets/7b9fa5cb-317e-42f8-b3cf-aee51be1f906 Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
Co-authored-by: TaylerUva <8679670+TaylerUva@users.noreply.github.com>
Summary
Successfully addressed all review feedback:
Screenshot: https://github.com/user-attachments/assets/7b9fa5cb-317e-42f8-b3cf-aee51be1f906
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.