|
| 1 | +# Dashboard Settings |
| 2 | + |
| 3 | +The FIRST Driver Station supports configuring custom dashboards and overriding the default WPILib year used for dashboard lookups. This is done via a JSON configuration file named `DriverStationDashboardSettings.json`. |
| 4 | + |
| 5 | +## File Location |
| 6 | + |
| 7 | +Place the file in the DS configuration directory: |
| 8 | + |
| 9 | +- **Windows**: `C:\Users\Public\Documents\FIRSTDriverStation\DriverStationDashboardSettings.json` |
| 10 | +- **Unix (Linux/macOS)**: `~/.firstds/DriverStationDashboardSettings.json` |
| 11 | + |
| 12 | +## Configuration |
| 13 | + |
| 14 | +The file is a JSON object with two optional top-level keys: `CustomDashboards` and `DashboardYearOverrides`. |
| 15 | + |
| 16 | +```json |
| 17 | +{ |
| 18 | + "CustomDashboards": [ |
| 19 | + { "Name": "CoolDash1", "Executable": "C:\\Dashboards\\CoolDash1App" }, |
| 20 | + { "Name": "ExtraDash", "Executable": "C:\\Dashboards\\ExtraDashApp" } |
| 21 | + ], |
| 22 | + "DashboardYearOverrides": [ |
| 23 | + { "DashboardYearToOverride": "2027_alpha5", "DashboardOverrideYear": "2027_alpha6" } |
| 24 | + ] |
| 25 | +} |
| 26 | +``` |
| 27 | + |
| 28 | +### CustomDashboards |
| 29 | + |
| 30 | +`CustomDashboards` is an array of custom dashboards to add to the dashboard selector in the DS. Each entry has the following fields: |
| 31 | + |
| 32 | +| Field | Type | Description | |
| 33 | +|--------------|--------|---------------------------------------------------------| |
| 34 | +| `Name` | string | The display name shown in the DS dashboard selector. | |
| 35 | +| `Executable` | string | The full path to the dashboard executable to launch. | |
| 36 | + |
| 37 | +### DashboardYearOverrides |
| 38 | + |
| 39 | +`DashboardYearOverrides` is an array of WPILib year overrides that redirect the DS when looking up default dashboards for a given year. Each entry has the following fields: |
| 40 | + |
| 41 | +| Field | Type | Description | |
| 42 | +|--------------------------|--------|---------------------------------------------------------------| |
| 43 | +| `DashboardYearToOverride`| string | The WPILib year string whose dashboard location is overridden. | |
| 44 | +| `DashboardOverrideYear` | string | The WPILib year string to use instead when locating dashboards.| |
0 commit comments