Power.h

Go to the documentation of this file.

// Copyright (c) FIRST and other WPILib contributors.
// Open Source Software; you can modify and/or share it under the terms of
// the WPILib BSD license file in the root directory of this project.
 
#pragma once
 
#include <stdint.h>
 
#include "hal/Types.h"
 
/**
 * @defgroup hal_power Power Functions
 * @ingroup hal_capi
 * @{
 */
 
#ifdef __cplusplus
extern "C" {
#endif
 
/**
 * Gets the roboRIO input voltage.
 *
 * @param[out] status the error code, or 0 for success
 * @return the input voltage (volts)
 */
double HAL_GetVinVoltage(int32_t* status);
 
/**
 * Gets the roboRIO input current.
 *
 * @param[out] status the error code, or 0 for success
 * @return the input current (amps)
 */
double HAL_GetVinCurrent(int32_t* status);
 
/**
 * Gets the 6V rail voltage.
 *
 * @param[out] status the error code, or 0 for success
 * @return the 6V rail voltage (volts)
 */
double HAL_GetUserVoltage6V(int32_t* status);
 
/**
 * Gets the 6V rail current.
 *
 * @param[out] status the error code, or 0 for success
 * @return the 6V rail current (amps)
 */
double HAL_GetUserCurrent6V(int32_t* status);
 
/**
 * Gets the active state of the 6V rail.
 *
 * @param[out] status the error code, or 0 for success
 * @return true if the rail is active, otherwise false
 */
HAL_Bool HAL_GetUserActive6V(int32_t* status);
 
/**
 * Gets the fault count for the 6V rail.
 *
 * @param[out] status the error code, or 0 for success
 * @return the number of 6V fault counts
 */
int32_t HAL_GetUserCurrentFaults6V(int32_t* status);
 
/**
 * Enables or disables the 6V rail.
 *
 * @param enabled whether the rail should be enabled
 * @param[out] status the error code, or 0 for success
 */
void HAL_SetUserRailEnabled6V(HAL_Bool enabled, int32_t* status);
 
/**
 * Gets the 5V rail voltage.
 *
 * @param[out] status the error code, or 0 for success
 * @return the 5V rail voltage (volts)
 */
double HAL_GetUserVoltage5V(int32_t* status);
 
/**
 * Gets the 5V rail current.
 *
 * @param[out] status the error code, or 0 for success
 * @return the 5V rail current (amps)
 */
double HAL_GetUserCurrent5V(int32_t* status);
 
/**
 * Gets the active state of the 5V rail.
 *
 * @param[out] status the error code, or 0 for success
 * @return true if the rail is active, otherwise false
 */
HAL_Bool HAL_GetUserActive5V(int32_t* status);
 
/**
 * Gets the fault count for the 5V rail.
 *
 * @param[out] status the error code, or 0 for success
 * @return the number of 5V fault counts
 */
int32_t HAL_GetUserCurrentFaults5V(int32_t* status);
 
/**
 * Enables or disables the 5V rail.
 *
 * @param enabled whether the rail should be enabled
 * @param[out] status the error code, or 0 for success
 */
void HAL_SetUserRailEnabled5V(HAL_Bool enabled, int32_t* status);
 
/**
 * Gets the 3V3 rail voltage.
 *
 * @param[out] status the error code, or 0 for success
 * @return the 3V3 rail voltage (volts)
 */
double HAL_GetUserVoltage3V3(int32_t* status);
 
/**
 * Gets the 3V3 rail current.
 *
 * @param[out] status the error code, or 0 for success
 * @return the 3V3 rail current (amps)
 */
double HAL_GetUserCurrent3V3(int32_t* status);
 
/**
 * Gets the active state of the 3V3 rail.
 *
 * @param[out] status the error code, or 0 for success
 * @return true if the rail is active, otherwise false
 */
HAL_Bool HAL_GetUserActive3V3(int32_t* status);
 
/**
 * Gets the fault count for the 3V3 rail.
 *
 * @param[out] status the error code, or 0 for success
 * @return the number of 3V3 fault counts
 */
int32_t HAL_GetUserCurrentFaults3V3(int32_t* status);
 
/**
 * Enables or disables the 3V3 rail.
 *
 * @param enabled whether the rail should be enabled
 * @param[out] status the error code, or 0 for success
 */
void HAL_SetUserRailEnabled3V3(HAL_Bool enabled, int32_t* status);
 
/**
 * Get the current brownout voltage setting.
 *
 * @param[out] status the error code, or 0 for success
 * @return The brownout voltage
 */
double HAL_GetBrownoutVoltage(int32_t* status);
 
/**
 * Set the voltage the roboRIO will brownout and disable all outputs.
 *
 * Note that this only does anything on the roboRIO 2.
 * On the roboRIO it is a no-op.
 *
 * @param[in] voltage The brownout voltage
 * @param[out] status the error code, or 0 for success
 */
void HAL_SetBrownoutVoltage(double voltage, int32_t* status);
 
/**
 * Get the current CPU temperature in degrees Celsius
 *
 * @param[out] status the error code, or 0 for success
 * @return current CPU temperature in degrees Celsius
 */
double HAL_GetCPUTemp(int32_t* status);
 
#ifdef __cplusplus
}  // extern "C"
#endif
/** @} */