DataApex Clarity (HPLC software)

Clarity is a chromatography data software for data acquisition, processing, and instrument control that can be controlled via a command line interface (CLI) as described on the manufacturer website.

In flowchem we provide a device type, named Clarity, to control local Clarity instances via HTTP with flowchem API.

Configuration

Configuration sample showing all possible parameters:

[device.hplc]  # This is the 'device' identifier
type = "Clarity"

# Optional paramters (default shown)
executable = "C:\\claritychrom\\bin\\claritychrom.exe"
instrument_number = 1  # Specify the instrument to be controlled (if the same Clarity instance has more than one)
startup-time = 20  # Max time necessary to start-up Clarity and connect all the instrument specified in the configuration
startup-method = "startup-method.met"  # Method sent to the device upon startup.
cmd_timeout =  3  # Max amount of time (in s) to wait for the execution of claritychrom.exe commands.
user = "admin"  # Default user name
password = ""  # Empty or option not present for no password
clarity-cfg-file = ""  # Configuration file for Clarity, if e.g. LaunchManager is used to save different configutations

API methods

Once configured, a flowchem Clarity object will expose the following commands:

PUT /hplc/run

Run

Run one analysis on the instrument. The sample name has to be set in advance via sample-name.

Note that it takes at least 2 sec until the run actually starts (depending on instrument configuration). While the export of the chromatogram in e.g. ASCII format can be achieved programmatically via the CLI, the best solution is to enable automatic data export for all runs of the HPLC as the chromatogram will be automatically exported as soon as the run is finished.

Status Codes

  • 200 OK – Successful Response

PUT /hplc/method

Set Method

Sets the HPLC method (i.e. a file with .MET extension) to the instrument.

Make sure to select ‘Send Method to Instrument’ option in Method Sending Options dialog in System Configuration.

Query Parameters

  • method_name (string) – (Required)

Status Codes
PUT /hplc/sample-name

Set Sample Name

Sets the name of the sample for the next run.

Query Parameters

  • sample_name (string) – (Required)

Status Codes
PUT /hplc/exit

Exit

Exit Clarity Chrom.

Status Codes

  • 200 OK – Successful Response

Further information

Only few of the commands available through Clarity CLI are exposed via flowchem. It is possible to add support for more commands if necessary, please refer to the manufacturer website for a list of all the available options.