Installing Phoenix 6#

Installation of Phoenix 6 is comprised of a few steps

API Installation#

Phoenix 6 currently supports the following languages for development.

  • Java

  • C++

  • Python

  • C# (non-FRC only)

System Requirements#

The following targets are supported:

  • NI roboRIO

  • Windows 10/11 x86-64

  • Linux x86-64 (desktop)

    • Ubuntu 22.04 or newer

    • Debian Bullseye or newer

  • Linux ARM32 and ARM64 (Raspberry Pi, NVIDIA Jetson)

    • Ubuntu 20.04 or newer

    • Debian Bullseye or newer

  • macOS (regular simulation only)

Offline#

Important

Users on non-Windows devices should skip to the Online installation instructions.

  1. Download the Phoenix Framework Installer

  2. Navigate through the installer, ensuring applicable options are selected

Showing the installation screen root

  1. Apply the vendordep via WPILib VS Code Adding Offline Libraries

Note

The Python and C# APIs can only be installed online. See Installing Additional Languages for more information.

Online#

Users in FRC can install Phoenix without an installer using WPILib’s Install New Libraries functionality in VS Code. This requires the user to have an installation of WPILib on their machine.

To begin, open WPILib VS Code and click on the WPILib icon in the top right.

WPILib icon is located in the top right of VS Code

Then type Manage Vendor Libraries and click on the menu option that appears. Click Install new libraries (online) and a textbox should appear. Follow the remaining instructions below on pasting the correct link into the textbox.

Important

This vendordep is for robot projects that are only using devices with Phoenix 6 firmware.

Paste the following URL in WPILib VS Code Install new libraries (online):

  • https://maven.ctr-electronics.com/release/com/ctre/phoenix6/latest/Phoenix6-frc2023-latest.json

Important

This vendordep is for robot projects that are using both Phoenix 6 devices & Phoenix 5 devices.

Paste the following URL in WPILib VS Code Install new libraries (online):

  • https://maven.ctr-electronics.com/release/com/ctre/phoenix6/latest/Phoenix6And5-frc2023-latest.json

Important

Devices on Phoenix 6 firmware must use the Phoenix 6 API. Device on Phoenix 5 firmware must use the Phoenix 5 API.

Phoenix 6 is distributed through our APT repository. Begin with adding the repository to your APT sources.

sudo curl -s --compressed -o /usr/share/keyrings/ctr-pubkey.gpg "https://deb.ctr-electronics.com/ctr-pubkey.gpg"
sudo curl -s --compressed -o /etc/apt/sources.list.d/ctr<year>.list "https://deb.ctr-electronics.com/ctr<year>.list"

Note

<year> should be replaced with the year of Phoenix 6 software for which you have purchased licenses.

After adding the sources, Phoenix 6 can be installed and updated using the following:

sudo apt update
sudo apt install phoenix-pro

Additional information for non-FRC users is available in Using Phoenix outside of FRC.

Tip

To get a robot application up and running quickly, check out our non-FRC Linux example.

Installing Additional Languages#

Python and C# require additional installation steps.

Note

Installation for Python and C# are only required if the user wants to use those languages. Otherwise, the below steps can be skipped.

Python#

Installation is available through PyPI.

python3 -m pip install phoenix-6

C# (non-FRC only)#

Installation is available through Nuget. An example on adding nuget packages to a Visual Studio project is available in the Microsoft Quickstart.

Tuner X Installation#

Phoenix Tuner X is a modern version of the legacy Phoenix Tuner v1 application that is used to configure CTRE Phoenix CAN devices.

Phoenix Tuner X is supported on Android, Windows 10 (build 1903+), and Windows 11. Installation is available from the respective OS stores.