Jump to main content

##

# 3.5.2 mcRpeI_RotorPositionReady

## C

    /* Check if rotor position estimation is ready  */
    bool mcRpeI_RotorPositionReady(  const tmcRpe_Parameters_s * const pParameters );

## Summary

Check the rotor position estimation status.

## Description

This function is used to read the rotor position estimation status.

## Precondition

None.

## Parameters

Param | Description
--- | ---
pParameters | A pointer to the rotor position estimation module parameter structure

## Returns

Returns the rotor position estimation status:

- True: Rotor position is ready.
- False: Rotor position is not ready.

## Example

    // Define the rotor position estimation module data structure
    tmcRpe_Parameters_s rpeParameters;
    bool status;
    /** Check if rotor position estimation is ready */
    status = mcRpeI_RotorPositionReady(&rpeParameters);

## Remarks

None.