Groupbrakestateget - Newport XPS Programmer's Manual

XPS Unified
7.2.1.71

GroupBrakeStateGet

Name
GroupBrakeStateGet – Gets current brake command state.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks if GPIO board number: (-17)
- Checks if GPIO board is present: (-100)
- Checks if "Brake" mode is enabled: (-205)
Description
This function reads the current brake command signal state 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 command signal:
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 GroupBrakeStateGet(
int SocketID,
char * GroupName,
int * BrakeCommand,
)
Input parameters
SocketID
GroupName
Output parameters
BrakeCommand
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).
119
Programmer's Manual
EDH0373En1023 — 01/18