WPILibC++
2018.4.1-20180928043320-1211-g175c6c1
|
Functions | |
HAL_AnalogInputHandle | HAL_InitializeAnalogInputPort (HAL_PortHandle portHandle, int32_t *status) |
Initializes the analog input port using the given port object. More... | |
void | HAL_FreeAnalogInputPort (HAL_AnalogInputHandle analogPortHandle) |
Frees an analog input port. More... | |
HAL_Bool | HAL_CheckAnalogModule (int32_t module) |
Checks that the analog module number is valid. More... | |
HAL_Bool | HAL_CheckAnalogInputChannel (int32_t channel) |
Checks that the analog output channel number is value. More... | |
void | HAL_SetAnalogSampleRate (double samplesPerSecond, int32_t *status) |
Sets the sample rate. More... | |
double | HAL_GetAnalogSampleRate (int32_t *status) |
Gets the current sample rate. More... | |
void | HAL_SetAnalogAverageBits (HAL_AnalogInputHandle analogPortHandle, int32_t bits, int32_t *status) |
Sets the number of averaging bits. More... | |
int32_t | HAL_GetAnalogAverageBits (HAL_AnalogInputHandle analogPortHandle, int32_t *status) |
Gets the number of averaging bits. More... | |
void | HAL_SetAnalogOversampleBits (HAL_AnalogInputHandle analogPortHandle, int32_t bits, int32_t *status) |
Sets the number of oversample bits. More... | |
int32_t | HAL_GetAnalogOversampleBits (HAL_AnalogInputHandle analogPortHandle, int32_t *status) |
Gets the number of oversample bits. More... | |
int32_t | HAL_GetAnalogValue (HAL_AnalogInputHandle analogPortHandle, int32_t *status) |
Gets a sample straight from the channel on this module. More... | |
int32_t | HAL_GetAnalogAverageValue (HAL_AnalogInputHandle analogPortHandle, int32_t *status) |
Gets a sample from the output of the oversample and average engine for the channel. More... | |
int32_t | HAL_GetAnalogVoltsToValue (HAL_AnalogInputHandle analogPortHandle, double voltage, int32_t *status) |
Converts a voltage to a raw value for a specified channel. More... | |
double | HAL_GetAnalogVoltage (HAL_AnalogInputHandle analogPortHandle, int32_t *status) |
Gets a scaled sample straight from the channel on this module. More... | |
double | HAL_GetAnalogAverageVoltage (HAL_AnalogInputHandle analogPortHandle, int32_t *status) |
Gets a scaled sample from the output of the oversample and average engine for the channel. More... | |
int32_t | HAL_GetAnalogLSBWeight (HAL_AnalogInputHandle analogPortHandle, int32_t *status) |
Gets the factory scaling least significant bit weight constant. More... | |
int32_t | HAL_GetAnalogOffset (HAL_AnalogInputHandle analogPortHandle, int32_t *status) |
Gets the factory scaling offset constant. More... | |
HAL_Bool HAL_CheckAnalogInputChannel | ( | int32_t | channel | ) |
Checks that the analog output channel number is value.
Verifies that the analog channel number is one of the legal channel numbers. Channel numbers are 0-based.
channel | The analog output channel number. |
HAL_Bool HAL_CheckAnalogModule | ( | int32_t | module | ) |
Checks that the analog module number is valid.
module | The analog module number. |
void HAL_FreeAnalogInputPort | ( | HAL_AnalogInputHandle | analogPortHandle | ) |
Frees an analog input port.
analogPortHandle | Handle to the analog port. |
int32_t HAL_GetAnalogAverageBits | ( | HAL_AnalogInputHandle | analogPortHandle, |
int32_t * | status | ||
) |
Gets the number of averaging bits.
This gets the number of averaging bits from the FPGA. The actual number of averaged samples is 2**bits. The averaging is done automatically in the FPGA.
analogPortHandle | Handle to the analog port to use. |
int32_t HAL_GetAnalogAverageValue | ( | HAL_AnalogInputHandle | analogPortHandle, |
int32_t * | status | ||
) |
Gets a sample from the output of the oversample and average engine for the channel.
The sample is 12-bit + the value configured in SetOversampleBits(). The value configured in SetAverageBits() will cause this value to be averaged 2**bits number of samples. This is not a sliding window. The sample will not change until 2**(OversamplBits + AverageBits) samples have been acquired from the module on this channel. Use GetAverageVoltage() to get the analog value in calibrated units.
analogPortHandle | Handle to the analog port to use. |
double HAL_GetAnalogAverageVoltage | ( | HAL_AnalogInputHandle | analogPortHandle, |
int32_t * | status | ||
) |
Gets a scaled sample from the output of the oversample and average engine for the channel.
The value is scaled to units of Volts using the calibrated scaling data from GetLSBWeight() and GetOffset(). Using oversampling will cause this value to be higher resolution, but it will update more slowly. Using averaging will cause this value to be more stable, but it will update more slowly.
analogPortHandle | Handle to the analog port to use. |
int32_t HAL_GetAnalogLSBWeight | ( | HAL_AnalogInputHandle | analogPortHandle, |
int32_t * | status | ||
) |
Gets the factory scaling least significant bit weight constant.
The least significant bit weight constant for the channel that was calibrated in manufacturing and stored in an eeprom in the module.
Volts = ((LSB_Weight * 1e-9) * raw) - (Offset * 1e-9)
analogPortHandle | Handle to the analog port to use. |
int32_t HAL_GetAnalogOffset | ( | HAL_AnalogInputHandle | analogPortHandle, |
int32_t * | status | ||
) |
Gets the factory scaling offset constant.
The offset constant for the channel that was calibrated in manufacturing and stored in an eeprom in the module.
Volts = ((LSB_Weight * 1e-9) * raw) - (Offset * 1e-9)
analogPortHandle | Handle to the analog port to use. |
int32_t HAL_GetAnalogOversampleBits | ( | HAL_AnalogInputHandle | analogPortHandle, |
int32_t * | status | ||
) |
Gets the number of oversample bits.
This gets the number of oversample bits from the FPGA. The actual number of oversampled values is 2**bits. The oversampling is done automatically in the FPGA.
analogPortHandle | Handle to the analog port to use. |
double HAL_GetAnalogSampleRate | ( | int32_t * | status | ) |
Gets the current sample rate.
This assumes one entry in the scan list. This is a global setting for the Athena and effects all channels.
int32_t HAL_GetAnalogValue | ( | HAL_AnalogInputHandle | analogPortHandle, |
int32_t * | status | ||
) |
Gets a sample straight from the channel on this module.
The sample is a 12-bit value representing the 0V to 5V range of the A/D converter in the module. The units are in A/D converter codes. Use GetVoltage() to get the analog value in calibrated units.
analogPortHandle | Handle to the analog port to use. |
double HAL_GetAnalogVoltage | ( | HAL_AnalogInputHandle | analogPortHandle, |
int32_t * | status | ||
) |
Gets a scaled sample straight from the channel on this module.
The value is scaled to units of Volts using the calibrated scaling data from GetLSBWeight() and GetOffset().
analogPortHandle | Handle to the analog port to use. |
int32_t HAL_GetAnalogVoltsToValue | ( | HAL_AnalogInputHandle | analogPortHandle, |
double | voltage, | ||
int32_t * | status | ||
) |
Converts a voltage to a raw value for a specified channel.
This process depends on the calibration of each channel, so the channel must be specified.
analogPortHandle | Handle to the analog port to use. |
voltage | The voltage to convert. |
HAL_AnalogInputHandle HAL_InitializeAnalogInputPort | ( | HAL_PortHandle | portHandle, |
int32_t * | status | ||
) |
Initializes the analog input port using the given port object.
portHandle | Handle to the port to initialize. |
void HAL_SetAnalogAverageBits | ( | HAL_AnalogInputHandle | analogPortHandle, |
int32_t | bits, | ||
int32_t * | status | ||
) |
Sets the number of averaging bits.
This sets the number of averaging bits. The actual number of averaged samples is 2**bits. Use averaging to improve the stability of your measurement at the expense of sampling rate. The averaging is done automatically in the FPGA.
analogPortHandle | Handle to the analog port to configure. |
bits | Number of bits to average. |
void HAL_SetAnalogOversampleBits | ( | HAL_AnalogInputHandle | analogPortHandle, |
int32_t | bits, | ||
int32_t * | status | ||
) |
Sets the number of oversample bits.
This sets the number of oversample bits. The actual number of oversampled values is 2**bits. Use oversampling to improve the resolution of your measurements at the expense of sampling rate. The oversampling is done automatically in the FPGA.
analogPortHandle | Handle to the analog port to use. |
bits | Number of bits to oversample. |
void HAL_SetAnalogSampleRate | ( | double | samplesPerSecond, |
int32_t * | status | ||
) |
Sets the sample rate.
This is a global setting for the Athena and effects all channels.
samplesPerSecond | The number of samples per channel per second. |