deploy: ce29473

.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: f8e4a6fe71d89b848c10235f397ad6b1
+tags: 645f666f9bcd5a90fca523b33c5a78b7

_sources/full-walkthrough/00-navigation/index.rst.txt

@@ -0,0 +1,35 @@
+JMS Navigation
+==============
+
+When browsing to the JMS UI (http://10.0.100.10/), you will be greeted with a page resembling the following.
+
+.. note::
+  On your first login, it will ask for an FTA password. Set this to something you will remember, since this is the admin user for JMS!
+
+.. image:: imgs/peripherals.png
+
+In the main view, you will find a tile for everything the current user is authorised to access. If you're not the admin user, you may only have access to a few of these.
+
+On the peripherals of the screen, you will find a set of buttons and indicators that represent the current state of JMS. These elements are:
+
+- **A**: The Emergency Stop button. The |estop| button is only present for users which have permission to E-Stop the field, usually referees and the FTA/FTAAs. Clicking this button opens a large dialog in which you can confirm or cancel your choice to Emergency Stop the field.
+
+.. warning::
+  Clicking the |estop| button will log who clicked it!
+
+.. image:: imgs/estop-confirm.png
+
+- **B**: The current Arena State. Accompanied by a change in top bar colour, this indicator will change according to the current state of the arena: Idle, Prestart (Working), Prestart (Ready), Emergency Stop, Match ARMed, Auto, Teleop, and Match Complete. In Match Play states (Auto, Teleop), it is accompanied by a countdown timer.
+
+.. image:: imgs/top-bar-estop.png
+.. image:: imgs/top-bar-prestart-ready.png
+.. image:: imgs/top-bar-armed.png
+.. image:: imgs/top-bar-auto.png
+
+- **C**: The current user (if logged in), and the login/logout button.
+
+- **D**: Container Status. JMS is deployed as a set of Docker Containers, each of which with its own purpose and function. A green indicator implies the container is up and running, whilst red usually denotes that it has been stopped or has crashed. Usually, this is only relevant to the FTA, but if you see any of these as red, make sure to alert your FTA!
+
+- **E**: Schedule Clock. When a schedule is loaded, this will tell you how far ahead or behind the field is running. 
+
+- **F**: Refresh button, for if the UI stops responding on a mobile device.

_sources/full-walkthrough/index.rst.txt

@@ -0,0 +1,7 @@
+Full Walkthrough
+=========
+
+This page is all about **using JMS**, i.e. everything you need to do on the day of the event. This walks through each section of JMS in detail.
+
+.. toctree::
+   00-navigation/index

_sources/index.rst.txt

@@ -0,0 +1,11 @@
+Welcome to the JMS documentation!
+===================================
+
+Contents
+--------
+
+.. toctree::
+  :maxdepth: 2
+
+  povs/index
+  full-walkthrough/index

_sources/povs/index.rst.txt

@@ -0,0 +1,14 @@
+POV: You're a .... - A Guide for Users
+=======================================
+
+So your event is using JMS. How do you use it? What do you do? Well, you're in the right place.
+
+This set of pages is all about what you need to do to run a successful event with JMS, according to your role. 
+
+Select your role from the below list for a guided walkthrough.
+
+.. toctree::
+  :maxdepth: 1
+
+  scorekeeper/index
+  referee-scorer/index

_sources/povs/referee-scorer/index.rst.txt

@@ -0,0 +1,90 @@
+REFEREE / SCORER
+================
+
+Referee
+*******
+As a Referee, you're responsible for enforcing the rules outlined in the FRC Game Manual and, depending on the year, scoring certain game elements at the end of the auto and teleop periods.
+
+Your Tablet Screen (accessible from the home page) looks like the below. See :doc:`/full-walkthrough/00-navigation/index` for more information about the peripheral elements.
+
+.. image:: imgs/ref-tablet.png
+
+Fouls and Tech Fouls
+^^^^^^^^^^^^^^^^^^^^
+
+At the centrepoint of the screen is the Foul / Tech Foul counter. This is pretty straightforward - when a team performs an action that earns a foul, increase the counter for *their own alliance* (i.e. if a blue robot is the subject of a foul, click the blue "foul" button). You may also subtract fouls here if you accidentally click a button.
+
+Game Specific
+^^^^^^^^^^^^^
+
+The Referee screen also contains game-specific scores. For 2024, this includes the AUTO LEAVE status of each robot (the set of push-buttons at the bottom), and the state of the Stage and Microphones at the end of the teleoperated period. To enter these scores, select "STAGE & MICS" at the top of the screen.
+
+.. image:: imgs/ref-stage-mic.png
+
+Select the state of each microphone and trap, and then enter the ONSTAGE status of each robot. A "minimap" representation of the stage is provided to orient yourself towards stage left, right, and center - with the vertical marked line representing the AUTO line towards the center of the field. All buttons are colour-coded according to the minimap. 
+
+.. important::
+  You don't have to manually calculate whether a trap or microphone counts for the ONSTAGE/SPOTLIT/other bonuses - JMS will do this for you. Enter the data as it is represented on the field in front of you, and JMS will figure out the rest. 
+
+Scorer
+******
+As a Scorer, you're responsible for scoring the gamepieces on the field. The specifics change from year to year, but in general if a gamepiece exits the field or is scored prior to the endgame period, it's on you to count it.
+
+Your Tablet Screen (accessible from the home page) looks like the below. See :doc:`/full-walkthrough/00-navigation/index` for more information about the peripheral elements.
+
+.. image:: imgs/scorer-tablet.png
+
+After the match starts, each time you see a note exit the AMP or SPEAKER, click the associated button. JMS will log this and calculate the running score for the alliance, whether they can AMPLIFY their speaker, and whether they can trigger the CO-OPERTITION bonus.
+
+At the end of the AUTO period, click the **FINALISE AUTO** button to switch to scoring in TELEOP. 
+
+.. important::
+  Make sure you hit **FINALISE AUTO** at the end of the auto period - it will not happen automatically. JMS needs to know what notes were scored in AUTO and which were scored in TELEOP in order to appropriately calculate the running score!
+
+.. warning::
+  Once you score a game element, it cannot be unscored! This is because the scored elements directly impact the timing of the AMPLIFICATION feature. **If you accidentally hit one of the buttons, note it in the back of your mind and notify the HEAD REFEREE so they can determine the appropriate course of action**.
+
+Head Referee
+************
+
+As Head Referee, your screen will have extra options.
+
+.. image:: imgs/head-ref-tablet.png
+
+Entry Condition
+^^^^^^^^^^^^^^^
+
+In the top right corner, you have access to set the field's ENTRY CONDITION. The ENTRY CONDITION, reflected on the Team Signs, specifies who is allowed on the field at any given time. 
+
+- **UNSAFE**: The default condition. In UNSAFE, the field cannot be entered by anyone except the FTA. This condition will usually be set for you when the field is ARMed by the scorekeeper. 
+- **RESET**: The field is safe for the FIELD RESET crew. This should be set as soon as possible once scores are finalised.
+- **SAFE**: The field is safe for the teams. This should be set once the field is declared safe by the Field Supervisor / FTA.
+
+Disqualification
+^^^^^^^^^^^^^^^^
+
+Also in this screen, you may choose to DISQUALIFY a team, under the provisions set out in the Game Manual.
+
+.. attention::
+  In Qualifications, a DISQUALIFICATION will result in a team being awarded ZERO Ranking Points for that match. In Playoffs, a DISQUALIFICATION for any team will result in ZERO Points for the entire alliance.
+
+  DISQUALIFICATION only applies for a single match.
+
+Edit Scores
+^^^^^^^^^^^
+
+You may choose to edit the scores for a match before or after the score is committed. Strictly speaking, you may do this yourself, but usually you would do this in conjunction with the SCOREKEEPER.
+
+The "Edit Scores" tile on the home screen will take you to the Edit Scores screen, which you can choose to either edit the LIVE scores (prior to the scores being committed), or the COMMITTED SCORES (after the scores have been committed). 
+
+.. image:: imgs/edit-scores-live.png
+
+.. important::
+  All changes to COMMITTED scores are version tracked. 
+
+.. attention::
+  Any changes to the score (once "UPDATE SCORES" in LIVE or "PUSH SCORES" in COMMITTED) is immediately put into effect. Changes will automatically be propagated to the Qualification rankings and on The Blue Alliance.
+
+.. warning::
+  During Playoffs, editing an already COMMITTED score will NOT change the playoff bracket. Once scores are committed, the outcome is locked once the subsequent matches are generated, as otherwise a generated match would have to be deleted.
+

_sources/povs/scorekeeper/before-the-event.rst.txt

@@ -0,0 +1,128 @@
+SCOREKEEPER - Event Setup
+=========================
+
+As Scorekeeper, you play a pivotal role in setting up JMS so the event runs smoothly. This guide will take you through the Event Wizard - the interface used to configure JMS for your event.
+
+To access the Event Wizard, log into JMS (http://10.0.100.10/) and select the "Event Wizard" tile from the homepage.
+
+.. warning::
+  Don't configure anything in "Advanced" or "Integrations" - this should already be done by your FTA. The settings in here are usually to do with integrations with outside services and the field hardware. If you're unsure, chat to your FTA and they will guide you through it. 
+
+.. warning::
+  During event setup, make sure you **check with the FTA** before performing these steps. Although most steps are reversible, it's important the two of you are on the same page!
+
+Managing Users
+**************
+Step 1 is to configure the users of the JMS software. Your FTA should have granted you admin access to JMS, and your volunteer coordinator should have given you a list of volunteers.
+
+In the "User Management" pane, add each of the users who will be using JMS and assign them permissions. A general outline of roles and permissions is given below:
+
+- **FTA** - Admin, FTA
+- **FTAA** - FTAA
+- **Head Referee** - Head Referee
+- **Referee and Scorers** - Scoring, Estop
+- **CSA** - Ticketing
+- **AV** - ManageAudience
+
+Game Announcers and the Audience Display can access their JMS screens without authentication.
+
+.. note::
+  In some games, such as CRESCENDO, Human Players may require a tablet to activate certain field elements. In this case, make a generic HPBlue and HPRed account with *only* the HumanPlayerBlue or HumanPlayerRed role! 
+
+  You'll have to login to their account on their tablets, so make sure when you do that you set a memorable (but hard to guess) PIN.
+
+.. image:: imgs/add-user.png
+
+Give each user their username and instruct them to login as soon as they can to set their PIN. For their first-time login, they can simply login with their username and a blank PIN.
+
+Event Details
+*************
+
+Step 2 is to configure your event. The "Event Details" pane contains everything you need to set in regards to details about the event itself.
+
+.. image:: imgs/event-details.png
+
+**Event Code** is the sync code used for your event. If your event is registered on TheBlueAlliance (TBA), this will be the same code in the URL of your event. If you're running a scrimmage or an event that doesn't sync to TBA, you can leave this blank or make one up in the format <year><code> (e.g. 2024auwarp). Just make sure it's not already taken!
+
+**Event Name** is the event name that will display on all audience screens - make it short and sweet!
+
+**Webcast URLs** are the URLs to where the event is being livestreamed, if any. These will be sync'd with TBA if configured.
+
+**Playoff Settings** describe your playoff format. For most competitions post-2023, this should be a Double Bracket. Configure the number of alliances you wish to have, what awards you want to give out during the breaks, how long per award, and the minimum break between rounds.
+
+.. note::
+  You will have to enter the awards first on the "Manage Awards" pane. You don't have to do this *immediately*, but you should do it before the playoff schedule gets generated.
+
+**AV Settings** are at the bottom and configure the look-and-feel of the Audience Display. Set these in collaboration with your A/V team.
+
+Team Setup
+**********
+
+Next up is setting up the teams who will compete in your tournament. In the "Manage Teams" pane, you can either enter team details one-by-one or load them from a prepopulated CSV prepared by your event coordination team. 
+
+You can edit any team details here at any point during the tournament, but you can only add and delete prior to generating the qualification schedule.
+
+There's also an "Update from TBA" button for convenience, which will populate team name, affiliation, and location if they exist on TBA.
+
+Manage Schedule
+***************
+
+Next up is configuring the event schedule. JMS provides a Google Calendar-esque interface for creating your schedule. You can go in as much or as little detail as you like, but the key parts are the Qualification match blocks and the Playoff match blocks. 
+
+.. image:: imgs/manage-schedule.png
+
+Click-and-drag to enter new blocks. For Qualification matches, you will have to specify a "cycle time" - the time between the start of one match and the start of the following match. Set this value in consultation with your FTA. Most regionals set this to be 7-8 minutes, however for most smaller offseasons 11 minutes is usually recommended.
+
+.. note::
+  Playoff matches will simply grow to the time alloted, so if you're finding your cycle time to be too rapid - try expanding your playoff blocks.
+
+The top of the screen will show you the total amount of quals matches that will be played, as well as the amount of quals matches per team.
+
+.. image:: imgs/schedule-counter.png
+  :scale: 50%
+
+Qualification Schedule
+**********************
+
+The next tab is to generate the Qualification Schedule. Hit the "Generate Qualification Schedule" button and configure your parameters.
+
+.. note::
+  Usually, you can leave these parameters at their default. Most schedules will generate in a matter of seconds, but you can optionally increase these values if you want to be extra sure your schedules are balanced.
+
+After the schedule is generated, you can delete any unplayed matches. Once a match is played, however, it cannot be deleted.
+
+.. important::
+  If you change your schedule blocks / time allocation for qualification matches, you can update the quals schedule in one of two ways:
+
+  **Keep what's been generated and just fill the extra space** by clicking "Generate Qualification Schedule", or
+
+  **Scrap the unplayed matches and regenerate from scratch** by clicking "Delete Unplayed" first.
+
+.. image:: imgs/quals-gen.png
+
+Alliance Selection and Playoffs
+*******************************
+
+At the conclusion of Qualifications, you can start the Alliance Selections process by going to the "Alliance Selections" tab. 
+
+Here, you can move add teams to and move teams between alliances. There's a handy "Promote Captains" button for when alliances pick another alliance's captain, which will the subsequent alliance captains up in rank and invite the next ranked team. 
+
+.. important::
+  Any changes you make here will show on the Audience Display immediately!
+
+The Playoff Schedule should manage itself from this point forth, however you can manually force an update by going to the "Playoff Schedule" tab and selecting "Update Playoff Schedule".
+
+Assign Awards
+*************
+
+You can create and assign awards in the "Manage Awards" pane. To create a new award, simply type its name into the "New Award Name" field and hit "Enter". From here, you can also assign awardees.
+
+.. important::
+  The WINNER and FINALIST awards will be automatically generated, so there's no need to add them in here.
+
+.. warning::
+  Make sure your screen is clear from prying eyes whilst on this pane!
+
+.. image:: imgs/awards.png
+
+Awards can then be displayed from the "Audience Display Controls" tile on the homepage.