# RotorHazard Race Timer User Guide - [Initial Setup](#initial-setup) - [Hardware and Software Setup](#hardware-and-software-setup) - [Connect to the Server](#connect-to-the-server) - [Pages](#pages) - [Home](#home) - [Event](#event) - [Results](#results) - [Current](#current) - [Settings](#settings) - [Run](#run) - [Marshal](#marshal) ## Initial Setup ### Hardware and Software Setup Follow the instructions here if not done already:
[Hardware Setup](Hardware%20Setup.md)
[Software Setup](Software%20Setup.md)
[RF shielding](Shielding%20and%20Course%20Position.md) ### Connect to the Server A computer, phone or tablet may be used to interact with the race timer by launching a web browser and entering the IP address of the Raspberry Pi. The Raspberry Pi may be connected using an ethernet cable, or to an available WiFi network. If the IP address of the Pi is not known, it may be viewed using the terminal command "ifconfig", and it can configured to a static value on the Pi desktop via the "Network Preferences." If the Pi is connected to a WiFi network, its IP address may be found in the 'Clients' list on the admin page for the network's router. In the web browser, type in the IP address of for the race timer and the port value you set in the config file. (You may leave off the :port if set to 80 or [port forwarding from 80](Software%20Setup.md#enable-port-forwarding) is enabled.) ``` XXX.XXX.XXX.XXX:5000 ``` Once the page is successfully displayed, it may be bookmarked in the browser. Pages reserved for the race director ("Admin / Settings") are password protected with the username and password specified in the config file. ## Pages ### Home This page displays the event name and description, along with a set of buttons to various other pages. ### Event This public page displays the current class setup (if applicable), and a summary of pilots and their heats with channel assignment. ### Results This public page will display results and calculated statistics of all previously saved races, organized into collapsible panels. Aggregate results are displayed for each heat with multiple rounds, each class, and the entire event. ### Current This page displays information about the currently running race, including real-time race time, pilot lap times and leaderboard. It automatially updates with the event, and is suitable for projecting to a prominently displayed screen. In the Audio Control section, the user can select whether any one pilot, all pilots, or no pilots will have laps announced. In this way, a pilot might elect to hear only their own laps announced. A user can also adjust the voice, volume, rate, and pitch of these announcements. ### Settings This page allows changing the timer's optional settings and event setup. #### Frequency Setup Choose a preset or manually select frequencies for each node. Arbitrary frequency selection is possible, as is disabling a node. The IMD score for currently selected frequencies is calculated and displayed at the bottom of the panel. Profiles contain frequencies and node tuning values. Changing this list immediately activates the selected profile, and changing current frequencies and node tuning immediately saves to the profile. #### Sensor Tuning See [doc/Tuning Parameters.md](Tuning%20Parameters.md) for a detailed description and tuning guide. #### Event and Classes Event information is displayed on the home page when users first connect to the system. Classes are not required for events; there's no need to create a class unless you will have two or more in the event. Classes can be used to have separate generated statistics for groups of heats. For example, Open and Spec class, or Beginner/Pro classes. #### Heats Add heats until there are enough for all pilots racing. Optional heat names can be added if desired. Heat slots may be set to *None* if no pilot is assigned there. If you are using classes, assign each heat to a class. Be sure to add enough heats for each pilot in each class; heats assigned to one class are not available in another. As you run races, heats will become locked and cannot be modified. This protects saved race data from becoming invalid. To modify heats again, open the *Database* panel and clear races. #### Pilots Add an entry for each pilot that will race. The system will announce pilots based on their callsign. A phonetic spelling for a callsign may be used to influence the voice callouts; it is not required. #### Audio Control All audio controls are local to the browser and device where you set them, including the list of available languages, volumes, and which announcements or indicators are in use. Voice select chooses the text-to-speech engine. Available selections are provided by the web browser and operating system. Announcements allow the user to choose to hear each pilot's callsign, lap number, and/or lap time as they cross. The "Race Clock" announcement will perioically call out how much time has elapsed or is remaining, depending on the timer mode in the race format. "Team Lap Total" is used only when "Team Racing Mode" is enabled. Voice volume, rate, and pitch control all text-to-speech announcements. "Tone Volume" controls race start and end signals. Indicator beeps are very short tones that give feedback on how the timer is working, and are most useful when trying to tune it. Each node is identified with a unique audio pitch. "Crossing Entered" will beep once when a pass begins, and "Crossing Exited" will beep twice rapidly when a pass is completed. "Manual Lap Button" will beep once if the "Manual" button is used to force a simulated pass. If you select "Use MP3 Tones instead of synthetic tones" then the '.mp3' files at "src/server/static/audio" will be used to play the tones. #### Event Actions Extend and personalize your timer's behavior by attaching *Effects* to *Events*. The timer generates an *Event* on race start, lap recorded, pilot done, etc. *Effects* are behaviors that can be triggered. Each effect may have parameters which can be configured. For example, you might add the "Speak" effect to the "Pilot Done" event in order to call out when each pilot has completed their own laps. * _Speak_ produces an audible voice callout * _Message_ creates a standard text notification * _Alert_ creates a priority (pop-up) alert message For the above effects, you can use "%PILOT%" for a callsign when a pilot triggers the event. #### Race Format Race formats define how a race is conducted. Choose an active race format. Settings that you adjust here will be saved to the currently active format. Hitting the "+" button will duplicate the current race format, and the "x" button will remove the current race format. (Once a race format is removed there is not a direct way to recover it, but if you go to "Settings | Database", select "Races and Race Formats" in the drop-down and then hit "Clear Data" it will restore the race formats to the original set. Note that any customized race formats will be deleted.) The race clock can count up or down as selected by _Race Clock Mode_. Use "No Time Limit" for a "First to X laps" style with a timer that counts upward from zero. Use "Fixed Time" for a timer which counts down to zero after the race starts. _Timer Duration_ is used in "Fixed Time" mode to determine race length. During a "Fixed Time" race, _Grace Period_ is the amount of time after the race clock expires before the timer is automatically stopped. Set _Grace Period_ to "0" to stop a race immediately when time expires. If _Grace Period_ is set to "-1", the clock continues indefinitely and must be stopped manually. Each race begins with a staging sequence. Adjust the _Prestage Tones_ value to control the length of the *prestage* phase, during which one tone will sound each second. Next is the *staging* phase, which can be a fixed or random duration. _Minimum Staging Time_ sets a fixed minimum duration for the *staging* phase. If _Random Staging Time_ is greater than zero, the timer will additionally delay randomly between zero and this value. Setting _Random Staging Time_ above zero also hides the staging clock, which will show "Ready" instead of a countdown. Choose whether tones are heard during the *staging* phase with _Staging Tones_. #####Examples: * A fixed "3, 2, 1, Go" countdown start: * _Prestage Tones_: 3 * _Staging Tones_: (any) * _Minimum Staging Time_: 1.0 * _Random Staging Time_: 0.0 * 1 prestage tone followed by a start tone within 1–5 seconds: * _Prestage Tones_: 1 * _Staging Tones_: None * _Minimum Staging Time_: 1.0 * _Random Staging Time_: 5.0 * 5 prestage tones followed by a random delay between 0.2 and 3.0 seconds: * _Prestage Tones_: 5 * _Staging Tones_: None * _Minimum Staging Time_: 0.2 * _Random Staging Time_: 2.8 * A variable number of tones between 2 and 5, then start: * _Prestage Tones_: 2 * _Staging Tones_: Each Second * _Minimum Staging Time_: 0.2 * _Random Staging Time_: 3.7 _A small amount of time is needed to ensure the timer has synchronized with all hardware, so there is always a short period to start a race even with all staging times set to zero._ When a pilot crosses for the first time in a race, _First Crossing_ affects how result displays and race outcomes are processed. "Hole Shot" records the race time of each pilot's first crossing as beginning their first lap. "First Lap" records the race time of each pilot's first crossing as ending their first lap. "Staggered Start" begins each pilot's own race clock their first crossing, disregarding the global race clock. "Staggered Start" is typically combined with the "No Time Limit" _Race Clock Mode_. _Win Condition_ determines how the timer calls out the winner of the race, the information presented in the OSD and streaming display, and sort method for leaderboards. Leaderboard sorting affects the results page and heat generator. * __Most Laps in Fastest Time__: Pilots are judged by the number of laps completed and how long it took to complete them. If there is a tie for the number of laps completed, the pilot who completed those laps in a shorter amount of time will be ranked higher. * __Most Laps Only__: Scored only by the completed lap count. Pilots with the same lap count are tied. Use with "Fixed Time" mode for a race style before timing was reliable, or with "No Time Limit" mode to judge the greatest distance instead of shortest time. * __Most Laps Only with Overtime__: Similar to _Most Laps in Fastest Time_, but with a "sudden death" component. When the timer expires (or the race is stopped early), if a pilot has more laps than all the others then that pilot is the winner. If there is a tie for lap count when the timer expires, the first of the tied pilots across the line is the winner. * __First to X Laps__: The race continues until one pilot reaches the desired lap count. In this mode, the _Number of Laps to Win_ parameter is used. Typically used with the _No Time Limit_ race mode. * __Fastest Lap__: Ignores the race progress and considers only each pilot's single fastest lap. * __Fastest 3 Consecutive Laps__: Considers all laps a pilot has completed and uses the three consecutive laps with the fastest combined time. * __None__: Does not declare a winner under any circumstance. Heats generated from a class with this condition will be assigned randomly. _Team Racing Mode_ activates alternate scoring for additional race formats. Win conditions in team racing mode differ somewhat: * __Most Laps in Fastest Time__: Teams are judged on combined lap count of all members and how long it took to complete those laps. * __Most Laps Only__: Teams are judged on total combined lap count of all members. * __Most Laps Only with Overtime__: Teams are judged on total combined lap count of all members. If tied when time expires, the first team (of those tied) to add a lap becomes the winner. * __First to X Laps__: The first team to complete the desired combined lap count is the winner. * __Fastest Lap__: After all team members have contributed one lap, teams are judged by the average of pilots' fastest lap time. * __Fastest 3 Consecutive Laps__: After all team members have contributed 3 laps, teams are judged by the average of pilots' fastest "three consecutive laps" time. With _Fastest Lap_ and _Fastest 3 Consecutive Laps_, teams with differing numbers of pilots can compete together fairly. _Minimum lap Time_ highlights or discards passes that would have registered laps less than the specified duration. Use the "discard" behavior with caution, as this will eliminate data that may have been valid. _Minimum Lap Time_ is not stored with the race format. #### LED Effects Choose a visual effect for each timer event. The timer will display this effect when the event occurs, immediately overriding any existing display or effect. Some visual effects are only available on particular timer events. Some visual effects are modified by the event, most notably the color of gate crossing enters/exits. Most effects can be previewed through the LED Control panel. Some LED effects can be delayed a short time if the timer is busy with time-critical tasks. (Others such as race start are never delayed.) Because of this effect and potentially concurrent crossings, _"Turn Off"_ should usually be avoided for gate exits. Instead, use _"No Change"_ on gate entrance and your desired effect on gate exit. _This section will not appear if your timer does not have LEDs configured. A notice appears in the startup log._ #### LED Control This section will override the current LED display. Choose to temporarily shut off the display, display some pre-configured colors, display any custom color, or display a defined effect. You can also use the slider to adjust the brightness of your panel. The ideal setting for FPV cameras is where the lit panel matches the brightness of a white object. This puts the panel output within the dynamic range of what the camera can capture. However, using a low brightness setting distorts color reproduction and smoothness of color transitions. _This section will not appear if your timer does not have LEDs configured. A notice appears in the startup log._ #### Database Choose to backup the current database (save to a file on the pi and prompt to download it) or clear data. You may clear races, classes, heats, and pilots. #### System Choose the interface language, and change parameters that affect the appearance of the timer such as its name and color scheme. You can also shut down the server from here. ### Run This page allows you to control the timer and run races. Select the Heat for the race which is to be run next. Start the race when ready. (Hotkey: z) The timer will do a quick communication to the server to compensate for client/server response time, then begin the staging procedure defined by the current race format. Tuning parameters can be adjusted here by clicking on/touching any of the graphs for each node. See [doc/Tuning Parameters.md](Tuning%20Parameters.md) for a detailed description and tuning guide. During the race, there is an "×" next to each counted lap. This will discard that lap pass, so its time is moved to the next lap. Use this to remove errant extra passes, or clean up pilots flying close to the start gate after their race finished. Pressing the "+ Lap" button will manually trigger a lap pass for that node. When a race is over, use the "Stop Race" button (Hotkey: x) to discontinue counting laps. You need to do this even if the timer reaches zero in a "Count Down" format—a popular race format allows pilots to finish the lap they are on when time expires. For best results, clear the timing gate and allow all valid crossings to end before stopping the race. Once a race has concluded, you must choose "Save Laps" or "Discard Laps" before starting another race. "Save Laps" (Hotkey: c) will store race results to the database and display them on the "Results" page. "Discard Laps" (Hotkey: v) will discard the race results. Saving laps will automatically advance the heat selection to the next heat with the same class as the saved race. (The spacebar can also be used as a hotkey for the Start, Stop and Save functions.) The Race Management panel provides quick access to change the current Race Format, Profile, Minimum Lap Time, or Team Racing Mode. _Audio Control_ and _LED Control_ are the same as the Settings page. The History Export dumps a CSV file to be downloaded of the recorded RSSI values in the most recently completed race. "Time Until Race Start" will schedule a race to be run at a future time. Operators may use this to set a hard limit on the amount of time allowed for pilots to prepare, or to start the timer and then participate in the race themselves. ### Marshal Adjust results of saved races. Select the round, heat, and pilot to adjust. Enter and Exit points are automatically loaded from the saved race data. Adjust the Enter and Exit points to recalibrate the race after the fact. "Load from Node" to copy current live calibration data over the active values. "Save to Node" to copy the active values over the current live values. "Recalculate Race" to use the active Enter/Exit values as calibration points for a "re-run" of the race. This will erase current laps and replace them with the recalculated information. Manually entered laps are preserved. Add laps by entering the crossing time in seconds from the beginning of the race, then pressing the "Add Lap" button. Delete laps with the "×" button on the unwanted lap. Deleted laps are removed from calculations but remain present in the data for later reference. "Discard Laps" to permanently remove the data from the database. You may click on/touch the graph to set enter/exit points, activate recalculation, and highlight specific laps. Clicking on laps in the list also adds a highlight on the graph. Press delete or x to delete a highlighted lap. Active laps are displayed in green, and deleted laps change to red. The width of the lap indicator shows the enter/exit points, and the yellow highlight draws a line at the exact lap time within that window. "Commit changes" when you are finished adjusting the race data to save it to the database and update the race results.
----------------------------- See Also:
[doc/Tuning Parameters.md](Tuning%20Parameters.md)
[doc/Software Setup.md](Software%20Setup.md)
[doc/Hardware Setup.md](Hardware%20Setup.md)
[Build Resources (PCB, etc) ➔︎](https://github.com/RotorHazard/RotorHazard/tree/main/resources/README.md)

Messages

About RotorHazard