Groupjogmodeenable - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.1.86

GroupJogModeEnable

Name
GroupJogModeEnable – Enables the jog mode.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Valids object type (group): (-8), (-18)
- Valids group name: (-19)
- Group status must be "READY": (-22)
- Backlash must not be activated: (-46)
Description
Enables the Jog mode. To use this function, the group must be in "READY" state and
all positioners must be idle (i.e velocity equal to 0).
This function enters "JOGGING" state.
If the group state is not "READY", (-22) error is returned.
To disable the jog mode use the "GroupJogModeDisable" function.
Prototype
int GroupJogModeEnable(
int SocketID,
char * GroupName
)
Input parameters
SocketID
GroupName
Output parameters
None.
NOTE
CAUTION
The jog mode cannot be used with spindle group.
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * Group name.
140
Programmer's Manual