Newport CONEX-LDS User manual

CONEX-LDS
Electronic
Autocollimator
Command Interface
Manual
V1
.0.x

CONEX-LDS 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.
EDH0333En1022 — 12/18 ii

CONEX-LDS Command Interface Manual
Table of Contents
1.0 Introduction .................................................................................................. 1
1.1 Purpose ....................................................................................................................................1
1.2 Overview .................................................................................................................................1
1.3 Location ...................................................................................................................................2
1.4 Possible uses of Newport.CONEXLDS.CommandInterface.dll..............................................2
2.0 Command Interface...................................................................................... 3
2.1 Constructor ..............................................................................................................................3
2.2 Functions .................................................................................................................................3
2.2.1 General ......................................................................................................................3
•OpenInstrument.................................................................................................... 3
•CloseInstrument ................................................................................................... 3
•GetDevices ........................................................................................................... 3
•WriteToInstrument ............................................................................................... 4
2.2.2 Commands.................................................................................................................4
CD ........................................................................................................................ 4
GP......................................................................................................................... 5
GX_Get ................................................................................................................ 5
GX_Set................................................................................................................. 5
GY_Get ................................................................................................................ 6
GY_Set................................................................................................................. 6
ID_Get.................................................................................................................. 6
ID_Set .................................................................................................................. 7
LB_Get................................................................................................................. 7
LB_Set.................................................................................................................. 7
LF_Get ................................................................................................................. 8
LF_Set .................................................................................................................. 8
PW_Get ................................................................................................................ 8
PW_Set................................................................................................................. 9
PX_Get................................................................................................................. 9
PX_Set.................................................................................................................. 9
PY_Get................................................................................................................10
PY_Set.................................................................................................................10
RG_Get ...............................................................................................................10
RG_Set ................................................................................................................11
RS........................................................................................................................11
RS485..................................................................................................................11
SA_Get................................................................................................................12
iii EDH0333En1022 — 12/18

CONEX-LDS Command Interface Manual
SA_Set.................................................................................................................12
SL_Get ................................................................................................................12
SL_Set .................................................................................................................13
SR_Get ................................................................................................................13
SR_Set.................................................................................................................13
SU_Get................................................................................................................14
SU_Set.................................................................................................................14
TB........................................................................................................................14
TE........................................................................................................................15
TS........................................................................................................................15
VE .......................................................................................................................15
ZT........................................................................................................................16
3.0 Python example........................................................................................... 17
Service Form ........................................................................................................ 21
EDH0333En1022 — 12/18 iv

CONEX-LDS 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 CONEX-LDS autocollimator exposed
in assembly Newport.CONEXLDS.CommandInterface.dll. This .Net
assembly is designed and developed by Newport. This DLL is used by
CONEX-LDS applet to communicate with the CONEX-LDS
autocollimator.
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.CONEXLDS.CommandInterface.dll is the assembly used for
communicating with the CONEX-LDS autocollimator. This assembly is
installed with the CONEX-LDS applet.
NOTES
Each function name is defined with the command code “AA”.
For more information on each command function, refer to the CONEX-LDS
programmer’s manual.
Electronic Autocollimator
CONEX
-LDS
1 EDH0333En1022 — 12/18

CONEX-LDS Command Interface Manual
1.3 Location
Newport.CONEXLDS.CommandInterface.dll is located with the
following path: \Newport\MotionControl\CONEX-
LDS\Bin\Newport.CONEXLDS.CommandInterface.dll
1.4 Possible uses of Newport.CONEXLDS.CommandInterface.dll
Newport.CONEXLDS.CommandInterface.dll is used by CONEX-LDS
applet for communicating with the CONEX-LDS autocollimator. The
same DLL can be used as a reusable software component for creating
Python scripts or LabVIEW VIs.
EDH0333En1022 — 12/18 2

CONEX-LDS Command Interface Manual
2.0 Command Interface
2.1 Constructor
CONEXLDS()
The constructor is used to create an instance of the CONEX-LDS device.
2.2 Functions
2.2.1 General
• OpenInstrument
Syntax
int OpenInstrument(string strDeviceKey)
string strDeviceKey: the device key is a serial COM port
return: 0 = successful or -1 = failure
Decription
This function allows opening communication with the selected device. If the opening
failed, the returned code is -1.
• CloseInstrument
Syntax
int CloseInstrument()
return: 0 = successful or -1 = failure
Decription
This function allows closing communication with the selected device. If the closing
failed, the returned code is -1.
• GetDevices
Syntax
string[] GetDevices()
return: list of strings that contains the accessible COM ports
Decription
This function returns the list of connected devices available to communicate.
3 EDH0333En1022 — 12/18

CONEX-LDS Command Interface Manual
• WriteToInstrument
Syntax
int WriteToInstrument(string command, ref string resp, int stage)
command: Instrument command
resp: Response of the command
stage: Instrument Stage
return: function error
Decription
This Overridden function Queries or writes the command issued by the user to the
instrument.
2.2.2 Commands
CD
Syntax
int CD(int controllerAddress, out string FactoryCalibrationInformation, out string
errstring)
controllerAddress: controllerAddress
FactoryCalibrationInformation: FactoryCalibrationInformation
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous CD Get command which is used to Get
factory calibration information. Refer to the Controller's User’s Manual for further
information..
EDH0333En1022 — 12/18 4

CONEX-LDS Command Interface Manual
GP
Syntax
int GP(int controllerAddress, out double PositionX, out double PositionY, out double
LaserPower, out string errstring)
controllerAddress: controllerAddress
PositionX: PositionX
PositionY: PositionY
LaserPower: LaserPower
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous GP Get command, which is used to Get
positions and power. Refer to the CONEX-LDS User’s Manual for more detailed
information on the command..
GX_Get
Syntax
int GX_Get(int controllerAddress, out double GainX, out string errstring)
controllerAddress: controllerAddress
GainX: GainX
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous GX Get command which is used to Get
gain for analog image of X channel. Refer to the CONEX-LDS User’s Manual for
more information on this command
GX_Set
Syntax
int GX_Set(int controllerAddress, double GainX, out string errstring)
controllerAddress: controllerAddress
GainX: GainX
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous GX Set command which is used to Set
gain for analog image of X channel. Refer to the CONEX-LDS User’s Manual for
more information on this command
5 EDH0333En1022 — 12/18

CONEX-LDS Command Interface Manual
GY_Get
Syntax
int GY_Get(int controllerAddress, out double GainY, out string errstring)
controllerAddress: controllerAddress
GainY: GainY
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous GY Get command which is used to Get
gain for analog image of Y channel. Refer to the CONEX-LDS User’s Manual for
more information on this command
GY_Set
Syntax
int GY_Set(int controllerAddress, double GainY, out string errstring)
controllerAddress: controllerAddress
GainY: GainY
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous GY Set command which is used to Set
gain for analog image of Y channel. Refer to the CONEX-LDS User’s Manual for
more information on this command
ID_Get
Syntax
int ID_Get(int controllerAddress, out string ControllerIdentifier, out string errstring)
controllerAddress: controllerAddress
ControllerIdentifier: ControllerIdentifier
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous ID Get command which is used to Get
controller identifier. Refer to the CONEX-LDS User’s Manual for more information
on this command
EDH0333En1022 — 12/18 6

CONEX-LDS Command Interface Manual
ID_Set
Syntax
int ID_Set(int controllerAddress, string ControllerIdentifier, out string errstring)
controllerAddress: controllerAddress
ControllerIdentifier: ControllerIdentifier
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous ID Set command which is used to Set
controller identifier. Refer to the CONEX-LDS User’s Manual for more information
on this command
LB_Get
Syntax
int LB_Get(int controllerAddress, out int LaserState, out string errstring)
controllerAddress: controllerAddress
LaserState: LaserState
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous LB Get command which is used to
Power ON/ Power OFF the laser. Refer to the CONEX-LDS User’s Manual for more
information on this command
LB_Set
Syntax
int LB_Set(int controllerAddress, int LaserState, out string errstring)
controllerAddress: controllerAddress
LaserState: LaserState
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous LB Set command which is used to
Power ON/ Power OFF the laser. Refer to the CONEX-LDS User’s Manual for more
information on this command
7 EDH0333En1022 — 12/18

CONEX-LDS Command Interface Manual
LF_Get
Syntax
int LF_Get(int controllerAddress, out float Frequency, out string errstring)
controllerAddress: controllerAddress
Frequency: Frequency
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous LF Get command which is used to Get
the low pass filter frequency. Refer to the CONEX-LDS User’s Manual for more
information on this command
LF_Set
Syntax
int LF_Set(int controllerAddress, float Frequency, out string errstring)
controllerAddress: controllerAddress
Frequency: Frequency
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous LF Set command which is used to Set
the low pass filter frequency. Refer to the CONEX-LDS User’s Manual for more
information on this command
PW_Get
Syntax
int PW_Get(int controllerAddress, out int ConfigurationState, out string errstring)
controllerAddress: controllerAddress
ConfigurationState: ConfigurationState
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous PW Get command which is used to
Enter/Leave the CONFIGURATION state. Refer to the CONEX-LDS User’s Manual
for more information on this command
EDH0333En1022 — 12/18 8

CONEX-LDS Command Interface Manual
PW_Set
Syntax
int PW_Set(int controllerAddress, int ConfigurationState, out string errstring)
controllerAddress: controllerAddress
ConfigurationState: ConfigurationState
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous PW Set command which is used to
Enter/Leave the CONFIGURATION state. Refer to the CONEX-LDS User’s Manual
for more information on this command
PX_Get
Syntax
int PX_Get(int controllerAddress, out double CalibrationCoefficientX, out string
errstring)
controllerAddress: controllerAddress
CalibrationCoefficientX: CalibrationCoefficientX
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous PX Get command which is used to Get
the calibration value for X channel. Refer to the CONEX-LDS User’s Manual for
more information on this command
PX_Set
Syntax
int PX_Set(int controllerAddress, double CalibrationCoefficientX, out string errstring)
controllerAddress: controllerAddress
CalibrationCoefficientX: CalibrationCoefficientX
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous PX Set command which is used to Set
the calibration value for X channel. Refer to the CONEX-LDS User’s Manual for
more information on this command
9 EDH0333En1022 — 12/18

CONEX-LDS Command Interface Manual
PY_Get
Syntax
int PY_Get(int controllerAddress, out double CalibrationCoefficientY, out string
errstring)
controllerAddress: controllerAddress
CalibrationCoefficientY: CalibrationCoefficientY
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous PY Get command which is used to Get
the calibration value for Y channel. Refer to the CONEX-LDS User’s Manual for
more information on this command
PY_Set
Syntax
int PY_Set(int controllerAddress, double CalibrationCoefficientY, out string errstring)
controllerAddress: controllerAddress
CalibrationCoefficientY: CalibrationCoefficientY
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous PY Set command which is used to Set
the calibration value for Y channel. Refer to the CONEX-LDS User’s Manual for
more information on this command
RG_Get
Syntax
int RG_Get(int controllerAddress, out int Range, out string errstring)
controllerAddress: controllerAddress
Range: Range
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous RG Get command which is used to Get
the range value. Refer to the CONEX-LDS User’s Manual for more information on
this command
EDH0333En1022 — 12/18 10

CONEX-LDS Command Interface Manual
RG_Set
Syntax
int RG_Set(int controllerAddress, int Range, out string errstring)
controllerAddress: controllerAddress
Range: Range
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous RG Set command which is used to Set
the range value. Refer to the CONEX-LDS User’s Manual for more information on
this command
RS
Syntax
int RS(int controllerAddress, out string errstring)
controllerAddress: controllerAddress
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous RS Set command which is used to
Reset the controller. Refer to the CONEX-LDS User’s Manual for more information
on this command
RS485
Syntax
int RS485(int controllerAddress, out string errstring)
controllerAddress: controllerAddress
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous RS## Set command which is used to
Reset the controller’s address to 1. Refer to the CONEX-LDS User’s Manual for more
information on this command
11 EDH0333En1022 — 12/18

CONEX-LDS Command Interface Manual
SA_Get
Syntax
int SA_Get(int controllerAddress, out int Address, out string errstring)
controllerAddress: controllerAddress
Address: Address
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous SA Get command which is used to Get
the controller’s RS-485 address. Refer to the CONEX-LDS User’s Manual for more
information on this command
SA_Set
Syntax
int SA_Set(int controllerAddress, int Address, out string errstring)
controllerAddress: controllerAddress
Address: Address
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous SA Set command which is used to Set
the controller’s RS-485 address. Refer to the CONEX-LDS User’s Manual for more
information on this command
SL_Get
Syntax
int SL_Get(int controllerAddress, out int LowlevelPowerThreshold, out string
errstring)
controllerAddress: controllerAddress
LowlevelPowerThreshold: LowlevelPowerThreshold
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous SL Get command which is used to Get
low level power threshold for valid measurements. Refer to the CONEX-LDS User’s
Manual for more information on this command
EDH0333En1022 — 12/18 12

CONEX-LDS Command Interface Manual
SL_Set
Syntax
int SL_Set(int controllerAddress, int LowlevelPowerThreshold, out string errstring)
controllerAddress: controllerAddress
LowlevelPowerThreshold: LowlevelPowerThreshold
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous SL Set command which is used to Set
low level power threshold for valid measurements. Refer to the CONEX-LDS User’s
Manual for more information on this command
SR_Get
Syntax
int SR_Get(int controllerAddress, out int HighlevelPowerThreshold, out string
errstring)
controllerAddress: controllerAddress
HighlevelPowerThreshold: HighlevelPowerThreshold
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous SR Get command which is used to Get
high level power threshold for valid measurements. Refer to the CONEX-LDS User’s
Manual for more information on this command
SR_Set
Syntax
int SR_Set(int controllerAddress, int HighlevelPowerThreshold, out string errstring)
controllerAddress: controllerAddress
HighlevelPowerThreshold: HighlevelPowerThreshold
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous SR Set command which is used to Set
high level power threshold for valid measurements. Refer to the CONEX-LDS User’
s Manual for more information on this command
13 EDH0333En1022 — 12/18

CONEX-LDS Command Interface Manual
SU_Get
Syntax
int SU_Get(int controllerAddress, out string Units, out string errstring)
controllerAddress: controllerAddress
Units: Units
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous SU Get command to set the the
measurement units. Refer to the CONEX-LDS User’s Manual for more information
on this command
SU_Set
Syntax
int SU_Set(int controllerAddress, string Units, out string errstring)
controllerAddress: controllerAddress
Units: Units
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous SU Set command to set the the
measurement units. Refer to the CONEX-LDS User’s Manual for more information
on this command
TB
Syntax
int TB(int controllerAddress, string inError, out string outError, out string errString)
controllerAddress: Address of Controller
inError: inError.
outError: outError
errString: The failure reason
return: 0 in success and -1 on failure
Decription
This function is used to process synchrounous TB Get command which explains the
meaning of the error string. Refer to the CONEX-LDS Controller’s manual to get the
command description.
EDH0333En1022 — 12/18 14

CONEX-LDS Command Interface Manual
TE
Syntax
int TE(int controllerAddress, out string LastCommandError, out string errstring)
controllerAddress: controllerAddress
LastCommandError: LastCommandError
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous TE Get command which is used to Get
the last command error. Refer to the CONEX-LDS User’s Manual for more
information on this command
TS
Syntax
int TS(int controllerAddress, out string ErrorCode, out string StatusCode, out string
errstring)
controllerAddress: controllerAddress
ErrorCode: ErrorCode
StatusCode: StatusCode
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous TS Get command which is used to Get
the positioner error and current controller state. Refer to the CONEX-LDS User’s
Manual for more information on this command
VE
Syntax
int VE(int controllerAddress, out string ControllerVersion, out string errstring)
controllerAddress: controllerAddress
ControllerVersion: ControllerVersion
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous VE Get command which is used to Get
controller revision information. Refer to the CONEX-LDS User’s Manual for more
information on this command
15 EDH0333En1022 — 12/18

CONEX-LDS Command Interface Manual
ZT
Syntax
int ZT(int controllerAddress, out List<string> ConfigurationParameters, out string
errstring)
controllerAddress: controllerAddress
ConfigurationParameters: ConfigurationParameters
errString: The failure reason
return: 0 in success and -1 on failure
Description
This function is used to process synchrounous ZT Get command which is used to Get
all controller parameters. Refer to the CONEX-LDS User’s Manual for more
information on this command
EDH0333En1022 — 12/18 16