Newport XPS-D - Getbrakestate

XPS Unified Programmer’s Manual
7.2.2.4 GetBrakeState
Name
GetBrakeState– Gets the brake status.
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
Description
This function reads the current brake command signal state from Inhibit or GPIO
connector. Refer to section [BRAKE] in System.ini configuration file.
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 GetBrakeState(
int SocketID,
int * BrakeStatus
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
Output parameters
BrakeStatus int * The brake status.
Return (In addition to the results of “Input Tests Common to all XPS
Functions”)
• 0: No error.
EDH0373En1023 — 01/18 592