3.9.5 mcUtils_PiControlReset

C 


/* Resets the floating point PI control output. */
void mcUtils_PiControlReset(const float32_t integral, tmcUtils_PiControl_s  * const pControl)

/* Resets the fixed point PI control output. */	
void mcUtils_PiControlReset(const int32_t out, tmcUtils_PiControl_s * const pControl)

Summary

Resets the output of the PI control.

Description

This function resets the PI controller by setting the integral output to the specified values.

Precondition

None.

Parameters

ParamDescription
integralThe output value to be reset. Please refer the generated header for the exact data type.
pControlPointer to the PI control structure that holds the controller's state and parameters.

Returns

None

Example 

// Define the PI controller data structure
tmcUtils_PiControl_s piControl;

// Define the parameters for floating point PI control 
float32_t value = 0.0f;

// Define the parameters for fixed point PI control 
int32_t value = 0;

/* Resets the PI control output */
mcUtils_PiControlReset(value, &piControl);

Remarks

Refer the generated header file for the exact function signature..