Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-07-01 02:41:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

[hal] Update PCM/PH HAL bitmap function docs (NFC) (#6885)

Browse Source
This commit is contained in:
Ryan Blue
2024-07-28 20:10:46 -04:00
committed by GitHub
parent 96de39ac6a
commit 4226d113f1
4 changed files with 22 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
hal/src/main/native/include/hal/CTREPCM.h
View File

@@ -179,7 +179,8 @@ HAL_Bool HAL_GetCTREPCMCompressorNotConnectedFault(HAL_CTREPCMHandle handle,
*
* @param[in] handle the PCM handle
* @param[out] status Error status variable. 0 on success.
* @return solenoid values
* @return Bitmask containing the state of the solenoids. The LSB represents
* solenoid 0.
*/
int32_t HAL_GetCTREPCMSolenoids(HAL_CTREPCMHandle handle, int32_t* status);
@@ -187,8 +188,10 @@ int32_t HAL_GetCTREPCMSolenoids(HAL_CTREPCMHandle handle, int32_t* status);
* Sets solenoids on a pneumatics module.
*
* @param[in] handle the PCM handle
* @param[in] mask bitmask to set
* @param[in] values solenoid values
* @param[in] mask Bitmask indicating which solenoids to set. The LSB represents
* solenoid 0.
* @param[in] values Bitmask indicating the desired states of the solenoids. The
* LSB represents solenoid 0.
* @param[out] status Error status variable. 0 on success.
*/
void HAL_SetCTREPCMSolenoids(HAL_CTREPCMHandle handle, int32_t mask,
@@ -199,7 +202,7 @@ void HAL_SetCTREPCMSolenoids(HAL_CTREPCMHandle handle, int32_t mask,
*
* @param[in] handle the PCM handle
* @param[out] status Error status variable. 0 on success.
* @return bitmask of disabled solenoids
* @return Bitmask indicating disabled solenoids. The LSB represents solenoid 0.
*/
int32_t HAL_GetCTREPCMSolenoidDisabledList(HAL_CTREPCMHandle handle,
int32_t* status);

9
hal/src/main/native/include/hal/REVPH.h
View File

@@ -311,7 +311,8 @@ void HAL_GetREVPHVersion(HAL_REVPHHandle handle, HAL_REVPHVersion* version,
*
* @param[in] handle the PH handle
* @param[out] status Error status variable. 0 on success.
* @return solenoid values
* @return Bitmask containing the state of the solenoids. The LSB represents
* solenoid 0.
*/
int32_t HAL_GetREVPHSolenoids(HAL_REVPHHandle handle, int32_t* status);
@@ -319,8 +320,10 @@ int32_t HAL_GetREVPHSolenoids(HAL_REVPHHandle handle, int32_t* status);
* Sets solenoids on a PH.
*
* @param[in] handle the PH handle
* @param[in] mask bitmask to set
* @param[in] values solenoid values
* @param[in] mask Bitmask indicating which solenoids to set. The LSB represents
* solenoid 0.
* @param[in] values Bitmask indicating the desired states of the solenoids. The
* LSB represents solenoid 0.
* @param[out] status Error status variable. 0 on success.
*/
void HAL_SetREVPHSolenoids(HAL_REVPHHandle handle, int32_t mask, int32_t values,