MPI 04.00 Reference >> mpiMotor

MPIMotorPhaseFindDriveMsg

Definition

typedef struct MPIMotorPhaseFindDriveMsg {
/* drive specific code and message reporting information
on the success or failure, see drive module for details */
int32_t code;
const char* message;
} MPIMotorPhaseFindDriveMsg;

 

Required Header: stdmpi.h

Change History: Modified in 04.00. Added in 03.03.00.

Description

MPIMotorPhaseFindDriveMsg drive specific information which reflects the quality or failure status of the phase finding routine.

Note: Not all drives will support this field.

code A value retrieved from the drive which reports the status or quality of the Phase Finding Procedure. This value is drive manufacturer specific and is used for informational purposes only and is not evaluated by the controller.
message A string provided by the drive manufacturer that describes what “code” represents.

See Also

MPIMotorPhaseFindState | MPIMotorPhaseFindStatus | mpiMotorPhaseFindStart | mpiMotorPhaseFindAbort | mpiMotorPhaseFindStatus | Motor Phase Finding