A Python package to determine the score of an FRC game from images
MIT License
A package which can determine the score of a live FRC game from an image.
$ pip install livescore
You will also need to have Tesseract
and OpenCV 3 (instructions for
macOS,
Windows and
Linux)
installed in order for frc-livescore
to work.
Check out the examples
directory for full examples on the usage of
frc-livescore
.
A very simple example program would be to just get the score data from a single image. To do this, we'll use OpenCV to read the image.
from livescore import Livescore2018
import cv2
# Initialize a new Livescore instance
frc = Livescore2018()
# Read the image from disk
image = cv2.imread('./examples/scenes/scene1.png')
# Get score data
data = frc.read(image)
print(data)
Currently supported years: 2017, 2018, 2019
e.g. Livescore2017(), Livescore2018() or Livescore2019()
debug
- Debug mode, where outputs are displayed.save_training_data
- Whether the training should be saved to disk.append_training_data
- Whether to start training from scratchCreates and returns a new Livescore instance with specified options.
img
- The image to read from.force_find_overlay
- Whether we should forcefully find the overlay or only doReads an image and returns an OngoingMatchDetails class
containing the score data. Values that could not be determined from the input
image will be False
.
Currently supported years: 2017, 2018, 2019
e.g. Alliance2017, Alliance2018 or Alliance2019
score
- The alliance's score.Stores year-specific properties for an alliance, such as whether the switch or scale is owned for the 2018 game.
match_key
- The match key, such as "qf1m2".match_name
- The match name, such as "Qualifications 16 of 128".mode
- The current game mode, one of pre_match
, auto
, teleop
, orpost_match
.time
- The time remaining in the match.red
- An Alliance class for the red alliance.blue
- An Alliance class for the blue alliance.