Open topic with navigation
Using the API Commands in TEMPEST
You can find a list of API commands in the FORMULATRIX Liquid Dispenser API Service .chm help file in your local TEMPEST drive. API commands are categorized into Classes, Interfaces, and Enumerations. You can read through each category to see the description of the methods and parameters.
Important: API integration parameters should only be modified by automation engineers or authorized IT personnel on your site. Consult with your developers or engineers to set up the instruments’ integration. Contact support@formulatrix.com if you have any questions.
Prerequisites
- You have opened the TEMPEST software on your computer.
- You have run the Start Integration Service option from the Tools menu in the TEMPEST software.
To access the FORMULATRIX Liquid Dispenser API Service .chm file:
-
Go to the TEMPEST installation directory and open the API folder.
-
If you are running TEMPEST from a USB drive, go to USB drive:\TEMPEST\Bin\API\.
-
If you are running TEMPEST from your local drive, go to C:\Program Files (x86)\Formulatrix\TEMPEST\Bin\API\. Usually, the installed software will be located in C:\ drive.
API Folder Location in the Local Drive
-
Then, from the folder, open the TempestAPI .chm file.
TempestAPI .chm File
-
The default landing page will be ( Default Namespace ) Namespace section. Select the Formulatrix.LiquidDispenser.API option under the Contents tab.
-
To access the TEMPEST dispensing API commands, choose from the following options:
-
Expand the Formulatrix.LiquidDispenser.API option, then select ILiquidDispenserService Interface.
-
Click Formulatrix.LiquidDispenser.API, and then open ILiquidDispenserService Interface under the Interfaces category.
Formulatrix.LiquidDispenser.API Option/Namespace
-
In the ILiquidDispenserService Interface, you can find a list of commands under the Methods section. See the TEMPEST API Commands for more information.
The API Commands under the Methods Section
Note: FORMULATRIX provides a sample code that is written in C# on how to use the API commands in TEMPEST. Go to the following location to access the files.
• VS2017 sample code: {Installation Directory}:\Bin\API\SampleVS2017
Best practices on how to use the API commands
Below are some best practices that demonstrate the most efficient way to use the TEMPEST API commands, each one is followed by an example:
Note: Comments highlighted in Green provide additional information.
-
Get the status of the current API execution before calling the next commands.
Most of the TEMPEST APIs are non-blocking calls, which means that the program will proceed to the next method without waiting for the current method to finish. Call the GetStatus() command to check the API execution status from the client software application. If the API status is BUSY, it is recommended that you wait before calling the next commands. Follow the sample code below to get the status.
-
Check and clear any errors that may occur after the API execution.
Checking for any possible errors after the latest API call is recommended. If an error occurs, the client software needs to call ClearCurrentErrorMessage to get the error’s information and clear it. Follow the sample code below to check and clear errors.
-
Check the TEMPEST status and errors before executing a command.
When the errors have been checked and cleared, it is best to again check the TEMPEST status before calling the next command. The following sample code describes how to call the WashAllInput command by initially checking the TEMPEST status and any errors after the latest API call.
-
Assign reagents to the inputs.
Before executing the dispense, you will need to assign the reagents (stocks) to the inputs by calling the SetInputStock command. Follow the sample code below to call SetInputStock command.
-
Load and run a Dispense List
When the reagents have been assigned to the inputs, you will need to load a dispense list by calling the LoadDispenseList command. Follow the sample code below to load a dispense list.
-
Load and run a protocol
You can also load and run a dispense protocol by using LoadProtocol and Run commands by following the sample code below.
Related Topics
|
|
|
| TOW-V38R123
|
|