构建基于命令的机器人项目

用户可以随意使用自己喜欢的基于命令的库(鼓励高级用户使用),但是新用户可能需要一些有关如何构建基本的基于命令的机器人项目的指南。

WPILib示例存储库中包含基于命令的机器人项目的标准模板(Java <https://github.com/wpilibsuite/allwpilib/tree/main/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/templates/commandbased> __,C ++ <https://github.com/wpilibsuite/allwpilib/tree/main/wpilibcExamples/src/main/cpp/templates/commandbased> __)。本节将向用户介绍此模板的结构。

根包/目录通常将包含四个类:

“Main”,这是主要的机器人应用程序(仅Java)。新用户*不应*接触此类。“Robot”,负责机器人代码的主控制流程。 “RobotContainer”包含机器人子系统和命令,是执行大多数声明性机器人设置(例如按钮绑定)的地方。 “Constants”,其中包含可在整个机器人中使用的全局可访问常量。

根目录还将包含两个子包/子目录:“Subsystems”包含所有用户定义的子系统类。 “Commands”包含所有用户定义的命令类。

Robot

由于``Robot’’(Java <https://github.com/wpilibsuite/allwpilib/blob/main/wpilibjExamples/src/main/java/edu/wpi/first/wpilibj/templates/commandbased/Robot.java>`__,`C ++(Header)<https://github.com/wpilibsuite/allwpilib/blob/main/wpilibcExamples/src/main/cpp/templates/commandbased/include/Robot.h>`__`C ++(Source)<https://github.com/wpilibsuite/allwpilib/blob/main/wpilibcExamples/src/main/cpp/templates/commandbased/cpp/Robot.cpp>`__)负责程序的控制流,基于命令的声明式范例旨在最大程度地减少由于用户必须对显式程序控制流程给予足够的关注,基于命令的项目的“机器人”类应该基本上为空。但是,必须包含一些重要的内容

25
26
27
28
29
30
31
32
33
34
  /**
   * This function is run when the robot is first started up and should be used for any
   * initialization code.
   */
  @Override
  public void robotInit() {
    // Instantiate our RobotContainer.  This will perform all our button bindings, and put our
    // autonomous chooser on the dashboard.
    m_robotContainer = new RobotContainer();
  }

在Java中,应在“ robotInit()”方法期间构造“RobotContainer”的实例——这很重要,因为大多数声明式机器人设置将从“RobotContainer”构造函数调用。

在C ++中,这是不需要的,因为RobotContainer是值成员,并且将在构建“Robot”时进行构造。

36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
  /**
   * This function is called every robot packet, no matter the mode. Use this for items like
   * diagnostics that you want ran during disabled, autonomous, teleoperated and test.
   *
   * <p>This runs after the mode specific periodic functions, but before
   * LiveWindow and SmartDashboard integrated updating.
   */
  @Override
  public void robotPeriodic() {
    // Runs the Scheduler.  This is responsible for polling buttons, adding newly-scheduled
    // commands, running already-scheduled commands, removing finished or interrupted commands,
    // and running subsystem periodic() methods.  This must be called from the robot's periodic
    // block in order for anything in the Command-based framework to work.
    CommandScheduler.getInstance().run();
  }

“robotPeriodic()”方法中必须包含“CommandScheduler.getInstance().run()”调用;没有此调用,调度程序将不会执行任何调度的命令。由于“TimedRobot”以默认的主循环频率50Hz运行,因此这是将调用定期命令和子系统方法的频率。不建议新用户从其代码中的其他任何地方调用此方法。

63
64
65
66
67
68
69
70
71
72
73
74
  /**
   * This autonomous runs the autonomous command selected by your {@link RobotContainer} class.
   */
  @Override
  public void autonomousInit() {
    m_autonomousCommand = m_robotContainer.getAutonomousCommand();

    // schedule the autonomous command (example)
    if (m_autonomousCommand != null) {
      m_autonomousCommand.schedule();
    }
  }

“autonomousInit()”方法调度由“RobotContainer”实例返回的自治命令。选择要运行的自治命令的逻辑可以在“RobotContainer”内部处理。

83
84
85
86
87
88
89
90
91
92
  @Override
  public void teleopInit() {
    // This makes sure that the autonomous stops running when
    // teleop starts running. If you want the autonomous to
    // continue until interrupted by another command, remove
    // this line or comment it out.
    if (m_autonomousCommand != null) {
      m_autonomousCommand.cancel();
    }
  }

“teleopInit()”方法取消所有仍在运行的自治命令。这通常是好的做法。

高级用户可以随意在自己认为合适的各种初始化和定期方法中添加其他代码;但是,应该注意的是,在“Robot.java”中包含大量命令式机器人代码与基于命令的范例的声明式设计哲学相反,并且可能导致结构混乱/结构混乱的代码。

RobotContainer

此类(Java`C ++(Header)<https://github.com/wpilibsuite/allwpilib/blob/main/wpilibcExamples/src/main/cpp/templates/commandbased/include/RobotContainer.h>`__`C ++(Source)<https://github.com/wpilibsuite/allwpilib/blob/main/wpilibcExamples/src/main/cpp/templates/commandbased/cpp/RobotContainer.cpp>`__)是大多数基于命令的机器人的设置地方。在此类中,您将定义机器人的子系统和命令,将这些命令绑定到触发事件(例如按钮),并指定将在自治例程中运行的命令。新手可能需要对此类进行解释:

24
  private final ExampleSubsystem m_exampleSubsystem = new ExampleSubsystem();

请注意,子系统在“RobotContainer”中被声明为私有字段。这与基于命令的框架的前身形成了鲜明的对比,但与商定的面向对象的最佳实践更加一致。如果子系统被声明为全局变量,则它允许用户从代码中的任何位置访问它们。虽然这可以使某些事情变得容易(例如,无需将子系统传递给命令以使这些命令可以访问它们),但由于不立即执行,因此使得程序的控制流更难以跟踪很明显,代码的哪些部分可以更改或可以被代码的其他哪些部分更改。这也妨碍了资源管理系统执行其工作的能力,因为易于访问使用户更容易意外地在资源管理命令之外意外调用子系统方法。

26
  private final ExampleCommand m_autoCommand = new ExampleCommand(m_exampleSubsystem);

由于子系统被声明为私有成员,因此必须将它们显式传递给命令(一种称为“依赖注入”的模式),以便这些命令在其上调用方法。这是通过“ExampleCommand”完成的,该示例传递了指向“ExampleSubsystem”的指针。

38
39
40
41
42
43
44
45
  /**
   * Use this method to define your button->command mappings.  Buttons can be created by
   * instantiating a {@link GenericHID} or one of its subclasses ({@link
   * edu.wpi.first.wpilibj.Joystick} or {@link XboxController}), and then passing it to a
   * {@link edu.wpi.first.wpilibj2.command.button.JoystickButton}.
   */
  private void configureButtonBindings() {
  }

如前所述,应在“ RobotContainer()”构造函数中进行机器人的大多数声明性设置,包括按钮绑定,配置自主选择器等。如果构造函数太“忙”,则鼓励用户将代码迁移到单独的子例程(例如默认包含的configureButtonBindings()方法)中,这些子例程从构造函数中调用。

48
49
50
51
52
53
54
55
56
57
  /**
   * Use this to pass the autonomous command to the main {@link Robot} class.
   *
   * @return the command to run in autonomous
   */
  public Command getAutonomousCommand() {
    // An ExampleCommand will run in autonomous
    return m_autoCommand;
  }
}

最后,“getAutonomousCommand()”方法为用户提供了一种方便的方法,可以将所选的自主命令发送到主要的Robot类(需要在启动自主类时对其进行调度)。

Constants

``Constants’’类(Java`C ++(Header)<https://github.com/wpilibsuite/allwpilib/blob/main/wpilibcExamples/src/main/cpp/templates/commandbased/include/Constants.h>`__)(在C ++中这不是一个类,而是一个定义了多个名称空间的头文件)是可全局访问的机器人的位置可以存储常数(例如速度,单位转换系数,PID增益和传感器/电动机端口)。建议用户将这些常量分成与子系统或机械手模式相对应的各个内部类,以使变量名更短。

在Java中,所有常量都应声明为“public static final”,以便它们可以全局访问且不能更改。在C ++中,所有常量都应为“constexpr”。

有关实践中“constants”类的外观的更多说明性示例,请参见各种基于命令的示例项目的示例:

在Java中,建议通过静态导入必要的内部类从其他类中使用常量。“import static”语句将类的静态名称空间导入到您正在工作的类中,以便可以直接引用任何“static”常量,就好像它们是在该类中定义的一样。在C ++中,使用``使用命名空间’’可以达到相同的效果:

import static edu.wpi.first.wpilibj.templates.commandbased.Constants.OIConstants.*;

Subsystems

用户定义的子系统应放在此软件包/目录中。

Commands

用户定义的命令应放在此软件包/目录中。