Introduction

Meanscout is a scouting application for FRC Competitions.

Contributing

Meanscout and the API is free and open source. You can find the source code on GitHub and issues and feature requests can be posted on the GitHub issue tracker. If you'd like to contribute, please consider opening a pull request.

Introduction

This is all just detailed(will probably be) documentation for FRC Team 4198's scouting system.

How this started

It was originally started by the 2022 Rapid React scouting lead, Joseph Melancon from a fork of team 2471's scouting app. As the year went on, a freshman rookie by the name Aiden Lee(the one writing this) wrote an API backend in python for Meanscout to easily convert the data into a readable format in a csv file. We would then use that csv and import it into Google Sheets.

Installation

A rundown of installing and using the API along with configuring Meanscout to run with it.

Meanscout Client

This chapter will go into how to use Meanscout, typically located at https://scouting.team4198.org/.

First navigate to the menu button on the top left, in this menu you must change 3 values, these values should not reset unless you tell them to. I recommend double-checking these values every shift change:

  1. Location - set this to the location assigned to you this location does change throughout the day so watch out and make sure you're set to the right location on every shift change.

  2. Event passcode - this is a unique password we will tell you at the event it should be noted that the passcode changes with every event.

  3. Name - literally just a field for your name.

Types of Metrics

This chapter will go over the various types of metrics used in the meanscout client.

Toggle

Bool

Number

Int

Select

String

Text

String

Rating

Int

Timer

Float

More in depth stuff

This will hopefully be where the really in depth stuff behind the api goes, along with meanscout as a whole. If you choose to edit the API, I highly suggest reading the rust book.

API

This section will talk about everything relating to the API and how it works. The API is meant to be the backend to convert data from the client to a readable form.

Endpoints

Endpoints are the points in the API that the Meanscout client can interact through.

/scouting

This endpoint is normally where all of the match data goes through.
Currently the API will take in items via a hardcoded struct located in csvstuff.rs. In the near future this will just dynamically run through the data to eliminate the need to recompile after changing the data. The api currently dynamically parses the data and sorts it with no need of recompilation.

Currently if you change the datapoints on the meanscout client, you may need to delete or move the contents of data.csv. This is because the new data will not fit into the sorted columns that were made before the change. This will be changed in a later version of the meanscout api.

Errors

YAAAAAY ERROSR

Data Management

Contributors

Here is a list of the contributors who have helped with this. Big shout-out to them!

If you feel you're missing from this list, feel free to add yourself in a PR.