mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-06-19 00:41:43 +00:00
Fixed some typos in the comments of MotorEncoderFixture.java, a method name in CANMotorEncoderFixture.java, and the README files
Change-Id: I87d982068f3e7cdcce6e5b06c34a7ef326f5eae0
This commit is contained in:
@@ -29,7 +29,7 @@ If you also want simulation to be build, add -PmakeSim. This requires gazebo_tra
|
||||
```
|
||||
|
||||
C++ simulation tasks (including plugins, gz_msgs, and wpilibcSim) all depend on gazebo_transport. In order for this to build you must have installed gazebo. See [The Gazebo website](https://gazebosim.org/) for installation instructions.
|
||||
If you prefer to use Cmake directly, the you can still do so.
|
||||
If you prefer to use CMake directly, the you can still do so.
|
||||
The common cmake tasks are wpilibcSim, frc_gazebo_plugins, and gz_msgs
|
||||
|
||||
```bash
|
||||
@@ -62,7 +62,7 @@ The following maven targets a published by this task:
|
||||
- org.gazebosim:JavaGazebo:0.1.0-SNAPSHOT - Gazebo protocol for Java.
|
||||
|
||||
## Structure and Organization
|
||||
The main wpilib code you're probably looking for is in wpilibj and wpilibc. Those directories are split into shared, sim, and athena. Athena contains the wpilib code meant to run on your RoboRIO. Sim is wpilib code meant to run on your computer with gazebo, and shared is code shared between the two. Shared code must be platform-independant, since it will be compiled with both the ARM cross-compiler and whatever desktop compiler you are using (g++, msvc, ect... ).
|
||||
The main wpilib code you're probably looking for is in wpilibj and wpilibc. Those directories are split into shared, sim, and athena. Athena contains the wpilib code meant to run on your RoboRIO. Sim is wpilib code meant to run on your computer with gazebo, and shared is code shared between the two. Shared code must be platform-independent, since it will be compiled with both the ARM cross-compiler and whatever desktop compiler you are using (g++, msvc, etc...).
|
||||
|
||||
The Simulation directory contains extra simulation tools and libraries, such as gz_msgs and JavaGazebo. See sub-directories for more information.
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
## Simulation Directory
|
||||
|
||||
Observe the following directory structure
|
||||
Observe the following directory structure:
|
||||
|
||||
.
|
||||
|-- frc_gazebo_plugins (contains Gazebo Plugins)
|
||||
@@ -21,7 +21,7 @@ Observe the following directory structure
|
||||
The gazbeo plugins are currently built with CMake.
|
||||
Eventually they will be built with gradle.
|
||||
|
||||
All of this is delivered to students via a zip file
|
||||
All of this is delivered to students via a zip file.
|
||||
|
||||
## Building
|
||||
see the top level building.md
|
||||
See the top level README.md.
|
||||
|
||||
@@ -36,7 +36,7 @@ public abstract class CANMotorEncoderFixture extends MotorEncoderFixture<CANJagu
|
||||
|
||||
protected abstract DigitalOutput giveFakeReverseLimit();
|
||||
|
||||
protected abstract Relay givePoweCycleRelay();
|
||||
protected abstract Relay givePowerCycleRelay();
|
||||
|
||||
public CANMotorEncoderFixture() {}
|
||||
|
||||
@@ -45,7 +45,7 @@ public abstract class CANMotorEncoderFixture extends MotorEncoderFixture<CANJagu
|
||||
if (!initialized) {
|
||||
initialized = true;// This ensures it is only initialized once
|
||||
|
||||
powerCycler = givePoweCycleRelay();
|
||||
powerCycler = givePowerCycleRelay();
|
||||
powerCycler.setDirection(Direction.kForward);
|
||||
logger.fine("Turning on the power!");
|
||||
powerCycler.set(Value.kForward);
|
||||
|
||||
@@ -19,7 +19,7 @@ import edu.wpi.first.wpilibj.test.TestBench;
|
||||
|
||||
/**
|
||||
* Represents a physically connected Motor and Encoder to allow for unit tests
|
||||
* on these difrent pairs<br>
|
||||
* on these different pairs<br>
|
||||
* Designed to allow the user to easily setup and tear down the fixture to allow
|
||||
* for reuse. This class should be explicitly instantiated in the TestBed class
|
||||
* to allow any test to access this fixture. This allows tests to be mailable so
|
||||
@@ -171,7 +171,7 @@ public abstract class MotorEncoderFixture<T extends SpeedController> implements
|
||||
|
||||
/**
|
||||
* Safely tears down the MotorEncoder Fixture in a way that makes sure that
|
||||
* even if an object fails to initialize the reset of the fixture can still be
|
||||
* even if an object fails to initialize the rest of the fixture can still be
|
||||
* torn down and the resources deallocated
|
||||
*/
|
||||
@Override
|
||||
|
||||
@@ -218,11 +218,11 @@ public final class TestBench {
|
||||
* (non-Javadoc)
|
||||
*$
|
||||
* @see
|
||||
* edu.wpi.first.wpilibj.fixtures.CANMotorEncoderFixture#givePoweCycleRelay
|
||||
* edu.wpi.first.wpilibj.fixtures.CANMotorEncoderFixture#givePowerCycleRelay
|
||||
* ()
|
||||
*/
|
||||
@Override
|
||||
protected Relay givePoweCycleRelay() {
|
||||
protected Relay givePowerCycleRelay() {
|
||||
return new Relay(kCANRelayPowerCycler);
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user