mirror of
https://github.com/wpilibsuite/allwpilib
synced 2026-06-22 01:11:42 +00:00
[doc] Add missing pneumatics docs (NFC) (#5389)
Add missing HAL docs for PCM and PH Fix references to PCM Document different one shot durations for PCM and PH
This commit is contained in:
@@ -211,16 +211,40 @@ public interface PneumaticsBase extends AutoCloseable {
|
||||
*/
|
||||
void unreserveSolenoids(int mask);
|
||||
|
||||
/**
|
||||
* Reserve the compressor.
|
||||
*
|
||||
* @return true if successful; false if compressor already reserved
|
||||
*/
|
||||
boolean reserveCompressor();
|
||||
|
||||
/** Unreserve the compressor. */
|
||||
void unreserveCompressor();
|
||||
|
||||
@Override
|
||||
void close();
|
||||
|
||||
/**
|
||||
* Create a solenoid object for the specified channel.
|
||||
*
|
||||
* @param channel solenoid channel
|
||||
* @return Solenoid object
|
||||
*/
|
||||
Solenoid makeSolenoid(int channel);
|
||||
|
||||
/**
|
||||
* Create a double solenoid object for the specified channels.
|
||||
*
|
||||
* @param forwardChannel solenoid channel for forward
|
||||
* @param reverseChannel solenoid channel for reverse
|
||||
* @return DoubleSolenoid object
|
||||
*/
|
||||
DoubleSolenoid makeDoubleSolenoid(int forwardChannel, int reverseChannel);
|
||||
|
||||
/**
|
||||
* Create a compressor object.
|
||||
*
|
||||
* @return Compressor object
|
||||
*/
|
||||
Compressor makeCompressor();
|
||||
}
|
||||
|
||||
@@ -117,11 +117,16 @@ public class Solenoid implements Sendable, AutoCloseable {
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the pulse duration in the PCM. This is used in conjunction with the startPulse method to
|
||||
* allow the PCM to control the timing of a pulse. The timing can be controlled in 0.01 second
|
||||
* increments.
|
||||
* Set the pulse duration in the pneumatics module. This is used in conjunction with the
|
||||
* startPulse method to allow the pneumatics module to control the timing of a pulse.
|
||||
*
|
||||
* @param durationSeconds The duration of the pulse, from 0.01 to 2.55 seconds.
|
||||
* <p>On the PCM, the timing can be controlled in 0.01 second increments, with a maximum of 2.55
|
||||
* seconds.
|
||||
*
|
||||
* <p>On the PH, the timing can be controlled in 0.001 second increments, with a maximum of 65.534
|
||||
* seconds.
|
||||
*
|
||||
* @param durationSeconds The duration of the pulse in seconds.
|
||||
* @see #startPulse()
|
||||
*/
|
||||
public void setPulseDuration(double durationSeconds) {
|
||||
@@ -130,7 +135,7 @@ public class Solenoid implements Sendable, AutoCloseable {
|
||||
}
|
||||
|
||||
/**
|
||||
* Trigger the PCM to generate a pulse of the duration set in setPulseDuration.
|
||||
* Trigger the pneumatics module to generate a pulse of the duration set in setPulseDuration.
|
||||
*
|
||||
* @see #setPulseDuration(double)
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user