Newport XPS-D - Setpiston

XPS Unified Programmer’s Manual
7.2.2.31 SetPiston
Name
SetPiston – Sets command to activate piston “Engaged” or “Released”.
Input tests
- Refer to section 7.1: “Input Tests Common to all XPS Functions”.
- Checks if the brake feature is enabled: (-205)
Description
Send command to activate piston “Engaged” or “Released”.
Refer to section [PISTON] in System.ini configuration file.
Piston commands:
1. PistonCommandSignalState parameter is defined “Direct” in System.ini
• 0 = Released
• 1 = Engaged
2. PistonCommandSignalState parameter is defined “Inverted” in System.ini
• 0 = Engaged
• 1 = Released
Prototype
int SetPiston(
int SocketID,
int Command
)
Input parameters
SocketID int Socket identifier gets by the
“TCP_ConnectToServer” function.
Command int Piston command (0 or 1).
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.
629 EDH0373En1023 — 01/18