MPIMotionMessage and MEIMotionMessage

MPIMotionMessage / MEIMotionMessage

Definition: MPIMotionMessage

typedef enum {
    MPIMotionMessageMOTION_INVALID,
    MPIMotionMessageAXIS_NOT_FOUND,
    MPIMotionMessageAXIS_COUNT,
    MPIMotionMessageAXIS_FRAME_COUNT,
    MPIMotionMessageTYPE_INVALID,
    MPIMotionMessageATTRIBUTE_INVALID,
    MPIMotionMessageIDLE,
    MPIMotionMessageMOVING,
    MPIMotionMessageSTOPPING,
    MPIMotionMessageSTOPPED,
    MPIMotionMessageSTOPPING_ERROR,
    MPIMotionMessageERROR,
    MPIMotionMessageAUTO_START,
    MPIMotionMessageILLEGAL_DELAY,
    MPIMotionMessagePROFILE_ERROR,
    MPIMotionMessagePROFILE_NOT_SUPPORTED,
    MPIMotionMessagePATH_ERROR,
    MPIMotionMessageFRAMES_LOW,
    MPIMotionMessageFRAMES_EMPTY,
    MPIMotionMessageFRAME_BUFFER_TOO_SMALL,
} MPIMotionMessage;

Required Header: stdmpi.h
Change History: Modified in the 03.03.00. Modified in the 03.02.00

Description

MPIMotionMessage is an enumeration of Motion error messages that can be returned by the MPI library.

MPIMotionMessageMOTION_INVALID
	The motion supervisor number is out of range. This message code is returned by mpiMotionCreate(...) if the motion supervisor number is less than zero or greater than or equal to MEIXmpMAX_MSs.
MPIMotionMessageAXIS_NOT_FOUND
	The specified axis object is not available. This message is returned from mpiMotionAxisRemove(...) if the axis that is being removed is not a member of the motion object.
MPIMotionMessageAXIS_COUNT
	The number of axes is out of range. This message is returned from mpiMotionConfigSet(...), mpiMotionStart(...), or mpiMotionModify(...) if there are no axes associated with the motion object or if the axis count exceeds MEIXmpMAX_COORD_AXES.
MPIMotionMessageAXIS_FRAME_COUNT
	The axis frame count invalid on this Motion object. All axes appended to a Motion object must have the same frame buffer size. The axis frame buffer sizes are configured with the low-level controller configuration routine mpiControlConfigSet(...).
MPIMotionMessageTYPE_INVALID
	The motion type or motion attribute is not valid. This message code is returned from mpiMotionStart(...) or mpiMotionModify(...) if the motion type or motion attribute mask is not recognized by the library. To correct the problem, select a motion type/attribute from the MPI and/or MEI enumerations.
MPIMotionMessageATTRIBUTE_INVALID
	The motion attribute is not valid. This message code is returned from mpiMotionStart(...) or mpiMotionModify(...) if the motion attribute mask is not compatible with the specified motion type. To correct the problem, do not use the motion attribute mask with the specified motion type or select a different motion type. Please see possible causes for receiving this message.
MPIMotionMessageIDLE
	All motion supervisor axes are not moving and are ready to move. This message code is returned from mpiMotionModify(...) when the motion supervisor is in the IDLE state. A motion cannot be modified if no motion is in progress. To correct the problem, use the AUTO_START attribute for mpiMotionModify(...) or use mpiMotionStart(...) instead. This message code is also returned from mpiMotionAction(...) when a STOP or RESUME is commanded when the motion supervisor is in the IDLE state. A motion cannot be stopped if there is no motion in progress and a motion cannot be resumed if there is no motion profile pending.
MPIMotionMessageMOVING
	At least one motion supervisor axis is moving. This message code is returned from mpiMotionStart(...) when the motion supervisor is in the MOVING state. A motion cannot be started if a motion is in progress. To correct the problem, use mpiMotionModify(...) instead. This message code is also returned from mpiMotionAction(...) when a RESUME or RESET is commanded when the motion supervisor is in the MOVING state. A motion cannot be resumed or reset while a motion is in progress.
MPIMotionMessageSTOPPING
	Motion supervisor axes are stopping due to a STOP action. This message code is returned from mpiMotionStart(...) or mpiMotionModify(...) when the motion supervisor is in the STOPPING state. A motion cannot be commanded when a stop is in progress. This message code is also returned from mpiMotionAction(...) when a RESUME or RESET is commanded when the motion supervisor is in the STOPPING state. A motion cannot be resumed or reset while a stop is in progress.
MPIMotionMessageSTOPPED
	Motion supervisor axes are stopped due to a STOP action. This message code is returned from mpiMotionAction(...) when a STOP action is commanded while the motion supervisor is already in the STOPPED state.
MPIMotionMessageSTOPPING_ERROR
	Motion supervisor axes are stopping due to an E_STOP or ABORT action. This message code is returned from mpiMotionStart(...) or mpiMotionModify(...) when the motion supervisor is in the STOPPING_ERROR state. A motion cannot be commanded when a stopping on error action is in progress. This message code is also returned from mpiMotionAction(...) when a RESUME or RESET is commanded when the motion supervisor is in the STOPPING state. A motion cannot be resumed or reset while a stopping on error action is in progress.
MPIMotionMessageERROR
	Motion supervisor axes are in an error state due to an E_STOP or ABORT action. This message code is returned from mpiMotionStart(...) or mpiMotionModify(...) when the motion supervisor is in the ERROR state. A motion cannot be commanded when the motion supervisor is in an error state. This message code is also returned from mpiMotionAction(...) when a STOP or RESUME is commanded when the motion supervisor is in the ERROR state. To correct the problem, fix the condition that caused the E_STOP or ABORT action and then clear the ERROR state using mpiMotionAction(...) with a RESET.
MPIMotionMessageAUTO_START
	The motion modify was automatically converted to a motion start. This message code is returned from mpiMotionModify(...) when the AUTO_START attribute mask was specified and the motion was commanded while the motion supervisor is in the IDLE state. This message code is useful for notifying an application of an auto-start, it is not an error condition.
MPIMotionMessageILLEGAL_DELAY
	Returned if a motion modify is called with a non-zero delay value and the MPIMotionAttrDELAY attribute is set while in motion. If it is currently not in motion and the AUTO_START attribute is set, this message will not be returned and the specified delay will be used at the beginning of the motion.
MPIMotionMessagePROFILE_ERROR
	The motion profile is not possible with the specified constraints. This message code is returned by mpiMotionModify(...) when the NO_REVERSAL attribute mask is specified, but the specified target position is in the reverse direction. To correct the problem, either remove the NO_REVERSAL constraint or specify a target position that is in the same direction as the motion profile in progress.
MPIMotionMessagePROFILE_NOT_SUPPORTED
	The controller firmware does not support the specified motion profile type. This message code is returned by mpiMotionStart(...) or mpiMotionModify(...) when an S_CURVE_JERK or VELOCITY_JERK motion type is commanded, but not supported by the controller firmware. Due to programming memory space constraints, specific revisions of controller firmware may not support jerk motion types. To correct the problem, use the S_CURVE or VELOCITY motion instead.
MPIMotionMessagePATH_ERROR
	The specified multi-point motion path is not valid. This message code is returned by mpiMotionStart(...) or mpiMotionModify(...) when the final point is not specified or the time slice is less than one controller sample.
MPIMotionMessageFRAMES_LOW
	The controller's frame buffer is low. This message code is returned by the internal method, meiMotionFramesLow(...). This is an internal message code used by the library to manage the frame buffering.
MPIMotionMessageFRAMES_EMPTY
	The controller's frame buffer is empty. This message code is returned by the internal method, meiMotionFramesLow(...). This is an internal message code used by the library to manage the frame buffering.
MPIMotionMessageFRAME_BUFFER_TOO_SMALL
	When trying to start a cam, an insufficient amount of space was found on the controller. To remedy this problem, you can either reduce the number of points within the cam (See Camming) or increase the number of points in the frame buffer. See Increasing the Maximum Cam Table Size.

Definition: MEIMotionMessage

	typedef enum { MEIMotionMessageRESERVED0, MEIMotionMessageRESERVED1, MEIMotionMessageRESERVED2, MEIMotionMessageNO_AXES_MAPPED, MEIMotionMessageBAD_PATH_DATA, } MEIMotionMessage;
	Required Header: stdmei.h Change History: 03.03.00

Description

MEIMotionMessage is an enumeration of Motion error messages that can be returned by the MPI library.

MEIMotionMessageRESERVED0
	Reserved for specialized use.
MEIMotionMessageRESERVED1
	Reserved for specialized use.
MEIMotionMessageRESERVED2
	Reserved for specialized use.
MEIMotionMessageNO_AXES_MAPPED
	The motion object has no axes. This message code is returned by mpiMotionStart(...), mpiMotionModify(...) or mpiMotionAction(...) if there are no axes mapped to the motion object. To correct this problem, make sure there is at least one axis object associated with the motion object before commanding any motion or motion actions. Possible Causes: No axes are mapped to the motion supervisor that the move was commanded on.
MEIMotionMessageBAD_PATH_DATA
	If any of the motion parameters passed to the MPI for path motion are infinite or NAN, the MPI will return MEIMotionMessageBAD_PATH_DATA and will not load the move to the controller.