Bootprint

protocol-schema: string

A version string for the Opentrons JSON Protocol schema being used. ".."

metadata: object

Optional metadata about the protocol

protocol-name: string: A short, human-readable name for the protocol
author: string: The author or organization who created the protocol
description: string: A text description of the protocol. For guidelines about how to write a good description, see (TODO WRITE DOCS & LINK HERE)
created: number: UNIX timestamp when this file was created
last-modified: number: UNIX timestamp when this file was last modified
category: string: Category of protocol (eg, "Basic Pipetting")
subcategory: string: Subcategory of protocol (eg, "Cell Plating")
tags: string[]: Tags to be used in searching for this protocol

string

designer-application: object

Optional data & metadata not required to execute the protocol, used by the application that created this protocol

application-name: string: Name of the application that created the protocol. Should be namespaced under the organization or individual who owns the organization, and be kebab-cased, eg "opentrons/protocol-designer"
application-version: string: Version of the application that created the protocol
data: object: Any data used by the application that created this protocol)

robot: object

model: string , x ∈ { OT-2 Standard }: Model of the robot this (currently only OT-2 Standard is supported)

pipettes: object

The pipettes used in this protocol, keyed by an arbitrary unique ID

labware: object

The labware used in this protocol, keyed by an arbitrary unique ID

procedure: object[]

An array of "subprocedure" objects representing the steps to be executed on the robot

object

annotation: object

Optional info annotating the subprocedure

subprocedure: []

object

Aspirate / dispense / air gap commands

command: object , x ∈ { aspirate , dispense , air-gap }

params:

pipette-access-params

object

Pick up tip / drop tip / touch tip / blowout commands

command: object , x ∈ { pick-up-tip , drop-tip , touch-tip , blowout }

params:

pipette-access-params

object

Delay command

command: object , x ∈ { delay }

params: object

wait:

either a number of seconds to wait (fractional values OK), or true to wait indefinitely until the user manually resumes the protocol

message: object

optional message describing the delay

Definitions