Jump to main content

##

# 3.3.23.1 mcRefI_ReferenceControlInit

## C

    /* Initialize reference control module */
    void  mcRefI_ReferenceControlInit( tmcRef_Parameters_s * const pParameters )

## Summary

Initializes the reference control module.

## Description

This function initializes the reference control module with the provided parameters. It links the state variable structure to the module, calculates the speed or position ramp rate per cycle, and updates the reference control module structure with the specified limits and ramp rate.

## Precondition

None.

## Parameters

Param | Description
--- | ---
pParameters | A pointer to the reference control module parameter structure.

## Returns

None

## Example

    // Define the reference control module data structure
    tmcRef_Parameters_s refParameters;

    /** Initialize parameters */
    mcRefI_ReferenceControlInit(&refParameters);

## Remarks

None.