Motion Library

You are here: Technical References > Motion Library > Motion Library - Common

MotionLibrary- Common

Functions sorted in alphabetical order.

Name	Description	Return type
MC_ErrorDescription	Return a text description corresponding to a motion controlMotion control is a sub-field of automation, in which the position and/or velocity of machines are controlled using some type of device such as a hydraulic pump, linear actuator, or an electric motor, generally a servo. Motion control is an important part of robotics and CNC machine tools; however, it is more complex than in the use of specialized machines, where the kinematics is usually simpler. The latter is often called General Motion Control (GMC). Motion control is widely used in the packaging, printing, textile and assembly industries error ID code	STRING
MLMotionCycleTime	Returns the Motion Base Cycle time in Seconds
MLMotionInit	Initializes the motion library. Must be called before any other Motion Library function. Returns TRUE if the function succeeded. BasePeriod is the duration of one motion cycle in microseconds.	BOOL
MLMotionRstErr	Clears motion engine errors, motion bus driver errors, and EtherCATEtherCAT is an open, high-performance Ethernet-based fieldbus system. The development goal of EtherCAT was to apply Ethernet to automation applications which require short data update times (also called cycle times) with low communication jitter (for synchronization purposes) and low hardware costs network errors. MLMotionRstErr will return the motion engine status to the Stopped state, if an error condition was cleared successfully. Returns TRUE if the function succeeded.	BOOL
MLMotionStart	Starts the motion engine, motion bus driver, and initializes EtherCAT network to operational mode. Applicable to PLCopenA vendor -and product- independent worldwide association active in Industrial Control and aiming at standardizing PLC file formats based on XML and PipesNetwork motion engines. Returns TRUE if the function succeeded.	BOOL
MLMotionStatus	Returns the status of the motion engine 0: Not initialized 1: Running 2: Stopped 3: Error	None
MLMotionStop	Stops the motion bus driver, motion engine, and EtherCAT network operation, resulting in the EtherCAT network transitioning to the Init state. Returns TRUE if the function succeeded.	BOOL
MLMotionSysTime	Prints the system time to the log	BOOL
MLProfileBuild	Builds a cam profile from application data	See Output
MLProfileCreate	Creates a new cam profile object	None
MLProfileInit	Initializes a previously created cam profile object	BOOL
MLProfileRelease	Removes a Profile so the Profile ID may be used by a different or new Profile.	See Output

Name

Description

Return type

Return a text description corresponding to a motion controlMotion control is a sub-field of automation, in which the position and/or velocity of machines are controlled using some type of device such as a hydraulic pump, linear actuator, or an electric motor, generally a servo. Motion control is an important part of robotics and CNC machine tools; however, it is more complex than in the use of specialized machines, where the kinematics is usually simpler. The latter is often called General Motion Control (GMC). Motion control is widely used in the packaging, printing, textile and assembly industries error ID code

STRING

MLMotionCycleTime

Returns the Motion Base Cycle time in Seconds

MLMotionInit

Initializes the motion library. Must be called before any other Motion Library function. Returns TRUE if the function succeeded. BasePeriod is the duration of one motion cycle in microseconds.

BOOL

MLMotionRstErr

Clears motion engine errors, motion bus driver errors, and EtherCATEtherCAT is an open, high-performance Ethernet-based fieldbus system. The development goal of EtherCAT was to apply Ethernet to automation applications which require short data update times (also called cycle times) with low communication jitter (for synchronization purposes) and low hardware costs network errors. MLMotionRstErr will return the motion engine status to the Stopped state, if an error condition was cleared successfully. Returns TRUE if the function succeeded.

BOOL

MLMotionStart

Starts the motion engine, motion bus driver, and initializes EtherCAT network to operational mode. Applicable to PLCopenA vendor -and product- independent worldwide association active in Industrial Control and aiming at standardizing PLC file formats based on XML and PipesNetwork motion engines. Returns TRUE if the function succeeded.

BOOL

MLMotionStatus

Returns the status of the motion engine 0: Not initialized 1: Running 2: Stopped 3: Error

None

MLMotionStop

Stops the motion bus driver, motion engine, and EtherCAT network operation, resulting in the EtherCAT network transitioning to the Init state. Returns TRUE if the function succeeded.

BOOL

MLMotionSysTime

Prints the system time to the log

BOOL

MLProfileBuild

Builds a cam profile from application data

See Output

MLProfileCreate

Creates a new cam profile object

None

MLProfileInit

Initializes a previously created cam profile object