WPILibC++  2019.2.1-25-g182758c
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
Analog Trigger Functions

Functions

 HAL_ENUM (HAL_AnalogTriggerType)
 The type of analog trigger to trigger on.
 
HAL_AnalogTriggerHandle HAL_InitializeAnalogTrigger (HAL_AnalogInputHandle portHandle, int32_t *index, int32_t *status)
 Initializes an analog trigger. More...
 
void HAL_CleanAnalogTrigger (HAL_AnalogTriggerHandle analogTriggerHandle, int32_t *status)
 Frees an analog trigger. More...
 
void HAL_SetAnalogTriggerLimitsRaw (HAL_AnalogTriggerHandle analogTriggerHandle, int32_t lower, int32_t upper, int32_t *status)
 Sets the raw ADC upper and lower limits of the analog trigger. More...
 
void HAL_SetAnalogTriggerLimitsVoltage (HAL_AnalogTriggerHandle analogTriggerHandle, double lower, double upper, int32_t *status)
 Sets the upper and lower limits of the analog trigger. More...
 
void HAL_SetAnalogTriggerAveraged (HAL_AnalogTriggerHandle analogTriggerHandle, HAL_Bool useAveragedValue, int32_t *status)
 Configures the analog trigger to use the averaged vs. More...
 
void HAL_SetAnalogTriggerFiltered (HAL_AnalogTriggerHandle analogTriggerHandle, HAL_Bool useFilteredValue, int32_t *status)
 Configures the analog trigger to use a filtered value. More...
 
HAL_Bool HAL_GetAnalogTriggerInWindow (HAL_AnalogTriggerHandle analogTriggerHandle, int32_t *status)
 Returns the InWindow output of the analog trigger. More...
 
HAL_Bool HAL_GetAnalogTriggerTriggerState (HAL_AnalogTriggerHandle analogTriggerHandle, int32_t *status)
 Returns the TriggerState output of the analog trigger. More...
 
HAL_Bool HAL_GetAnalogTriggerOutput (HAL_AnalogTriggerHandle analogTriggerHandle, HAL_AnalogTriggerType type, int32_t *status)
 Gets the state of the analog trigger output. More...
 

Detailed Description

Function Documentation

void HAL_CleanAnalogTrigger ( HAL_AnalogTriggerHandle  analogTriggerHandle,
int32_t *  status 
)

Frees an analog trigger.

Parameters
analogTriggerHandlethe trigger handle
HAL_Bool HAL_GetAnalogTriggerInWindow ( HAL_AnalogTriggerHandle  analogTriggerHandle,
int32_t *  status 
)

Returns the InWindow output of the analog trigger.

True if the analog input is between the upper and lower limits.

Parameters
analogTriggerHandlethe trigger handle
Returns
the InWindow output of the analog trigger
HAL_Bool HAL_GetAnalogTriggerOutput ( HAL_AnalogTriggerHandle  analogTriggerHandle,
HAL_AnalogTriggerType  type,
int32_t *  status 
)

Gets the state of the analog trigger output.

Parameters
analogTriggerHandlethe trigger handle
typethe type of trigger to trigger on
Returns
the state of the analog trigger output
HAL_Bool HAL_GetAnalogTriggerTriggerState ( HAL_AnalogTriggerHandle  analogTriggerHandle,
int32_t *  status 
)

Returns the TriggerState output of the analog trigger.

True if above upper limit. False if below lower limit. If in Hysteresis, maintain previous state.

Parameters
analogTriggerHandlethe trigger handle
Returns
the TriggerState output of the analog trigger
HAL_AnalogTriggerHandle HAL_InitializeAnalogTrigger ( HAL_AnalogInputHandle  portHandle,
int32_t *  index,
int32_t *  status 
)

Initializes an analog trigger.

Parameters
portHandlethe analog input to use for triggering
indexthe trigger index value (output)
Returns
the created analog trigger handle
void HAL_SetAnalogTriggerAveraged ( HAL_AnalogTriggerHandle  analogTriggerHandle,
HAL_Bool  useAveragedValue,
int32_t *  status 
)

Configures the analog trigger to use the averaged vs.

raw values.

If the value is true, then the averaged value is selected for the analog trigger, otherwise the immediate value is used.

Parameters
analogTriggerHandlethe trigger handle
useAveragedValuetrue to use averaged values, false for raw
void HAL_SetAnalogTriggerFiltered ( HAL_AnalogTriggerHandle  analogTriggerHandle,
HAL_Bool  useFilteredValue,
int32_t *  status 
)

Configures the analog trigger to use a filtered value.

The analog trigger will operate with a 3 point average rejection filter. This is designed to help with 360 degree pot applications for the period where the pot crosses through zero.

Parameters
analogTriggerHandlethe trigger handle
useFilteredValuetrue to use filtered values, false for average or raw
void HAL_SetAnalogTriggerLimitsRaw ( HAL_AnalogTriggerHandle  analogTriggerHandle,
int32_t  lower,
int32_t  upper,
int32_t *  status 
)

Sets the raw ADC upper and lower limits of the analog trigger.

HAL_SetAnalogTriggerLimitsVoltage is likely better in most cases.

Parameters
analogTriggerHandlethe trigger handle
lowerthe lower ADC value
upperthe upper ADC value
void HAL_SetAnalogTriggerLimitsVoltage ( HAL_AnalogTriggerHandle  analogTriggerHandle,
double  lower,
double  upper,
int32_t *  status 
)

Sets the upper and lower limits of the analog trigger.

The limits are given as floating point voltage values.

Parameters
analogTriggerHandlethe trigger handle
lowerthe lower voltage value
upperthe upper voltage value