[hal, wpilib] Add OpMode support (#7744)

User code:
- OpModeRobot used as the robot base class
- LinearOpMode and PeriodicOpMode are provided opmode base classes
- In Java, annotations can be used to automatically register opmode classes

Additional user code functionality:
- OpMode (string) is available in addition to the overall
auto/teleop/test robot mode
- OpMode does not indicate enable (enable/disable is still separate)
- The HAL API uses integer UIDs; these are exposed at the user API level
as well for faster checks
- User code creates opmodes on startup (these have name, category,
description, etc).

DS:
- DS will present opmode selection lists for auto and teleop for
match/practice. During a match, the DS will automatically activate the
selected opmode in the corresponding match period.
- For testing, an overall mode is selected (e.g. teleop/auto/test) and a
single opmode is selected

Future work:
- Command framework support/integration
- Python annotation support
- Unit tests (needs race-free DS sim updates)
- Porting of examples

Co-authored-by: Joseph Eng <91924258+KangarooKoala@users.noreply.github.com>
This commit is contained in:
Peter Johnson
2025-12-12 21:25:57 -07:00
committed by GitHub
parent 2a41b80e00
commit dacded37e5
163 changed files with 7454 additions and 2175 deletions

View File

@@ -4,9 +4,9 @@
#include "wpi/framework/IterativeRobotBase.hpp"
#include "wpi/driverstation/DSControlWord.hpp"
#include "wpi/driverstation/DriverStation.hpp"
#include "wpi/hal/DriverStation.h"
#include "wpi/hal/DriverStationTypes.h"
#include "wpi/nt/NetworkTableInstance.hpp"
#include "wpi/smartdashboard/SmartDashboard.hpp"
#include "wpi/system/Errors.hpp"
@@ -98,18 +98,10 @@ void IterativeRobotBase::LoopFunc() {
DriverStation::RefreshData();
m_watchdog.Reset();
// Get current mode
DSControlWord word;
Mode mode = Mode::kNone;
if (word.IsDisabled()) {
mode = Mode::kDisabled;
} else if (word.IsAutonomous()) {
mode = Mode::kAutonomous;
} else if (word.IsTeleop()) {
mode = Mode::kTeleop;
} else if (word.IsTest()) {
mode = Mode::kTest;
}
// Get current mode; treat disabled as unknown
wpi::hal::ControlWord word = wpi::hal::GetControlWord();
bool enabled = word.IsEnabled();
RobotMode mode = enabled ? word.GetRobotMode() : RobotMode::UNKNOWN;
if (!m_calledDsConnected && word.IsDSAttached()) {
m_calledDsConnected = true;
@@ -117,51 +109,48 @@ void IterativeRobotBase::LoopFunc() {
}
// If mode changed, call mode exit and entry functions
if (m_lastMode != mode) {
if (m_lastMode != static_cast<int>(mode)) {
// Call last mode's exit function
if (m_lastMode == Mode::kDisabled) {
if (m_lastMode == static_cast<int>(RobotMode::UNKNOWN)) {
DisabledExit();
} else if (m_lastMode == Mode::kAutonomous) {
} else if (m_lastMode == static_cast<int>(RobotMode::AUTONOMOUS)) {
AutonomousExit();
} else if (m_lastMode == Mode::kTeleop) {
} else if (m_lastMode == static_cast<int>(RobotMode::TELEOPERATED)) {
TeleopExit();
} else if (m_lastMode == Mode::kTest) {
} else if (m_lastMode == static_cast<int>(RobotMode::TEST)) {
TestExit();
}
// Call current mode's entry function
if (mode == Mode::kDisabled) {
if (mode == RobotMode::UNKNOWN) {
DisabledInit();
m_watchdog.AddEpoch("DisabledInit()");
} else if (mode == Mode::kAutonomous) {
} else if (mode == RobotMode::AUTONOMOUS) {
AutonomousInit();
m_watchdog.AddEpoch("AutonomousInit()");
} else if (mode == Mode::kTeleop) {
} else if (mode == RobotMode::TELEOPERATED) {
TeleopInit();
m_watchdog.AddEpoch("TeleopInit()");
} else if (mode == Mode::kTest) {
} else if (mode == RobotMode::TEST) {
TestInit();
m_watchdog.AddEpoch("TestInit()");
}
m_lastMode = mode;
m_lastMode = static_cast<int>(mode);
}
// Call the appropriate function depending upon the current robot mode
if (mode == Mode::kDisabled) {
HAL_ObserveUserProgramDisabled();
HAL_ObserveUserProgram(word.GetValue());
if (mode == RobotMode::UNKNOWN) {
DisabledPeriodic();
m_watchdog.AddEpoch("DisabledPeriodic()");
} else if (mode == Mode::kAutonomous) {
HAL_ObserveUserProgramAutonomous();
} else if (mode == RobotMode::AUTONOMOUS) {
AutonomousPeriodic();
m_watchdog.AddEpoch("AutonomousPeriodic()");
} else if (mode == Mode::kTeleop) {
HAL_ObserveUserProgramTeleop();
} else if (mode == RobotMode::TELEOPERATED) {
TeleopPeriodic();
m_watchdog.AddEpoch("TeleopPeriodic()");
} else if (mode == Mode::kTest) {
HAL_ObserveUserProgramTest();
} else if (mode == RobotMode::TEST) {
TestPeriodic();
m_watchdog.AddEpoch("TestPeriodic()");
}