Motion_Lib M_Actuation Methods - BASG-Support/TwinCAT_3_Lib GitHub Wiki

DINT Halt (void)

###Summary Stops the current movement without blocking out new commands. Set the dynamics via the relevant properties.

###Return Less than 0 : Success

Equal to 0 : Busy

More than 0 : Fail

---

DINT Reset (void)

###Summary Resets the motion axis. It will typically stop any current movement.

###Return Less than 0 : Success

Equal to 0 : Busy

More than 0 : Fail

---

DINT Home (void)

###Summary Starts the homing sequence. Movement dynamics are set via the properties. Please set the function block's homing properties to match the NC parameters. Enabling the property to match the parameters directly may be implemented in the future.

###Return Less than 0 : Success

Equal to 0 : Busy

More than 0 : Fail

---

DINT Home_Forced (void)

###Summary Sets the current position as the calibrated position. No movement is done.

###Return Less than 0 : Success

Equal to 0 : Busy

More than 0 : Fail

---

DINT Move_Along (LREAL Velocity, BOOL Forward)

###Summary Start a movement along a direction at a target speed.

###Parameters Velocity Specifies the required speed to move.

Forward Travels forward if TRUE.

###Return Less than 0 : Success

Equal to 0 : Busy

More than 0 : Fail

---

DINT Move_By (LREAL Distance, LREAL Velocity)

###Summary Start a movement along a direction at a target speed.

###Parameters Distance Specifies the required distance to move.

Velocity Specifies the required speed for the movement.

###Return Less than 0 : Success

Equal to 0 : Busy

More than 0 : Fail

---

DINT Move_To (LREAL Position, LREAL Velocity)

###Summary Start a movement along a direction at a target speed.

###Parameters Specifics Specifies the required position where the movement should end.

Velocity Specifies the required speed for the movement.

###Return Less than 0 : Success

Equal to 0 : Busy

More than 0 : Fail

---

DINT Activate_External_SetPoint (void)

###Summary Enables the use of external set points. The function block's state must first be in E_ACTUATIONSTATE.E_SETPOINT_ACTUATION.

###Return Less than 0 : Success

Equal to 0 : Busy

More than 0 : Fail

---

DINT Deactivate_External_SetPoint (void)

###Summary Disables the use of external set points. The function block's state must first be in E_ACTUATIONSTATE.E_SETPOINT_ACTUATION_ACTIVATED.

###Return Less than 0 : Success

Equal to 0 : Busy

More than 0 : Fail

---

DINT Activate_TouchProbe (void)

###Summary Enables the drive's touch probe functionality and begin sampling. Touch probe functions are currently W.I.P.

###Return Less than 0 : Success

Equal to 0 : Busy

More than 0 : Fail

---

DINT Deactivate_TouchProbe (void)

###Summary Disables the drive's touch probe functionality and begin sampling. Touch probe functions are currently W.I.P.

###Return Less than 0 : Success

Equal to 0 : Busy

More than 0 : Fail