falcon_alliance.Match

class falcon_alliance.Match(**kwargs)

Class representing a match’s metadata with methods to get match specific data.

TBA match key with the format yyyy[EVENT_CODE]_[COMP_LEVEL]m[MATCH_NUMBER], where yyyy is the year, and EVENT_CODE is the event code of the event, COMP_LEVEL is (qm, ef, qf, sf, f), and MATCH_NUMBER is the match number in the competition level. A set number may be appended to the competition level if more than one match in required per set.

Type: str

comp_level

The competition level the match was played at.

Type: str, optional

set_number

The set number in a series of matches where more than one match is required in the match series.

Type: int, optional

match_number

The match number of the match in the competition level.

Type: int, optional

alliances

A list of alliances, the teams on the alliances, and their score.

Type: list[falcon_alliance.Match.Alliance], optional

winning_alliance

The color (red/blue) of the winning alliance. Will contain an empty string in the event of no winner, or a tie.

Type: str, optional

event_key

Event key of the event the match was played at.

Type: str, optional

time

UNIX timestamp (seconds since 1-Jan-1970 00:00:00) of the scheduled match time, as taken from the published schedule.

Type: datetime.datetime, optional

actual_time

UNIX timestamp (seconds since 1-Jan-1970 00:00:00) of actual match start time.

Type: datetime.datetime, optional

predicted_time

UNIX timestamp (seconds since 1-Jan-1970 00:00:00) of the TBA predicted match start time.

Type: datetime.datetime, optional

post_result_time

UNIX timestamp (seconds since 1-Jan-1970 00:00:00) when the match result was posted.

Type: datetime.datetime, optional

score_breakdown

Score breakdown for auto, teleop, etc. points. Varies from year to year. May be None.

Type: dict, optional

videos

A list of video objects associated with this match.

Type: list, optional

class Alliance(color: Union[Literal['blue'], Literal['red']], score: Optional[int], team_keys: List[str], surrogate_team_keys: List[str], dq_team_keys: List[str]): Class representing an alliance’s performance/metadata during a match.

class ZebraMotionworks(key: str, times: List[float], alliances: Team)

Class representing Zebra MotionWorks data for a team during a match.

class Team(team_key: str, xs: list, ys: list): Class representing a team’s specific Zebra MotionWorks data during a match.

alliance_of(team_key: Union[int, str, Team]) → Optional[Alliance]

Returns the alliance of the team provided, can return None if a team is in neither of the alliances for a match.

Parameters: team_key (int, str, falcon_alliance.Team) – An integer representing the team number to search for in the alliance team keys or a string representing the team key to search for in the alliance team keys or a Team object representing the team to get the alliance of.