Groupmotiondisable - Newport XPS Programmer's Manual

XPS Unified
7.2.1.90

GroupMotionDisable

Name
GroupMotionDisable – Disables a "READY" group.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Actor must be a group: (-8), (-18)
- Valids group name: (-19)
- Group status must be "READY": (-22)
Description
Turns OFF the motors, stops the corrector servo loop and disables the position compare
mode, if active. The group status becomes "DISABLE".
If the group is not in "READY" state, error (-22) is returned.
In the "DISABLED" state the encoder is still read.
To return to "READY" state, call "GroupMotionEnable" function.
Prototype
int GroupMotionDisable(
int SocketID,
char * GroupName
)
Input parameters
SocketID
GroupName
Output parameters
None.
Return (In addition to the results of "Input Tests Common to all XPS
Functions")
• 0: No error.
• -8: Wrong object type for this command.
• -18: Positioner Name doesn't exist or unknown command.
• -19: GroupName doesn't exist or unknown command.
• -22: Not allowed action.
NOTE
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * Group name.
147
Programmer's Manual
EDH0373En1023 — 01/18