MatchState

class wpilib.MatchState

Bases: pybind11_object

Provides access to match state information from the Driver Station.

static getAlliance() → wpilib._wpilib.Alliance | None

Get the current alliance from the FMS.

If the FMS is not connected, it is set from the team alliance setting on the driver station.

Returns:

The alliance (red or blue) or an empty optional if the alliance is invalid

static getEventName() → str

Returns the name of the competition event provided by the FMS.

Returns:

A string containing the event name

static getGameData() → str | None

Returns the game specific message provided by the FMS.

If the FMS is not connected, it is set from the game data setting on the driver station.

Returns:

A string containing the game specific message.

static getLocation() → int | None

Return the driver station location from the FMS.

If the FMS is not connected, it is set from the team alliance setting on the driver station.

This could return 1, 2, or 3.

Returns:

The location of the driver station (1-3, 0 for invalid)

static getMatchNumber() → int

Returns the match number provided by the FMS.

Returns:

The number of the match

static getMatchTime() → wpimath.units.seconds

Return the approximate match time. The FMS does not send an official match time to the robots, but does send an approximate match time. The value will count down the time remaining in the current period (auto or teleop). Warning: This is not an official time (so it cannot be used to dispute ref calls or guarantee that a function will trigger before the match ends).

When connected to the real field, this number only changes in full integer increments, and always counts down.

When the DS is in practice mode, this number is a floating point number, and counts down.

When the DS is in teleop or autonomous mode, this number returns -1.0.

Simulation matches DS behavior without an FMS connected.

Returns:

Time remaining in current match period (auto or teleop) in seconds

static getMatchType() → wpilib._wpilib.MatchType

Returns the type of match being played provided by the FMS.

Returns:

The match type enum (kNone, kPractice, kQualification, kElimination)

static getReplayNumber() → int

Returns the number of times the current match has been replayed from the FMS.

Returns:

The number of replays