Newport MKS HXP Series User manual

HXP
Hexapod
Motion Controller
Command Interface
Manual
Intaller Pack Version #30002

HXP Command Interface Manual
©2018by Newport Corporation, Irvine, CA. All rights reserved.
Original instructions.
No part of this document may be reproduced or copied without the prior written
approval of Newport Corporation. This document is provided for information only, and
product specifications are subject to change without notice. Any change will be
reflected in future publishings.
EDH0318En1042 — 12/18 ii

HXP Command Interface Manual
Table of Contents
1.0 Introduction .................................................................................................. 1
1.1 Purpose ....................................................................................................................................1
1.2 Overview .................................................................................................................................1
1.3 Location ...................................................................................................................................1
1.4 Possible Uses of Newport. HXP.CommandInterface.dll .........................................................1
2.0 Command Interface...................................................................................... 2
2.1 Constructor ..............................................................................................................................2
2.2 Functions .................................................................................................................................2
2.2.1 OpenInstrument .............................................................................................................2
2.2.2 CloseInstrument.............................................................................................................2
2.2.3 ControllerMotionKernelTimeLoadGet ..........................................................................3
2.2.4 ElapsedTimeGet ............................................................................................................3
2.2.5 ErrorStringGet ...............................................................................................................4
2.2.6 FirmwareVersionGet .....................................................................................................4
2.2.7 TCLScriptExecute .........................................................................................................5
2.2.8 TCLScriptExecuteAndWait...........................................................................................5
2.2.9 TCLScriptKill................................................................................................................6
2.2.10 TCLScriptKillAll...........................................................................................................6
2.2.11 TimerGet........................................................................................................................7
2.2.12 TimerSet ........................................................................................................................7
2.2.13 Reboot............................................................................................................................8
2.2.14 Login..............................................................................................................................8
2.2.15 CloseAllOtherSockets....................................................................................................9
2.2.16 EventAdd .......................................................................................................................9
2.2.17 EventGet ......................................................................................................................10
2.2.18 EventRemove...............................................................................................................10
2.2.19 EventWait ....................................................................................................................11
2.2.20 EventExtendedConfigurationTriggerSet......................................................................11
2.2.21 EventExtendedConfigurationTriggerGet.....................................................................12
2.2.22 EventExtendedConfigurationActionSet.......................................................................12
2.2.23 EventExtendedConfigurationActionGet ......................................................................13
2.2.24 EventExtendedStart .....................................................................................................14
2.2.25 EventExtendedAllGet ..................................................................................................14
2.2.26 EventExtendedGet .......................................................................................................15
2.2.27 EventExtendedRemove................................................................................................15
2.2.28 EventExtendedWait .....................................................................................................16
2.2.29 GatheringConfigurationGet .........................................................................................16
iii EDH0318En1042 — 12/18

HXP Command Interface Manual
2.2.30 GatheringConfigurationSet ..........................................................................................17
2.2.31 GatheringCurrentNumberGet ......................................................................................17
2.2.32 GatheringStopAndSave ...............................................................................................18
2.2.33 GatheringDataAcquire .................................................................................................18
2.2.34 GatheringDataGet ........................................................................................................19
2.2.35 GatheringDataMultipleLinesGet..................................................................................19
2.2.36 GatheringReset ............................................................................................................20
2.2.37 GatheringRun...............................................................................................................20
2.2.38 GatheringStop ..............................................................................................................21
2.2.39 GatheringExternalConfigurationSet ............................................................................21
2.2.40 GatheringExternalConfigurationGet............................................................................22
2.2.41 GatheringExternalCurrentNumberGet.........................................................................22
2.2.42 GatheringExternalStopAndSave ..................................................................................23
2.2.43 GlobalArrayGet ...........................................................................................................23
2.2.44 GlobalArraySet............................................................................................................24
2.2.45 DoubleGlobalArrayGet................................................................................................24
2.2.46 DoubleGlobalArraySet ................................................................................................25
2.2.47 GPIOAnalogGet ..........................................................................................................25
2.2.48 GPIOAnalogSet ...........................................................................................................26
2.2.49 GPIOAnalogGainGet...................................................................................................26
2.2.50 GPIOAnalogGainSet ...................................................................................................27
2.2.51 GPIODigitalGet ...........................................................................................................27
2.2.52 GPIODigitalSet............................................................................................................28
2.2.53 GroupCorrectorOutputGet ...........................................................................................28
2.2.54 GroupHomeSearch.......................................................................................................29
2.2.55 GroupHomeSearchAndRelativeMove .........................................................................29
2.2.56 GroupReadyAtPosition................................................................................................30
2.2.57 GroupInitialize.............................................................................................................30
2.2.58 GroupInitializeWithEncoderCalibration......................................................................31
2.2.59 GroupKill.....................................................................................................................31
2.2.60 GroupMoveAbort ........................................................................................................32
2.2.61 GroupMoveAbsolute ...................................................................................................32
2.2.62 GroupMoveRelative.....................................................................................................33
2.2.63 GroupMotionDisable ...................................................................................................33
2.2.64 GroupMotionEnable ....................................................................................................34
2.2.65 GroupPositionCorrectedProfilerGet ............................................................................34
2.2.66 GroupPositionCurrentGet ............................................................................................35
2.2.67 GroupPositionSetpointGet ...........................................................................................35
2.2.68 GroupPositionTargetGet..............................................................................................36
2.2.69 GroupReferencingActionExecute ................................................................................36
2.2.70 GroupReferencingStart ................................................................................................37
2.2.71 GroupReferencingStop ................................................................................................37
2.2.72 GroupStatusGet............................................................................................................38
2.2.73 GroupStatusStringGet..................................................................................................38
EDH0318En1042 — 12/18 iv

HXP Command Interface Manual
2.2.74 KillAll..........................................................................................................................39
2.2.75 RestartApplication .......................................................................................................39
2.2.76 PositionerBacklashGet.................................................................................................40
2.2.77 PositionerBacklashSet .................................................................................................40
2.2.78 PositionerBacklashEnable ...........................................................................................41
2.2.79 PositionerBacklashDisable ..........................................................................................41
2.2.80 PositionerCorrectorNotchFiltersSet.............................................................................42
2.2.81 PositionerCorrectorNotchFiltersGet ............................................................................42
2.2.82 PositionerCorrectorPIDFFAccelerationSet..................................................................43
2.2.83 PositionerCorrectorPIDFFAccelerationGet .................................................................44
2.2.84 PositionerCorrectorPIDFFVelocitySet ........................................................................45
2.2.85 PositionerCorrectorPIDFFVelocityGet........................................................................46
2.2.86 PositionerCorrectorPIDDualFFVoltageSet..................................................................46
2.2.87 PositionerCorrectorPIDDualFFVoltageGet .................................................................47
2.2.88 PositionerCorrectorPIPositionSet ................................................................................48
2.2.89 PositionerCorrectorPIPositionGet................................................................................49
2.2.90 PositionerCorrectorTypeGet........................................................................................49
2.2.91 PositionerCurrentVelocityAccelerationFiltersSet........................................................50
2.2.92 PositionerCurrentVelocityAccelerationFiltersGet .......................................................50
2.2.93 PositionerDriverStatusGet ...........................................................................................51
2.2.94 PositionerDriverStatusStringGet..................................................................................52
2.2.95 PositionerEncoderAmplitudeValuesGet ......................................................................52
2.2.96 PositionerEncoderCalibrationParametersGet...............................................................53
2.2.97 PositionerErrorGet.......................................................................................................53
2.2.98 PositionerErrorRead.....................................................................................................54
2.2.99 PositionerErrorStringGet .............................................................................................54
2.2.100 PositionerHardwareStatusGet......................................................................................55
2.2.101 PositionerHardwareStatusStringGet ............................................................................55
2.2.102 PositionerHardInterpolatorFactorGet...........................................................................56
2.2.103 PositionerHardInterpolatorFactorSet ...........................................................................56
2.2.104 PositionerMaximumVelocityAndAccelerationGet......................................................57
2.2.105 PositionerMotionDoneGet ...........................................................................................57
2.2.106 PositionerMotionDoneSet............................................................................................58
2.2.107 PositionerSGammaExactVelocityAjustedDisplacementGet........................................59
2.2.108 PositionerSGammaParametersGet...............................................................................59
2.2.109 PositionerSGammaParametersSet................................................................................60
2.2.110 PositionerSGammaParametersDistanceGet .................................................................60
2.2.111 PositionerSGammaPreviousMotionTimesGet .............................................................61
2.2.112 PositionerStageParameterGet ......................................................................................62
2.2.113 PositionerStageParameterSet .......................................................................................62
2.2.114 PositionerUserTravelLimitsGet ...................................................................................63
2.2.115 PositionerUserTravelLimitsSet....................................................................................63
2.2.116 HexapodMoveAbsolute ...............................................................................................64
2.2.117 HexapodMoveIncremental...........................................................................................64
v EDH0318En1042 — 12/18

HXP Command Interface Manual
2.2.118 HexapodCoordinatesGet..............................................................................................65
2.2.119 HexapodCoordinateSystemSet ....................................................................................66
2.2.120 HexapodCoordinateSystemGet....................................................................................67
2.2.121 HexapodMoveIncrementalControl...............................................................................67
2.2.122 HexapodMoveIncrementalControlWithTargetVelocity...............................................68
2.2.123 HexapodMoveIncrementalControlPulseAndGatheringSet ..........................................69
2.2.124 HexapodMoveIncrementalControlLimitGet................................................................69
2.2.125 HexapodSGammaParametersDistanceGet...................................................................70
2.2.126 SingleAxisSlaveModeEnable ......................................................................................71
2.2.127 SingleAxisSlaveModeDisable .....................................................................................71
2.2.128 SingleAxisSlaveParametersSet....................................................................................72
2.2.129 SingleAxisSlaveParametersGet ...................................................................................72
2.2.130 OptionalModuleExecute ..............................................................................................73
2.2.131 OptionalModuleKill.....................................................................................................73
2.2.132 ControllerStatusGet .....................................................................................................74
2.2.133 ControllerStatusStringGet............................................................................................74
2.2.134 EEPROMCIESet..........................................................................................................75
2.2.135 EEPROMDACOffsetCIESet .......................................................................................75
2.2.136 EEPROMDriverSet......................................................................................................76
2.2.137 EEPROMINTSet .........................................................................................................76
2.2.138 CPUCoreAndBoardSupplyVoltagesGet ......................................................................77
2.2.139 CPUTemperatureAndFanSpeedGet.............................................................................77
2.2.140 RunTraceloggerProcessWithTimeSetting....................................................................78
2.2.141 RunTraceloggerProcessWithRollingBuffer .................................................................78
2.2.142 CreateQNXEvent.........................................................................................................79
2.2.143 StartEventsAcqusition .................................................................................................79
2.2.144 StopEventsAcqusition..................................................................................................80
2.2.145 EventTriggerSet ...........................................................................................................80
2.2.146 ActionListGet ..............................................................................................................81
2.2.147 ActionExtendedListGet ...............................................................................................81
2.2.148 APIExtendedListGet....................................................................................................82
2.2.149 APIListGet...................................................................................................................82
2.2.150 ErrorListGet.................................................................................................................83
2.2.151 EventListGet ................................................................................................................83
2.2.152 GatheringListGet .........................................................................................................84
2.2.153 GatheringExtendedListGet ..........................................................................................84
2.2.154 GatheringExternalListGet............................................................................................85
2.2.155 GroupStatusListGet .....................................................................................................85
2.2.156 HardwareInternalListGet .............................................................................................86
2.2.157 HardwareDriverAndStageGet......................................................................................86
2.2.158 HexapodTrajectoryListGet ..........................................................................................87
2.2.159 ObjectsListGet .............................................................................................................87
2.2.160 PositionerErrorListGet.................................................................................................88
2.2.161 PositionerHardwareStatusListGet................................................................................88
EDH0318En1042 — 12/18 vi

HXP Command Interface Manual
2.2.162 PositionerDriverStatusListGet .....................................................................................89
2.2.163 ReferencingActionListGet ...........................................................................................89
2.2.164 ReferencingSensorListGet ...........................................................................................90
2.2.165 GatheringUserDatasGet...............................................................................................90
2.2.166 ControllerMotionKernelPeriodMinMaxGet ................................................................91
2.2.167 ControllerMotionKernelPeriodMinMaxReset .............................................................91
2.2.168 TestTCP .......................................................................................................................92
2.2.169 PrepareForUpdate........................................................................................................92
3.0 Examples...................................................................................................... 94
3.1 Python Script .........................................................................................................................94
3.2 C# ..........................................................................................................................................96
3.3 LabVIEW...............................................................................................................................98
Service Form ........................................................................................................ 99
vii EDH0318En1042 — 12/18

HXP Command Interface Manual
EDH0318En1042 — 12/18 viii

HXP Command Interface Manual
1.0 Introduction
1.1 Purpose
The purpose of this document is to provide the method syntax of each command to
communicate with the HXP device exposed in assembly Newport.
HXP.CommandInterface.dll.
1.2 Overview
Command Interface DLL is a generic name that refers to a DLL used to communicate
with an instrument. Typically this DLL exposes all the commands the instrument
supports. These commands are exposed as function calls of the Command Interface
DLL.
Newport. HXP.CommandInterface.dll is the assembly used for communicating with
HXP instrument. This assembly gets installed when HXP applet is installed.
NOTE
Each function name is defined with the command code “AA”.
For each command function, refer to the HXP programmer’s manual.
1.3 Location
Newport. HXP.CommandInterface.dll is located at
C:\Program Files
(x86)\Newport\MotionControl\HXP\Bin\Newport.HXP.CommandInterface.dll
1.4 Possible Uses of Newport. HXP.CommandInterface.dll
Newport. HXP.CommandInterface.dll is used by HXP applet for communicating with
HXP instrument. The same DLL can be used as a reusable software component for
creating Python script or for creating LabVIEW VIs.
Hexapod
Motion Controller
HXP
1 EDH0318En1042 — 12/18

HXP Command Interface Manual
2.0 Command Interface
2.1 Constructor
Syntax
HXP()
Decription
The constructor is used to create an instance of the HXP device.
2.2 Functions
2.2.1 OpenInstrument
Syntax
C# prototype
int OpenInstrument (string Address, int port)
Python prototype
[Return] OpenInstrument (Address, Port)
Parameter
Input parameters
None
Output parameters
(string) Address: TCP IP address controller
(int) Port: TCP IP port
Return
(int) error code: 0 in success and -1 on failure
Description
This function is used to open the communication with the controller. A socket is created
and the TCP IP connection is established. Refer to the HXP Programmer’s manual to
get the command description.
2.2.2 CloseInstrument
Syntax
C# prototype
int CloseInstrument ()
Python prototype
[Return] CloseInstrument ()
Parameter
Input parameters
None
EDH0318En1042 — 12/18 2

HXP Command Interface Manual
Output parameters
None
Return
(int) error code: 0 in success and -1 on failure
Description
This function is used to close the communication with the controller. The current socket
is deleted and the TCP IP connection is closed.
Refer to HXP Programmer’s manual to get the command description.
2.2.3 ControllerMotionKernelTimeLoadGet
Syntax
C# prototype
int ControllerMotionKernelTimeLoadGet(out double CPUTotalLoadRatio, out double
CPUCorrectorLoadRatio, out double CPUProfilerLoadRatio, out double
CPUServitudesLoadRatio, out string errstring)
Python prototype
[CPUTotalLoadRatio, CPUCorrectorLoadRatio, CPUProfilerLoadRatio,
CPUServitudesLoadRatio, errstring] ControllerMotionKernelTimeLoadGet ()
Parameters
Input parameters
None
Output parameters
(double) CPUTotalLoadRatio: CPUTotalLoadRatio
(double) CPUCorrectorLoadRatio: CPUCorrectorLoadRatio
(double) CPUProfilerLoadRatio: CPUProfilerLoadRatio
(double) CPUServitudesLoadRatio: CPUServitudesLoadRatio
(string) errString: The failure reason
Return
(int) error code: 0 in success and -1 on failure
Description
This function is used to process synchrounous ControllerMotionKernelTimeLoadGet
command which is used to Get controller motion kernel time load. Refer to the XPS
Programmer's manual to get the command description.
2.2.4 ElapsedTimeGet
Syntax
C# prototype
int ElapsedTimeGet(out double ElapsedTime, out string errstring)
Python prototype
[ElapsedTime, errstring] ElapsedTimeGet ()
3 EDH0318En1042 — 12/18

HXP Command Interface Manual
Parameters
Input parameters
None
Output parameters
(double) ElapsedTime: ElapsedTime
(string) errString: The failure reason
Return
(int) error code: 0 in success and -1 on failure
Description
This function is used to process synchrounous ElapsedTimeGet command which is used
to Return elapsed time from controller power on. Refer to the XPS Programmer's
manual to get the command description.
2.2.5 ErrorStringGet
Syntax
C# prototype
int ErrorStringGet(Int32 ErrorCode, out string ErrorString, out string errstring)
Python prototype
[ErrorString, errstring] ErrorStringGet (ErrorCode)
Parameters
Input parameters
(Int32) ErrorCode: ErrorCode
Output parameters
(string) ErrorString: ErrorString
(string) errString: The failure reason
Return
(int) error code: 0 in success and -1 on failure
Description
This function is used to process synchrounous ErrorStringGet command which is used
to Return the error string corresponding to the error code. Refer to the XPS
Programmer's manual to get the command description.
2.2.6 FirmwareVersionGet
Syntax
C# prototype
int FirmwareVersionGet(out string Version, out string errstring)
Python prototype
[Version, errstring] FirmwareVersionGet ()
Parameters
Input parameters
None
EDH0318En1042 — 12/18 4

HXP Command Interface Manual
Output parameters
(string) Version: Version
(string) errString: The failure reason
Return
(int) error code: 0 in success and -1 on failure
Description
This function is used to process synchrounous FirmwareVersionGet command which is
used to Return firmware version. Refer to the XPS Programmer's manual to get the
command description.
2.2.7 TCLScriptExecute
Syntax
C# prototype
int TCLScriptExecute(string TCLFileName, string TaskName, string ParametersList,
out string errstring)
Python prototype
[errstring] TCLScriptExecute (TCLFileName, TaskName, ParametersList)
Parameters
Input parameters
(string) TCLFileName: TCLFileName
(string) TaskName: TaskName
(string) ParametersList: ParametersList
Output parameters
(string) errString: The failure reason
Return
(int) error code: 0 in success and -1 on failure
Description
This function is used to process synchrounous TCLScriptExecute command which is
used to Execute a TCL script from a TCL file. Refer to the XPS Programmer's manual
to get the command description.
2.2.8 TCLScriptExecuteAndWait
Syntax
C# prototype
int TCLScriptExecuteAndWait(string TCLFileName, string TaskName, string
InputParametersList, out string OutputParametersList, out string errstring)
Python prototype
[OutputParametersList, errstring] TCLScriptExecuteAndWait (TCLFileName,
TaskName, InputParametersList)
5 EDH0318En1042 — 12/18

HXP Command Interface Manual
Parameters
Input parameters
(string) TCLFileName: TCLFileName
(string) TaskName: TaskName
(string) InputParametersList: InputParametersList
Output parameters
(string) OutputParametersList: OutputParametersList
(string) errString: The failure reason
Return
(int) error code: 0 in success and -1 on failure
Description
This function is used to process synchrounous TCLScriptExecuteAndWait command
which is used to Execute a TCL script from a TCL file and wait the end of execution to
return. Refer to the XPS Programmer's manual to get the command description.
2.2.9 TCLScriptKill
Syntax
C# prototype
int TCLScriptKill(string TaskName, out string errstring)
Python prototype
[errstring] TCLScriptKill (TaskName)
Parameters
Input parameters
(string) TaskName: TaskName
Output parameters
(string) errString: The failure reason
Return
(int) error code: 0 in success and -1 on failure
Description
This function is used to process synchrounous TCLScriptKill command which is used
to Kill TCL Task. Refer to the XPS Programmer's manual to get the command
description.
2.2.10 TCLScriptKillAll
Syntax
C# prototype
int TCLScriptKillAll( out string errstring)
Python prototype
[errstring] TCLScriptKillAll ()
EDH0318En1042 — 12/18 6

HXP Command Interface Manual
Parameters
Input parameters
None
Output parameters
(string) errString: The failure reason
Return
(int) error code: 0 in success and -1 on failure
Description
This function is used to process synchrounous TCLScriptKillAll command which is
used to Kill all TCL Tasks. Refer to the XPS Programmer's manual to get the command
description.
2.2.11 TimerGet
Syntax
C# prototype
int TimerGet(string TimerName, out Int32 FrequencyTicks, out string errstring)
Python prototype
[FrequencyTicks, errstring] TimerGet (TimerName)
Parameters
Input parameters
(string) TimerName: TimerName
Output parameters
(Int32_i) FrequencyTicks: FrequencyTicks
(string) errString: The failure reason
Return
(int) error code: 0 in success and -1 on failure
Description
This function is used to process synchrounous TimerGet command which is used to
Get a timer. Refer to the XPS Programmer's manual to get the command description.
2.2.12 TimerSet
Syntax
C# prototype
int TimerSet(string TimerName, Int32 FrequencyTicks, out string errstring)
Python prototype
[errstring] TimerSet (TimerName, FrequencyTicks)
Parameters
Input parameters
(string) TimerName: TimerName
(Int32) FrequencyTicks: FrequencyTicks
7 EDH0318En1042 — 12/18

HXP Command Interface Manual
Output parameters
(string) errString: The failure reason
Return
(int) error code: 0 in success and -1 on failure
Description
This function is used to process synchrounous TimerSet command which is used to Set
a timer. Refer to the XPS Programmer's manual to get the command description.
2.2.13 Reboot
Syntax
C# prototype
int Reboot( out string errstring)
Python prototype
[errstring] Reboot ()
Parameters
Input parameters
None
Output parameters
(string) errString: The failure reason
Return
(int) error code: 0 in success and -1 on failure
Description
This function is used to process synchrounous Reboot command which is used to
Reboot the controller. Refer to the XPS Programmer's manual to get the command
description.
2.2.14 Login
Syntax
C# prototype
int Login(string Name, string Password, out string errstring)
Python prototype
[errstring] Login (Name, Password)
Parameters
Input parameters
(string) Name: Name
(string) Password: Password
Output parameters
(string) errString: The failure reason
Return
(int) error code: 0 in success and -1 on failure
EDH0318En1042 — 12/18 8

HXP Command Interface Manual
Description
This function is used to process synchrounous Login command which is used to Log in.
Refer to the XPS Programmer's manual to get the command description.
2.2.15 CloseAllOtherSockets
Syntax
C# prototype
int CloseAllOtherSockets( out string errstring)
Python prototype
[errstring] CloseAllOtherSockets ()
Parameters
Input parameters
None
Output parameters
(string) errString: The failure reason
Return
(int) error code: 0 in success and -1 on failure
Description
This function is used to process synchrounous CloseAllOtherSockets command which
is used to Close all socket beside the one used to send this command. Refer to the XPS
Programmer's manual to get the command description.
2.2.16 EventAdd
Syntax
C# prototype
int EventAdd(string PositionerName, string EventName, string EventParameter, string
ActionName, string ActionParameter1, string ActionParameter2, string
ActionParameter3, out string errstring)
Python prototype
[errstring] EventAdd (PositionerName, EventName, EventParameter, ActionName,
ActionParameter1, ActionParameter2, ActionParameter3)
Parameters
Input parameters
(string) PositionerName: PositionerName
(string) EventName: EventName
(string) EventParameter: EventParameter
(string) ActionName: ActionName
(string) ActionParameter1: ActionParameter1
(string) ActionParameter2: ActionParameter2
(string) ActionParameter3: ActionParameter3
Output parameters
(string) errString: The failure reason
9 EDH0318En1042 — 12/18

HXP Command Interface Manual
Return
(int) error code: 0 in success and -1 on failure
Description
This function is used to process synchrounous EventAdd command which is used to **
OBSOLETE ** Add an event. Refer to the XPS Programmer's manual to get the
command description.
2.2.17 EventGet
Syntax
C# prototype
int EventGet(string PositionerName, out string EventsAndActionsList, out string
errstring)
Python prototype
[EventsAndActionsList, errstring] EventGet (PositionerName)
Parameters
Input parameters
(string) PositionerName: PositionerName
Output parameters
(string) EventsAndActionsList: EventsAndActionsList
(string) errString: The failure reason
Return
(int) error code: 0 in success and -1 on failure
Description
This function is used to process synchrounous EventGet command which is used to **
OBSOLETE ** Read events and actions list. Refer to the XPS Programmer's manual to
get the command description.
2.2.18 EventRemove
Syntax
C# prototype
int EventRemove(string PositionerName, string EventName, string EventParameter,
out string errstring)
Python prototype
[errstring] EventRemove (PositionerName, EventName, EventParameter)
Parameters
Input parameters
(string) PositionerName: PositionerName
(string) EventName: EventName
(string) EventParameter: EventParameter
Output parameters
(string) errString: The failure reason
EDH0318En1042 — 12/18 10

HXP Command Interface Manual
Return
(int) error code: 0 in success and -1 on failure
Description
This function is used to process synchrounous EventRemove command which is used to
** OBSOLETE ** Delete an event. Refer to the XPS Programmer's manual to get the
command description.
2.2.19 EventWait
Syntax
C# prototype
int EventWait(string PositionerName, string EventName, string EventParameter, out
string errstring)
Python prototype
[errstring] EventWait (PositionerName, EventName, EventParameter)
Parameters
Input parameters
(string) PositionerName: PositionerName
(string) EventName: EventName
(string) EventParameter: EventParameter
Output parameters
(string) errString: The failure reason
Return
(int) error code: 0 in success and -1 on failure
Description
This function is used to process synchrounous EventWait command which is used to **
OBSOLETE ** Wait an event. Refer to the XPS Programmer's manual to get the
command description.
2.2.20 EventExtendedConfigurationTriggerSet
Syntax
C# prototype
int EventExtendedConfigurationTriggerSet(string[] ExtendedEventName, string[]
EventParameter1, string[] EventParameter2, string[] EventParameter3, string[]
EventParameter4, out string errstring)
Python prototype
[errstring] EventExtendedConfigurationTriggerSet (ExtendedEventName,
EventParameter1, EventParameter2, EventParameter3, EventParameter4)
11 EDH0318En1042 — 12/18

HXP Command Interface Manual
Parameters
Input parameters
(string[]) ExtendedEventName: ExtendedEventName
(string[]) EventParameter1: EventParameter1
(string[]) EventParameter2: EventParameter2
(string[]) EventParameter3: EventParameter3
(string[]) EventParameter4: EventParameter4
Output parameters
(string) errString: The failure reason
Return
(int) error code: 0 in success and -1 on failure
Description
This function is used to process synchrounous EventExtendedConfigurationTriggerSet
command which is used to Configure one or several events. Refer to the XPS
Programmer's manual to get the command description.
2.2.21 EventExtendedConfigurationTriggerGet
Syntax
C# prototype
int EventExtendedConfigurationTriggerGet(out string EventTriggerConfiguration, out
string errstring)
Python prototype
[EventTriggerConfiguration, errstring] EventExtendedConfigurationTriggerGet ()
Parameters
Input parameters
None
Output parameters
(string) EventTriggerConfiguration: EventTriggerConfiguration
(string) errString: The failure reason
Return
(int) error code: 0 in success and -1 on failure
Description
This function is used to process synchrounous EventExtendedConfigurationTriggerGet
command which is used to Read the event configuration. Refer to the XPS
Programmer's manual to get the command description.
2.2.22 EventExtendedConfigurationActionSet
Syntax
C# prototype
int EventExtendedConfigurationActionSet(string[] ExtendedActionName, string[]
ActionParameter1, string[] ActionParameter2, string[] ActionParameter3, string[]
ActionParameter4, out string errstring)
EDH0318En1042 — 12/18 12