Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-07-05 03:21:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

[doc] Add missing pneumatics docs (NFC) (#5389)

Browse Source 
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:
sciencewhiz
2023-06-15 08:14:35 -07:00
committed by GitHub
parent c3e04a6ea2
commit 5c2addda0f
9 changed files with 497 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
wpilibc/src/main/native/include/frc/Solenoid.h
View File

@@ -87,18 +87,22 @@ class Solenoid : public wpi::Sendable, public wpi::SendableHelper<Solenoid> {
bool IsDisabled() const;
/**
* 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 duration The duration of the pulse, from 0.01 to 2.55 seconds.
* On the PCM, the timing can be controlled in 0.01 second increments, with a
* maximum of 2.55 seconds. On the PH, the timing can be controlled in 0.001
* second increments, with a maximum of 65.534 seconds.
*
* @param duration The duration of the pulse.
*
* @see startPulse()
*/
void SetPulseDuration(units::second_t duration);
/**
* %Trigger the PCM to generate a pulse of the duration set in
* %Trigger the pneumatics module to generate a pulse of the duration set in
* setPulseDuration.
*
* @see setPulseDuration()