Evoware Commands & Types

This page lists the commands and types made available by the Evoware backend. Note that:

Types begin with an uppercase letter, whereas command and namespaces begin with a lowercase letter.
A namespace group related commands and types, such as the pipetter namespace contains items relevant to pipetting. Normally the namespaces will be nouns by convention.
As a matter of convention, all commands belong to a namespace. Normally commands will start with a verb. For example, pipetter.mix is a command to use the pipetter to mix well contents.
Commands and types that begin with an underscore, such as pipetter._mix, are low-level commands. Normally you will not need to use them and can use the other higher-level commands instead.

evoware

The evoware commands specify low-level instructions provided by the Evoware backend.

Properties:

Name	Type	Description	Required
type	string	Type of this object One of: EvowareRobot	required
config	object	configuration options for evoware

Properties:

Name	Type	Description	Required
type	string	Type of this object One of: EvowareWashProgram	required

An Evoware Execute command

Properties:

Name	Type	Description	Required
agent	Agent	Agent identifier
path	string	Path to program to execute	required
args	array	Arguments to pass to the exeternal program	required
wait	boolean	True, if Evoware should wait until the program finishes execution	required

An Evoware FACTS command

Properties:

Name	Type	Description	Required
agent	Agent	Agent identifier
factsEquipment	string		required
factsVariable	string		required
factsValue	string
labware	Plate

An Evoware direct command

Properties:

Name	Type	Description	Required
agent	Agent	Agent identifier
commands	string		required

An Evoware 'Subroutine' command

Properties:

Name	Type	Description	Required
agent	Agent	Agent identifier
filename	string	The filename of the subroutine file to call	required

An Evoware UserPrompt command

Properties:

Name	Type	Description	Required
agent	Agent	Agent identifier
text	string	Text to show the user	required
beep	integer	0: no beep, 1: beep once, 2: beep three times, 3: beep every 3 seconds
autoclose	integer	number of second to leave the prompt open before autoclosing it and continuing operation (-1 means no autoclose)

Set an Evoware variable

Properties:

Name	Type	Description	Required
agent	Agent	Agent identifier
name	string	Variable name	required
value	string,number	Variable value	required