Skip to content

Commit

Permalink
Update installation for Game Tools and LabVIEW (#2887)
Browse files Browse the repository at this point in the history
Add known issue for offline game tools installation needing NI Package
Manager
  • Loading branch information
sciencewhiz authored Jan 1, 2025
1 parent 19ada1d commit 96ab97c
Show file tree
Hide file tree
Showing 8 changed files with 25 additions and 6 deletions.
1 change: 1 addition & 0 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,7 @@
linkcheck_anchors_ignore_for_url = [
r".*github.com.*",
r".*ni.com/en/support/downloads/drivers/download.frc-game-tools.html.*",
r".*ni.com/en/support/downloads/software-products/download.package-manager.html.*",
]

# Sets linkcheck timeout in seconds
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 9 additions & 0 deletions source/docs/yearly-overview/known-issues.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,15 @@ This article details known issues (and workarounds) for FRC\ |reg| Control Syste

## Open Issues

### Game Tools install fails due to outdated NI Package Manager

**Issue:** An offiline installation of NI Game Tools may fail due to outdated NI Package Manager

.. image:: images/known-issues/game-tools-package-manager.png
:alt: Chinese character appearing in the Driver Station log window.

**Workaround:** Install the latest [National Instruments Package Manager](https://www.ni.com/en/support/downloads/software-products/download.package-manager.html) (Note: Click on link for "Install Offline") and then restart Game Tools installation.

### Driver Station randomly disabled

**Issue:** The Driver Station contains tighter safety mechanisms in 2024 to protect against control issues. Some teams have seen this cause the robot to disable.
Expand Down
11 changes: 9 additions & 2 deletions source/docs/zero-to-robot/step-2/frc-game-tools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,19 @@ The LabVIEW runtime components required for the Driver Station and Imaging Tool

- Windows 10 or higher (Windows 10, 11).

- Download the [FRC Game Tools](https://www.ni.com/en/support/downloads/drivers/download.frc-game-tools.html#500107) from NI.
## Download Game Tools

Navigate to the [FRC Game Tools](https://www.ni.com/en/support/downloads/drivers/download.frc-game-tools.html#553883) from NI.

.. image:: images/labview/ni-login.png
:alt: The login button for the NI installer.

Log-in or create an National Instruments account.

.. image:: images/labview/offline-installer.png
:alt: The Download button for the NI installer with the offline installer link below it.

If you wish to install on other machines offline, click :guilabel:`Individual Offline Installers` before clicking :guilabel:`Download` to download the full installer.
If you wish to install on other machines offline, click :guilabel:`Install Offline` or else choose :guilabel:`Download` to download the online installer which will download while installing.

## Uninstall Old Versions (Recommended)

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions source/docs/zero-to-robot/step-2/labview-setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,14 @@ In the dialog box that appears, select all entries. The easiest way to do this i

## Getting LabVIEW installer

Download the [LabVIEW for FRC 2024 installer](https://www.ni.com/en-us/support/downloads/software-products/download.labview-software-for-frc.html) from NI. Be sure to select the correct version from the drop-down.
Download the [LabVIEW for FRC 2025 installer](https://www.ni.com/en-us/support/downloads/software-products/download.labview-software-for-frc.html) from NI. Be sure to select the correct version from the drop-down.

.. image:: images/labview/offline-installer.png
:alt: The Download button for the NI installer with the offline installer link below it.

If you wish to install on other machines offline, do not click the Download button, click **Individual Offline Installers** and then click Download, to download the full installer.
If you wish to install on other machines offline, do not click the Download button, click :guilabel:`Offline Install` and then click Download, to download the full installer.

.. note:: This is a large download (~10GB). It is recommended to use a fast internet connection and to use the NI Downloader to allow the download to resume if interrupted.
.. note:: This is a large download (~11GB). It is recommended to use a fast internet connection and to use the NI Downloader to allow the download to resume if interrupted.

## Installing LabVIEW

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ This documentation can be downloaded for offline viewing. The link to download t

### All Teams

- [2024 FRC Game Tools](https://www.ni.com/en/support/downloads/drivers/download.frc-game-tools.html#500107) (Note: Click on link for "Individual Offline Installers")
- [2025 FRC Game Tools](https://www.ni.com/en/support/downloads/drivers/download.frc-game-tools.html#553883) (Note: Click on link for "Install Offline")

- [National Instruments Package Manager](https://www.ni.com/en/support/downloads/software-products/download.package-manager.html#322516) (Note: Click on link for "Install Offline")

### LabVIEW Teams

Expand Down

0 comments on commit 96ab97c

Please sign in to comment.