2020 Scouting System Planning

[yuliu2016]

This is an ongoing list of tasks to be completed for the 2020 version of the scouting app. The codebase needs to be completed by February 14th, 2020 (3 weeks before the first competition). Data analysis is not included in this list as it's a lot more flexible.

Scouting App Features and Enhancements

This section includes enhancements to the scouting app compared with last season

UI/UX

• Create scouting layouts for 2020
  • Autonomous Screen Add new layouts and improve Boardfile #16
  • Teleop Screen Add new layouts and improve Boardfile #16
  • Endgame Screen Add new layouts and improve Boardfile #16
  • Super Scouting Add templates for super scouting #38
  • Add Tags Add Support for Tags #36
• Explore changing the app icon Deferred
• Add a SliderField with discrete values Deferred
  • Explore continuous values not possible due to limitations of the V6 Encoder
• Add settings item for team number @LocPham2003 Validate team number with pop up Toast #6 Team number validation #13
  • Validate team number
  • Remember number
• Add settings item for event @LocPham2003 Validate team number with pop up Toast #6 Team number validation #13
  • Show events with the team in it from TBA
  • Add an override-with-key option
  • Remember event key
• Explore merging already-scouted entries with the match schedule Rejected
• Explore deleting a scouted entry Rejected
• Enable super-scouting board Implement the V6 Data Encoder #11
• Explore adding a popup screen for buttons that are not often used Rejected for tags in comments
• Explore adding a section of the screen that doesn't move Rejected
• Integrate match schedule into the main activity if the event key preference exists Integrate Match Schedule from The Blue Alliance #19
• Highlight team-in-event on the match schedule Add adjustments to EntryListAdapter #27
• Add event selection activity

Data Backend

• Implement V6 Encoding
  • Explore tracking precision to 10th of a second
  • Explore tracking precision to 100th of a second
  • Explore Implement removing the space in the scout name
  • Explore Implement removing the event name Simplifying the event name
  • Explore remove the undo count
  • Explore Implement optimizing index lookup with a binary search
  • Add a displayName property to Board, and remove board_choice string resource
  • Change time tracker from Int to Double
  • Reimplement the focused function with a modified binary search, which returns true if time is "close enough"
• Create a specification format in JSON so that the setup (scouting metrics, screens, etc.) can be changed without changing code
  • Design the scouting screen template format
  • Implement a parser and serializer Add new layouts and improve Boardfile #16
  • Implement reading from and writing to files Add new layouts and improve Boardfile #16
  • Explore Opening the file using a file extension Rejected
  • Explore adding TBA key and team number Rejected
  • Explore adding match schedule Rejected
  • Remove hard-coded exampleBoardfile Add new layouts and improve Boardfile #16
• Explore adding condensed data tracking for ButtonField Rejected. Timetamp is important.
• Add fetching match schedules from TBA Integrate Match Schedule from The Blue Alliance #19
• Explore the ability to cache TBA match schedules Add API interface for The Blue Alliance #7 and Integrate Match Schedule from The Blue Alliance #19
• Explore the ability to remember previously scouted matches after the app is closed
  • Add settings option to clear the history Rejected for automatic hiding on event change

App Architecture

• Remove 2018 app (v4) from the codebase, including classes and resources
• Integrate the Toggle Switch Button library directly in the codebase
• Integrate the Kotlin TBA library in the codebase Add API interface for The Blue Alliance #7
  • Replace direct calls of URL.openConnection with the library functions Integrate Match Schedule from The Blue Alliance #19
• Setup a CI workflow with GitHub Actions
  • Explore enforcing branching/pull requests
  • Explore automatic publishing
  • Explore linting
• Set up a unit testing framework Add JUnit testing framework #8

Alpha Release Change List

This section includes issues/bugs that are fixed as they are found through the development of 2020.1.0-alpha

Regressions

• Fix a regression caused by a getString call to a nonexisting string resource, making the Settings activity crash when started Fix a regression that causes a string resource missing #9
• Fix a regression caused by a potential null-receiver on the shared preferences Fix a regression that causes a string resource missing #9
• Revert binary search algorithm causing infinite loops
• Fix a regression caused by attempting to format a double string, by adding integer conversion to the displayed time
• Fix a null pointer exception trying to access the vibrator before the context is fully created
• Fix an extra tab state update caused by a Handler method call in SwitchField
• Fix a string encoder regression that produces duplicate characters in each data point, which is caused by different bitwise operator precedence between Java and Kotlin
• Fix a regression on the getNextIndex function always returning 1 when the time is 0
• Fix a regression caused by getRelativeTime returning match time field
• Fix a regression caused by the data class of TemplateField overriding equals Add serialization to EntryInMatch #29

Code Quality

• Condense root package into less number of files
• Write unit tests for the V6 Encoder
• Write V6 changes in the code docs
• Refactor .v5 out of the codebase Refactor "v5" out of the codebase #10
• Move currentTime out of the scouting activity interface as it's only used in the implementation
• Remove ManagedPreferences
• Remove handler from the scouting activity interface
• Refactor relativeTime into a function instead of property
• Refactor ScoutingActivity's UI components from lateinits to getters
• ScoutingActivity: Move intent processing into local scope
• Move board names from string resources to Board
• Refactor MainActivity's UI components from lateinits to getters Reorganize MainActivity for code clarity and bug fix #18
• Reorganize MainActivity into more functions Reorganize MainActivity for code clarity and bug fix #18
• Move validateName to a top-level file Reorganize MainActivity for code clarity and bug fix #18
• Fix deprecated call to FragmentPagerAdapter Fix deprecated call to FragmentPagerAdapter #24
• Refactor EventInfo into new package Refactor EventInfo into new package #23
• Remove unnecessary data modifier in classes Add serialization to EntryInMatch #29
• Change EntryItemState into two properties: isComplete and isScheduled Add serialization to EntryInMatch #29
• Rename EntryItem to EntryInMatch Add serialization to EntryInMatch #29

UI/UX

• Add a settings option to relax the restriction on scout name by allowing multiple initials after the first name Reorganize MainActivity for code clarity and bug fix #18
• Fix crash if permission is not granted in MainActivity Reorganize MainActivity for code clarity and bug fix #18
• Fix hardcoded colours for EntryListAdapter Replace hardcoded colours in EntryListAdapter #14
• Simplify vibration by making it a function in BaseScoutingActivity Implement the V6 Data Encoder #11
• Explore improving the event selector box to be non-scrolling Deferred
• QRCodeFragment: Do not update unless data points or comments change Implement the V6 Data Encoder #11
• Hide non-scouted entries with eye toggle Remove eye toggle Reorganize MainActivity for code clarity and bug fix #18
• Remove "qm" qualifier from UI, and add M to keep consistency Reorganize MainActivity for code clarity and bug fix #18
• Update Remove "eye" icon to better reflect purpose due to being unused Reorganize MainActivity for code clarity and bug fix #18
• Make more space for event name by making the toolbar text smaller Tweak UI elements in MainActivity #20
• Remove bold font in the app to make UI more consistent Tweak UI elements in MainActivity #20
• Change "add new entry" font size to match the rest of the UI Add adjustments to EntryListAdapter #27
• Remove separate color for Added entry state Add adjustments to EntryListAdapter #27
• Swap outer and inner buttons on the two screens @LocPham2003 Switch "Inner" and "Outer" button positions #28
• Event selection: Exit to main instead of settings Event Selection: Exit to MainActivity instead of Settings #30
• Replace schedule searching with result intent Add serialization to EntryInMatch #29
• Add periodicUpdate function to avoid self-referencing Runnable Add serialization to EntryInMatch #29
• ScoutingActivity: Remove old hidden feature timerIsCountingUp on title banner Add serialization to EntryInMatch #29
• EntryInMatch: Add CSV converter Add serialization to EntryInMatch #29
• Layout: Remove the Inner button

Data Backend

• Remove isTiming property from entry implementation due to always true Implement the V6 Data Encoder #11
• DataPoint: Stop Implementing Iterable<Byte> Implement the V6 Data Encoder #11
• BaseScoutingActivity.relativeTime: Use Double to avoid conversion in fields Implement the V6 Data Encoder #11
• Remove incorrect return of low - 1 in getNextIndex Implement the V6 Data Encoder #11
• Rename focused to isFocused for clarity Implement the V6 Data Encoder #11
• Update Boardfile.json with serializer Add new layouts and improve Boardfile #16
• Separate eventKey, eventName, and matchSchedule from Boardfile into EventInfo Add new layouts and improve Boardfile #16
• Set up build config script to hide TBA key Move TheBlueAlliance Key from code to BuildConfig #15
• FieldType: Rename Toggle to MultiToggle for clarity Add new layouts and improve Boardfile #16
• Remove exampleMatchSchedule Integrate Match Schedule from The Blue Alliance #19
• Boardfile: Separate version into year and revision Boardfile: Separate version into year and revision #22
• Pass entire entry as an intent to ScoutingActivity Add serialization to EntryInMatch #29
• ScoutingActivity: Pause timer when the activity pauses ScoutingActivity: Fix match timer handling #31
• ScoutingActivity: Keep the screen on while scouting ScoutingActivity: Fix match timer handling #31
• Distinguish buttons with the same name between auto and tele

App Architecture

• Update code dependencies
  • Kotlin 1.3.60
  • Android Tools 3.5.3
  • Android 10 Target SDK
  • AndroidX artifacts for appcompat
• Fix an issue caused by the absence of local.properties on CI builds
• Update .gitignore to exclude gradle.properties

Beta Release Change List

This section includes issues/bugs that are fixed as they are found through the development of 2020.1.0-beta

Regressions

• Fix undo not showing up on QR code scanner if there is only one data point Fix various bugs for 2020.1.0-beta #40
• Critical Fix inverted value on Checkbox and Switch Revise the imlementation of field views #34
• Fix a regression where tapping on the bounding box of a CheckboxField inverts it Add Support for Tags #36

UI/UX

• Add ripple effect on ButtonField, SwitchField and CheckboxField to make it consistent with other buttons Revise the imlementation of field views #34
• Fix colors in ripple_transparent Revise the imlementation of field views #34
• Fix activity crash when nothing is entered in an unscheduled match Add persistent scouted entries and bug fixes in MainActivity #39
• Add tags in the comment text box Add Support for Tags #36
• Add retainInstance to tab fragments Add team number templates for super scouting #37
• Add team number templates Add team number templates for super scouting #37
• Add team number templates for tags Add templates for super scouting #38
• Add Switch Lite Add templates for super scouting #38
• Add team number templates for MultiToggle Add templates for super scouting #38
• Add settings hint in MainActivity Add persistent scouted entries and bug fixes in MainActivity #39
• Lift restriction on adding unscheduled matchs while in a super scouting board Add persistent scouted entries and bug fixes in MainActivity #39
• Add option to delete a scouted entry Add persistent scouted entries and bug fixes in MainActivity #39
• Switch Lite: Don't disable when not in timed scouting Fix various bugs for 2020.1.0-beta #40

Data Backend

• Change field data to zero-indexed Revise the imlementation of field views #34
• Add RelativeBoard for team templates Add team number templates for super scouting #37
• Add match schedule to super scouting encoder Add templates for super scouting #38
• Fix the blue alliance instance always using cache-first Fix various bugs for 2020.1.0-beta #40

Code Quality

• Extract inline strings into resources Add Support for Tags #36
• Remove boardfile from BaseScoutingActivity Add team number templates for super scouting #37
• Remove updateTabStates from BaseScoutingActivity Add team number templates for super scouting #37
• Clean up boardfile, getScreens, and pagerAdapter in ScoutingActivity Add team number templates for super scouting #37

Final Change List

This section includes issues/bugs that are fixed as they are found through the development of 2020.1.0 final

• Rename Field Areas and re-word some buttons in the layout Fix wording and remove the generic option field in Boardfile #41
• Remove generic options field in JSON Fix wording and remove the generic option field in Boardfile #41
• Remove and Serializer.kt Fix wording and remove the generic option field in Boardfile #41
• Super Scouting: Fix match not saved when start timer is not clicked Super Scouting: Fix lost match when timer not started #42
• QRCodeFragment: Fix encoded text not showing up QRCodeFragment: Fix encoded text not showing up #43
• Auto: Change intake buttons to reflect zones Auto: Change intake buttons to reflect zones #44
• Add updateAdjacentTabState call when additional info is edited Add updateAdjacentTabState call when additional info is edited #45

Desktop Tools

This section includes the development of desktop tools for the scouting system

WARP7 Scouting Scan Tool Features

• Implement new QR Code Scanner
  • Multiple cameras, with the ability to refresh
  • Image flipping
  • Image resizing to screen
  • AutoSave
  • Open saved data
  • Skip incompatible lines in the save file
  • Sort matches
  • Scout Stats
  • Duplicate Detection
  • Missing Entries Detection
• Set up a repository in the team GitHub account repo link
  • Port the code as a separate Gradle build
  • Publish 2020.1.0 (initial release)
  • Publish 2020.1.1 (bug fixes)
  • Publish 2020.2.0 (v6 encoding, super scouts)
• Package Scanner as stand-alone installer
• Update to Encoding V6, potentially changing event, scout name, and undo
• Explore adding CSS into the application
• Add an "About" section
• Explore fullscreen shortcuts

WARP7 Scouting Scan Tool Bugs

• Change app icon from PNG to ICO
• Change ICO size to maximum
• Add correct icon to the window
• Add ownership to child windows in the main stage
• Change application title
• Change confirm function from Alert to Dialog<ButtonType>
• Refactor Cells.kt into separate classes
• Fix "Open File" not showing entries Move Java classes out of Kotlin source folder
• Remove restriction on super scouts in Missising Entries
• Add M prefix to scout stats and table
• Change title to include app version

Raw Data Processing

• Implement the V6 Decoder in Python
• Implement board file lookup in Python
• Implement basic processing @EvanBialo