Home

Jeremy Koritzinsky edited this page Feb 6, 2016 · 1 revision
Clone this wiki locally

Welcome to SuperScouter for First Robotics Competition!

Here's a quick run down on how to use it.

Using the Local Server (Windows only)

SuperScouter Server

Creating Schemas

Click on the Open Schema Editor button:

The Schema Editor

Schema Editor

In the yellow you see the Schema Name field. This is what identifies your schema to SuperScouter. SuperScouter assumes that two schemas with the same name are the same schema.

Note: The Schema name cannot contain periods.

In the green you see the different possible entry types in SuperScouter.

  • Switch
    • Mobile version of a check box. Used for yes/no options.
  • Number Input
    • Used for inputting numbers (i.e. number of points)
  • Slider
    • Used for constrained number inputs (numbers between a minimum value and a maximum value)
  • Textbox
    • Used for text boxes for general comments (i.e. most pit scouting)
  • Multiple Choice
    • Used for a limited number of non-number choices (i.e. defenses in Stronghold)

When you pick a control, a window pops up with choices for a section. Each section corresponds to a column below. Pick the column that the entry goes into. In the image there has been one of each command created in the various sections.

Common elements of each entry type in the editor

Each entry type has two arrow buttons on the left. These are used to re-order elements in the editor. They also have a red x button on the right. This is used to delete the entry.

Each entry also needs to have an ID. These ids must be unique. If they are not, you will not be allowed to save the schema.

There are other attributes for each element that has customizability. In most entries you can set a default value. For multiple choice you build up the entries by using the add item button. You can also allow selecting multiple options with the "Allow multiple" check box.

Saving a schema

Either use the "Save Schema" button on the bottom of the screen, or File > Save on the main menu, or Ctrl+s. They all do the same thing, save into SuperScouter's schema storage, which is located at C:\Users\your username\AppData\Roaming\SuperScouter4FRC. Schemas have the .ssfrcs extension.

Editing a saved schema

NOTE: editing an already deployed schema means that the schema will have to be re-deployed to the mobile devices. If you delete an entry in the schema, then that data will not be exported during the export. Also, deleting an entry and making a new entry of a different type with the same ID will give unexpected results during an export (mainly some missing data in the export). It is strongly recommended (though not required) to finish schema design before a regional and not change it again until after a regional.

Go to File > Open and select your schema. It will open in the editor for you to edit.

Moving a schema between servers

Open the schema storage folder mentioned above and copy the schema to a flash drive. Move the flash drive to the other computer. In the schema editor, go to File > Open and navigate to the flash drive and open the schema. Then save the schema. The schema is now installed on the server.

Deploying a schema

To deploy a schema you need to temporarily set a regional (like when you collect data as covered later). To do this, fill in the regional text box here with a word:

Then Start the HTTP Server (you can start it once there's something in the Regional text box):

In the mobile app, open it up an go to Manage Schemas. Then tap the Add or + on the top of the screen. Enter the IP address of the server as given on the server application here:

If there are multiple listed, you might need to try each of them individually if some do not work. Tap Search. When the available schemas show up, tap the schema that you want and then tap Download Selected. If the schema fails to install, you might not have an updated app version. As new versions are released, new controls will be added. Schemas with these controls will fail to install on app versions that do not have support for the new controls. When you see "Schema successfully installed", then you have installed the schema.