Setbrake - Newport XPS Programmer's Manual

XPS Unified
EDH0373En1023 — 01/18
7.2.2.27

SetBrake

Name
SetBrake– Sets Brake command.
Input tests
- Refer to section 7.1: "Input Tests Common to all XPS Functions".
- Checks if the break feature is enabled: (-205)
Description
This function sets brake command signal from Inhibit or GPIO connector.
Refer to section [BRAKE] in System.ini configuration file.
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 SetBrake(
int SocketID,
int Command
)
Input parameters
SocketID
Command
Output parameters
None.
Return (In addition to the results of "Input Tests Common to all XPS
Functions")
• 0: No error.
• -17: Parameter out of range or incorrect.
• -205: Not enable in your configuration.
int Socket identifier gets by the
"TCP_ConnectToServer" function.
int Brake command (0 or 1).
622
Programmer's Manual