Skip to content

Creating a template

Jump to bottom
Sebastian edited this page Feb 15, 2023 · 2 revisions

Notes

  • Templates are saved as JSON files
  • All templates will be exported to the directory Documents/scouting/templates/..
  • Match and pit scouting templates are created and used separately and can't be used interchangeably

How to start

On the main app page, select Create a template and then choose either to make a pit template or a match template and if you have an existing template that you'd like to make changes to, choose import existing template. The main difference between a pit scouting template and a match scouting template is that in match scouting, you'll be able to create two separate sheets for autonomous mode and teleop mode while in pit scouting it's a single sheet. To add components to your template, select the Add item button. After you are happy with the order of items, select the finalize template button at the top, and then you'll be able to drag and drop to edit the order that your data appears in the output file after scouting.

Editing items

  • To change the order of items, touch and hold on the icon, then drag and drop it to the desired position.
  • To edit item data (save key, label etc.) simply tap on the dotted round box of the item that you wish to edit, and a dialog will appear

Save keys

In the template editor, each item that can save a value has a save key attached to it. These serve two main purposes:

  • Allow you to easily identify which item is which when editing the CSV save order
  • Serve as the label of the column in the final output file

Components

Score bar

ScoreBarSample

  • Has a counter and a label
  • Saves as a single integer value

Rating bar

RatingBarSample

  • Has a label, and a 1-5 scale that users can pick from
  • Default value is 0 if the user doesn't interact with it
  • Saves as a single integer value
  • The value that the user chooses will be saved literally (If they select 3, it will be saved as 3, so non-zero based index)

Text field

TextFieldSample

  • Has an input field that can contain a placeholder label
  • Saves as a single string value
  • One thing to keep in mind is that if users enter a comma in the input field, when opening the output data in Excel or Google Sheets, it will think that it's two separate columns (Fix WIP)

Text note

TextNoteSample

  • Has a label
  • Does not save any values
  • Literally is just a text note, nothing special about it

Checkbox

CheckboxSample

  • Has a label and a checkbox
  • Saves as a single boolean value

Triple counter

TripleCounterSample

  • Has three score bars, each with it's own label above it
  • Saves as three separateinteger values, one for each counter

Triple button

TripleButtonSample

  • Has a header label, and a label for each of the buttons
  • Saves as a single integer value being a zero-based index of the button selected (0 for the first one, 1 for the second one etc..)
Clone this wiki locally