Singleaxisslavemodeenable - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.1.302

SingleAxisSlaveModeEnable

Name
SingleAxisSlaveModeEnable – Enables the slave-master mode.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks the group type (must be a SingleAxis group): (-8)
- Checks the positioner name: (-18)
- Checks the group name: (-19)
- Group state must be "READY": (-22)
- Checks the slave parameters (must be configured): (-41)
Description
This function enables the master-slave mode only if the slave group is in "READY"
state. In this mode the slave must be defined as a SingleAxis group and the master can
be a positioner from any group.
To use this function, the SingleAxis group must be in the READY state. If it's not the
case then (-22) error is returned.
To use this function, the master positioner and the slave ratio must be configured using
the "SingleAxisSlaveParametersSet" function. If it's not the case then (-41) error is
returned.
Prototype
int SingleAxisSlaveModeEnable(
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.
• -41: Slave-master mode not configured.
int Socket identifier gets by the
"TCP_ConnectToServer" function.
char * SingleAxis group name.
446
Programmer's Manual