From 5bfddd29ca3e7774548548f5a1e8b4b26aab734c Mon Sep 17 00:00:00 2001 From: chiming wang Date: Sun, 24 Mar 2024 12:11:29 -0400 Subject: [PATCH] --- HelpTOC.json | 2 +- Map.jhm | 2 +- app-navigation.html | 4 ++-- building.html | 16 ++++++++-------- exporting-data.html | 4 ++-- getting-started.html | 4 ++-- home.html | 4 ++-- reference.html | 4 ++-- scouting-guide.html | 16 ++++++++++++++++ scouting.html | 4 ++-- 10 files changed, 38 insertions(+), 22 deletions(-) create mode 100644 scouting-guide.html diff --git a/HelpTOC.json b/HelpTOC.json index 51678bb..d88b747 100644 --- a/HelpTOC.json +++ b/HelpTOC.json @@ -1 +1 @@ -{"entities":{"pages":{"Home":{"id":"Home","title":"Argus","url":"home.html","level":0,"tabIndex":0},"Getting_Started":{"id":"Getting_Started","title":"Getting Started","url":"getting-started.html","level":0,"pages":["App-Navigation"],"tabIndex":1},"App-Navigation":{"id":"App-Navigation","title":"Navigating the App","url":"app-navigation.html","level":1,"parentId":"Getting_Started","tabIndex":0},"Scouting":{"id":"Scouting","title":"Scouting","url":"scouting.html","level":0,"pages":["Exporting-Data"],"tabIndex":2},"Exporting-Data":{"id":"Exporting-Data","title":"Exporting Data","url":"exporting-data.html","level":1,"parentId":"Scouting","tabIndex":0},"Reference":{"id":"Reference","title":"Reference","url":"reference.html","level":0,"tabIndex":3},"Building":{"id":"Building","title":"Building","url":"building.html","level":0,"tabIndex":4}}},"topLevelIds":["Home","Getting_Started","Scouting","Reference","Building"]} \ No newline at end of file +{"entities":{"pages":{"Home":{"id":"Home","title":"Argus","url":"home.html","level":0,"tabIndex":0},"Getting_Started":{"id":"Getting_Started","title":"Getting Started","url":"getting-started.html","level":0,"pages":["App-Navigation"],"tabIndex":1},"App-Navigation":{"id":"App-Navigation","title":"Navigating the App","url":"app-navigation.html","level":1,"parentId":"Getting_Started","tabIndex":0},"Scouting":{"id":"Scouting","title":"Scouting","url":"scouting.html","level":0,"pages":["Scouting-Guide","Exporting-Data"],"tabIndex":2},"Scouting-Guide":{"id":"Scouting-Guide","title":"Scouting Guide","url":"scouting-guide.html","level":1,"parentId":"Scouting","tabIndex":0},"Exporting-Data":{"id":"Exporting-Data","title":"Exporting Data","url":"exporting-data.html","level":1,"parentId":"Scouting","tabIndex":1},"Reference":{"id":"Reference","title":"Reference","url":"reference.html","level":0,"tabIndex":3},"Building":{"id":"Building","title":"Building","url":"building.html","level":0,"tabIndex":4}}},"topLevelIds":["Home","Getting_Started","Scouting","Reference","Building"]} \ No newline at end of file diff --git a/Map.jhm b/Map.jhm index b4fff5b..6c8a87f 100644 --- a/Map.jhm +++ b/Map.jhm @@ -1 +1 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/app-navigation.html b/app-navigation.html index d70348a..d53bab7 100644 --- a/app-navigation.html +++ b/app-navigation.html @@ -1,5 +1,5 @@ -Navigating the App | Help Instance

Help Instance Help

Navigating the App

Argus features multiple destinations on its Bottom Navigation Rail that can take you to many helpful places. Another place that you can find additional destinations, is the floating action button, which appears at the bottom right of the screen.

Home

Bottom Navigation Rail

Here are the destinations you can go by clicking the bottom navigation rail.

Duc

This is mostly hidden away without a special toggle for Scouting Leader Mode in settings of the app.

This page is used for scouting leaders to collect data and also manage scouters.

Scouting

This page is the main page used for collecting data and provides a scouting form.

History

This page will show all the matches that have been scouted by a scouter. This allows for quick retrieval of previously scouted matches.

Settings

Tune the application to your heart's content. Features include:

  • Note: YOU MUST ENABLE THE ALTERNATIVE LAYOUT SETTING FOR THE APP TO WORK CORRECTLY!! This is a bug that will be fixed soon.

About

A simple page about the app and the team behind it.

Last modified: 19 March 2024
Getting StartedScouting
\ No newline at end of file +}

Help Instance Help

Navigating the App

Argus features multiple destinations on its Bottom Navigation Rail that can take you to many helpful places. Another place that you can find additional destinations, is the floating action button, which appears at the bottom right of the screen.

Home

Bottom Navigation Rail

Here are the destinations you can go by clicking the bottom navigation rail.

Duc

This is mostly hidden away without a special toggle for Scouting Leader Mode in settings of the app.

This page is used for scouting leaders to collect data and also manage scouters.

Scouting

This page is the main page used for collecting data and provides a scouting form.

History

This page will show all the matches that have been scouted by a scouter. This allows for quick retrieval of previously scouted matches.

Settings

Tune the application to your heart's content. Features include:

  • Note: YOU MUST ENABLE THE ALTERNATIVE LAYOUT SETTING FOR THE APP TO WORK CORRECTLY!! This is a bug that will be fixed soon.

About

A simple page about the app and the team behind it.

Last modified: 24 March 2024
Getting StartedScouting
\ No newline at end of file diff --git a/building.html b/building.html index 9602e20..898b351 100644 --- a/building.html +++ b/building.html @@ -1,5 +1,5 @@ -Building | Help Instance

Help Instance Help

Building

If you would like to build the app from source, please make sure you are building for a support platform:

  1. Windows

  2. Android

  3. iOS (+iPadOS)

Other platforms may be supported, but they are untested and unstable.

Download Flutter SDK

Go to flutter.dev and follow the instructions to download and setup the Flutter SDK for your platform.

Download the source code

This steps requires that you have git installed!

Run

+}

Help Instance Help

Building

If you would like to build the app from source, please make sure you are building for a support platform:

  1. Windows

  2. Android

  3. iOS (+iPadOS)

Other platforms may be supported, but they are untested and unstable.

Download Flutter SDK

Go to flutter.dev and follow the instructions to download and setup the Flutter SDK for your platform.

Download the source code

This steps requires that you have git installed!

Run

git clone https://github.com/rebels2638/ScoutingApp2024 -

Then move into the cloned directory with

+

Then move into the cloned directory with

cd ScoutingApp2024 -

Building for Windows

Run

+

Building for Windows

Run

flutter build windows --release -

The resultant artifacts can be found in build/windows/x64/runner/Release

Building for Android

Make sure you have Android Studio installed! You can find it here

After that, you can either build an app bundle or an APK:

+

The resultant artifacts can be found in build/windows/x64/runner/Release

Building for Android

Make sure you have Android Studio installed! You can find it here

After that, you can either build an app bundle or an APK:

flutter build apk --release --no-tree-shake-icons -

Or

+

Or

flutter build aab --release --no-tree-shake-icons -

The resultant artifacts can be found in build/app/outputs/

Building for iOS/iPadOS

Make sure you have XCode installed. You can more information here

After that you can run:

+

The resultant artifacts can be found in build/app/outputs/

Building for iOS/iPadOS

Make sure you have XCode installed. You can more information here

After that you can run:

flutter build ipa --release -
Last modified: 19 March 2024
Reference
\ No newline at end of file +
Last modified: 24 March 2024
Reference
\ No newline at end of file diff --git a/exporting-data.html b/exporting-data.html index ee9dc58..1c61727 100644 --- a/exporting-data.html +++ b/exporting-data.html @@ -1,5 +1,5 @@ -Exporting Data | Help Instance

Help Instance Help

Exporting Data

Data exports in the app are done via QR code. Wireless (bluetooth) exporting features may be added later.

Exporting Methods

To export data, a match must have been recorded already. To access the data exporting menu, open the "Recorded" page from the bottom navbar.

DUC Share

DUC is the primary method for giving data to the scouting leaders during competitions. After a match has been recorded, a scouter can simply press the DUC share button and show the DUC QR code to their scouting leader.

QR Share

QR Share is a simpler data sharing method that isn't used as much as DUC.

Importing Data (for Scouting Leaders)

To import data, a Scouting Leader must first enable the Scouting Leader-only DUC menu, which can be done from the Settings page.

To import a DUC code, the Scouter can press "Scan DUC" in the DUC menu and use their device's built-in camera to scan the QR code from a scouter.

Last modified: 20 March 2024
ScoutingReference
\ No newline at end of file +}

Help Instance Help

Exporting Data

Data exports in the app are done via QR code. Wireless (bluetooth) exporting features may be added later.

Exporting Methods

To export data, a match must have been recorded already. To access the data exporting menu, open the "Recorded" page from the bottom navbar.

DUC Share

DUC is the primary method for giving data to the scouting leaders during competitions. After a match has been recorded, a scouter can simply press the DUC share button and show the DUC QR code to their scouting leader.

QR Share

QR Share is a simpler data sharing method that isn't used as much as DUC.

Importing Data (for Scouting Leaders)

To import data, a Scouting Leader must first enable the Scouting Leader-only DUC menu, which can be done from the Settings page.

To import a DUC code, the Scouter can press "Scan DUC" in the DUC menu and use their device's built-in camera to scan the QR code from a scouter.

Last modified: 24 March 2024
Scouting GuideReference
\ No newline at end of file diff --git a/getting-started.html b/getting-started.html index 93a4910..89c4099 100644 --- a/getting-started.html +++ b/getting-started.html @@ -1,5 +1,5 @@ -Getting Started | Help Instance

Help Instance Help

Getting Started

Argus is only supported on a few platforms, but we are trying to make it more and more accessible to platforms like Linux & Browsers. At the moment, only Windows, MacOS, iOS, and Android are supported.

Downloading

GitHub Download

You can find downloads for Android & Windows on our GitHub here

Google Playstore

Click here

Apple Appstore

Click here

Last modified: 19 March 2024
ArgusNavigating the App
\ No newline at end of file +}

Help Instance Help

Getting Started

Argus is only supported on a few platforms, but we are trying to make it more and more accessible to platforms like Linux & Browsers. At the moment, only Windows, MacOS, iOS, and Android are supported.

Downloading

GitHub Download

You can find downloads for Android & Windows on our GitHub here

Google Playstore

Click here

Apple Appstore

Click here

Last modified: 24 March 2024
ArgusNavigating the App
\ No newline at end of file diff --git a/home.html b/home.html index 8463d0e..75a1515 100644 --- a/home.html +++ b/home.html @@ -1,5 +1,5 @@ -Argus | Help Instance

Help Instance Help

Argus

Argus is a scouting app created by team 2638 "Rebel Robotics" for the 2024 FRC Game CRESCENDO. It is written using Flutter and you can find it on GitHub here.

You can also read the code's API documentation here

Getting Started

If you want to start using the app, read the Getting Started Page

Building

If you would like to build the app yourself from source, check out Building.md

Last modified: 19 March 2024
Getting Started
\ No newline at end of file +}

Help Instance Help

Argus

Argus is a scouting app created by team 2638 "Rebel Robotics" for the 2024 FRC Game CRESCENDO. It is written using Flutter and you can find it on GitHub here.

You can also read the code's API documentation here

Getting Started

If you want to start using the app, read the Getting Started Page

Building

If you would like to build the app yourself from source, check out Building.md

Last modified: 24 March 2024
Getting Started
\ No newline at end of file diff --git a/reference.html b/reference.html index c048f58..9639eeb 100644 --- a/reference.html +++ b/reference.html @@ -1,5 +1,5 @@ -Reference | Help Instance

Help Instance Help

Reference

Useful information to know for FRC and CRESCENDO. Make sure you know everything here. Game knowledge is extremely important for scouting.

Glossary

Useful Terms to Know

Autonomous

The Autonomous (Auto) Period is during the first 15 seconds of the game when robots are required to run autonomously without input from the human drivers.

Tele-op

The Tele-operated Period is the part of the game after the Auto period where human drivers have control of the robot.

Taxi

In Autonomous, when the robot crosses the line of tape in the starting area, this is referred to as "taxiing." The team receives points for this.

Stage

The Stage is the area on the game field where robots can climb onto the chain and score Notes in the Trap. Robots score points for parking on stage (touching the red/blue lines around the Stage), climbing onto the chains on the stage, and scoring Notes in the Trap

Last modified: 19 March 2024
Exporting DataBuilding
\ No newline at end of file +}

Help Instance Help

Reference

Useful information to know for FRC and CRESCENDO. Make sure you know everything here. Game knowledge is extremely important for scouting.

Glossary

Useful Terms to Know

Autonomous

The Autonomous (Auto) Period is during the first 15 seconds of the game when robots are required to run autonomously without input from the human drivers.

Tele-op

The Tele-operated Period is the part of the game after the Auto period where human drivers have control of the robot.

Taxi

In Autonomous, when the robot crosses the line of tape in the starting area, this is referred to as "taxiing." The team receives points for this.

Stage

The Stage is the area on the game field where robots can climb onto the chain and score Notes in the Trap. Robots score points for parking on stage (touching the red/blue lines around the Stage), climbing onto the chains on the stage, and scoring Notes in the Trap

Last modified: 24 March 2024
Exporting DataBuilding
\ No newline at end of file diff --git a/scouting-guide.html b/scouting-guide.html new file mode 100644 index 0000000..5b2a349 --- /dev/null +++ b/scouting-guide.html @@ -0,0 +1,16 @@ + +Scouting Guide | Help Instance

Help Instance Help

Scouting Guide

Not sure how to start Scouting with Argus? Here's a quick guide.

Scouting with the app is simple and intuitive. Before Scouting, make sure you have basic knowledge of the CRESCENDO! game and game field. Also, it's extremely important that you have the latest version of the Scouting App. If you don't remember any vocabulary related to CRESCENDO! or FRC, refer to the Reference Page

Starting a Scouting Session

Upon opening the app, press the "New Session" button to start a scouting session.

Note: Due to a small bug, "Alternative Layout" must be enabled in settings for the app to display data correctly. This bug will be fixed in the future.

Recording the Match

When scouting a match/robot, you should be sure to enter all possible information:

Match Information

In the Match Information section, be sure to record the Match Number (Round Number) and the Match Type.

Note: Match Number is the round number for the entire FRC event, not your personal match number! Example: if it's your 13th scouted match, but the match is Qualification Round #30, set the match number to 30.

Team Information

Make sure to record the team number, alliance color, and starting position.

Autonomous

It's time to actually start scouting! In the Autonomous section, you will be recording data for the Autonomous (auto) part of the match (first 15 seconds).

Here, you will be recording how the robot's Auto programming performs, and how their Auto strategy works.

Make sure you record which notes the robot picks up, and the number of shots scored during Auto.

Tele-op

In tele-op, human drivers have control of the robot. Make sure you input all types of information here. It's extremely important for us to know how the human drivers think and perform, and what strategies they use during the match. They can also record strategy-specific information, like if the team Lobs or not.

Note: Ignore the "Pieces Scored" buttons and only use the "Scored in Speaker," "Scored in AMP," and "Scored while AMPed" buttons.

Note 2: "Score while AMPed" is referring to the number of Notes scored in the speaker while the Amp is activated.

Endgame

Endgame is the last phase of the match where teams try to go on stage, climb the chains, score in the trap, or score in the Microphone.

In the endgame section, make sure to record all this information, as well as the result of the match (Win/Loss/Tie)

Other

This section includes important information that doesn't fit in any of the above sections. This includes information about coopertition and breakdowns.

In this section, you can also include any comments you have about the robot, drivers, autonomous, etc.

Important: please make sure you provide specific and informative comments!

Last modified: 24 March 2024
ScoutingExporting Data
\ No newline at end of file diff --git a/scouting.html b/scouting.html index ba18149..0da3617 100644 --- a/scouting.html +++ b/scouting.html @@ -1,5 +1,5 @@ -Scouting | Help Instance

Help Instance Help

Scouting

Scouting with the app is simple and intuitive. Before Scouting, make sure you have basic knowledge of the CRESCENDO! game and game field. Also, it's extremely important that you have the latest version of the Scouting App. If you don't remember any vocabulary related to CRESCENDO! or FRC, refer to the Reference Page

Starting a Scouting Session

Upon opening the app, press the "New Session" button to start a scouting session.

Note: Due to a small bug, "Alternative Layout" must be enabled in settings for the app to display data correctly. This bug will be fixed in the future.

Recording the Match

When scouting a match/robot, you should be sure to enter all possible information:

Match Information

In the Match Information section, be sure to record the Match Number (Round Number) and the Match Type.

Note: Match Number is the round number for the entire FRC event, not your personal match number! Example: if it's your 13th scouted match, but the match is Qualification Round #30, set the match number to 30.

Team Information

Make sure to record the team number, alliance color, and starting position.

Autonomous

It's time to actually start scouting! In the Autonomous section, you will be recording data for the Autonomous (auto) part of the match (first 15 seconds).

Here, you will be recording how the robot's Auto programming performs, and how their Auto strategy works.

Make sure you record which notes the robot picks up, and the number of shots scored during Auto.

Tele-op

In tele-op, human drivers have control of the robot. Make sure you input all types of information here. It's extremely important for us to know how the human drivers think and perform, and what strategies they use during the match.

Note: Ignore the "Pieces Scored" buttons and only use the "Scored in Speaker," "Scored in AMP," and "Scored while AMPed" buttons.

Note 2: "Score while AMPed" is referring to the number of Notes scored in the speaker while the Amp is activated.

Endgame

Endgame is the last phase of the match where teams try to go on stage, climb the chains, score in the trap, or score in the Microphone.

In the endgame section, make sure to record all this information, as well as the result of the match (Win/Loss/Tie)

Other

This section includes important information that doesn't fit in any of the above sections. This includes information about coopertition and breakdowns.

In this section, you can also include any comments you have about the robot, drivers, autonomous, etc.

Important: please make sure you provide specific and informative comments!

Last modified: 19 March 2024
Navigating the AppExporting Data
\ No newline at end of file +}

Help Instance Help

Scouting

Scouting with the app is simple and intuitive. Scouters can input information via the number selection wheels, true/false buttons, and number increment buttons.

Starting a Scouting Session

Upon opening the app, scouters press the "New Session" button to start a scouting session.

Note: Due to a small bug, "Alternative Layout" must be enabled in settings for the app to display data correctly. This bug will be fixed in the future.

Recording the Match

When scouting a match/robot, there are many essential pieces of information to record:

Match Information

In the Match Information section, scouters can record important information about the match.

Team Information

Here, scouters record information about a specific team that allows the Scouting Leaders to identify teams later.

Autonomous

In the Autonomous section, scouters can record data for the Autonomous part of the match. This includes information like which notes the robot picks up, how many notes they score in the speaker, etc.

Tele-op

In the tele-op section, scouters record information on what the human driver is doing with the robot during the teleoperated period.

Endgame

The endgame section includes endgame-specific information like if the team attempted to climb on chain, achieve harmony, or score on the mic.

Other

This section includes important information that doesn't fit in any of the above sections. This includes information about coopertition and breakdowns.

Last modified: 24 March 2024
Navigating the AppScouting Guide
\ No newline at end of file