CONEX-LDS - Command Interface Manual
Contents
1. ht ee 8 ee 8 PW CC m IA 8 m 9 PXcOeb 9 PA Sel 9 ladic cm M n 10 PY Sel coti dnte ddnde ett eI DEI 10 10 11 RS 11 OR ns ERE 11 GET 12 Page iii E DH0333En1020 03 13 CONEX LDS Electronic Autocollimator 3 0 Python ani ple LT Service QR Experience Solutions EDH0333En1020 03 13 Page iv CONEX LDS Electronic Autocollimator CONEX LDS Electronic Autocollimator 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 dil This 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 code2. AA For more information on each command function refer to the CONEX LDS programmer s manual D Newport Experience Solutions E DH0333En1020 03 13 Page 1 CONEX LDS Electronic Autocollimator EDH0333En1020 03 13 1 3 1 4 Location Newport CONEXLDS CommandInterface dll is located with the following path Newport MotionControl CONEX LDS Bin Newport CONEXLDS CommandlInterface dll Possible uses of Newport CONEXLDS CommandlInterface 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 Experience Solutions Page 2 CONEX LDS Electronic Autocollimator 2 0 Command Interface D Newpo 2 1 rt Experience Solutions Constructor CONEXLDS The constructor is used to create an instance of the CONEX LDS device Functions 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 de
3. CONEX LDS Electronic Autocollimator ND Command Interface NU Manual Newport Experience Solutions 1 0 For Motion Think Newport CONEX LDS Electronic Autocollimator QR Experience Solutions EDH0333En1020 03 13 Page ii CONEX LDS Electronic Autocollimator Table of Contents 1 0 1 1 1 2 1 3 1 4 IntFOQUCOI Purpose ean e 1 1 LOCATION e tati 2 Possible uses of Newport CONEXLDS Commandinterface dil 2 2 0 2 1 2 2 QW N Experience Solutions Command Interface eee eee eee CODSITUCI P I 3 EURCHONS SA iade aru 3 2 2 1 Genet l 3 e QOpenlInstr ment eii rere tret 3 Clos Instrument rere me P separ RR n 3 GetDeVICes c eo ense n INIM EH MU 3 WnteTolInstr nieht niente a ne ec e EI e ne 4 222 Commands aetna ea es US SE ERE 4 e etr tu ust e Le es 4 OP H 5 CX Geb Re ne edt ta ME LII rU 5 GX SE 5 Gy Gel De e MEA 6 6 6 ar ae 7 DEC S dias 7 LB 7
4. Syntax int SA Set int controllerAddress int Address out string errstring controllerAddress controllerA ddress 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 controller Address out int LowlevelPowerThreshold out string errstring controllerAddress controllerA ddress 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 QR Experience Solutions EDH0333En1020 03 13 Page 12 CONEX LDS Electronic Autocollimator 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 m
5. 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 controllerA ddress 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 controllerA ddress 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 QR Experience Solutions EDH0333En1020 03 13 Page 8 CONEX LDS Electronic Autocollimator PW Set Syntax int PW Set int controller Address 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 Se
6. 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 controllerA ddress 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 gt Newport EDH0333En1020 03 13 Page 14 CONEX LDS Electronic Autocollimator 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 S
7. Level errString LDS GP address if flag 1 if result 0 print Position X gt posX print Position Y gt posY print Light level gt lightLevel else print GP Error errString return result posX posY lightLevel Hk KKK RR RR KKK KK RR ck KK k ck ck ckckckck ck ck KK KR RR RR ck KKK KK kkk kk kk Procedure to get the laser status LB Command Hk KKK RR ck KR KK KK RR ck KK KK kkk kkk ck KK KR RK RK KK KK RK kk kk k k def CONEXLDS GetLaserStatus LDS address flag result laserStatus errString LDS LB Get address if flag 1 if result 0 print Laser status gt laserStatus else print LB Get Error gt errString return result laserStatus Hk KKK RRR KK KKK KR RR KK KK KK RR RRR KK KK KK RR KKK KK kk KKK KKK Procedure to set the laser status LB Command Hk KKK KR RK KKK KK RR RK KR KKK KR RRR KKK KK KR KKK def CONEXLDS SetLaserStatus LDS address laserStatus flag result errString LDS LB Set address laserStatus if flag 1 if result 0 print LB Set Error errString return result dE coe e e he e e e e e e e e he he e e e ke cse ke e he he he he e cec ck ke e he he he e ecc ke ke e e e e e amp Main Initialization instrument COM19 displayFlag 1 address 1 Create a CONEX LDS interface and open communication LDS CONEXLD
8. S Open instrument Get controller revision information result version CONEXLDS GetControllerVersion LDS address displayFlag Get laser status result iLaserStatus CONEXLDS GetLaserStatus LDS address displayFlag if result 0 If the laser is OFF then turn the laser ON gt Newport EDH0333En1020 03 13 Page 18 ic CONEX LDS Electronic Autocollimator Check and refresh the laser status if iLaserStatus OFF print Laser is OFF result CONEXLDS SetLaserStatus LDS address ON displayFlag result iLaserStatus CONEXLDS GetLaserStatus LDS address displayFlag Get positions if iLaserStatus ON print Laser is ON Get X Y positions and light level returnValue positionX positionY lightLevel CONEXLDS GetPositionsAndLightLevel LDS address displayFlag close communication CONEXLDS Close LDS print End of script gt Newport Page 19 DH0333En1020 03 13 CONEX LDS Electronic Autocollimator QR Experience Solutions EDH0333En1020 03 13 Page 20 CONEX LDS Electronic Autocollimator Service Form Your Local Representative Tel Fax Name Return authorization Please obtain prior to return of item Address Date Country Phone Number P O Number Fax Number Item s Being Returned Serial Description Reasons of return of goods plea
9. al for more information on this command gt Newport EDH0333En1020 03 13 Page 16 CONEX LDS Electronic Autocollimator 3 0 Python example Newport Proprietary and Confidential Newport Corporation 2012 No part of this file in any format with or without modification shall be used copied or distributed without the express written consent of Newport Corporation Description This is a Python Script to access CONEX LDS library Initialization Start The script within Initialization Start and Initialization End is needed for properly initializing Command Interface for Conex LDS instrument The user should copy this code as is and specify correct paths here import sys Command Interface DLL can be found here print Adding location of Newport CONEXLDS CommandInterface dll to SyS path sys path append r C Program Files Newport MotionControl CONEX LDS Bin The CLR module provide functions for interacting with the underlying NET runtime import clr Add reference to assembly and import names from namespace clr AddReferenceToFile Newport CONEXLDS CommandInterface d1ll from CommandInterfaceConexLDS import import System Constant ON 1 OFF 0 PRK KKK KK RR RK KKK KR kkk kkk kk kk k KK ck ckckckckckck ck ck ck KK k k k kk k k Procedure to open communication with instrument PRK KKK KK RK KKK KKK KK RR KK KK kkk kk c
10. cess 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 controller Address 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 D Newport Experience Solutions Page 11 E DH0333En1020 03 13 CONEX LDS Electronic Autocollimator 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
11. ess 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 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 D Newport Experience Solutions Page 7 E DH0333En1020 03 13 CONEX LDS Electronic Autocollimator LF Get Syntax int LF Get int controller Address out float Frequency out string errstring controllerAddress controllerA ddress Frequency Frequency errString The failure reason return 0 in success and 1 on failure Description This function is used to process
12. itionX 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 controller Address out double GainX out string errstring controller Address controller Address 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 controller Address double GainX out string errstring controller Address controller Address 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 gt Newport Page 5 E DH0333En1020 03 13 CONEX LDS Electronic Autocollimator GY _ Get Syntax int GY_Get int controller Address out double GainY out string errstring controllerAddress controllerAddress GainY GainY errString The failure reason retu
13. k ck ck kk kk kk kk KKK KK k kk k k def CONEXLDS Open instrumentKey Create a CONEX LDS instance LDS ConexLDS print Instrument Key gt instrumentKey ret LDS OpenInstrument instrumentKey print OpenInstrument gt ret return LDS PKK K KKK KR ck kk ke KK KR RR RK ck ck k ck kk kk ck ck k kk kkk k ck ck ck KK KK k kk k k Procedure to close communication PK KK KK KK RR RK KK ck kk kk k k ck ck ck ck ck k k k ck ck ck k k k k k k k ck ck ck KK k k k k k k def CONEXLDS Close LDS LDS CloseInstrument PRK KKK ke cec ke ck KKK KK KR KKK ck ck ck ck ckckckck ck KKK KKK kk KKK kkk kkk k k Procedure to get the controller version VE PRK KKK KKK KR KKK KK KK RRR KKK KK KR RK KK ck kckckckckck ck ck ck KK KKK KEK def CONEXLDS GetControllerVersion LDS address flag D Newport Experience Solutions Page 17 E DH0333En1020 03 13 CONEX LDS Electronic Autocollimator result version errString LDS VE address if flag 1 if result 0 print CONEX LDS firmware version gt version else print VE Error gt errString return result version Hk KKK KR RRR KK KK KR RR ck KK KK KR RR KK KK KK RR RK KK KK KK KK KKK Procedure to get the laser status GP Command Pk KKK RR RR KKK KK RR KK KK KK ck RK KK KKK RR RK KK KK RK kk kk k k def CONEXLDS GetPositionsAndLightLevel LDS address flag Get X Y positions and light level Using GP Command result posX light
14. ore 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 D Newport Experience Solutions Page 13 E DH0333En1020 03 13 CONEX LDS Electronic Autocollimator 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
15. rn 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 controllerA ddress 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 controllerA ddress 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 QR Experience Solutions EDH0333En1020 03 13 Page 6 CONEX LDS Electronic Autocollimator ID_Set Syntax int ID_Set int controllerAddress string ControllerIdentifier out string errstring controllerAddress controllerAddress ControllerIdentifier ControllerIdentifier errString The failure reason return 0 in succ
16. se list any specific problems Page 21 E DH0333En1020 03 13 Newport Experience Solutions Visit Newport Online at Www newport com North America amp Asia Newport Corporation 1791 Deere Ave Irvine CA 92606 USA Sales Tel 800 222 6440 e mail sales newport com Technical Support Tel 800 222 6440 e mail tech newport com Service RMAs amp Returns Tel 800 222 6440 e mail rma service newport com Europe MICRO CONTROLE Spectra Physics S A S 9 rue du Bois Sauvage 91055 Evry CEDEX France Sales Tel 33 0 1 60 91 68 68 e mail france newport fr com Technical Support e mail tech_europe newport com Service amp Returns Tel 33 0 2 38 40 51 55
17. t 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 D Newport Cons Stine Page 9 DH0333En1020 03 13 CONEX LDS Electronic Autocollimator 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 fail
18. ure 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 CH Experience Solutions EDH0333En1020 03 13 Page 10 CONEX LDS Electronic Autocollimator 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 pro
19. vice 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 Page 3 E DH0333En1020 03 13 CONEX LDS Electronic Autocollimator EDH0333En1020 03 13 2 2 2 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 Commands CD Syntax int CD int controllerAddress out string FactoryCalibrationInformation out string errstring controllerAddress ddress 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 D Newport Experience Solutions Page 4 CONEX LDS Electronic Autocollimator GP Syntax int GP int controllerAddress out double PositionX out double PositionY out double LaserPower out string errstring controllerAddress controllerAddress PositionX Pos
20. yntax 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 gt Newport Page 15 E DH0333En1020 03 13 CONEX LDS Electronic Autocollimator ZT Syntax int ZT int controllerAddress out List lt string gt ConfigurationParameters out string errstring controller Address controller Address 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 Manu
Download Pdf Manuals
Related Search