Newport CONEX-LDS Command Interface Manual

CONEX-LDS
Electronic
Manual
.0.x
Autocollimator
V1
CONEX-LDS Command Interface Manual
©2018 by 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
Electronic Autocollimator CONEX
-LDS

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
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.
exposed

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.
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.
NOTES
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
Loading...
+ 18 hidden pages