Skip to content

jbfrc/TBAInfo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 

Repository files navigation

TBAInfo PowerShell Module

TBAInfo (The Blue Alliance Info) is a PowerShell module designed to simplify access to data from The Blue Alliance API v3. It provides a suite of functions to retrieve and analyze data related to the FIRST Robotics Competition (FRC).


Features

  • Retrieve lists of all FRC events or teams by year
  • Access detailed event data including team lists and match keys
  • Fetch team-specific match data and names
  • Calculate and retrieve OPR (Offensive Power Rating) and COPR (Component Offensive Power Rating) statistics

Requirements

  • PowerShell 7+
  • A valid API key from The Blue Alliance Account Dashboard

Installation

Install the module from the PowerShell Gallery:

Install-Module TBAInfo

Usage

  1. To work correctly, the TBA API key must be entered into the JSON config file that this module uses.
Update-TBAJsonAPIKey "MyAPIKey"
  1. The JSON config file also has default values for the team_key (frc4611)parameter. It's recommended that these is value be changed to your team number. This can be done with the Update-TBAJsonEventKey function:
Update-TBAJsonTeamKey frc4611

or

Update-TBAJsonTeamKey 4611
  1. Likewise, the default event key should be changed as well. It is currently set to 2026ohcl, but can be changed with the Update-TBAJsonEventKey function.
Update-TBAJsonEventKey 2025nyro
  1. Functions that require a team or event key will default to the values in the JSON config file, but also accept -TeamKey and -EventKey parameters to supply different ones too.

  2. Available functions to get TBA information include:

    • Get-TBAAllEventList
    • Get-TBAAllTeamList
    • Get-TBAEventCOPR
    • Get-TBAEventOPR
    • Get-TBAEventRanking
    • Get-TBAEventTeamList
    • Get-TBAJsonAPIKey
    • Get-TBAJsonConfig
    • Get-TBAJsonEventKey
    • Get-TBAJsonFilePath
    • Get-TBAJsonTeamKey
    • Get-TBATeamEventMatchInfo
    • Get-TBATeamEventOPR
    • Get-TBATeamName
    • New-TBAJsonConfigFile
    • Test-TBAStatus
    • Update-TBAJsonAPIKey
    • Update-TBAJsonEventKey
    • Update-TBAJsonTeamKey

Notes

  • This module relies heavily on the API provided by The Blue Alliance and would not be possible without the work they do.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors