mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-06-22 01:11:42 +00:00
[hal,wpilib] Remove MXP mentions in API docs (NFC) (#8694)
This commit is contained in:
@@ -15,13 +15,6 @@ import org.wpilib.util.sendable.SendableRegistry;
|
||||
* Analog channel class.
|
||||
*
|
||||
* <p>Each analog channel is read from hardware as a 12-bit number representing 0V to 3.3V.
|
||||
*
|
||||
* <p>Connected to each analog channel is an averaging and oversampling engine. This engine
|
||||
* accumulates the specified ( by setAverageBits() and setOversampleBits() ) number of samples
|
||||
* before returning a new value. This is not a sliding window average. The only difference between
|
||||
* the oversampled samples and the averaged samples is that the oversampled samples are simply
|
||||
* accumulated effectively increasing the resolution, while the averaged samples are divided by the
|
||||
* number of samples to retain the resolution, but get more stable values.
|
||||
*/
|
||||
public class AnalogInput implements Sendable, AutoCloseable {
|
||||
int m_port; // explicit no modifier, private and package accessible.
|
||||
@@ -30,7 +23,7 @@ public class AnalogInput implements Sendable, AutoCloseable {
|
||||
/**
|
||||
* Construct an analog channel.
|
||||
*
|
||||
* @param channel The channel number to represent. 0-3 are on-board 4-7 are on the MXP port.
|
||||
* @param channel The SmartIO channel for the analog input.
|
||||
*/
|
||||
@SuppressWarnings("this-escape")
|
||||
public AnalogInput(final int channel) {
|
||||
|
||||
@@ -25,7 +25,7 @@ public class DigitalInput implements AutoCloseable, Sendable {
|
||||
/**
|
||||
* Create an instance of a Digital Input class. Creates a digital input given a channel.
|
||||
*
|
||||
* @param channel the DIO channel for the digital input 0-9 are on-board, 10-25 are on the MXP
|
||||
* @param channel the SmartIO channel for the digital input
|
||||
*/
|
||||
@SuppressWarnings("this-escape")
|
||||
public DigitalInput(int channel) {
|
||||
|
||||
@@ -26,8 +26,7 @@ public class DigitalOutput implements AutoCloseable, Sendable {
|
||||
/**
|
||||
* Create an instance of a digital output. Create an instance of a digital output given a channel.
|
||||
*
|
||||
* @param channel the DIO channel to use for the digital output. 0-9 are on-board, 10-25 are on
|
||||
* the MXP
|
||||
* @param channel the SmartIO channel to use for the digital output.
|
||||
*/
|
||||
@SuppressWarnings("this-escape")
|
||||
public DigitalOutput(int channel) {
|
||||
|
||||
@@ -42,7 +42,7 @@ public class PWM implements Sendable, AutoCloseable {
|
||||
*
|
||||
* <p>By default, adds itself to SendableRegistry.
|
||||
*
|
||||
* @param channel The PWM channel number. 0-9 are on-board, 10-19 are on the MXP port
|
||||
* @param channel The SmartIO channel number.
|
||||
*/
|
||||
public PWM(final int channel) {
|
||||
this(channel, true);
|
||||
@@ -51,7 +51,7 @@ public class PWM implements Sendable, AutoCloseable {
|
||||
/**
|
||||
* Allocate a PWM given a channel.
|
||||
*
|
||||
* @param channel The PWM channel number. 0-9 are on-board, 10-19 are on the MXP port
|
||||
* @param channel The SmartIO channel number.
|
||||
* @param registerSendable If true, adds this instance to SendableRegistry
|
||||
*/
|
||||
@SuppressWarnings("this-escape")
|
||||
|
||||
@@ -38,8 +38,7 @@ public abstract class PWMMotorController extends MotorSafety
|
||||
* Constructor.
|
||||
*
|
||||
* @param name Name to use for SendableRegistry
|
||||
* @param channel The PWM channel that the controller is attached to. 0-9 are on-board, 10-19 are
|
||||
* on the MXP port
|
||||
* @param channel The SmartIO channel that the controller is attached to.
|
||||
*/
|
||||
@SuppressWarnings("this-escape")
|
||||
protected PWMMotorController(final String name, final int channel) {
|
||||
|
||||
@@ -30,8 +30,7 @@ public class AnalogPotentiometer implements Sendable, AutoCloseable {
|
||||
* point after scaling is 135 degrees. This will calculate the result from the fullRange times the
|
||||
* fraction of the supply voltage, plus the offset.
|
||||
*
|
||||
* @param channel The analog input channel this potentiometer is plugged into. 0-3 are on-board
|
||||
* and 4-7 are on the MXP port.
|
||||
* @param channel The SmartIO channel this potentiometer is plugged into.
|
||||
* @param fullRange The scaling to multiply the fraction by to get a meaningful unit.
|
||||
* @param offset The offset to add to the scaled value for controlling the zero value
|
||||
*/
|
||||
@@ -73,8 +72,7 @@ public class AnalogPotentiometer implements Sendable, AutoCloseable {
|
||||
* degree potentiometer, and you want the output to be degrees with the starting point as 0
|
||||
* degrees. The scale value is 270.0(degrees).
|
||||
*
|
||||
* @param channel The analog input channel this potentiometer is plugged into. 0-3 are on-board
|
||||
* and 4-7 are on the MXP port.
|
||||
* @param channel The analog input channel this potentiometer is plugged into.
|
||||
* @param scale The scaling to multiply the voltage by to get a meaningful unit.
|
||||
*/
|
||||
public AnalogPotentiometer(final int channel, double scale) {
|
||||
@@ -100,8 +98,7 @@ public class AnalogPotentiometer implements Sendable, AutoCloseable {
|
||||
*
|
||||
* <p>The potentiometer will return a value between 0 and 1.0.
|
||||
*
|
||||
* @param channel The analog input channel this potentiometer is plugged into. 0-3 are on-board
|
||||
* and 4-7 are on the MXP port.
|
||||
* @param channel The analog input channel this potentiometer is plugged into.
|
||||
*/
|
||||
public AnalogPotentiometer(final int channel) {
|
||||
this(channel, 1, 0);
|
||||
|
||||
@@ -64,8 +64,8 @@ public class Encoder implements CounterBase, Sendable, AutoCloseable {
|
||||
*
|
||||
* <p>The encoder will start counting immediately.
|
||||
*
|
||||
* @param channelA The 'a' channel DIO channel. 0-9 are on-board, 10-25 are on the MXP port
|
||||
* @param channelB The 'b' channel DIO channel. 0-9 are on-board, 10-25 are on the MXP port
|
||||
* @param channelA The 'a' SmartIO channel.
|
||||
* @param channelB The 'b' SmartIO channel.
|
||||
* @param reverseDirection represents the orientation of the encoder and inverts the output values
|
||||
* if necessary so forward represents positive values.
|
||||
*/
|
||||
@@ -78,8 +78,8 @@ public class Encoder implements CounterBase, Sendable, AutoCloseable {
|
||||
*
|
||||
* <p>The encoder will start counting immediately.
|
||||
*
|
||||
* @param channelA The a channel digital input channel.
|
||||
* @param channelB The b channel digital input channel.
|
||||
* @param channelA The 'a' SmartIO channel.
|
||||
* @param channelB The 'b' SmartIO channel.
|
||||
*/
|
||||
public Encoder(final int channelA, final int channelB) {
|
||||
this(channelA, channelB, false);
|
||||
@@ -90,8 +90,8 @@ public class Encoder implements CounterBase, Sendable, AutoCloseable {
|
||||
*
|
||||
* <p>The encoder will start counting immediately.
|
||||
*
|
||||
* @param channelA The a channel digital input channel.
|
||||
* @param channelB The b channel digital input channel.
|
||||
* @param channelA The 'a' SmartIO channel.
|
||||
* @param channelB The 'b' SmartIO channel.
|
||||
* @param reverseDirection represents the orientation of the encoder and inverts the output values
|
||||
* if necessary so forward represents positive values.
|
||||
* @param encodingType either k1X, k2X, or k4X to indicate 1X, 2X or 4X decoding. If 4X is
|
||||
|
||||
Reference in New Issue
Block a user