Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ export default defineConfig({
{ text: 'Onboarding', link: '/curriculum/getting-started/onboarding' },
{ text: 'Environment Setup', link: '/curriculum/getting-started/environment-setup' },
{ text: 'Java Basics', link: '/curriculum/getting-started/java-basics' },
{ text: 'In-Season Onboarding', link: '/curriculum/getting-started/in-season-onboarding' },
],
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/curriculum/challenges/running-on-a-real-robot.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Handy addresses for later in this page:
- Wifi IP = 10.4.88.2
- USB IP = 172.22.11.2

If you only did the minimal computer setup at the start of the curriculum, you may need to install the FRC Game Tools from [Full Programming Onboarding](https://github.com/Team488/XbotEdu/wiki/Programming-Onboarding). Check if you have **FRC Driver Station** installed - if you don't have it, you will need to install the FRC Game Tools.
If you only did the minimal computer setup at the start of the curriculum, you may need to install the FRC Game Tools from [Full Programming Onboarding](/curriculum/getting-started/in-season-onboarding). Check if you have **FRC Driver Station** installed - if you don't have it, you will need to install the FRC Game Tools.

## The Robox
The Robox is a "robot-in-a-box" that we built a few years ago and have been using for all sorts of testing ever since.
Expand Down
2 changes: 1 addition & 1 deletion docs/curriculum/getting-started/environment-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ In this first challenge you'll get your own copy of the XbotEdu code, download i

If you just want to do the curriculum, follow the instructions in [Edu Onboarding](/curriculum/getting-started/onboarding).

Or if you need to set up for in-season robot programming, follow the instructions in [Full Programming Onboarding](https://github.com/Team488/XbotEdu/wiki/Programming-Onboarding) instead. It covers everything in Edu Onboarding plus a few extra tools.
Or if you need to set up for in-season robot programming, follow the instructions in [Full Programming Onboarding](/curriculum/getting-started/in-season-onboarding) instead. It covers everything in Edu Onboarding plus a few extra tools.

**Important:** Don't continue until onboarding is complete. Missing tools cause confusing errors in the steps below.

Expand Down
36 changes: 36 additions & 0 deletions docs/curriculum/getting-started/in-season-onboarding.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# In-Season Onboarding

Extra setup for programming students working on the competition robot during the season.

::: tip Start with the regular onboarding
This page covers **only what is different** for in-season work. Do [Onboarding](/curriculum/getting-started/onboarding) first -- accounts, GitHub Desktop, WPILib and IntelliJ are all set up there and are not repeated here.
:::

Everything below is about talking to real hardware, which is the part the curriculum never needs.

## FRC Game Tools

The Game Tools include the **FRC Driver Station**, the program that enables and disables the robot. You cannot drive a real robot without it.

::: warning Windows only
The FRC Game Tools do not run on macOS. If you are on a Mac, install [QDriverStation](/tooling/qdriverstation) instead -- it is a third-party replacement for the Driver Station.
:::

Follow WPILib's [FRC Game Tools installation guide](https://docs.wpilib.org/en/stable/docs/zero-to-robot/step-2/frc-game-tools.html), plus two notes:

- It is recommended to uninstall any previous FRC-related files first, as the guide describes.
- The installer prompts you to log in. Create a National Instruments account, and set Organization to `team488`.
- Install updates when the NI app prompts you.

## Device programming tools

These configure motor controllers and similar devices. Not everyone needs them, but they are useful when bringing up a brand new robot.

| Tool | Install |
|------|---------|
| REV Hardware Client | [REV Hardware Client 2 instructions](https://docs.revrobotics.com/rev-hardware-client-2) |
| Phoenix Tuner X | [Microsoft Store](https://apps.microsoft.com/detail/9nvv4pwdw27z?hl=en-US&gl=US) -- see [Phoenix Tuner](/tooling/phoenix-tuner) |

## Next steps

With the robot tooling installed, the [Running on a Real Robot](/curriculum/challenges/running-on-a-real-robot) challenge walks through deploying code to a RoboRIO and enabling it safely.
4 changes: 2 additions & 2 deletions docs/curriculum/getting-started/onboarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Welcome to Team 488 XBOT's programming discipline! This document will guide you through setting up the accounts and software you'll need to complete the XbotEdu curriculum.

> [!NOTE]
> This document describes only the tools you'll need to complete the XbotEdu curriculum. **If you are a programming student during competition season, you'll need to set up a few additional accounts and tools.** Please see the [in-season Programming Onboarding](https://github.com/Team488/XbotEdu/wiki/Programming-Onboarding) for more instructions.
> This document describes only the tools you'll need to complete the XbotEdu curriculum. **If you are a programming student during competition season, you'll need to set up a few additional accounts and tools.** Please see the [in-season Programming Onboarding](/curriculum/getting-started/in-season-onboarding) for more instructions.

> [!IMPORTANT]
> **Please don't skip any steps** during this onboarding process. Doing so always results in pain down the road as we try to figure out which steps you did or didn't do!
Expand Down Expand Up @@ -88,4 +88,4 @@ Now you should have everything set up to complete the XbotEdu curriculum. Enjoy!
Head back to [Setting up your environment](/curriculum/getting-started/environment-setup) to fork the code and open it in IntelliJ.

> [!WARNING]
> Remember, **if you are a programming student during competition season, you'll need to set up a few additional accounts and tools.** Please see the [in-season Programming Onboarding](https://github.com/Team488/XbotEdu/wiki/Programming-Onboarding) for more instructions.
> Remember, **if you are a programming student during competition season, you'll need to set up a few additional accounts and tools.** Please see the [in-season Programming Onboarding](/curriculum/getting-started/in-season-onboarding) for more instructions.
2 changes: 2 additions & 0 deletions docs/curriculum/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ Get your accounts, tools, and a copy of the code before writing anything.
| [Environment Setup](getting-started/environment-setup) | Fork the practice project and open it in IntelliJ |
| [Java Basics](getting-started/java-basics) | The minimum Java you need to get started |

Programming on the competition robot during the season? [In-Season Onboarding](getting-started/in-season-onboarding) covers the extra hardware tools you will need.

## Reference

Background you will be pointed at from the challenges, and can come back to any time.
Expand Down
Loading