Updated docs for 2015.

This commit is contained in:
Patrick Fairbank
2015-09-26 19:53:53 -07:00
parent 413207774b
commit eb2ae740cb
2 changed files with 24 additions and 14 deletions

View File

@@ -7,7 +7,8 @@ Check out a [video overview](http://video.team254.com/watch/Z5ZWI2cDqsvVe--AjHhe
**For participants and spectators:**
* No-lag goal/pedestal lighting and realtime scoring
* Same network isolation and security as the official FIRST FMS
* No-lag realtime scoring
* Team stack lights and sevent-segment display are replaced by an LCD screen, which shows team info before the match and realtime scoring and timer during the match
* Smooth-scrolling rankings display
* Direct publishing of schedule, results, and rankings to The Blue Alliance
@@ -42,6 +43,12 @@ Teams may use Cheesy Arena freely for practice, scrimmages, and off-season event
1. Run the `cheesy-arena` or `cheesy-arena.exe` binary
1. Navigate to http://localhost:8080 in your browser (Google Chrome recommended)
##roboRIO Compatibility
The 2015 FIRST FMS uses dynamic addressing and mDNS; however, the protocol by which it does so has not been documented or reverse-engineered.
As a result, in order to use Cheesy Arena with the 2015 control system, all teams must assign static IP addresses to their roboRIOs and driver stations,
as well as select the *'15 DS, '14 FMS* mode in the driver station settings. See the
[Team Network Configuration wiki page](https://github.com/Team254/cheesy-arena/wiki/Team-Network-Configuration) for more details.
##Under the hood
Cheesy Arena is written using [Go](http://golang.org), a relatively new language developed by Google. Go excels in the areas of concurrency, networking, performance, and portability, which makes it ideal for a field management system.
@@ -68,7 +75,7 @@ Cheesy Arena is far from finished! You can help by:
* Sending baked goods to Pat
##Acknowledgements
The following individuals contributed to make Cheesy Arena a reality:
The following individuals contributed to make the initial release of Cheesy Arena a reality:
* Tom Bottiglieri
* James Cerar
@@ -81,4 +88,6 @@ The following individuals contributed to make Cheesy Arena a reality:
* Andrew Nabors
* Jared Russell
* Austin Schuh
* Colin Wilson
* Colin Wilson
Since then, [several others](https://github.com/Team254/cheesy-arena/graphs/contributors) have contributed pull requests. Thanks!

23
TODO.md
View File

@@ -6,9 +6,7 @@ Cheesy Arena To-Do List
* Awards tracking and publishing
* Elimination bracket report and audience screen
* Interface for viewing logs (right now it's CSV files in Excel)
* Ability to edit match result before committing it
* Configurable match period timing (for test/practice matches only)
* Block driver station port through AP to facilitate on-field tethering
* Log/report to see which teams have successfully connected to the field
* Quality of service
* Twitter publishing
@@ -19,23 +17,26 @@ Cheesy Arena To-Do List
###Scorekeeper-facing features
* Ability to unscore a match and reset it to non-played status
* Role-based cookie authentication
* Ability to mute match sounds from match play screen
* Logging console on Match Play page for errors and warnings
* Schedule generation takes match cycle time in min:sec instead of just seconds
* Team/field timeout tracking and overlay
* Make lower third show/hide commands use websockets instead of POST so that the scrolling doesn't reset when the page reloads
* Allow reordering of lower thirds and sponsor slides in their respective setup pages
* Allow reordering of sponsor slides in the setup page
* Automatic creation of lower thirds for awards
* Persist schedule blocks after schedule generation, in case the schedule needs to be tweaked and re-run
###Features for other volunteers
* Referee interface: add timer starting at field reset to track time limit for calling timeouts/backups
* Referee interface: have separate fouls for tech/non-tech for each applicable rule instead of the extra variable
* Mobile compatibility for FTA and announcer displays
* Automatic download of recent accomplishments (needs better TBA API)
* Mobile compatibility for announcer display
###Cheesy Arena Lite -- a game-agnostic version
* Configurable match period timing
* Realtime scoring: just a simple single number input, plus API
* Final score screen: just show point total and remove breakdowns
* Genericize logos
* Manual input of match name
* Remove match scheduling and team standings functionality
###Development tasks
* Change to use the new FMS API for team data
* Generate more schedules and find an automated way to evaluate them
* Clean up sponsor carousel JavaScript and make it load new slides asynchronously without needing a reload of the audience display page
* Refactor websockets to reduce code repetition between displays with similar functions