TABLE OF FIGURES... II A - DISCUSSION...1

Transcription

1 Radiant Technologies, Inc. 2835D Pan American Freeway NE Albuquerque, NM Tel: Fax: Table of Contents TABLE OF FIGURES... II A - DISCUSSION...1 A.1 - Obtaining the Status/Error Word... 1 A.2 - Execution Modes... 2 A.3 - File Processing... 3 A.4 - Limitation... 4 B MAIN CONFIGURATION...6 B.1 - Setup Dialog... 6 B.2 - Discussion B.3 - Controls C QUIKLOOK CONFIGURE...17 C.1 Configuration and Execution Dialog C.2 - Discussion C.3 Controls D - ARCHIVE REGRAPH AND EXPORTING...23 D.1 Archive Regraphing D.2 Admin Info D.3 - Test Definition Graph C.5 - Exporting D.5 - Controls D.6 - Discussion E USER VARIABLES...38 F CHANGE AND VERSION RECORD...39 I

2 Table of Figures Figure B Generic GPIB Configuration Dialog. Command String is Set to Control a Tektronix O'Scope Figure B Generic GPIB Configuration Dialog 2. Command String is Set to Write a Query of the Cursor Status to the Tektronix O'Scope Figure B Generic GPIB Configuration Dialog 3. The Task is Configured to Read the Cursor Status Response from the Tektronix O'Scope Figure B Generic GPIB Configuration Dialog 4. The Task is Configured to Write One or More Commands from a Single Input File Figure B Generic GPIB Configuration Dialog 5. The Task is Configured to Write One or More Commands from a Series of Input Files in a Branch Loop Figure B Generic GPIB Configuration Dialog 6. The Task is Configured to Write One Command per Branch Loop from a Series of Commands in a Single Input File Figure C Generic GPIB QuikLook Configuration and Execution Dialog Figure C Text File Containing One GPIB Command Per Line Figure C Showing and Hiding the GPIB Status Word Figure C Clearing the GPIB Status Word and Instrument Response Figure C GPIB Error Dialog - Timeout Occurred Figure D Recall the Task from the DataSet Archive Figure D Recall the Task from the DataSet Archive Figure D Generic GPIB Task Regraph Response Dialog Figure D Admin Info Subdialog Figure D Generic GPIB Task Test Definition Graph Text Output Figure D Export Dialog Figure D Standard Windows File Browser Dialog Figure D Export Configuration Dialog - Printer Option Figure D Standard Windows Printer Configuration Dialog Figure D User Generic GPIB Text Export Sample Figure D Sample User Variable Snapshot Task Excel Export Output Figure D Sample Generic GPIB Task Word Export Output II

3 A - Discussion Radiant Technologies, Inc. 2835D Pan American Freeway NE Albuquerque, NM Tel: Fax: radiant@ferrodevices.com The Generic GPIB Task is a test program developed for use in conjunction with the Precision Industrial Ferroelectric Test Systems by Radiant Technologies Inc. The Generic GPIB program is designed to communicate with your GPIB board in order to control and send data to and receive data from any external instrument connected to the tester at the GPIB port. The Task is designed to be generic and its simple setup will allow a user ability to interact with any GPIB-capable instrument. The original Precision Workstation and Premier testers were equipped with a built-in GPIB board. For the Precision NGS series of testers (Precision LC, Precision Premier II, Precision RT66B, etc.) the user provides the host computer to control the tester. To use this Task that host computer must be equipped with a National Instruments GPIB board and must be running NI software. National Instruments provides a variety of GPIB interfaces. Radiant Technologies recommends the National Instruments GPIB-USB-HS because of its portability and ease of use. This is an external GPIB interface that connects to the host computer through a USB cable. NOTE: Prior to attempting communication with you GPIB board and external instrument, please ensure that the instrument is properly connected to the board and that all settings are set as stated in you GPIB and instrument manual. In particular, you must know the instrument's address, secondary address, and End of String Termination character. Status Error Charts: The GPIB Task makes both the status and error word register contents of the GPIB board available to the user. These values are returned from calls to ibsta and iberr. (For more detailed explanation of these calls, consult your GPIB help documentation. ) The GPIB board updates status variables to determine the performance of your GPIB board. In Vision, two variables, the status word and error word, are combined into one Status Error String. The syntax of the Status Word returned in Vision is made up of a combination of two mnemonics. The first is the mnemonic from the iberr call, then the mnemonic from the ibsta call. Then, following both of these is a text explanation of the status mnemonic. Below, you can find a chart explaining both error mnemonic s and status mnemonics. 1

4 Error Word Chart Mnemonic iberr Value Description EDVR 0 System error ECIC 1 Function requires GPIB interface to be CIC ENOL 2 No Listeners on the GPIB EADR 3 GPIB interface not addressed correctly EARC 4 Invalid argument to function call ESAC 5 GPIB interface not System Controller as required EABO 6 I/O operation aborted (timeout) ENEB 7 Nonexistent GPIB interface EDMA 8 DMA error EOIP 10 Asynchronous I/O in progress ECAP 11 No capability for operation EFSO 12 File system error EBUS 14 GPIB bus error ESTB 15 Serial poll status byte queue overflow ESRQ 16 SRQ stuck in ON position ETAB 20 Table problem Status Word Chart Mnemonic Bit Hex Description ERR NI error - Note that an error set in iberr has no meaning unless this bit is set. TIMO Time limit exceeded END END or EOS detected SRQI SRQ interrupt received RQS Device requesting service CMPL I/O completed LOK 7 80 Lockout State REM 6 40 Remote State CIC 5 20 Controller-In-Charge ATN 4 10 Attention is asserted TACS 3 8 Talker LACS 2 4 Listener DTAS 1 2 Device Trigger State DCAS 0 1 Device Clear State A.1 - Obtaining the Status/Error Word If a user wishes to use or see the error and status word, not as a text description, but as an actual word byte (number representation) this number can be referenced/seen by inserting the GPIB Task in a CTD, then inserting a Program Control Task that produces an execution dialog after the GPIB task. Then, when configuring the Program Control Task select a GPIB control from the list as the program control. For example, create, a CTD that consists of first a Generic GPIB Task, then following it, a Pause Task. When configuring the Pause Task select "GPIB Status Word" as the Parameter To Append To Prompt. Then, when the CTD executes, the user will see the value of the status word, as returned by the 1

5 call to ibsta, as the Generic GPIB Task runs. A.2 - Execution Modes GPIB communication has a bidirectional 8-bit parallel protocol. Up to fifteen instruments can be connected together with a single instrument being designated as system controller. For the generic GPIB Task to operate, the Precision host computer must be set to be system controller. (See the GPIB documentation accompanying the tester or LC host board to set the configuration.) Each instrument can read from and write to the bus. Communication is directed by the system controller by telling attached device to read or write. Attached devices have some control as they are able to set control lines indicating that they are not ready to read or that they have data to transmit. Data may be transmitted to all devices as a group or devices may be addressed individually by GPIB address ( system controller normally set to 0). The host controller, running Vision can write data to a single instrument, read data from a single instrument or combine the operations as follows. Write - A single line of text is sent to a single attached instrument, identified by GPIB address. This command assumes that the instrument will not reply to the text message. Or the Write command may be followed immediately by a Readconfigured instance of the Generic GPIB Task, addressed to the same instrument, if the message expects a response. Read - A single line of text is read from a single attached instrument, identified by GPIB address. This command assumes that a message to the instrument that prompts a return line of text was sent in a previous instance of the Generic GPIB Task. The return message is recorded by the Task, written as a User Variable and stored if the Task is executing in a DataSet. Query - This command combines the Write and Read sequence into a single instantiation of the Generic GPIB Task. A programmed line of text is transmitted to an attached instrument identified by GPIB address. That instrument is then told to transmit its response, which is captured by the GPIB Task, written to a User Variable and stored to the DataSet. Note that this mode cannot be used with file transmission as discussed in the next section. Generic GPIB may be executed in a DataSet or in QuikLook. In a DataSet, a single preprogrammed execution will occur, although multiple message may be sent by using a file of messages as discussed in the next section. When executed from QuikLook, the Task may be arbitrarily and repeatedly used to Write and/or Read and/or Query in a single instance of the Task. 2

6 A.3 - File Processing The Generic GPIB Task offers users a way to execute multiple GPIB/device commands from a pre-existing file. In order for this option to work, the user must have previously written a file containing commands for the relevant device attached to the GPIB cable. There do exist syntax rules that the file must comply to in order to execute properly within Vision. General File Syntax Rules 1. The file must be a text file. (Files generated by word processors have embedded control characters that will confuse this function.) 2. The maximum command length is 100 characters. 3. The last line/command must end with a single carriage return. 4. The commands must comply with command syntax specifications of the user's given GPIB instrument under control. See device/probe station documentation for these specifications. Vision is not responsible for knowledge of this information. The Generic GPIB Task s objective is merely to provide an interface capable of communication, but communication is not particular to any device. Below is an explanation of the options available to users. Each section describes its option and any additional rules and other relevant user information. Generic GPIB File Options The Generic GPIB task presents users with two distinct file operation commands. The two commands are: 1. File Execute Line-By-Line - In this type of execution a single line in the file is executed every time the Task is executed. Thus, the File - Execute Line-by Line command assumes that the Generic GPIB Task is programmed into a in Branch Loop. If the file is not in a loop, then only the first line of the file is executed. Also, if the loop the Task is in loops more times than there are commands in the file, then the GPIB Task will terminate execution, and the Branch will be aborted. Therefore, the number of command lines must greater than or equal to the number of iterations of the Branch Loop. Again, the command syntax in the file must comply with regulations provided by the users probe station documentation, and those listed below. Rules: a. There is to be one command per line. b. Every command must end with a carriage return. c. After the last line in the file there is to be a single carriage return and noth- 3

7 ing else. If these rules are not followed, a user will have trouble executing the Task. 2. File Execute All - In this type of execution an entire file of commands is executed every time the Task is executed. The File - All command can be executed in or outside of a Branch Loop. This command has a couple types of loop options. Each option is described by the table below. What is Selected/Checked/Set File Execute All File Name = filename.txt File Execute All Loop Count (checked) Count (set with some number, for example x ) File Name = filename.txt Result Every time this Task is run the entire file of commands will be executed Assumes that the Task is within a CTD that contains a Branch. The GPIB Task will execute as many times as the Count, NOT as many times as the Branch. On first execution the Generic GPIB Task will read commands from the file, filename.txt For each following execution the file name will change. The name will be appended with a number, starting with 1, and ending with the number equal to Count. Thus, on second execution, the file name will be filename1.txt, and third will be filename2.txt, and so on. If a file does not exist, the Task and Branch will be aborted. Again, the command syntax in the file must comply with regulations provided by the users probe station documentation, and those rules listed below. Rules: a. There is to be one command per line. b. Every command must end with a carriage return. c. After the last line in the file there is to be a single carriage return and nothing else. If these rules are not followed, a user will have trouble executing the Task. A.4 - Limitation The Generic GPIB Task is intended to communicate with any device on the GPIB bus. Vision is not configurable to respond to data sent by an external device to the Generic GPIB Task. Actions taken as the result of specific text sent to the Precision GPIB port and into Vision require that the Task that is receiving that text be specifically programmed to handle the text from the device in question. Tasks such as Imprint and Chamber are programmed in that way, as they control specific thermal devices. Some rudimentary program control can be performed based on a device response by using the text, saved as a User Variable, in performing comparisons that control Branch Tasks, Au- 4

8 tomatic Branch Abort Tasks and Automatic Exit Tasks. New to Version 4.1.x Comments control extended to 511 characters. Office/Word/Excel 2000 and later export. (Office '97 export eliminated.) Added a File Delay (in milliseconds) between commands executed from a multiline file. Added the Admin Info button and subdialog. Added Test Definition Graphing output. Task Updates Since Admin Info button added. Test Definition Graph output added. 5

9 B Main Configuration Task Name: Generic GPIB Version: Last Update: 8 June 2010 In QuikLook Menu: Yes Folder: Hardware Subfolder: GPIB Subsubfolder: None Window Name: Generic GPIB Change Record: Change and Version Record Known Bugs: None User Variables Added: Go to List B.1 - Setup Dialog Figure B Generic GPIB Configuration Dialog. Command String is Set to Control a Tektronix O'Scope. 6

10 Figure B Generic GPIB Configuration Dialog 2. Command String is Set to Write a Query of the Cursor Status to the Tektronix O'Scope. 7

11 Figure B Generic GPIB Configuration Dialog 3. The Task is Configured to Read the Cursor Status Response from the Tektronix O'Scope. 8

12 Figure B Generic GPIB Configuration Dialog 4. The Task is Configured to Write One or More Commands from a Single Input File. 9

13 Figure B Generic GPIB Configuration Dialog 5. The Task is Configured to Write One or More Commands from a Series of Input Files in a Branch Loop. 10

14 Figure B Generic GPIB Configuration Dialog 6. The Task is Configured to Write One Command per Branch Loop from a Series of Commands in a Single Input File. B.2 - Discussion The examples shown throughout this document represent real communications with a Tektronix TDS 310 Oscilloscope with GPIB Primary Address '5'. The simple communications used involve setting and querying the scopes cursors as follows: Command CURS? Meaning Request the current scope cursors status. As a request for information, this command should be used as a query or be followed immediately by a read command. The Response will take the format "CURSOR:" Function: Units: Position1: Position 2. 11

15 For Example: CURS:FUNC HBARS CURS:FUNC VBARS CURS:FUNC PAIRED CURS:FUNC OFF HBARS;SECONDS;1.01E-3;2.1E-3;CURSOR2;5.0E0;- 5.2E0;CURSOR1;1.01E-3;2.1E-3;CURSOR2 Cursors are horizontal bars that measure Volts. Cursors are vertical bars that measure time or frequency. Cursors are paired and show both time and Volts. Cursors are turned off. The dialog is used to configure a line of text that will be sent out to an external instrument or to read any text that is buffered on the GPIB bus. The GPIB Address must correspond to the addresses of the external device. The End of String Termination "EOS" is normally a carriage return, a line feed or both. This is selected in the Append to Command list box. The Generic GPIB Task can be set to Write a command, Read a response or combine the two into a Query. If a Read is selected, no command need be written to the Command String control and the control is hidden. The Task can also be set to execute multiple command writes (with no intermittent reads) from a file that lists the commands, one per line. A File Name control and associated Browse control must contain a valid path and file name. The file may be executed one line at a time in a Branch Loop or may be completely executed in a single instance of the Generic GPIB Task. In the latter case, if the Task is programmed into a Branch Loop, multiple files can be executed, one per loop iteration. Files will have the File Name as their root name and have a serially incrementing value appended to them "Filename.1", "Filename.2", etc. The number of files is specified in Count and the option is enabled (and the Count control is shown) by checking File Loop. Clear Instrument on Initial Access, Clear Instrument on Read and Clear Instrument on Write controls are check boxes that enable or disable calls to ibclr() a) after the initial call to ibdev(), b) after a call to ibrd() and c) before a call to ibwrt(). See the GPIB documentation that accompanied the GPIB interface device for a more detailed description. These controls may assist in making communications work between the tester and the instrument under control. The instrument manual should indicate if this is a desirable action. For safety, the device should not be cleared until after its data has been transmitted. For this reason, Clear Instrument on Initial Access and Clear Instrument on Write default to disabled, while Clear Instrument on Read is enabled as a default. Note that sending the ibclr() command to some instruments may cancel their current operation. See the documentation for the particular instrument under control. The dialogs of Figures B.1.1 through B.1.6 represent the various configuration options as follows: 12

16 Figure 1: Query - This execution writes a "CURS?" command to the instrument at GPIB address '5'. No control character is appended to the command. The Task execution expects and waits for a reply from the instrument. The command written must be one that will be replied to. (In many instruments, all commands are replied to.) Once a reply is received the GPIB buffer is cleared. In a Branch Loop, the command will be repeated and a reply accepted at each iteration. Figure 2: Write - This execution writes a "CURS?" command to the instrument at GPIB address '5'. No control character is appended to the command. This Task execution does not expect and does not wait for a reply from the instrument. Any command may be written whether or not it elicits a reply. (In many instruments, all commands are replied to.) In a Branch Loop, the command will be repeated at each iteration. Since the example is a query command, it should be followed immediately by a GPIB Task configured to read the reply buffer. Figure 3: Read - This execution reads the GPIB buffer of the instrument at GPIB address '5'. No characters are written to the buffer. Once a reply is received the GPIB buffer is cleared. If no data are written to the GPIB buffer, the command will time out. In a Branch Loop, the buffer will be read at each iteration. Figure 4: Write sequentially all commands written in the C:\GPIB Files\TDS 310 Command List.txt file. In the example, the file contains only the single command "CURS?". Since this is a query command that elicits a response, it can only be the last command in the file. This Task should be followed immediately by a GPIB Task configured to read the buffer. If the file contained multiple commands, all would be executed in sequence, with a 100 ms delay between commands. In a Branch Loop, this Task will repeatedly execute all commands written to the input file. Figure 5: Write sequentially the commands written in the C:\GPIB Files\TDS 310 Command List.txt file. If the Task is not located in a Branch Loop, only the commands in the C:\GPIB Files\TDS 310 Command List.txt will be written. If the Task executed in a Branch Loop, the file lines in C:\GPIB Files\TDS 310 Command List.txt will be written in the first Branch Loop iteration. The second iteration will write all the lines of C:\GPIB 13

17 Files\TDS 310 Command List.1.txt. The third iteration will write the lines of C:\GPIB Files\TDS 310 Command List.2.txt. This will continue until the fifth iteration when C:\GPIB Files\TDS 310 Command List.4.txt will be written. '4' is the limit, given by File Loop Count. Any subsequent Branch Loop iterations will cause the Task to fail. Figure 6: Write line-by-line the commands written in the C:\GPIB Files\TDS 310 Command List.txt file. If the Task is not located in a Branch Loop, only the first command line in the C:\GPIB Files\TDS 310 Command List.txt will be written. If the Task executed in a Branch Loop, the first line in C:\GPIB Files\TDS 310 Command List.txt will be written in the first Branch Loop iteration. The second iteration will write second line of C:\GPIB Files\TDS 310 Command List.txt, and so on. If the number of Branch Loop iterations exceeds the number of lines in the file, the Task will fail when the file is exhausted. Changes for Version 4.1.x: Comments control extended to 511 characters. Added the File Delay (ms) control. Added the Respond to Nesting Branch Reset control. B.3 - Controls Name Type Default Description Task Text Generic This serves as a root identifier for this instance of the Generic GPIB Name GPIB-# Task. The Task will be identified with this value in the Editor and the CTD. Executed Tasks will be displayed and stored with this name. Command String Command Type Clear Instrument on Initial Access Clear Instrument on Text 100 characters maximum. This is the text that is written on the GPIB bus to the target instrument indicated by the Primary Address. This control is hidden unless a Command Type of "Write" or "Query" is selected. Boolean Read / Write / Query / Execute From File Options Check Box Check Box Determine what type of command will be executed. A Read returns the data on the bus of the GPIB Board. A Write communicates with the Board and gives the instrument under control an instruction. The Query not only instructs, but also returns information too. Finally, there are two options for file operations. The first option is to execute commands line by line from a file. This means that the Generic GPIB Task lies with a Branch Loop. The file is executed, one line per Branch iteration. The second option is to execute the entire file at a single Task instance. In this case the Task may lie within the Branch Loop. Selections made in this control will either show or hide File Name, Loop Count, Count, Append to Command and Command String as appropriate. Unchecked Instructs the Task to send and ibclr() command to the instrument immediately after the ibdev() command locates the instrument. Checked Instructs the Task to send and ibclr() command to the instrument immediately after the ibrd() command reads the buffer text from the instrument. 14

18 Read Clear Instrument on Write GPIB Address Append to Command Check Box Unchecked Instructs the Task to send and ibclr() command to the instrument immediately before the ibwrt() command writes to the instrument buffer. In some instruments, this option may halt the command before it completes. Integer 5 The primary address of the GPIB Board (Note that the secondary address is not used and is fixed at a value of '0'.) List "None" Box Indicates the command terminator that will be added to the command text if the Command Type is a "Write" or a "Query". The options are Carriage Return, Line Feed, both or neither. The option that you select will depend on the requirements of your instrument under control. This control is disabled if Command Type is not "Write" or "Query". File Name Text The path and name of the file that the GPIB/device commands are coming from. The file must be a text file. The commands in the file can be no more than 100 characters, and each command must be ended with a carriage return. Also, the last command/line of the file must end with a single carriage return and nothing else. File Loop Check Box Unchecked This option only appears if the user selects the File Execute All command. This box assumes that the Task is going to be executed in a loop. If this box is checked, then on the first execution the file name in the File Name edit box will be used as the file for execution. On any additional executions, the file name in the edit box, appended with a number (starting at 1) will be used. For example, if the user entered file name.txt in the file name edit box, and checked the File Loop box, on the first execution of this Task, the program would look for commands from the file, file name.txt. On the seconds execution of this Task (in a loop of course) the program would look for the file name, file name1.txt. The third execution would look for file name2.txt and so on. Count Integer 0 The number of times your file will append a count after first execution. So if you file list looks like this: Respond to Nesting Branch Reset Check Box Checked Filename.txt FileName1.txt FileName2.txt FileName3.txt Your count should be set to three. This control is hidden unless File - Execute All and Loop Count are selected. This control is hidden unless Command Type is File - Execute Line-by- Line. Checking this control causes file execution to return to the first line if the "Nesting Branch Task: Reset" Boolean User Variable is set to true. Subsequent executions will continue from the second line. This resets the line pointer in the file when instructed to do so by the Nesting Branch Task. See the main Vision help pages Tutorial section VIII for more details regarding the configuration and use of Nested Branch Looping. Comments Text 511 Characters Maximum. A free-form user field to describe the Task, its configuration and its use in the Test Definition. Export Button Unpressed This button is normally disabled. It is enabled when the dialog appears as the result of an Archive Regraph. Operating this button during Arc- 15

19 hive Regraph will open the Export dialog and allow the user to select and configure the exporting of the Task configuration data to a file or the printer. Help Button Unpressed Read this Help page. OK Button Unpressed Accept the configured User Variable Snapshot Task values Cancel Button Unpressed Do not add the User Variable Snapshot Task to the list in the Editor. 16

20 C QuikLook Configure Task Name: Generic GPIB Version: Last Update: 8 June 2010 In QuikLook Menu: Yes Folder: Hardware Subfolder: GPIB Subsubfolder: None Window Name: Generic GPIB Change Record: Change and Version Record Known Bugs: None User Variables Added: Go to List C.1 Configuration and Execution Dialog Figure C Generic GPIB QuikLook Configuration and Execution Dialog. 17

21 C.2 - Discussion The QuikLook execution of the Generic GPIB Task is very unique. The GPIB communications can be repeatedly configured and executed from within a single instance of the dialog - a single QuikLook execution. Closing the configuration and execution dialog does not result in further execution, but simply indicates that the QuikLook session is completed. QuikLook is a particularly useful tool, in this case, to test and verify commands and queries to the instrument under control before they are programmed into a Test Definition. The QuikLook operation is nearly as capable as Test Definition operation in a DataSet. Only the Branch Loop options are unavailable. Operations include Write to the instrument's GPIB buffer, Read the buffer or combine the two operations sequentially into a Query command. A sequential list of commands that do not elicit an instrument's response may also be executed from an input file, with a File Delay (ms) wait between executions. Operation is straight-forward. Type the appropriate command into Command String. The command must be one that is recognized by the instrument under control. Select the terminator used by the instrument in Append to Command. Ensure that the GPIB Address entry matches the GPIB address of the instrument to be controlled. If the command produces no GPIB response from the instrument, click Write. Observe the instrument response to the command at the instrument. If the command does produce a response, either click Write, then follow immediately with Read, or click Query to combine both the Write and Read into a single action. In either case, the GPIB buffer written by the instrument is observed in Response. Note that Read transmits no message and is independent of Command String. A series of multiple write commands can be sent to the addressed instrument in a single execution of the Generic GPIB Task. This is done by listing the commands, line-by-line, in a text file as in Figure C.2.1. The Generic GPIB Task will repeatedly read a line and send it to the instrument until the file is exhausted. The execution includes a programmable delay, set in File Delay (ms), (added as of Version 4.1.x) given in milliseconds, between each command transmission. The procedure is simply to Browse to the text input file and then click File Execute. This technique cannot be used to send queries or commands that cause the instrument to place a response in the GPIB buffer. Including the line "CURS?" in the file of Figure C.2.1 would cause the Task to fail. Note that the final command entry in the text file must end in a carriage return or the line will not execute. 18

22 Figure C Text File Containing One GPIB Command Per Line. The dialog can alternate between displaying or hiding the Status Word by selecting or deselecting Show Status Word. Both the Status Word and the Response controls can be cleared by clicking the Clear Response button. Figure C Showing and Hiding the GPIB Status Word. 19

23 Figure C Clearing the GPIB Status Word and Instrument Response. Changes for Version 4.1.x: Comments control extended to 511 characters. Added the File Delay (ms) control. C.3 Controls Name Type Default Description Command String Text This is the text that is written on the GPIB bus to the target instrument indicated by the Primary Address when Write or Query is invoked. This text will have the Append to String Value appended to it before the Write. Primary Integer 5 The primary address of the GPIB Board Address Append to Command List Box None Indicates the command terminator that will be added to the command string for a Write or a Query. The options are Carriage Return, Line Feed, both or neither. The option that you select will depend on the requirements of your instrument under control. This control is not used if the action is not Write or Query. File Name Text The path and name of the file that the GPIB/device commands are coming from when the File Execute control is used. The file must be a text file. The commands in the file can be no more than 100 characters, and each command must be ended with a carriage return. Also, the last command/line of the file must end with a single carriage return and nothing else. The text in this control is updated with the path and file name identified using Browse. 20

24 File Delay Integer to 10000, in milliseconds. This is a delay that will occur between each command transmitted in a file-based sequence of commands initiated using File Execute. Browse Button Unpressed Causes a standard Windows browser dialog to open to allow the path and name of an input file to be specified. This will be the text file containing the line-by-line GPIB commands to be executed if File Execute is clicked. The selection made using this button will be written to File Name. Read Button Unpressed Causes the Task to collect the text that is on the GPIB buffer and addressed to the tester. This presumes that some previous action has caused the instrument under control to place a response on the buffer. If there is no text buffered, the Task will freeze until the timeout period is complete, then will indicate an error. File Execute Figure C GPIB Error Dialog - Timeout Occurred. Write Button Unpressed Cause the combination of the Command String and Append to Command control characters to be sent to the instrument at Primary Address. Use of this button should be followed by a Read if the command will produce a response in the instrument under control. If this is not done, further commands will not execute since the buffer is not empty. Query Button Unpressed Combines a Write, then a Read into a single command. Should only be used if the Command String will produce a response in the instrument under control. Button Unpressed Sequentially reads GPIB commands and executes them, line-by-line, from the file specified in File Name. All of the lines in the file will be sequentially sent to the instrument under control in a single instance of this button. The file must exist at the specified path and the commands it contains should be recognizable to the instrument. Between each command the process delays for the period in milliseconds specified by File Delay (ms). Commands that elicit a response from the device should not be used since the read buffer is not read. Comments Text 511-characters maximum. A field that can be used to provide a description of the experiment being performed. Export Button Unpressed Initiate the exporting of the Generic GPIB parameters to a printer, a text file or Excel or Word. Note that the export will not occur until the dialog is closed. Only a single export can be performed during a single instance of the QuikLook Task because exporting occurs when the QuikLook dialog is closed. 21

25 OK Button Unpressed Close the dialog. Take no further GPIB communications action. This is identical to Cancel. Cancel Button Unpressed Close the dialog. Take no further GPIB communications action. This is identical to OK. Help Button Unpressed Read this Help page. 22

26 D - Archive Regraph and Exporting Execution of the Generic GPIB Task within a Test Definition in a DataSet will produce no apparent results within Vision, though the instrument under control should respond to the Task execution. Vision will only respond if there is an error in the execution. In this case, a dialog will normally appear indicating the nature of the error and requiring acknowledgement before the Test Definition continues. In some cases, if the error occurs within a Branch Loop, the Branch will be aborted. D.1 Archive Regraphing Once the Generic GPIB Task has been executed in a Test Definition, it is stored in the DataSet Archive. Once stored the Task can be recalled to review both its configuration parameters and the results of its execution by exporting the data. To recall the Task from the Archive, open the appropriate DataSet, then open the Archive. Open the desired Executed Test Definition (ETD) and its "Experiment Data Folder". Finally double-click on the appropriate Task. 23

27 Figure D Recall the Task from the DataSet Archive. 24

28 The Task configuration dialog will appear, showing the configuration under which the Task was executed. Most controls are disabled. Help is available and Cancel closes the Dialog. Export can be used to write Generic GPIB parameters to a source external to Vision as described below. Admin Info opens a subdialog providing Vision information as described in the next section. Figure D Recall the Task from the DataSet Archive. When the configuration dialog is closed, a second dialog appears that shows the instrument response, if any, and the GPIB status word. 25

29 Figure D Generic GPIB Task Regraph Response Dialog. D.2 Admin Info The Admin Info button shown in Figure D.1.2 has been added to all Tasks as of Version 4.2.x. The button opens one of two subdialogs. Program Tasks, such as the Generic GPIB Task present the dialog of Figure D.2.1. Here, the Vision Version and compilation date along with the Task configuration and execution date and time are presented. This information is of minor value to the user. However, Measurement Tasks also present Tester Type, Tester Serial Number and Driver Version. This information can be useful to RTI in helping the customer troubleshoot problems with Vision and/or the tester. Note that the exporting of this information has also been added to the export target applications as described below. Figure D Admin Info Subdialog. 26

30 D.3 - Test Definition Graph Figure D.3.1 shows an example of the Generic GPIB Task text output to a Test Definition Graph in "Standard" text mode. Test Definition Graphing is available by rightclicking in the Editor or DataSet Tab window. Information about the configuration of the Tasks that make up the Test Definition is presented graphically. See the discussion in the main Vision help pages under Tutorial IX or the Main Manual Section XIII. Figure D Generic GPIB Task Test Definition Graph Text Output. C.5 - Exporting In order to allow data to be exported from the Task when the Task is recalled from the DataSet Archive, an Export button appears on the recalled configuration dialog. This button is normally disabled, but it is enabled in Archive Regraph as in Figure D.1.2, above. Clicking the button produces the new dialog that appears below. Figure D.4.1 shows the Export configuration dialog in which the "Export Text" option is selected and the browser button enable. Figure D.4.2 shows the browser dialog that opens when the Browse for File Name button is clicked. 27

31 Figure D Export Dialog. 28

32 Figure D Standard Windows File Browser Dialog. D.5 - Controls Name Type Default Description Select List "Print" Select between the "Print", "Export Text", "Export Word" and "Export Option Box Excel" options. This control enables the Browse for File Name button Line Spacing Left Margin Tab Spacing Browse for File for all selections except the "Print" option. Integer 100 This control appears when Select Option is set to "Print". Otherwise it is hidden. Increasing or decreasing this value will increase or decrease the vertical spacing of lines on the printed page. Experimentation will fix the value for any given printer. Integer 100 This control appears when Select Option is set to "Print". Otherwise it is hidden. Increasing or decreasing this value will increase or decrease the left start point of text on the printed page. Experimentation will fix the value for any given printer. Integer 200 This control appears when Select Option is set to "Print". Otherwise it is hidden. Increasing or decreasing this value will increase or decrease the horizontal spacing of tabbed sections of text on the printed page. Experimentation will fix the value for any given printer. Button Unpressed This control is enabled for all export options except "Print". For the remaining options, this control must be selected. The browser dialog 29

33 Name File Name will appear where a path and file name must be specified for the export output. Text This control is always disabled and cannot be used to specify the file name or path for Text, Word or Excel export. Once the browser is used to select a path and file name, those will be displayed in this control for review. Note that a path and file name MUST be specified for the "Text" export option and may be specified for "Excel" or "Word". Help Button Unpressed Open this help document for review. OK Button Unpressed Accept the configured export and close the dialog. Exporting will occur when the main data regraph dialog is closed. Cancel Button Unpressed Close the export dialog. Do not export. D.6 - Discussion Data can be exported to one of four targets: Printer - Pre-formatted text is sent to the printer when the configuration dialog is closed. Before printing a printer setup dialog will appear (Figure D.6.2), allowing printer options to be adjusted. (The appearance of the dialog will vary from user to user.) With the release of Version 4.1.x, printer text can be formatted from within Vision by adjusting the Line Spacing, Left Margin and Tab Spacing integer values (Figure D.6.1). Experimentation will show the proper settings for all exporting to the attached printer. These controls are hidden unless the printer is specified as the target. 30

34 Figure D Export Configuration Dialog - Printer Option. 31

35 Figure D Standard Windows Printer Configuration Dialog. Text File - Selecting this option enables the Browse for File Name button. Clicking this button will open a standard browser dialog in which a file name and path must be selected. If the file already exists, the output will be appended to existing text. An output file name must be specified for this export. Figure D.6.3 shows a sample of the Generic GPIB Task text export. The information shown in the Admin Info subdialog of Figure D.2.1 has been added to the Text Export output. 32

36 Figure D User Generic GPIB Text Export Sample. 33

37 Excel - Selecting this option enables the Browse for File Name button. Clicking this button will open a standard browser dialog in which a file name and path may be selected. Specifying a file name is optional. However, if specified, a unique file name/file path must be created or an overwrite situation will occur. Data are not appended to existing files. When the configuration dialog is closed, the Excel program will be started and a spread sheet created. When Excel is closed, the data will be written to the specified file name, or the user will be prompted to save if the file is not specified. Office/Excel 2000 or later must be loaded for this option. Office/Excel is not provided with the tester or Vision software. Figure D.6.4 shows a sample of the Generic GPIB Task Excel export. The information shown in the Admin Info subdialog of Figure D.2.1 has been added to the Excel Export output. 34

38 Figure D Sample User Variable Snapshot Task Excel Export Output. 35

39 Word - Selecting this option enables the Browse for File Name button. Clicking this button will open a standard browser dialog in which a file name and path may be selected. Specifying a file name is optional. The Word program will be opened and written when the regraph dialogs have been closed. If a new file name is specified, the document will be saved immediately. If no file name is specified, the user will be prompted to save the documents when closed. Office/Word 2000 or later must be loaded for this option. Office/Word is not provided with the tester or Vision software. The information shown in the Admin Info subdialog of Figure D.2.1 has been added to the Word Export output. 36

40 Figure D Sample Generic GPIB Task Word Export Output. 37

41 E User Variables GPIB Command String Text The most recent command text send to the external instrument during a Write or Query operation. GPIB Response String Text The most recent instrument response to a Write or Query operation GPIB Status/Error String Text A concatenation of textual representations of the status and error bits set GPIB Error Word Integer An integer whose individual bits represent particular GPIB parameters. The state of the parameter is indicated by the set/cleared state of the bit. GPIB Status Word Integer In integer whose individual bits represent particular GPIB error conditions. Bits that are set indicate that a particular error occurred only if the error bit is set in GPIB Error Word. 38

42 Version December 2001 F Change and Version Record 1. Set the Version to for development of the next release - SPC - 10 December Added Excel and Text Exporting - SPC - 31 December Added Clear Response control and Comments to the QuikLook Configuration/Execution dialog. - SPC - 31 December Eliminated EOS controls in QuikLook and Main Dialogs. - SPC - 31 December Added Printer Exporting - SPC - 2 January Added Most Recent Command control to the QuikLook Configuration/Execution dialog. - SPC - 2 January Updated Excel and Text Exporting. - SPC - 2 January Version March Set to Version for release. 14 March SPC. 2. Installed initial Word file export - 26 March SPC. 3. Eliminated the GPIB Secondary Address control. This value is now forced to zero, indicating that the instrument under control has no secondary GPIB address. 29 April SPC. 4. Added Configured and Executed date/time controls to the configuration dialog. Controls are hidden during configuration, but visible when the Task is recalled from the DataSet Archive. 29 April SPC. 5. Added "Clear Instrument" controls to the main and QuikLook configuration dialogs. Controls determine if the instrument under control is to have its interface cleared when first accessed, before writing or after reading. 29 April SPC. 6. Updated to Version October SPC. 7. Eliminated the "Eye" icon March SPC. 8. Added Tool Tips - 4 December SPC. 9. Added Office 2000 Exporting February SPC. Version April Set to Version to develop the next release. 30 April SPC. 2. Added custom text spacing to printer output. 31 July SPC. Version June Set to Version for the next release. 3 June SPC. 39

43 2. Fixed bulk file execution to be controlled line-by-line within Vision instead of passing the entire file to NI July SPC. 3. In view of item 2, it was possible to add a programmable delay, in milliseconds, to occur between the execution of each line in the file. 14 July SPC. 4. Improved error checking including trapping for an unspecified file name in configuring a file operation. 14 July SPC. 5. Updated dialog appearance including changing disabled controls to read-only and better positioning and sizing of controls. 15 July SPC. 6. Corrected file name serializing for multiple file execution in a Branch Loop. 15 July SPC. Version January Set to Version for the next release. 24 January SPC. Version February Set to Version to match the main Vision program version. 26 February SPC. 2. Fixed the Loop Count variable to respond dynamically to the configured communication type. 11 June SPC. 3. Fixed the Loop Count variable to appear and hide properly based on the checked value of the Loop Count Enable control. 11 June SPC. 4. Stopped resetting the Loop Count value to 0 when the Loop Count Enable control is unchecked. 11 June SPC. 5. Set to version to reflect the changes. 11 June SPC. 6. Added the Admin Info button and subdialog. 22 July SPC. 7. Added Vision Version and Vision Compile Date to all exporting. 22 July SPC. 8. Set to version to reflect the changes. 22 July SPC. 9. Add the Respond to Nesting Branch Reset control and respond properly to it. 3 August SPC. 10. Set to Version to reflect the change. 3 August SPC. 11. Add Test Definition Graphing capabilities. 3 November SPC. 12. Set to Version to reflect the change. 3 November SPC. Version November Set to Version to match the main Vision program version. 5 November SPC. 40

44 Version January Set to Version to match the main Vision program version. 11 January SPC. Version June Set to Version to match the main Vision program version. 8 June SPC. 41