Skip to content

Commit 45fbe29

Browse files
committed
Merge branch 'main' into 2027
2 parents 40e8703 + b10ea0b commit 45fbe29

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

69 files changed

+260
-162
lines changed

.github/workflows/build.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,30 @@ jobs:
3030
- name: Check formatting
3131
run: npm run check-format
3232

33+
build-docs:
34+
name: Build Docs
35+
runs-on: ubuntu-latest
36+
37+
steps:
38+
- name: Checkout
39+
uses: actions/checkout@v4
40+
- name: Setup Node.js
41+
uses: actions/setup-node@v4
42+
with:
43+
node-version: "20.x"
44+
cache: "npm"
45+
- name: Install Node.js dependencies
46+
run: npm ci
47+
env:
48+
ASCOPE_NO_FFMPEG: true
49+
- name: Build docs
50+
run: npm run docs:build
51+
- name: Upload artifact
52+
uses: actions/upload-artifact@v4
53+
with:
54+
name: docs
55+
path: docs/build/
56+
3357
compile-frc6328:
3458
name: Compile for FRC 6328
3559
runs-on: ubuntu-latest

docs/docs/img/prefs.png

170 KB
Loading

docs/docs/img/xr.webp

-252 KB
Binary file not shown.

docs/docs/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ AdvantageScope is a robot diagnostics, log review/analysis, and data visualizati
1818
items={[
1919
{
2020
type: "category",
21-
label: "Getting Started",
22-
href: "/category/getting-started"
21+
label: "Overview",
22+
href: "/category/overview"
2323
},
2424
{
2525
type: "category",
@@ -34,7 +34,7 @@ href: "/category/more-features"
3434
{
3535
type: "category",
3636
label: "Championship Conference",
37-
href: "/getting-started/champs-conference"
37+
href: "/overview/champs-conference"
3838
}
3939
]}
4040
/>

docs/docs/legacy-formats.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sidebar_position: 2
44

55
# Legacy Format Deprecation
66

7-
WPILib supports the type-safe and unit-safe **struct format** for publishing complex data types such as geometry objects, swerve states, and more! AdvantageScope takes advantage of the struct format to streamline the process of configuring fields for visualization. For example, 2D and 3D poses can now be used side-by-side on the [🗺 2D Field](tab-reference/2d-field.md) and [👀 3D Field](tab-reference/3d-field.md) tabs with **no manual configuration** and **no unit errors**.
7+
WPILib supports the type-safe and unit-safe **struct format** for publishing complex data types such as geometry objects, swerve states, and more! AdvantageScope takes advantage of the struct format to streamline the process of configuring fields for visualization. For example, 2D and 3D poses can now be used side-by-side on the [🗺 2D Field](tab-reference/2d-field) and [👀 3D Field](tab-reference/3d-field) tabs with **no manual configuration** and **no unit errors**.
88

99
Before 2025, AdvantageScope supported both structs and the legacy "number array" format for geometry types. The legacy format packed structured data into a format like `double[]` (e.g. a pose would be represented by the array `[x, y, rotation]`).
1010

@@ -143,7 +143,7 @@ logEntry.append(new Pose2d());
143143
The Phoenix signal logger does not support the modern struct format. Consider publishing geometry data using one of the logging libraries shown above instead of using custom signals in Phoenix.
144144

145145
:::tip
146-
AdvantageScope can automatically merge log files from multiple sources, such as Hoot and WPILOG files. See [here](getting-started/manage-files.md) for details.
146+
AdvantageScope can automatically merge log files from multiple sources, such as Hoot and WPILOG files. See [here](/overview/log-files) for details.
147147
:::
148148

149149
</details>
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
import PrefsImage from '../img/prefs.png';
6+
import CenterRotatedDiagram from './img/coordinate-system-center-rotated.png';
7+
8+
# 📐 Coordinate Systems
9+
10+
AdvantageScope includes support for several common coordinate systems on the [🗺️ 2D Field](/tab-reference/2d-field) and [👀 3D Field](/tab-reference/3d-field) tabs. Please reference the [WPILib coordinate system documentation](https://docs.wpilib.org/en/stable/docs/software/basic-programming/coordinate-system.html#wpilib-coordinate-system) for more information on the axis and rotation conventions used by AdvantageScope.
11+
12+
### Customization
13+
14+
By default, the coordinate system is automatically selected based on the chosen field image/model. To select a different coordinate system for use on all fields, open the preferences window by clicking `App` > `Show Preferences...` (Windows/Linux) or `AdvantageScope` > `Settings...` (macOS) and change the "Coordinate System" option.
15+
16+
:::tip
17+
All coordinate system options are compatible with both FRC and FTC fields.
18+
:::
19+
20+
## Blue Wall
21+
22+
The origin is in the rightmost corner of the blue alliance wall with the +X axis facing the red alliance wall, as shown below. **This is the default coordinate system for FRC fields from 2023 to 2026.**
23+
24+
![Blue wall coordinate system](./img/coordinate-system-blue-wall.png)
25+
26+
## Alliance Wall
27+
28+
The origin is in the rightmost corner of the alliance wall for the _robot's current alliance_ with the +X axis facing the opposite alliance wall, as shown below. **This is the default coordinate system for FRC in 2022.**
29+
30+
![Alliance wall coordinate system](./img/coordinate-system-alliance-wall.png)
31+
32+
## Center/Rotated
33+
34+
The origin is in the center of the field with the +X axis facing to the right from the perspective of the red alliance wall, as shown below. **This is the default coordinate system for FTC fields from 2024-2025 to 2026-2027.**
35+
36+
<img src={CenterRotatedDiagram} alt="Center/rotated coordinate system" height="400" />
37+
38+
## Center/Red (SystemCore)
39+
40+
The origin is in the center of the field with the +X axis facing away from the red alliance wall, as shown below. **This is the default coordinate system for FRC fields starting in 2027 and FTC fields starting in 2027-2028.**
41+
42+
:::warning
43+
This coordinate system is only available in the 2027 (v27.x) releases of AdvantageScope.
44+
:::
45+
46+
![Center/red coordinate system](./img/coordinate-system-center-red.png)
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"label": "⚙️ Custom Assets",
3+
"position": 3,
4+
"collapsed": true
5+
}

docs/docs/more-features/gltf-convert.md renamed to docs/docs/more-features/custom-assets/gltf-convert.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
1-
---
2-
sidebar_position: 6
3-
---
4-
51
# Converting Onshape & STEP Files to glTF
62

7-
AdvantageScope's 3D view accepts custom models for fields and robots, which can be installed using the process described [here](../more-features/custom-assets.md). All models must use the [glTF](https://www.khronos.org/gltf/) file format, chosen for its efficiency when storing and loading models. Note that AdvantageScope uses the binary form (.glb), which includes all resources in a single file, rather than the pure JSON form (.gltf).
3+
AdvantageScope's 3D view accepts custom models for fields and robots, which can be installed using the process described [here](/more-features/custom-assets). All models must use the [glTF](https://www.khronos.org/gltf/) file format, chosen for its efficiency when storing and loading models. Note that AdvantageScope uses the binary form (.glb), which includes all resources in a single file, rather than the pure JSON form (.gltf).
84

95
## Converting Onshape to STEP
106

File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)