SOFTWARE INSTRUCTION MANUAL APIcom Instrument Control Software Version 3.9.2 Teledyne Advanced Pollution Instrumentation, Inc. 9480 Carroll Park Drive San Diego, CA 92121 TOLL-FREE: FAX: TEL: E-MAIL: WEB SITE: 800-324-5190 858-657-9816 858-657-9800 customerservice@teledyne-api.com http://www.teledyne-api/software/apicom Copyright 1998-2005 Teledyne API Inc. API part #: 05499 Rev. A 29.
END USER LICENSE AGREEMENT (EULA) End-User License Agreement For APIcom Graphical Interface Software This End-User License Agreement ("EULA") is a legal agreement between you ("the user") and Teledyne Advanced Pollution Instrumentation Inc. ("T-API"), San Diego, USA. The Software product (“APIcom”) includes computer software, the medias belonging to it, printed materials and electronic documentation. By installing, copying or any other usage of APIcom you agree to the terms of this agreement.
TABLE OF CONTENTS TABLE OF CONTENTS..................................................................................................................................III LIST OF FIGURES......................................................................................................................................... IV LIST OF TABLES ........................................................................................................................................... V 1. INTRODUCTION ..............
.12.2. 4.12.3. 4.12.4. 5. Selecting Channels for Automatic Download ......................................................................................4-15 Activating Automatic Download Mode.................................................................................................4-15 File Names For Automatic Download..................................................................................................4-15 M700 CALIBRATOR SEQUENCES ...................................................
Figure 4-7: Figure 4-8: Figure 4-9: Figure 4-10: Figure 4-11: Figure 4-12: Figure 4-13: Figure 5-1: Figure 5-2: Figure 5-3: Figure 5-4: Figure 5-5: Figure 5-6: Figure 5-7: Figure 5-8: Figure 5-9: Figure 5-10: Figure 5-11: Figure 5-12: Figure 5-13: Figure 5-14: Figure 5-15: Figure 5-16: Figure 5-17: Figure 5-18: Figure 5-19: Figure 6-1: Figure 6-2: Unsuccessful iDAS Send Dialog ...........................................................................................................
1. INTRODUCTION This manual describes APIcom, a graphical interface that permits users to connect to the standard suite of ambient and stack-gas API instruments from remote locations and to operate those instruments as easily as if the user were sitting in front of the instrument. The user interface is simple and intuitive. Anyone who is familiar with API’s instruments can use APIcom. The figure below shows the primary APIcom interface to a remote instrument.
APIcom Instruction Manual Introduction Supports the new iDAS SDEV sampling mode. Lengthy data downloads from the iDAS can now be aborted using a “Cancel” button to the iDAS dialog to abort lengthy data downloads. APIcom now supports “total flow rate” specification for the M700 (M700 software revisions F.3 and later), as well as Generate, GPT, and GPT-preset steps. Support for the TMS Terminus and TMS modules via the terminus, but not standalone TMS modules.
APIcom Instruction Manual Introduction Names of items such as files and setup variables are indicated using italicized capital characters, as in RS232_MODE. 1.6. Installing APIcom If the installation file was downloaded, simply locate the file named APIcom.Installer.X.X.exe on the hard drive and double-click on it, then follow the instructions. (X.X being the revision number). If APIcom was received on CD, locate your CD drive in Explorer, locate the file named APIcom.Installer.X.X.
APIcom Instruction Manual Introduction executables sent to you from anybody outside of API are safe to run. If in doubt, run a virus checker before and after running the installer file. Uninstalling APIcom versions 3 and higher with the provided uninstallation utility (to be found in the APIcom program group) or when running the Installer again and selecting YES to uninstall previous versions, will delete all of the registry entries (program and iDAS settings) and the entire folder with APIcom files.
2. CONFIGURATION This section explains how to configure APIcom to connect to an instrument. 2.1. Main Application Window The following figure shows the top-level window of APIcom. This window will always be open in addition to one window for each instrument front panel. Figure 2-1: Main Application Window All configuration tasks can be carried out with the buttons on the toolbar, which are summarized in the table below. Table 2-1: Button 2.2.
APIcom Instruction Manual Step 2. 3. 4. 5. Action 7. 8. Comment to create a new site Click on Specify the site’s properties. Click to finish Select Settings-Instruments from the menu or click on the 6. Configuration Create an instrument. toolbar button Click on to create a new instrument and specify the instrument’s properties Click to finish Attach a serial cable Refer to the following paragraph.
APIcom Instruction Manual Configuration Figure 2-2: Connection Dialog 2.3. Physical Instrument Settings This section briefly explains how to configure an API analyzer to work with APIcom. Refer to the instrument’s manual for detailed information. Baud Rate In most instruments pressing SETUP-MORE-COMM-BAUD sets the baud rate. The higher the baud rate, the faster the communication with the instrument.
APIcom Instruction Manual Configuration In addition, most of API’s instruments have a password protection capability in which the instrument will only accept commands after a password has been submitted. This security feature must be used carefully with modems. The problem is that while the modem is answering an incoming call, it sends status messages such as “RING” and “CONNECT” to the instrument, to which the instrument responds “MUST LOG ON” if the security mode is enabled.
APIcom Instruction Manual Configuration Tab Property Description General (continued) Save network configuration automatically on exit If checked, APIcom will automatically save the network configuration when it exits. If it’s not checked and the configuration is modified, APIcom will prompt to save the configuration when it exits. This is useful to temporarily modify some settings but not save them.
APIcom Instruction Manual Configuration Remote Site A APICOM (local computer) APICOM M100A APICOM M200A M100A APICOM Site A APICOM Modem Modem Modem APICOM M300 M200A M300 Remote Site B APICOM M100A APICOM M200A M100A APICOM Site B APICOM Modem Modem Modem APICOM M700 M200A M700 Figure 2-4: Instruments, Sites, and Connectors 2.5.1.
APIcom Instruction Manual Configuration Most of the instrument properties are optional and are included for maximum compatibility with all of API’s instruments. The button in the Basic tab (Figure 2-6) will reset all options to their default values. Notice that only the instrument-specific communication settings appear in this dialog box. The remaining communication settings are specified on a site-by-site basis. The following section describes all instrument properties. 2.5.1.2.
APIcom Instruction Manual Configuration Property Description iDAS configuration Permits off-line editing of the instrument’s iDAS configuration. Enabled only if instrument has iDAS and APIcom was connected to the instrument and downloaded its iDAS configuration at least once. After connecting to an instrument, it takes a few seconds to make this option available. During this time, APIcom does not respond to any user input.
APIcom Instruction Manual Configuration Code Activated Switch Tab The following figure shows the instrument properties screen Code Activated Switch tab. Table 2-5 identifies the instrument properties and provides a brief description of each property.
APIcom Instruction Manual Configuration Handshaking Tab The following figure shows the instrument properties screen Handshaking tab. Table 2-6 identifies the instrument properties and provides a brief description of each property. Figure 2-9: Instrument Properties Dialog Box, Handshaking Tab Table 2-6: Instrument Properties, Handshaking Tab Property Description Receive timeout Maximum time (in milliseconds) that APIcom waits for a response from the instrument after a command is sent.
APIcom Instruction Manual Configuration Table 2-7: Instrument Properties, Security Tab Property Description Use this password to logon to an instrument If checked, APIcom will use the specified password to logon to the instrument when establishing a connection. Most of API’s instruments have some password mode in which the instrument will only accept commands after a password has been submitted. Also refer to the section titled Modems below. 2.5.2.
APIcom Instruction Manual Configuration Table 2-8: Site Properties Property Description Name A user-defined name for the site. The name appears in graphs and window captions. The site name is combined with the instrument name to form a title for dialog boxes and graphs.
APIcom Instruction Manual Configuration 2.5.4. Windows (TAPI) Modem Connections If a site’s Connection Type property is set to Windows Modem, then clicking on the following dialog box. will display Figure 2-13: Windows Modem Connection Properties Dialog Editing the Windows modem settings must be done using the Windows Control Panel or the software provided by the modem manufacturer. This approach was chosen in order to keep APIcom as simple as possible.
APIcom Instruction Manual Configuration Table 2-10: Non-Windows Modem Connection Properties Property Description Comm. Port The COM port on the computer that the modem is attached to. Most internal modems emulate a COM port. Consult the modem documentation or the Windows Control Panel to determine which COM port the modem emulates. Modem Type The modem type to use. Click on to define or edit a modem type. Telephone Number The telephone number to dial if the connection is a modem connection.
APIcom Instruction Manual Configuration Figure 2-16: Modem Properties Dialog The default properties should work for most standard modems. If properties were changed, clicking on will reset all parameters to the defaults. Notice that the commands include the “AT” command prefix. When APIcom establishes a non-Windows modem connection it sends the commands to the modem in the following order: Reset command (e.g. “ATZ”) Wait for OK response (e.g. “OK”) Initialization command (e.g.
APIcom Instruction Manual Configuration Property Description OK response The string that the modem sends to APIcom to indicate successful execution of a command. Connect response The string that the modem sends to APIcom to indicate that a connection has been established. Data mode command The command that switches the modem from online mode into data mode. Reset command The command that resets the modem to its power up state. Initialization command The command that initializes the modem.
APIcom Instruction Manual Configuration name and a .CFG extension in any location on disk or a local area network. This enables to create different configuration files to represent different networks and to share configuration settings with other users. APIcom also stores the iDAS or sequence configuration for each instrument in this file. This allows you to create predefined standard iDAS and sequence configurations and easily upload them to an instrument upon connection.
3. BASIC OPERATION 3.1. Connecting to an Instrument To connect to an instrument and display its Front Panel Window, click on , type Ctrl-C on the computer keyboard, or select File-Connect from the Main Application Window. See Figure 2-2 for an example of the connection dialog box. There are three ways to establish the connection: Select an instrument from the list and click on . Press Enter on the computer keyboard. Double-click an the instrument name in the list.
APIcom Instruction Manual 3.5. Basic Operation Using APIcom with the TMS9000 APIcom can be used with terminus-equipped TMS9000 systems that are configured for ASCII data mode (see TMS9000 Terminus manual), either directly to the serial port or via the Ethernet port using a TCP connection. At present APIcom does not support MODBUS operation for the TMS9000. When connected to a TMS9000 the button is replaced by a button which allows the user to scroll between system and sensor modules of the TMS9000.
4. iDAS CONFIGURATION AND DATA ACCESS A major feature of APIcom is its ability to modify the built-in iDAS configuration and access the iDAS data in a remote instrument. The current instrument configuration can be downloaded, modified, and then sent back to the instrument. Once the iDAS configuration was downloaded, it can be edited off-line, saving money on long distance phone connections to the instrument.
APIcom Instruction Manual iDAS Configuration and Data Access Figure 4-1: iDAS Configuration and Downloaded Data Dialog This dialog box displays both the iDAS configuration and the number of records downloaded for each parameter. Initially, the configuration list is empty. Press the button to download the instrument’s iDAS configuration. This dialog box can also be entered off-line when editing the instrument’s properties by clicking on .
APIcom Instruction Manual Button iDAS Configuration and Data Access Description Loads the iDAS configuration from a text file stored on the computer. This configuration may be edited and saved on the computer again, or it may be sent to an instrument. This configuration file may have been downloaded from the instrument using the “D PRINT SCRIPT” RS-232 command, or it may have been created using the button in APIcom. Saves the iDAS configuration to a text file on the computer.
APIcom Instruction Manual iDAS Configuration and Data Access In Figure 4-1, the channels have been expanded to show all the parameters. The dialog box displays a summary of the channels, including the channel name, the triggering event, and the maximum number of records the channel stores. The parameter summary includes the parameter name and numeric units, the sampling mode, the record set number, and the number of records actually downloaded from the instrument.
APIcom Instruction Manual iDAS Configuration and Data Access 3000-12000 records. E-series instruments will have 1 MB of data storage capacity and the ability to store up to about 1000000 records. Figure 4-2: iDAS Channel Context Menu – Adding or Modifying a Channel To edit the existing channel, select Edit Channel or click on following tabbed dialog box.
APIcom Instruction Manual Tab Basic (cont.) Advanced Property Description Enable Channel If checked, the channel will store records. If unchecked, the channel will not store records. This property can disable a channel without having to delete it. Hold Off If checked, this channel will not store any records during the hold off interval (calibration period). If unchecked, this channel will store records regardless of the hold off state.
APIcom Instruction Manual Tab iDAS Configuration and Data Access Property Description Append downloaded data to file If checked, APIcom will append new data to the existing file. Otherwise it will completely overwrite the file. 4.5.2. iDAS Channel Names When a channel’s properties are edited, APIcom checks to make sure that the channel name is unique and contains valid characters.
APIcom Instruction Manual iDAS Configuration and Data Access Figure 4-4: iDAS Parameter Context Menu – Adding or Modifying a Parameter To edit any existing parameter, click on Edit Parameter or dialog box. , which will bring up the following Figure 4-5: iDAS Parameter Properties Dialog The following table describes the parameter properties shown above. Table 4-4: Property iDAS Parameter Properties Description Parameter This is the instrument-specific parameter to sample.
APIcom Instruction Manual 4.6. iDAS Configuration and Data Access Sending the iDAS Configuration to the Instrument To send the iDAS configuration to the instrument, click on . Sending the iDAS configuration to the instrument will completely replace the instrument’s current iDAS configuration and discard all of the data stored in the instrument. Therefore, APIcom will prompt to confirm the operation before proceeding.
APIcom Instruction Manual iDAS Configuration and Data Access Figure 4-8: Select Records Dialog The following table describes the properties shown above. Table 4-5: Select Records Dialog Property Description All Downloads all the records stored in the instrument for the selected channels or parameters. Since last download Downloads all the records stored since the last download. Most recent records Downloads the most recent N records.
APIcom Instruction Manual iDAS Configuration and Data Access Property Description All Downloads all the records stored in the instrument for the selected channels or parameters. to begin downloading. Note that Specify the record selection criteria to use and click on iDAS data downloads can take several minutes, depending on the baud rate and how many data were selected. For instruments with the proper software downloads can be canceled by pressing the cancel button .
APIcom Instruction Manual iDAS Configuration and Data Access Figure 4-10: Downloaded iDAS Data Note the number of records that were downloaded from the Concentration and Pneumatic channels (32), and from the SlopeOffset channel (1). APIcom remembers the downloaded iDAS data as long as it is connected to the instrument or until the configuration is downloaded again. When the instrument is disconnected, the data are discarded to conserve memory. 4.7.1.
APIcom Instruction Manual iDAS Configuration and Data Access Figure 4-11: Graphing Multiple iDAS Parameters With Different Scales In the example above, each graph window has a different Y-axis scale that is appropriate for the range of data values being graphed; as all data stem from the same record set, X-axes are time-aligned. The primary purpose of the Graph Window is to preview the data. For more sophisticated graphs we recommend to download and save the data, then import them into e.g.
APIcom Instruction Manual iDAS Configuration and Data Access 4.9.1. Changing the Precision of iDAS Data When Viewing or Saving Downloaded data are formatted using the precision setting specified in the instrument’s iDAS configuration. However, iDAS data are always downloaded in their full resolution, hence, the precision of downloaded data can be changed for viewing or saving by editing the parameter’s properties and changing the precision as desired. 4.10.
APIcom Instruction Manual iDAS Configuration and Data Access 4.12. Downloading iDAS Data Automatically APIcom can be configured to download iDAS data automatically at periodic intervals. Different intervals and record selection criteria can be chosen for each channel. Each channel must be configured separately for automatic download using the Advanced tab of the channel property dialog (see Figure 4-3). 4.12.1.
5. M700 CALIBRATOR SEQUENCES APIcom includes support for modifying the sequence configuration in M700 calibrators. APIcom can only modify the sequence configuration in M700 calibrators with firmware revision D.3 or higher. However, calibrators with firmware prior to D.3 can still be edited through the front panel. The user interface for sequence configuration is very similar to that for configuring the iDAS.
APIcom Instruction Manual Property M700 Calibrator Sequences Description Sends the sequence configuration in APIcom to the instrument. This will completely replace the instrument’s current sequence configuration. Loads a sequence configuration from a text file stored on the computer. This configuration many be edited and saved on the computer again, or it may be sent to an instrument.
APIcom Instruction Manual 5.4. M700 Calibrator Sequences Modifying a Sequence Configuration APIcom can only modify the sequence configuration in M700 calibrators with firmware revision D.3 or higher. This section assumes familiarity with configuring the sequences in an instrument.
APIcom Instruction Manual M700 Calibrator Sequences Figure 5-3: Sequence Properties Dialog The following table describes the properties shown above. Table 5-2: Sequence Properties Property Description Name Name of this sequence. The name cannot contain any spaces. Run mode Run one time: runs the sequence one time when it’s executed. This is the usual case. Run several times: runs the sequence the number of times specified (0-100).
APIcom Instruction Manual M700 Calibrator Sequences 5.4.2. Sequence Names When editing a sequence’s properties and clicking , APIcom checks that the sequence name is unique and contains valid characters. APIcom does not perform this check when downloading a configuration from an instrument or when loading a configuration from a file because it assumes that the names are already valid in these cases.
APIcom Instruction Manual M700 Calibrator Sequences Step Type Description GPT Generates a GPT consisting of NO and O3. GPT PRESET Generates a GPT-preset consisting of NO and O3. MANUAL Generates gas under manual control using the specified gas, flows, and O3 generator setting. PURGE Purges the system with high flowrate and zero air. STANDBY Stops all actions and puts calibrator in standby mode.
APIcom Instruction Manual M700 Calibrator Sequences 5.4.7. Generate Step Editing a Generate step will bring up the following dialog box. The properties are described in Table 5-4. Figure 5-8: Generate Step Properties Dialog The following table describes the properties shown above. Table 5-4: Generate Step Properties Property Description Concentration The numeric concentration to generate. Units The concentration unit to use. The M700 will perform any necessary unit conversions.
APIcom Instruction Manual M700 Calibrator Sequences Table 5-5: GPT and GPT Preset Step Properties Property Description O3 Conc. The numeric concentration of O3 gas to generate. O3 Units The O3 concentration unit to use. The M700 will perform any necessary unit conversions. NO Conc. The numeric concentration of NO gas to generate. NO Units The NO concentration units to use. 5.4.9. Manual Steps A Manual step will display the following property dialog. The properties are described in Table 5-6.
APIcom Instruction Manual M700 Calibrator Sequences The following table describes the property shown above. Table 5-7: Duration Step Properties Property Description Duration The duration of the step in minutes. 5.4.11. Execute Sequence Steps Property dialog box and properties table. Figure 5-13: Execute Sequence Step Properties Dialog The following table describes the property shown above.
APIcom Instruction Manual M700 Calibrator Sequences Figure 5-15: Set CC Output Step Properties Dialog The following table describes the property shown above. Table 5-10: Set CC Output Step Properties Property Description Output Pattern The contact closure outputs will be set to the pattern indicated by checkboxes 1–12 when the step is executed. 5.4.14.
APIcom Instruction Manual M700 Calibrator Sequences Figure 5-17: Sequence Send Configuration Confirmation Dialog If the send operation is successful, APIcom will display the following dialog box: Figure 5-18: Successful Sequence Send Dialog If the send operation is unsuccessful, APIcom will display the following dialog box.
6. ADVANCED FEATURES 6.1. Instrument Information Dialog Whenever APIcom connects to an instrument it interrogates the instrument to determine the type of instrument and its capabilities. Since APIcom supports all standard API instruments (except industrial ozone), there are many options to be supported on an instrument-by-instrument basis.
APIcom Instruction Manual Advanced Features Field Description Has AMX Yes = has AMX operating system. No = has older operating system. Has DAS Yes = Has DAS. No = Does not have DAS. Has New DAS Yes = Has DAS from standard library revision 3.0 that is flash-friendly and much faster. No = Earlier DAS. Has DAS Hex Command Yes = DAS supports HEX option to download records in compressed hex format. This is faster and more reliable than text format.
APIcom Instruction Manual Advanced Features Field Description Has XON/XOFF Flow Control Yes = Instrument has bi-directional XON/XOFF flow control. This is useful when using APIcom to upload large DAS or sequence configurations to the instrument. This does not mean that XON/XOFF flow control is enabled in this instrument, only that it is available. No = Instrument either lacks XON/XOFF flow control entirely or supports it only when sending data, and not when receiving. 6.2.
APIcom Instruction Manual Advanced Features Beware that the log files can get very large. For example, if automatic display updating at 5-second intervals is enabled, APIcom stores about 280 bytes per display update, per instrument in the log file. That works out to about 67.2 kbytes per hour, or about 1.6 MB per day, per instrument. Also, the log file is locked for access while APIcom is running. Timeout errors will always appear in the log file. These are not necessarily errors, though they might be.
APPENDIX A. FIRMWARE COMPATIBILITY A.1. Remote (RS-232) Configuration of iDAS Whereas the basic functionality (remote control of the front panel functions) of APIcom works with all of our standard analyzers, new features that are introduced from time to time may require updates of the analyzer's firmware. The iDAS feature built into AMX instruments was created around 1996. But the ability to configure the iDAS through the RS-232 interface wasn't added to the standard libraries until revision 2.1 in 1999.
APIcom Instruction Manual A.2. Advanced Features Number of Samples in Concentration Average Another new feature of APIcom is to store the number of samples in averaged iDAS concentration data. This feature is supported starting with the firmware revisions listed in the following table. Newer firmware also allows APIcom to use the internal iDAS clock when extracting a range of data (instead of "all" data). This feature speeds up download because it transfers only those data that were requested.
APIcom Instruction Manual 05499 Rev. A Advanced Features Instrument Firmware Revision Date M400A-AMX C.
