Groupbrakeset - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.1.72

GroupBrakeSet

Name
GroupBrakeSet – Sets brake command.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks GPIO board number / Checks brake command value: (-17)
- Checks if GPIO board is present: (-100)
- Checks if "Brake" mode is enabled: (-205)
Description
This function sets brake command signal from Inhibit or GPIO connector.
Refer to section [BRAKE] in System.ini configuration file. The feature is developed to
avoid a run away after hardware error detection (XY group only).
Brake commands:
1) BrakeCommandSignalState parameter is defined "Direct" in System.ini
• 0 = Brake OFF.
• 1 = Brake ON.
2) BrakeCommandSignalState parameter is defined "Inverted" in System.ini
• 0 = Brake ON.
• 1 = Brake OFF.
Prototype.
int GroupBrakeSet(
int SocketID,
char * GroupName,
int BrakeCommand,
)
Input parameters
SocketID
GroupName
BrakeCommand
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.
• -17: Parameter out of range or incorrect.
• -205: Not enable in your configuration.
• -100: Internal error (memory allocation error ...).
int Socket identifier gets by the
TCP_ConnectToServer" function.
char * Group name (XY).
int Brake command (0 or 1).
120
Programmer's Manual