From 66f8396a513b168a2f5e818fd7568bb9fa383548 Mon Sep 17 00:00:00 2001 From: Aidan Sun Date: Mon, 26 Feb 2024 15:06:59 -0500 Subject: [PATCH] Update docs --- docs/CHANGELOG.md | 1 + docs/config.md | 2 ++ docs/tps.md | 27 +++++++++++++++++++++++++++ 3 files changed, 30 insertions(+) create mode 100644 docs/tps.md diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 497c1e0..e5c881b 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -7,6 +7,7 @@ This document tracks the changes between Black Hawks Scouting versions. Dates ar ### Additions - Added an "exclude headers" option for QR code generation (#8). +- Added The Purple Standard (TPS) support. [Documentation](tps.md) ## 2024.0 (01/06/2024) diff --git a/docs/config.md b/docs/config.md index 43d2253..35377fa 100644 --- a/docs/config.md +++ b/docs/config.md @@ -10,6 +10,8 @@ Each configuration contains the pages, widgets, and layout of the scouting form. Each configuration has a file name in the format `config-`, followed by the name of the configuration and then the file extension (`.json`). (Examples: `config-matches.json` or `config-pits-2022.json`) +**Note:** `config-tps` is a reserved name for the scouting form used for The Purple Standard (TPS). See the documentation for [TPS in Black Hawks Scouting](tps.md) for details. + ## Configuration List To make a configuration appear in Black Hawks Scouting's home page, it must be included in the configuration list at `/public/assets/configurations.txt`. diff --git a/docs/tps.md b/docs/tps.md new file mode 100644 index 0000000..097fd94 --- /dev/null +++ b/docs/tps.md @@ -0,0 +1,27 @@ +# The Purple Standard + +## Overview + +[**The Purple Standard (TPS)**](https://github.com/HarkerRobo/the-purple-standard) "is a unified, community-driven standard for FRC scouting data." Since v2024.1, Black Hawks Scouting supports exporting data in the TPS format through a separate `config-tps.json` configuration and a TPS Exporter tool. + +## Enabling + +By default, the `tps` configuration is hidden from the home page. Add it to the [configurations list](config.md#configuration-list) to show it. + +## Exporting + +The "TPS Exporter" link on the home page brings you to a page where you can download TPS data as a JSON file from your scouted matches. You can also set your team number which will appear in the downloaded file. + +**Note:** Attempting to download data from the TPS config will result in a file that is in Black Hawks Scouting's own CSV format. The TPS Exporter tool must be used if you want data in the TPS JSON format. + +## Configuration + +The information below is intended for developers and those who want to modify Black Hawks Scouting or how it exports TPS data. For the end-user, no modification is needed other than the configurations list. + +Black Hawks Scouting has a configuration for TPS data called `config-tps.json`. Because the TPS Exporter tool only reads from this configuration, this is a reserved config name and cannot be used for other forms. This form is specifically set up with the data that TPS includes, so it generally does not need to be modified within the season. + +The `tps-exporter.json` file in `/public/assets` dictates how data from Black Hawks Scouting's internal format is converted to TPS JSON. Keys in the JSON object are widget names exported by the form, and the values are in the format `[iface] [prop] [type]`: + +- `[iface]`: TPS interface containing the data +- `[prop]`: Name of the TPS property +- `[type]`: How the data should be interpreted