UG01 USB to GPIB Controller USER`S MANUAL
Contents
1. 0 Otherwise the return value is 1 The function can be used to check if the UG01 is plugged into USB socket of a PC If not plugged return value is 1 otherwise UGO1 will return the firmware version Function J Suppress all warning messages int Setwarningmessage bool setwm The function is to set not to display warning messages or other messages in all functions The variable setwm in the function is Boolean type If setwm is true or 1 all messages in the functions will be displayed when necessary Otherwise all messages will be suppressed The default value of the messages display is true The function should be called before other functions Function I and Function J are for software developers or product developers who would like to integrate UG01 into their products or into their projects 2 3 UGO01 API stdcall UGO01 API stdcall is comprised of header file LQUGO1_s h static library LOUGOI s lib and dynamic link library LQUGOI s dll The files are installed in the folder of C Program Files LQElectronics UGOI UGOIAPI for 32bit Windows OS or C Program Files x86 LQElectronics UGOI UGO1API for 64bit Windows OS The static library and dynamic library are written of Visual Studio 2005 C and can be called by user s programs in any languages at Windows OS such as VB VBA or C C It is very convenient to call the functions in the libraries UG01 API stdcall functions Function A Write GPIB command to specific equipment2. Int _stdcall Gwrite int address char scpi The input variables of the function are integer address and character pointer scpi where store the GPIB address of specific equipment and GPIB command respectively The return value should be 0 if function is successful Otherwise the return value is 1 Function B Read data or test result from equipment char _stdcall Gread int address The input variable is integer address which stores the address of the equipment you want to read after you wrote query command to the equipment The return value is the character pointer of the data ASCII LQ Electronics Corp Page 10 of 14 UGO01 USB GPIB Controller User s Manual characters read back if it is successful otherwise return decimal 10 Hex OxA The maximum length of the ASCII characters read back is 20000 If first character returned is Linefeed OxA maybe USB or GPIB equipment is not connected or GPIB address error Function C Write binary data or binary file to specific equipment int _stdcall Gbwrite int address bool mode unsigned char bdata int writelength There are four input variables First variable is integer address which stores the address of the equipment you want to write Second variable is Boolean type mode which stores the binary data sending mode If mode is true or 1 the binary data or file will be sent in Definite Length format Otherwise the binary data will be sent in Indefinite Length format Whic
3. Address 20 is attached Data query Command IDN has been sent to GPIB address 10 The Data read from Equipment of GPIB address 10 is HEWLETT PACKARD 344014 0 11 5 2 IU ELECFRON CS CORP Copyright 2014 Fig 1 UGO1 Control Panel 2 1 1 Functions of each item Fig 2 illustrates the items which are shown in the Fig 1 LQ Electronics Corp Page 5 of 14 UGO01 USB GPIB Controller User s Manual The functions of each item is explained as below 1 Button Find Click this button to find all the GPIB interface equipment connected on the GPIB bus 2 GPIB address window for GPIB equipment initialization Input GPIB address or click the GPIB address shown in item 12 for the equipment you want to initialize see item 14 3 GPIB address window for GPIB equipment communication Input GPIB address or click the GPIB address shown in item 12 for the equipment you want to connect to 4 GPIB command window Input GPIB command you want to send to specific equipment 5 Browse button Click this button to find a specific GPIB script for loading 6 GPIB script file path and file name window After clicking Browse button the GPIB script file path and name for loading will be shown in the window 7 Information window All information will be shown in this window 8 Load button Click the button to load GPIB script The GPIB script will be loaded and run after the button clicked 9 Data read button Read test result or data from a
4. UG download html When you start to install the UGO1 USB to GPIB Controller follow the steps below 1 Plug the UGO1 USB to GPIB Controller to a computer ignore all reminders of the computer Insert the CDR to DVD CD drive double click the file of UGO1_v _setup exe 3 Follow the instruction appeared on the screen of your monitor the software will be installed automatically We strongly recommend you plug UG01 USB to GPIB controller to the computer before install UG01 Software to avoid window assigns wrong USB driver 4 2 Starting the Application The application of UGO1 GUI is installed into the startup program menu at LQElectronics UGOI Just click it the UGO1 GUI will start up LQ Electronics Corp Tel 408 836 8112 Email sales 9 lgelectronics com http www lgelectronics com March 27 2015 LQ Electronics Corp Page 14 of 14
5. UGO01 USB GPIB Controller User s Manual UGO1 USB to GPIB Controller USER S MANUAL LQ Electronics Corp Page 1 of 14 UGO01 USB GPIB Controller User s Manual UG01 USB to GPIB Controller USER S MANUAL TABLE OF CONTENTS Page 1 0 GENERAL INFORMATION ete eset etin tener adeb eg eepo en oee entop eee tke ehh egeret eer aoas ieS ane ove 3 1 1 UG01 USB to GPIB Controller and UG01 Software Overview eeeeeceee 3 1 2 Authorized Use PermissiOn 4 eere eene eese essen eese ssassn snae tastes ene rsss oinei sesso seta stas ss 4 1 3 Points of Contact eere eee e eese eene eene entes eta sta tosta sesso seta Sas os natos eta AE Sosas STESS Esei ESNE Sasss 4 1 3 1 IMPOLIMAL ON 6 eec ette reete eret c Re Pe et e beta lates Re Pep oet ete be cu Re Re PERDE 4 2 0 UGOL SOETWARE nett te ree pir teet e een ri rre Eth ue TEE 5 2 1 GOL GUT rt 5 2 1 1 Functions ot Each temi Gn biet eret ett tern be dte Hero t deri odd 5 24 2 Using UGOIT Control Panel uico erre Eee ende estre PER en e e ren 6 2 1 3 GPIB Script hene ete de eie EAN E EAEE E often d tutae 7 22 UG01 API cdecl cesse E esee etes AE E sesso aeta sees E E 8 2 3 UG01 API Exin 10 2 4 Visual Basic VB and Visual Basic Application VBA Modules eeeeeee 12 2 5 UG01 API vs Lab View 13 3 0 U GOT HARDWARE eter a a
6. dress 10 is attached Equipment with GPIB Address 20 is attached Data query Command IDN has been sent to GPIB address 10 The Data read from Equipment of GPIB address 10 is HEWLETT PACKARD 344014 0 11 5 2 7 Lg ELECTRONICS CORP Copyright 2014 Fig 2 Items appeared on UGO1 Control Panel 2 1 3 GPIB script The GPIB script is for the convenience of the people who is not familiar with program languages The script is a text file which stores the GPIB equipment address and the GPIB command which can be obtained from user manual of most equipment Just follow the defined format a person who doesn t LQ Electronics Corp Page 7 of 14 UGO01 USB GPIB Controller User s Manual know program languages can realize remote control of GPIB equipment and get the data from the equipment The script format is very simple First letter of a line should be a or A means following is GPIB address after the letter After the GPIB address is dash for isolating the address and GPIB command After dash there is GPIB command to be sent If the command to be sent is a command for query command contains the data or result read will be saved to result txt Where is the name of this script If a line is started by this line will be treated as comment and will not be executed The script sample is at folder C Program Files LQElectronics UGO1 UGO01API Samplefiles GPIBscript for 32bit Windows OS For 64bit Windows OS it
7. e CSV file trace status file sta or other file type unknown Set variable mode to be false or O for reading a text file Third is a character pointer filename which is stores the name and path of the file to be saved on the local PC This name can be the same or different with file name on the GPIB equipment Function G Find the addresses of the GPIB equipment connected on the GPIB bus Int Gfind void There is no variable in Function G The return value is integer pointer for the addresses of the GPIB equipment connected on the GPIB bus after Function G is called Function H Query function This function is simply combined of Gwrite and Gread Char Gquery int address char scpi LQ Electronics Corp Page 9 of 14 UGO01 USB GPIB Controller User s Manual The function is a read after write function After it wrote GPIB command to the GPIB equipment it read the result back The variable of integer address stores the address of the GPIB equipment The variable of character pointer scpi stores the GPIB command The return value is the character pointer of the data read back ASCII characters if the function is successful otherwise return decimal 10 Hex OxA The maximum length of the ASCII characters read back is 20000 Function I Function to get Firmware version Double GetF WVersion void The function has no variable The return value is a double value as if the function is successful such as 1 0 for Firmware version 1
8. eaa a aa Eiaa easa 13 4 0 GETTING STARTED 1 ree nein to aet se eek Pe rae eU no ehe sa edbecatelevedtondenseedee 14 4 1 Inst lling UGO Softwa ce 14 4 2 Starting the Application sesesssesosssesocsseeoossessossoseossocssesocssessosseseossossossosssesoossessossesesssossossose 14 LQ Electronics Corp Page 2 of 14 UGO01 USB GPIB Controller User s Manual 1 0 GENERAL INFORMATION 1 1 UG01 USB to GPIB Controller and Software Overview UGO01 USB to GPIB Controller is powerful friendly and low cost GPIB controller It is very easy for use The software includes ASCII format command data transfer functions and binary data file transfer functions between PC and GPIB equipment We already compact everything you need for driving the equipment with GPIB interface Therefore you can eliminate the complicated VISA library The software for UGO1 USB to GPIB Controller is UGO1 Software which includes three main elements 1 One is the UGO0I control panel UGO1 exe which is user friendly Graphic User Interface GUI User can control GPIB interface equipment by inputting GPIB command and read data or test result from the GPIB equipment by just clicking the Data read button after you sent GPIB query command 2 Second is Application Programmable Interface API for cdecl calling convention which includes static library LQUGO1_c lib and dynamic link library LQUGOI c dll Users can write your own programs to realize remote control of t
9. equipment after you sent query command 10 GPIB address window for Capture Screen button Input GPIB address or click the GPIB address shown in item 12 for the Capture Screen button 11 Capture Screen Button Click the button to capture the screen image for the equipment of GPIB address shown in item 10 12 Display GPIB addresses for the equipment connected on the GPIB bus All the GPIB addresses of the equipment connected on the GPIB bus are displayed here after clicking Find button or when control panel is launched 13 GPIB command write button Writing GPIB command to specific equipment GPIB address is shown in GPIB address window 14 Initialize button Click the button to initialize specific GPIB equipment 2 1 2 Using UG01 Control Panel Using the UGO1 Control Panel e Find equipment connected on the GPIB bus By clicking Find button the GPIB addresses of the equipment will be shown at item 12 Click a GPIB address at item 12 the address will be shown in item 2 item 3 and item 10 so as to avoid input GPIB address at GPIB address window item 2 item 3 and item 10 e Initialize a GPIB equipment for IEEE488 2 only Click the button to initialize specific GPIB equipment Clicking the button will send a GPIB common command RST to the GPIB equipment which address is shown in item 2 e Write GPIB command to equipment Input or click the GPIB address at item 12 and input GPIB command at item 4 then click Command W
10. h binary read function Gbread or Gfilesave to realize a screen image capture See sample program of UGO1 dll VC or UGOI dll Excel LQ Electronics Corp Page 3 of 14 UGO01 USB GPIB Controller User s Manual 1 2 Authorized Use Permission Usage of this software is limited to its owner via the terms of its development UGO1 Software is wholly owned by LQ Electronics Corp and may not be used or referenced without their express consent 1 3 Points of Contact 1 3 4 Information For additional information please email sales gelectronics com LQ Electronics Corp Page 4 of 14 UGO01 USB GPIB Controller User s Manual 2 0 UG01 SOFTWARE 2 1 UG01 GUI UGO01 GUI UG01 exe is installed in the folder of C Program Files LQElectronics UGO1 UGO1GUI for 32bit Windows OS or in the folder of C Program Files x86 LQElectroncis UGO1I UGO1GUI for 64bit Windows OS It is a user friendly GUI and very easy for user to control UGO1 USB to GPIB Controller UG01 USB to GPIB Controller control Panel If you plug an UG01 USB GPIB Controller on your computer you will see the Icon as shown in Fig 1 when you run UGOI exe m UGO1 USB to GPIB Controllor PERSE Find GPIB Equipment Attached Equipment GPIB Addresses 10 20 Initialize a specific Equipment Capture Screen Communicate to Equipment GPIB Command Load GPIB script GPIB Script file Equipment with GPIB Address 10 is attached Equipment with GPIB
11. h format is chosen depends on the GPIB equipment Third variable is unsigned character pointer bdata which stores the binary data or file Fourth variable is integer writelength which stores the length to be sent of the binary data or file You must know the length of the binary data or file so that UGOI can encode the binary data to be Definite Length or Indefinite Length The return value should be 0 if function is successful Otherwise the return value is 1 Function D and E Read binary data or file from specific equipment and Get the received binary data or file length Function D Unsigned char stdcall Gbread int address Function E int stdcall Gbreadlength void Generally these two functions are used together The input variable in Function D is integer address which stores the address of the equipment you want to read after you wrote query command to the equipment The return value is the unsigned character pointer of the data read back Windows OS defined unsigned char as BYTE if function is successful otherwise return decimal 10 Hex OxA The maximum length of the unsigned characters read back is 100000 Function E returns data length of the binary data or file which has been read by Function D It has no variable After Function D called the return value of Function E has generated automatically For binary data or file reading UGO1 can detect the coding format Definite Length or Indefinite leng
12. har stdcall Gquery int address char scpi The function is a read after write function After it wrote GPIB command to the GPIB equipment it read the result back The variable of integer address stores the address of the GPIB equipment The variable of character pointer scpi stores the GPIB command The return value is the character pointer of the data read back ASCII characters if the function is successful otherwise return decimal 10 Hex OxA The maximum length of the ASCII characters read back is 20000 Function I Function to get Firmware version Double stdcall GetFWVersion void The function has no variable The return value is a double value as if the function is successful such as 1 0 for Firmware version 1 0 Otherwise the return value is 1 The function can be used to check if the UG01 is plugged into USB socket of a PC If not plugged return value is 1 otherwise UGO1 will return the firmware version Function J Suppress all warning messages int stdcall Setwarningmessage bool setwm The function is to set not to display warning messages or other messages in all functions The variable setwm in the function is Boolean type If setwm is true or 1 all messages in the functions will be displayed when necessary Otherwise all messages will be suppressed The default value of the messages display is true The function should be called before other functions Function I and Function J are for software developers o
13. he GPIB interface equipment in any languages except VB VBA 3 Third is Application Programmable Interface API for stdcall calling convention which includes static library LQUGO1_s lib and dynamic link library LQUGOI s dll This is for VB and VBA clients since VB VBA only take stdcall calling convention Users can write your own programs to realize remote control of the GPIB interface equipment even in Windows Office software such as Excel VBA The API examples have been installed with the software together The examples are built by Visual Studio 2005 at 32bit OS of Windows XP with SP3 UGO01 Software has been tested on 32bit OS of Windows XP with SP3 32bit OS of Windows 7 with SPI 64bit OS of Windows Vista with SP1 and 64bit OS of Windows 7 with SP1 Detailed functioning of the software will be covered in Section 2 in this document For UG01 and UGSimple USB to GPIB Controller comparison please see table below Table1 UG01 and UGSimple USB to GPIB Controller Comparison Model ASCII character Binary data Screen GPIB script File read GPIB equipment length for transfer image feature andsave drives command data Capture UGSimple 60 No No No No lt 5 UGO1 20000 Yes Yes Yes Yes 14 The screen image capture on the UGO1 Control Panel works for GPIB IEEE488 2 and does not work for HPIB IEEEA488 1 If you want to capture a screen image for HPIB interface you have to write a program wit
14. int address Function E int Gbreadlength void Generally these two functions are used together The input variable in Function D is integer address which stores the address of the equipment you want to read after you wrote query command to the equipment The return value is the unsigned character pointer of the data read back Windows OS defined unsigned char as BYTE if function is successful otherwise return decimal 10 Hex OxA The maximum length of the unsigned characters read back is 100000 Function E returns data length of the binary data or file which has been read by Function D It has no variable After Function D called the return value of Function E has generated automatically For binary data or file reading UGO1 can detect the coding format Definite Length or Indefinite length automatically and decode the received binary data then obtain the data length information Therefore the returned data from Function D is decoded binary data or file data The length coding has been eliminated Function F Read a file from specific GPIB equipment and save it to local PC int Gfilesave int address bool mode char filename There are three variables in Function F First variable is address which stores the address of the GPIB equipment for reading Second is Boolean type mode which stores the mode of the file for reading Set variable mode to be true or 1 if the file is binary file such as screen image trace data fil
15. is at folder C Program Files x86 LQElectronics UGO1 UGO1API Samplefiles GPIBscript GPIB script can only be loaded by UGO1 Control Panel and cannot be called by any functions 2 2 UG01 Software API cdecl UGO01 Software API cdecl is comprised of header file LQUGO1_c h static library LQUGO1_c lib and dynamic link library LQUGOI c dll The files are installed in the folder of C Program Files LQElectronics UGOI UGOIAPI for 32bit Windows OS or C Program Files x86 LQElectronics UGOI UGO1API for 64bit Windows OS The static library and dynamic library are written of Visual Studio 2005 C and can be called by user s programs in any languages except VB VBA at Windows OS such as C C Python It is very convenient to call the functions in the libraries UG01 API cdecl functions Function A Write GPIB command to specific equipment int Gwrite int address char scpi The input variables of the function are integer address and character pointer scpi where store the GPIB address of specific equipment and GPIB command respectively The return value should be 0 if function is successful Otherwise the return value is 1 Function B Read data or test result from equipment char Gread int address The input variable is integer address which stores the address of the equipment you want to read after you wrote query command to the equipment The return value is the character pointer of the data ASCII characters read back if i
16. r product developers who would like to integrate UG01 into their products or into their projects 2 4 Visual Basic VB and Visual Basic Application VBA Modules UGO01VB32 bas UGOI V B32 vb UGO1VB64 bas and UGO1VB64 vb are VB modules UGO01VB32 bas is for VBA on 32bit Window OS and UGO1 VB64 bas is for VBA on 64bit Windows OS When you write a VBA program you can add or import the module to your program so as to call the functions from LQUGOI s dll UGO01VB32 vb is for VB in Visual studio 2005 or other version Visual studio on 32bit Windows OS and UGOIVB64 vb is for VB in Visual studio 2005 or other version Visual Studio on 64bit Windows OS respectively When you write a VB program you can add the module to your program so as to call the functions from LQUGOI s dll LQ Electronics Corp Page 12 of 14 UGO01 USB GPIB Controller User s Manual Function Gfind in VB and VBA module The return value of Gfind in VB and VBA module is not integer pointer It is string Each ASCII character represents an address of the GPIB equipment The true integer address of the GPIB equipment is the ASCII character value minus 0x30 Example 1 If the ASCII character in the returned string is 9 then the true GPIB address is 9 which is equal to 0x39 ASCII value of character 9 minus 0x30 Example 2 If the ASCII character in the returned string is A then the true GPIB address is 17 which is equal to Ox41 ASCCII value of character A min
17. rite button e Read data or result from equipment Click Data read button to read data or result from the equipment after you sent query command The data read is ASCII format LQ Electronics Corp Page 6 of 14 UGO01 USB GPIB Controller User s Manual e Capture screen image please see Note If you want to capture the screen image of the GPIB equipment if necessary you can click Capture Screen button It will prompt a folder on local PC for where to save the screen image then save the screen image as GIF file This will take around 3 6 minutes to read the binary file from the GPIB equipment and save it Note Capture screen works on most of equipment with IEEE488 2 GPIB and does not wok on equipment with IEEE488 1 HPIB e Load a GPIB script If you want to load a GPIB script you can click Browse button and find the GPIB script Then click Load button the GPIB script will be loaded If there are some GPIB query commands the result read from GPIB equipment will be saved at the folder file path the dame with the script The saved file name is the name of the GPIB script plus result txt 14 13 m UGO1 USB to GPIB Controllor MEI Find GPIB Equipment Attached Equipment GPIB Addresses 1 10 20 12 Initialize a specific Equipment Capture Screen 2 nites 0 DN Communicate to Equipment 10 diee 0 GPIB Command Load GPIB script 5 8 GPIB Script file 6 Equipment with GPIB Ad
18. t is successful otherwise return decimal 10 Hex OxA The maximum length of the ASCII characters read back is 20000 If first character returned is Linefeed OxA maybe USB or GPIB equipment is not connected or GPIB address error Function C Write binary data or binary file to specific equipment int Gbwrite int address bool mode unsigned char bdata int writelength LQ Electronics Corp Page 8 of 14 UGO01 USB GPIB Controller User s Manual There are four input variables First variable is integer address which stores the address of the equipment you want to write Second variable is Boolean type mode which stores the binary data sending mode If mode is true or 1 the binary data or file will be sent in Definite Length format Otherwise the binary data will be sent in Indefinite Length format Which format is chosen depends on the GPIB equipment requirement Third variable is unsigned character pointer bdata which stores the binary data or file Fourth variable is integer writelength which stores the length to be sent of the binary data or file You must know the length of the binary data or file so that UGO1 can encode the binary data to be Definite Length or Indefinite Length The return value should be O if function is successful Otherwise the return value is 1 Function D and E Read binary data or file from specific equipment and Get the received binary data or file length Function D Unsigned char Gbread
19. th automatically and decode the received binary data then obtain the data length information Therefore the returned data from Function D is decoded binary data or file data The length coding has been eliminated Function F Read a file from specific GPIB equipment and save it to local PC int stdcall Gfilesave int address bool mode char filename There are three variables in Function F First variable is address which stores the address of the GPIB equipment for reading Second is Boolean type mode which stores the mode of the file for reading Set variable mode to be true or 1 if the file is binary file such as screen image trace data file CSV file trace status file sta or other file type unknown Set variable mode to be false or O for reading a text file Third is a character pointer filename which is stores the name and path of the file to be saved on the local PC This name can be the same or different with file name on the GPIB equipment Function G Find the addresses of the GPIB equipment connected on the GPIB bus Int stdcall Gfind void LQ Electronics Corp Page 11 of 14 UGO01 USB GPIB Controller User s Manual There is no variable in Function G The return value is integer pointer for the addresses of the GPIB equipment connected on the GPIB bus after Function G is called If error is found the returned address becomes 1 or 2 Function H Query function This function is simply combined of Gwrite and Gread C
20. us 0x30 2 5 UGO01 API vs LabView It is possible for UGO1 API cdecl to be loaded by LabView because LabView is a C compiler and Functions in library of LQUGOI c dll are exported by standard C format All function is exported with extern C For detailed information of calling functions of third party library into LabView please refer to link at http www ni com white paper 3341 en fttoc5 or http www ni com tutorial 3009 en 3 0 UGO01 HARDWARE The USB interface of UGO1 USB GPIB Controller is full speed USB 2 0 UGO1 USB to GPIB Controller is a full function of GPIB Controller It can drive 14 GPIB interface equipment which comply with TEEE488 2 and IEEE488 1 requirement Only one UGO1 USB GPIB Controller can be installed at a computer For product details Please visit http www lgelectroncis com products USBUG USBUG html to compare both models LQ Electronics Corp Page 13 of 14 UGO01 USB GPIB Controller User s Manual 4 0 GETTING STARTED Installing UGO1 Software and starting Application 4 1 Installing UGO1 Software UG01 Software is properly compressed in an installation file which is called UGO1_v _setup exe The is a two digits version of the software All the files are included in UGO1_v _setup exe UGO1_v _setup exe is stored on a CDR which is attached with the UGO1 USB to GPIB Controller when you buy the product In addition you can download it from website http www lgelectronics com support US B
Download Pdf Manuals
Related Search