@opentrons/shared-data 0.1.0-beta.2 → 0.1.0-beta.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (504) hide show
  1. package/Makefile +2 -1
  2. package/package.json +1 -1
  3. package/lib/command/schemas/7.json +0 -3301
  4. package/lib/command/schemas/8.json +0 -3831
  5. package/lib/command/types/annotation.d.ts +0 -24
  6. package/lib/command/types/calibration.d.ts +0 -58
  7. package/lib/command/types/gantry.d.ts +0 -132
  8. package/lib/command/types/incidental.d.ts +0 -15
  9. package/lib/command/types/index.d.ts +0 -41
  10. package/lib/command/types/module.d.ts +0 -191
  11. package/lib/command/types/pipetting.d.ts +0 -194
  12. package/lib/command/types/setup.d.ts +0 -147
  13. package/lib/command/types/timing.d.ts +0 -39
  14. package/lib/commandAnnotation/schemas/1.json +0 -74
  15. package/lib/commandAnnotation/types/index.d.ts +0 -19
  16. package/lib/deck/definitions/3/ot2_short_trash.json +0 -477
  17. package/lib/deck/definitions/3/ot2_standard.json +0 -477
  18. package/lib/deck/definitions/3/ot3_standard.json +0 -989
  19. package/lib/deck/definitions/4/ot2_short_trash.json +0 -405
  20. package/lib/deck/definitions/4/ot2_standard.json +0 -405
  21. package/lib/deck/definitions/4/ot3_standard.json +0 -609
  22. package/lib/deck/fixtures/3/deckExample.json +0 -481
  23. package/lib/deck/index.d.ts +0 -1
  24. package/lib/deck/schemas/1.json +0 -229
  25. package/lib/deck/schemas/2.json +0 -239
  26. package/lib/deck/schemas/3.json +0 -296
  27. package/lib/deck/schemas/4.json +0 -319
  28. package/lib/deck/types/schemaV4.d.ts +0 -9
  29. package/lib/errors/definitions/1/errors.json +0 -226
  30. package/lib/errors/schemas/1.json +0 -49
  31. package/lib/gripper/definitions/1/gripperV1.1.json +0 -29
  32. package/lib/gripper/definitions/1/gripperV1.2.json +0 -29
  33. package/lib/gripper/definitions/1/gripperV1.json +0 -28
  34. package/lib/gripper/schemas/1.json +0 -186
  35. package/lib/labware/definitions/1/12-well-plate.json +0 -147
  36. package/lib/labware/definitions/1/24-vial-rack.json +0 -281
  37. package/lib/labware/definitions/1/24-well-plate.json +0 -281
  38. package/lib/labware/definitions/1/384-plate.json +0 -4667
  39. package/lib/labware/definitions/1/48-vial-plate.json +0 -547
  40. package/lib/labware/definitions/1/48-well-plate.json +0 -547
  41. package/lib/labware/definitions/1/5ml-3x4.json +0 -147
  42. package/lib/labware/definitions/1/6-well-plate.json +0 -80
  43. package/lib/labware/definitions/1/96-PCR-flat.json +0 -1079
  44. package/lib/labware/definitions/1/96-PCR-tall.json +0 -1079
  45. package/lib/labware/definitions/1/96-deep-well.json +0 -1079
  46. package/lib/labware/definitions/1/96-flat.json +0 -1079
  47. package/lib/labware/definitions/1/96-well-plate-20mm.json +0 -1079
  48. package/lib/labware/definitions/1/MALDI-plate.json +0 -4282
  49. package/lib/labware/definitions/1/PCR-strip-tall.json +0 -1079
  50. package/lib/labware/definitions/1/T25-flask.json +0 -20
  51. package/lib/labware/definitions/1/T75-flask.json +0 -20
  52. package/lib/labware/definitions/1/alum-block-pcr-strips.json +0 -188
  53. package/lib/labware/definitions/1/biorad-hardshell-96-PCR.json +0 -1079
  54. package/lib/labware/definitions/1/e-gelgol.json +0 -1078
  55. package/lib/labware/definitions/1/fixed-trash.json +0 -19
  56. package/lib/labware/definitions/1/hampton-1ml-deep-block.json +0 -1078
  57. package/lib/labware/definitions/1/opentrons-aluminum-block-2ml-eppendorf.json +0 -281
  58. package/lib/labware/definitions/1/opentrons-aluminum-block-2ml-screwcap.json +0 -281
  59. package/lib/labware/definitions/1/opentrons-aluminum-block-96-PCR-plate.json +0 -1079
  60. package/lib/labware/definitions/1/opentrons-aluminum-block-PCR-strips-200ul.json +0 -1079
  61. package/lib/labware/definitions/1/opentrons-tiprack-10ul.json +0 -986
  62. package/lib/labware/definitions/1/opentrons-tiprack-300ul.json +0 -986
  63. package/lib/labware/definitions/1/opentrons-tuberack-1.5ml-eppendorf.json +0 -281
  64. package/lib/labware/definitions/1/opentrons-tuberack-15_50ml.json +0 -125
  65. package/lib/labware/definitions/1/opentrons-tuberack-15ml.json +0 -181
  66. package/lib/labware/definitions/1/opentrons-tuberack-2ml-eppendorf.json +0 -281
  67. package/lib/labware/definitions/1/opentrons-tuberack-2ml-screwcap.json +0 -281
  68. package/lib/labware/definitions/1/opentrons-tuberack-50ml.json +0 -80
  69. package/lib/labware/definitions/1/point.json +0 -18
  70. package/lib/labware/definitions/1/rigaku-compact-crystallization-plate.json +0 -2146
  71. package/lib/labware/definitions/1/small_vial_rack_16x45.json +0 -280
  72. package/lib/labware/definitions/1/tall-fixed-trash.json +0 -19
  73. package/lib/labware/definitions/1/tiprack-1000ul-H.json +0 -503
  74. package/lib/labware/definitions/1/tiprack-1000ul-chem.json +0 -1034
  75. package/lib/labware/definitions/1/tiprack-1000ul.json +0 -986
  76. package/lib/labware/definitions/1/tiprack-10ul-H.json +0 -503
  77. package/lib/labware/definitions/1/tiprack-10ul.json +0 -986
  78. package/lib/labware/definitions/1/tiprack-200ul.json +0 -986
  79. package/lib/labware/definitions/1/trash-box.json +0 -20
  80. package/lib/labware/definitions/1/trough-12row-short.json +0 -143
  81. package/lib/labware/definitions/1/trough-12row.json +0 -143
  82. package/lib/labware/definitions/1/trough-1row-25ml.json +0 -21
  83. package/lib/labware/definitions/1/tube-rack-.75ml.json +0 -281
  84. package/lib/labware/definitions/1/tube-rack-15_50ml.json +0 -125
  85. package/lib/labware/definitions/1/tube-rack-2ml-9x9.json +0 -911
  86. package/lib/labware/definitions/1/tube-rack-2ml.json +0 -281
  87. package/lib/labware/definitions/1/tube-rack-5ml-96.json +0 -1079
  88. package/lib/labware/definitions/1/tube-rack-80well.json +0 -907
  89. package/lib/labware/definitions/1/wheaton_vial_rack.json +0 -565
  90. package/lib/labware/definitions/2/agilent_1_reservoir_290ml/1.json +0 -54
  91. package/lib/labware/definitions/2/appliedbiosystemsmicroamp_384_wellplate_40ul/1.json +0 -4320
  92. package/lib/labware/definitions/2/armadillo_96_wellplate_200ul_pcr_full_skirt/1.json +0 -1019
  93. package/lib/labware/definitions/2/armadillo_96_wellplate_200ul_pcr_full_skirt/2.json +0 -1045
  94. package/lib/labware/definitions/2/axygen_1_reservoir_90ml/1.json +0 -56
  95. package/lib/labware/definitions/2/biorad_384_wellplate_50ul/1.json +0 -4329
  96. package/lib/labware/definitions/2/biorad_384_wellplate_50ul/2.json +0 -4331
  97. package/lib/labware/definitions/2/biorad_96_wellplate_200ul_pcr/1.json +0 -1020
  98. package/lib/labware/definitions/2/biorad_96_wellplate_200ul_pcr/2.json +0 -1046
  99. package/lib/labware/definitions/2/corning_12_wellplate_6.9ml_flat/1.json +0 -171
  100. package/lib/labware/definitions/2/corning_12_wellplate_6.9ml_flat/2.json +0 -180
  101. package/lib/labware/definitions/2/corning_24_wellplate_3.4ml_flat/1.json +0 -293
  102. package/lib/labware/definitions/2/corning_24_wellplate_3.4ml_flat/2.json +0 -300
  103. package/lib/labware/definitions/2/corning_384_wellplate_112ul_flat/1.json +0 -4703
  104. package/lib/labware/definitions/2/corning_384_wellplate_112ul_flat/2.json +0 -4717
  105. package/lib/labware/definitions/2/corning_48_wellplate_1.6ml_flat/1.json +0 -535
  106. package/lib/labware/definitions/2/corning_48_wellplate_1.6ml_flat/2.json +0 -544
  107. package/lib/labware/definitions/2/corning_6_wellplate_16.8ml_flat/1.json +0 -103
  108. package/lib/labware/definitions/2/corning_6_wellplate_16.8ml_flat/2.json +0 -110
  109. package/lib/labware/definitions/2/corning_96_wellplate_360ul_flat/1.json +0 -1049
  110. package/lib/labware/definitions/2/corning_96_wellplate_360ul_flat/2.json +0 -1063
  111. package/lib/labware/definitions/2/eppendorf_96_tiprack_1000ul_eptips/1.json +0 -1019
  112. package/lib/labware/definitions/2/eppendorf_96_tiprack_10ul_eptips/1.json +0 -1019
  113. package/lib/labware/definitions/2/geb_96_tiprack_1000ul/1.json +0 -1017
  114. package/lib/labware/definitions/2/geb_96_tiprack_10ul/1.json +0 -1017
  115. package/lib/labware/definitions/2/nest_12_reservoir_15ml/1.json +0 -190
  116. package/lib/labware/definitions/2/nest_1_reservoir_195ml/1.json +0 -54
  117. package/lib/labware/definitions/2/nest_1_reservoir_195ml/2.json +0 -56
  118. package/lib/labware/definitions/2/nest_1_reservoir_290ml/1.json +0 -54
  119. package/lib/labware/definitions/2/nest_96_wellplate_100ul_pcr_full_skirt/1.json +0 -1018
  120. package/lib/labware/definitions/2/nest_96_wellplate_100ul_pcr_full_skirt/2.json +0 -1039
  121. package/lib/labware/definitions/2/nest_96_wellplate_200ul_flat/1.json +0 -1017
  122. package/lib/labware/definitions/2/nest_96_wellplate_200ul_flat/2.json +0 -1031
  123. package/lib/labware/definitions/2/nest_96_wellplate_2ml_deep/1.json +0 -1121
  124. package/lib/labware/definitions/2/nest_96_wellplate_2ml_deep/2.json +0 -1137
  125. package/lib/labware/definitions/2/opentrons_10_tuberack_falcon_4x50ml_6x15ml_conical/1.json +0 -164
  126. package/lib/labware/definitions/2/opentrons_10_tuberack_falcon_4x50ml_6x15ml_conical_acrylic/1.json +0 -162
  127. package/lib/labware/definitions/2/opentrons_10_tuberack_nest_4x50ml_6x15ml_conical/1.json +0 -160
  128. package/lib/labware/definitions/2/opentrons_15_tuberack_falcon_15ml_conical/1.json +0 -211
  129. package/lib/labware/definitions/2/opentrons_15_tuberack_nest_15ml_conical/1.json +0 -209
  130. package/lib/labware/definitions/2/opentrons_1_trash_1100ml_fixed/1.json +0 -50
  131. package/lib/labware/definitions/2/opentrons_1_trash_3200ml_fixed/1.json +0 -50
  132. package/lib/labware/definitions/2/opentrons_1_trash_850ml_fixed/1.json +0 -50
  133. package/lib/labware/definitions/2/opentrons_24_aluminumblock_generic_2ml_screwcap/1.json +0 -300
  134. package/lib/labware/definitions/2/opentrons_24_aluminumblock_generic_2ml_screwcap/2.json +0 -301
  135. package/lib/labware/definitions/2/opentrons_24_aluminumblock_nest_0.5ml_screwcap/1.json +0 -299
  136. package/lib/labware/definitions/2/opentrons_24_aluminumblock_nest_1.5ml_screwcap/1.json +0 -299
  137. package/lib/labware/definitions/2/opentrons_24_aluminumblock_nest_1.5ml_snapcap/1.json +0 -301
  138. package/lib/labware/definitions/2/opentrons_24_aluminumblock_nest_2ml_screwcap/1.json +0 -299
  139. package/lib/labware/definitions/2/opentrons_24_aluminumblock_nest_2ml_snapcap/1.json +0 -301
  140. package/lib/labware/definitions/2/opentrons_24_tuberack_eppendorf_1.5ml_safelock_snapcap/1.json +0 -312
  141. package/lib/labware/definitions/2/opentrons_24_tuberack_eppendorf_2ml_safelock_snapcap/1.json +0 -311
  142. package/lib/labware/definitions/2/opentrons_24_tuberack_eppendorf_2ml_safelock_snapcap_acrylic/1.json +0 -309
  143. package/lib/labware/definitions/2/opentrons_24_tuberack_generic_0.75ml_snapcap_acrylic/1.json +0 -298
  144. package/lib/labware/definitions/2/opentrons_24_tuberack_generic_2ml_screwcap/1.json +0 -300
  145. package/lib/labware/definitions/2/opentrons_24_tuberack_nest_0.5ml_screwcap/1.json +0 -300
  146. package/lib/labware/definitions/2/opentrons_24_tuberack_nest_1.5ml_screwcap/1.json +0 -300
  147. package/lib/labware/definitions/2/opentrons_24_tuberack_nest_1.5ml_snapcap/1.json +0 -302
  148. package/lib/labware/definitions/2/opentrons_24_tuberack_nest_2ml_screwcap/1.json +0 -300
  149. package/lib/labware/definitions/2/opentrons_24_tuberack_nest_2ml_snapcap/1.json +0 -302
  150. package/lib/labware/definitions/2/opentrons_40_aluminumblock_eppendorf_24x2ml_safelock_snapcap_generic_16x0.2ml_pcr_strip/1.json +0 -481
  151. package/lib/labware/definitions/2/opentrons_6_tuberack_falcon_50ml_conical/1.json +0 -112
  152. package/lib/labware/definitions/2/opentrons_6_tuberack_nest_50ml_conical/1.json +0 -110
  153. package/lib/labware/definitions/2/opentrons_96_aluminumblock_biorad_wellplate_200ul/1.json +0 -1029
  154. package/lib/labware/definitions/2/opentrons_96_aluminumblock_generic_pcr_strip_200ul/1.json +0 -1026
  155. package/lib/labware/definitions/2/opentrons_96_aluminumblock_generic_pcr_strip_200ul/2.json +0 -1027
  156. package/lib/labware/definitions/2/opentrons_96_aluminumblock_nest_wellplate_100ul/1.json +0 -1027
  157. package/lib/labware/definitions/2/opentrons_96_deep_well_adapter/1.json +0 -41
  158. package/lib/labware/definitions/2/opentrons_96_deep_well_adapter_nest_wellplate_2ml_deep/1.json +0 -1121
  159. package/lib/labware/definitions/2/opentrons_96_filtertiprack_1000ul/1.json +0 -1017
  160. package/lib/labware/definitions/2/opentrons_96_filtertiprack_10ul/1.json +0 -1017
  161. package/lib/labware/definitions/2/opentrons_96_filtertiprack_200ul/1.json +0 -1017
  162. package/lib/labware/definitions/2/opentrons_96_filtertiprack_20ul/1.json +0 -1017
  163. package/lib/labware/definitions/2/opentrons_96_flat_bottom_adapter/1.json +0 -41
  164. package/lib/labware/definitions/2/opentrons_96_flat_bottom_adapter_nest_wellplate_200ul_flat/1.json +0 -1027
  165. package/lib/labware/definitions/2/opentrons_96_pcr_adapter/1.json +0 -1032
  166. package/lib/labware/definitions/2/opentrons_96_pcr_adapter_armadillo_wellplate_200ul/1.json +0 -1027
  167. package/lib/labware/definitions/2/opentrons_96_pcr_adapter_nest_wellplate_100ul_pcr_full_skirt/1.json +0 -1025
  168. package/lib/labware/definitions/2/opentrons_96_tiprack_1000ul/1.json +0 -1019
  169. package/lib/labware/definitions/2/opentrons_96_tiprack_10ul/1.json +0 -1019
  170. package/lib/labware/definitions/2/opentrons_96_tiprack_20ul/1.json +0 -1019
  171. package/lib/labware/definitions/2/opentrons_96_tiprack_300ul/1.json +0 -1019
  172. package/lib/labware/definitions/2/opentrons_96_well_aluminum_block/1.json +0 -1032
  173. package/lib/labware/definitions/2/opentrons_96_wellplate_200ul_pcr_full_skirt/1.json +0 -1019
  174. package/lib/labware/definitions/2/opentrons_96_wellplate_200ul_pcr_full_skirt/2.json +0 -1045
  175. package/lib/labware/definitions/2/opentrons_aluminum_flat_bottom_plate/1.json +0 -41
  176. package/lib/labware/definitions/2/opentrons_calibration_adapter_heatershaker_module/1.json +0 -62
  177. package/lib/labware/definitions/2/opentrons_calibration_adapter_temperature_module/1.json +0 -62
  178. package/lib/labware/definitions/2/opentrons_calibration_adapter_thermocycler_module/1.json +0 -69
  179. package/lib/labware/definitions/2/opentrons_calibrationblock_short_side_left/1.json +0 -71
  180. package/lib/labware/definitions/2/opentrons_calibrationblock_short_side_right/1.json +0 -71
  181. package/lib/labware/definitions/2/opentrons_flex_96_filtertiprack_1000ul/1.json +0 -1026
  182. package/lib/labware/definitions/2/opentrons_flex_96_filtertiprack_200ul/1.json +0 -1026
  183. package/lib/labware/definitions/2/opentrons_flex_96_filtertiprack_50ul/1.json +0 -1026
  184. package/lib/labware/definitions/2/opentrons_flex_96_tiprack_1000ul/1.json +0 -1026
  185. package/lib/labware/definitions/2/opentrons_flex_96_tiprack_200ul/1.json +0 -1026
  186. package/lib/labware/definitions/2/opentrons_flex_96_tiprack_50ul/1.json +0 -1026
  187. package/lib/labware/definitions/2/opentrons_flex_96_tiprack_adapter/1.json +0 -41
  188. package/lib/labware/definitions/2/opentrons_universal_flat_adapter/1.json +0 -151
  189. package/lib/labware/definitions/2/opentrons_universal_flat_adapter_corning_384_wellplate_112ul_flat/1.json +0 -4710
  190. package/lib/labware/definitions/2/thermoscientificnunc_96_wellplate_1300ul/1.json +0 -1019
  191. package/lib/labware/definitions/2/thermoscientificnunc_96_wellplate_2000ul/1.json +0 -1019
  192. package/lib/labware/definitions/2/tipone_96_tiprack_200ul/1.json +0 -1017
  193. package/lib/labware/definitions/2/usascientific_12_reservoir_22ml/1.json +0 -192
  194. package/lib/labware/definitions/2/usascientific_96_wellplate_2.4ml_deep/1.json +0 -1116
  195. package/lib/labware/fixtures/1/fixture_tiprack.json +0 -986
  196. package/lib/labware/fixtures/2/fixture_12_trough.json +0 -188
  197. package/lib/labware/fixtures/2/fixture_12_trough_v2.json +0 -188
  198. package/lib/labware/fixtures/2/fixture_24_tuberack.json +0 -295
  199. package/lib/labware/fixtures/2/fixture_384_plate.json +0 -4316
  200. package/lib/labware/fixtures/2/fixture_96_plate.json +0 -1015
  201. package/lib/labware/fixtures/2/fixture_flex_96_tiprack_1000ul.json +0 -1026
  202. package/lib/labware/fixtures/2/fixture_flex_96_tiprack_adapter.json +0 -41
  203. package/lib/labware/fixtures/2/fixture_irregular_example_1.json +0 -600
  204. package/lib/labware/fixtures/2/fixture_overlappy_wellplate.json +0 -1113
  205. package/lib/labware/fixtures/2/fixture_regular_example_1.json +0 -57
  206. package/lib/labware/fixtures/2/fixture_regular_example_2.json +0 -95
  207. package/lib/labware/fixtures/2/fixture_tiprack_1000_ul.json +0 -1015
  208. package/lib/labware/fixtures/2/fixture_tiprack_10_ul.json +0 -1015
  209. package/lib/labware/fixtures/2/fixture_tiprack_300_ul.json +0 -1014
  210. package/lib/labware/fixtures/2/fixture_trash.json +0 -50
  211. package/lib/labware/schemas/2.json +0 -372
  212. package/lib/liquid/schemas/1.json +0 -21
  213. package/lib/liquid/types/index.d.ts +0 -5
  214. package/lib/module/definitions/1.json +0 -57
  215. package/lib/module/definitions/2/magneticModuleV1.json +0 -22
  216. package/lib/module/definitions/2/magneticModuleV2.json +0 -69
  217. package/lib/module/definitions/2/temperatureModuleV1.json +0 -22
  218. package/lib/module/definitions/2/temperatureModuleV2.json +0 -69
  219. package/lib/module/definitions/2/thermocyclerModuleV1.json +0 -23
  220. package/lib/module/definitions/3/heaterShakerModuleV1.json +0 -521
  221. package/lib/module/definitions/3/magneticBlockV1.json +0 -199
  222. package/lib/module/definitions/3/magneticModuleV1.json +0 -435
  223. package/lib/module/definitions/3/magneticModuleV2.json +0 -488
  224. package/lib/module/definitions/3/temperatureModuleV1.json +0 -190
  225. package/lib/module/definitions/3/temperatureModuleV2.json +0 -315
  226. package/lib/module/definitions/3/thermocyclerModuleV1.json +0 -1380
  227. package/lib/module/definitions/3/thermocyclerModuleV2.json +0 -3686
  228. package/lib/module/fixtures/3/compatibleGenerationV1.json +0 -69
  229. package/lib/module/fixtures/3/compatibleGenerationV2.json +0 -69
  230. package/lib/module/fixtures/3/incompatibleGenerationV1.json +0 -22
  231. package/lib/module/fixtures/3/incompatibleGenerationV2.json +0 -69
  232. package/lib/module/schemas/1.json +0 -54
  233. package/lib/module/schemas/2.json +0 -112
  234. package/lib/module/schemas/3.json +0 -206
  235. package/lib/pipette/definitions/1/pipetteModelSpecs.json +0 -10197
  236. package/lib/pipette/definitions/1/pipetteNameSpecs.json +0 -694
  237. package/lib/pipette/definitions/2/general/eight_channel/p10/1_0.json +0 -59
  238. package/lib/pipette/definitions/2/general/eight_channel/p10/1_3.json +0 -59
  239. package/lib/pipette/definitions/2/general/eight_channel/p10/1_4.json +0 -59
  240. package/lib/pipette/definitions/2/general/eight_channel/p10/1_5.json +0 -59
  241. package/lib/pipette/definitions/2/general/eight_channel/p10/1_6.json +0 -59
  242. package/lib/pipette/definitions/2/general/eight_channel/p1000/1_0.json +0 -68
  243. package/lib/pipette/definitions/2/general/eight_channel/p1000/3_0.json +0 -68
  244. package/lib/pipette/definitions/2/general/eight_channel/p1000/3_3.json +0 -68
  245. package/lib/pipette/definitions/2/general/eight_channel/p1000/3_4.json +0 -68
  246. package/lib/pipette/definitions/2/general/eight_channel/p1000/3_5.json +0 -68
  247. package/lib/pipette/definitions/2/general/eight_channel/p20/2_0.json +0 -59
  248. package/lib/pipette/definitions/2/general/eight_channel/p20/2_1.json +0 -59
  249. package/lib/pipette/definitions/2/general/eight_channel/p300/1_0.json +0 -59
  250. package/lib/pipette/definitions/2/general/eight_channel/p300/1_3.json +0 -59
  251. package/lib/pipette/definitions/2/general/eight_channel/p300/1_4.json +0 -59
  252. package/lib/pipette/definitions/2/general/eight_channel/p300/1_5.json +0 -59
  253. package/lib/pipette/definitions/2/general/eight_channel/p300/2_0.json +0 -59
  254. package/lib/pipette/definitions/2/general/eight_channel/p300/2_1.json +0 -59
  255. package/lib/pipette/definitions/2/general/eight_channel/p50/1_0.json +0 -59
  256. package/lib/pipette/definitions/2/general/eight_channel/p50/1_3.json +0 -59
  257. package/lib/pipette/definitions/2/general/eight_channel/p50/1_4.json +0 -59
  258. package/lib/pipette/definitions/2/general/eight_channel/p50/1_5.json +0 -59
  259. package/lib/pipette/definitions/2/general/eight_channel/p50/3_0.json +0 -74
  260. package/lib/pipette/definitions/2/general/eight_channel/p50/3_3.json +0 -74
  261. package/lib/pipette/definitions/2/general/eight_channel/p50/3_4.json +0 -74
  262. package/lib/pipette/definitions/2/general/eight_channel/p50/3_5.json +0 -74
  263. package/lib/pipette/definitions/2/general/ninety_six_channel/p1000/1_0.json +0 -87
  264. package/lib/pipette/definitions/2/general/ninety_six_channel/p1000/3_0.json +0 -92
  265. package/lib/pipette/definitions/2/general/ninety_six_channel/p1000/3_3.json +0 -87
  266. package/lib/pipette/definitions/2/general/ninety_six_channel/p1000/3_4.json +0 -87
  267. package/lib/pipette/definitions/2/general/ninety_six_channel/p1000/3_5.json +0 -87
  268. package/lib/pipette/definitions/2/general/single_channel/p10/1_0.json +0 -52
  269. package/lib/pipette/definitions/2/general/single_channel/p10/1_3.json +0 -52
  270. package/lib/pipette/definitions/2/general/single_channel/p10/1_4.json +0 -52
  271. package/lib/pipette/definitions/2/general/single_channel/p10/1_5.json +0 -52
  272. package/lib/pipette/definitions/2/general/single_channel/p1000/1_0.json +0 -52
  273. package/lib/pipette/definitions/2/general/single_channel/p1000/1_3.json +0 -52
  274. package/lib/pipette/definitions/2/general/single_channel/p1000/1_4.json +0 -52
  275. package/lib/pipette/definitions/2/general/single_channel/p1000/1_5.json +0 -52
  276. package/lib/pipette/definitions/2/general/single_channel/p1000/2_0.json +0 -52
  277. package/lib/pipette/definitions/2/general/single_channel/p1000/2_1.json +0 -52
  278. package/lib/pipette/definitions/2/general/single_channel/p1000/2_2.json +0 -52
  279. package/lib/pipette/definitions/2/general/single_channel/p1000/3_0.json +0 -61
  280. package/lib/pipette/definitions/2/general/single_channel/p1000/3_3.json +0 -61
  281. package/lib/pipette/definitions/2/general/single_channel/p1000/3_4.json +0 -61
  282. package/lib/pipette/definitions/2/general/single_channel/p1000/3_5.json +0 -61
  283. package/lib/pipette/definitions/2/general/single_channel/p1000/3_6.json +0 -61
  284. package/lib/pipette/definitions/2/general/single_channel/p20/2_0.json +0 -52
  285. package/lib/pipette/definitions/2/general/single_channel/p20/2_1.json +0 -52
  286. package/lib/pipette/definitions/2/general/single_channel/p20/2_2.json +0 -52
  287. package/lib/pipette/definitions/2/general/single_channel/p300/1_0.json +0 -52
  288. package/lib/pipette/definitions/2/general/single_channel/p300/1_3.json +0 -52
  289. package/lib/pipette/definitions/2/general/single_channel/p300/1_4.json +0 -52
  290. package/lib/pipette/definitions/2/general/single_channel/p300/1_5.json +0 -52
  291. package/lib/pipette/definitions/2/general/single_channel/p300/2_0.json +0 -52
  292. package/lib/pipette/definitions/2/general/single_channel/p300/2_1.json +0 -52
  293. package/lib/pipette/definitions/2/general/single_channel/p50/1_0.json +0 -52
  294. package/lib/pipette/definitions/2/general/single_channel/p50/1_3.json +0 -52
  295. package/lib/pipette/definitions/2/general/single_channel/p50/1_4.json +0 -52
  296. package/lib/pipette/definitions/2/general/single_channel/p50/1_5.json +0 -52
  297. package/lib/pipette/definitions/2/general/single_channel/p50/3_0.json +0 -67
  298. package/lib/pipette/definitions/2/general/single_channel/p50/3_3.json +0 -67
  299. package/lib/pipette/definitions/2/general/single_channel/p50/3_4.json +0 -67
  300. package/lib/pipette/definitions/2/general/single_channel/p50/3_5.json +0 -67
  301. package/lib/pipette/definitions/2/geometry/eight_channel/p10/1_0.json +0 -37
  302. package/lib/pipette/definitions/2/geometry/eight_channel/p10/1_3.json +0 -37
  303. package/lib/pipette/definitions/2/geometry/eight_channel/p10/1_4.json +0 -37
  304. package/lib/pipette/definitions/2/geometry/eight_channel/p10/1_5.json +0 -37
  305. package/lib/pipette/definitions/2/geometry/eight_channel/p10/1_6.json +0 -37
  306. package/lib/pipette/definitions/2/geometry/eight_channel/p1000/1_0.json +0 -37
  307. package/lib/pipette/definitions/2/geometry/eight_channel/p1000/3_0.json +0 -37
  308. package/lib/pipette/definitions/2/geometry/eight_channel/p1000/3_3.json +0 -37
  309. package/lib/pipette/definitions/2/geometry/eight_channel/p1000/3_4.json +0 -37
  310. package/lib/pipette/definitions/2/geometry/eight_channel/p1000/3_5.json +0 -37
  311. package/lib/pipette/definitions/2/geometry/eight_channel/p20/2_0.json +0 -37
  312. package/lib/pipette/definitions/2/geometry/eight_channel/p20/2_1.json +0 -37
  313. package/lib/pipette/definitions/2/geometry/eight_channel/p300/1_0.json +0 -37
  314. package/lib/pipette/definitions/2/geometry/eight_channel/p300/1_3.json +0 -37
  315. package/lib/pipette/definitions/2/geometry/eight_channel/p300/1_4.json +0 -37
  316. package/lib/pipette/definitions/2/geometry/eight_channel/p300/1_5.json +0 -37
  317. package/lib/pipette/definitions/2/geometry/eight_channel/p300/2_0.json +0 -37
  318. package/lib/pipette/definitions/2/geometry/eight_channel/p300/2_1.json +0 -37
  319. package/lib/pipette/definitions/2/geometry/eight_channel/p50/1_0.json +0 -37
  320. package/lib/pipette/definitions/2/geometry/eight_channel/p50/1_3.json +0 -37
  321. package/lib/pipette/definitions/2/geometry/eight_channel/p50/1_4.json +0 -37
  322. package/lib/pipette/definitions/2/geometry/eight_channel/p50/1_5.json +0 -37
  323. package/lib/pipette/definitions/2/geometry/eight_channel/p50/3_0.json +0 -37
  324. package/lib/pipette/definitions/2/geometry/eight_channel/p50/3_3.json +0 -37
  325. package/lib/pipette/definitions/2/geometry/eight_channel/p50/3_4.json +0 -37
  326. package/lib/pipette/definitions/2/geometry/eight_channel/p50/3_5.json +0 -37
  327. package/lib/pipette/definitions/2/geometry/ninety_six_channel/p1000/1_0.json +0 -291
  328. package/lib/pipette/definitions/2/geometry/ninety_six_channel/p1000/3_0.json +0 -291
  329. package/lib/pipette/definitions/2/geometry/ninety_six_channel/p1000/3_3.json +0 -291
  330. package/lib/pipette/definitions/2/geometry/ninety_six_channel/p1000/3_4.json +0 -291
  331. package/lib/pipette/definitions/2/geometry/ninety_six_channel/p1000/3_5.json +0 -291
  332. package/lib/pipette/definitions/2/geometry/single_channel/p10/1_0.json +0 -10
  333. package/lib/pipette/definitions/2/geometry/single_channel/p10/1_3.json +0 -10
  334. package/lib/pipette/definitions/2/geometry/single_channel/p10/1_4.json +0 -10
  335. package/lib/pipette/definitions/2/geometry/single_channel/p10/1_5.json +0 -10
  336. package/lib/pipette/definitions/2/geometry/single_channel/p1000/1_0.json +0 -10
  337. package/lib/pipette/definitions/2/geometry/single_channel/p1000/1_3.json +0 -10
  338. package/lib/pipette/definitions/2/geometry/single_channel/p1000/1_4.json +0 -10
  339. package/lib/pipette/definitions/2/geometry/single_channel/p1000/1_5.json +0 -10
  340. package/lib/pipette/definitions/2/geometry/single_channel/p1000/2_0.json +0 -10
  341. package/lib/pipette/definitions/2/geometry/single_channel/p1000/2_1.json +0 -10
  342. package/lib/pipette/definitions/2/geometry/single_channel/p1000/2_2.json +0 -10
  343. package/lib/pipette/definitions/2/geometry/single_channel/p1000/3_0.json +0 -10
  344. package/lib/pipette/definitions/2/geometry/single_channel/p1000/3_3.json +0 -10
  345. package/lib/pipette/definitions/2/geometry/single_channel/p1000/3_4.json +0 -10
  346. package/lib/pipette/definitions/2/geometry/single_channel/p1000/3_5.json +0 -10
  347. package/lib/pipette/definitions/2/geometry/single_channel/p1000/3_6.json +0 -10
  348. package/lib/pipette/definitions/2/geometry/single_channel/p20/2_0.json +0 -10
  349. package/lib/pipette/definitions/2/geometry/single_channel/p20/2_1.json +0 -10
  350. package/lib/pipette/definitions/2/geometry/single_channel/p20/2_2.json +0 -10
  351. package/lib/pipette/definitions/2/geometry/single_channel/p300/1_0.json +0 -10
  352. package/lib/pipette/definitions/2/geometry/single_channel/p300/1_3.json +0 -10
  353. package/lib/pipette/definitions/2/geometry/single_channel/p300/1_4.json +0 -10
  354. package/lib/pipette/definitions/2/geometry/single_channel/p300/1_5.json +0 -10
  355. package/lib/pipette/definitions/2/geometry/single_channel/p300/2_0.json +0 -10
  356. package/lib/pipette/definitions/2/geometry/single_channel/p300/2_1.json +0 -10
  357. package/lib/pipette/definitions/2/geometry/single_channel/p50/1_0.json +0 -10
  358. package/lib/pipette/definitions/2/geometry/single_channel/p50/1_3.json +0 -10
  359. package/lib/pipette/definitions/2/geometry/single_channel/p50/1_4.json +0 -10
  360. package/lib/pipette/definitions/2/geometry/single_channel/p50/1_5.json +0 -10
  361. package/lib/pipette/definitions/2/geometry/single_channel/p50/3_0.json +0 -10
  362. package/lib/pipette/definitions/2/geometry/single_channel/p50/3_3.json +0 -10
  363. package/lib/pipette/definitions/2/geometry/single_channel/p50/3_4.json +0 -10
  364. package/lib/pipette/definitions/2/geometry/single_channel/p50/3_5.json +0 -10
  365. package/lib/pipette/definitions/2/liquid/eight_channel/p10/default/1_0.json +0 -58
  366. package/lib/pipette/definitions/2/liquid/eight_channel/p10/default/1_3.json +0 -58
  367. package/lib/pipette/definitions/2/liquid/eight_channel/p10/default/1_4.json +0 -58
  368. package/lib/pipette/definitions/2/liquid/eight_channel/p10/default/1_5.json +0 -47
  369. package/lib/pipette/definitions/2/liquid/eight_channel/p10/default/1_6.json +0 -55
  370. package/lib/pipette/definitions/2/liquid/eight_channel/p1000/default/1_0.json +0 -356
  371. package/lib/pipette/definitions/2/liquid/eight_channel/p1000/default/3_0.json +0 -359
  372. package/lib/pipette/definitions/2/liquid/eight_channel/p1000/default/3_3.json +0 -359
  373. package/lib/pipette/definitions/2/liquid/eight_channel/p1000/default/3_4.json +0 -359
  374. package/lib/pipette/definitions/2/liquid/eight_channel/p1000/default/3_5.json +0 -239
  375. package/lib/pipette/definitions/2/liquid/eight_channel/p20/default/2_0.json +0 -311
  376. package/lib/pipette/definitions/2/liquid/eight_channel/p20/default/2_1.json +0 -191
  377. package/lib/pipette/definitions/2/liquid/eight_channel/p300/default/1_0.json +0 -67
  378. package/lib/pipette/definitions/2/liquid/eight_channel/p300/default/1_3.json +0 -67
  379. package/lib/pipette/definitions/2/liquid/eight_channel/p300/default/1_4.json +0 -67
  380. package/lib/pipette/definitions/2/liquid/eight_channel/p300/default/1_5.json +0 -67
  381. package/lib/pipette/definitions/2/liquid/eight_channel/p300/default/2_0.json +0 -190
  382. package/lib/pipette/definitions/2/liquid/eight_channel/p300/default/2_1.json +0 -190
  383. package/lib/pipette/definitions/2/liquid/eight_channel/p50/default/1_0.json +0 -128
  384. package/lib/pipette/definitions/2/liquid/eight_channel/p50/default/1_3.json +0 -128
  385. package/lib/pipette/definitions/2/liquid/eight_channel/p50/default/1_4.json +0 -128
  386. package/lib/pipette/definitions/2/liquid/eight_channel/p50/default/1_5.json +0 -110
  387. package/lib/pipette/definitions/2/liquid/eight_channel/p50/default/3_0.json +0 -99
  388. package/lib/pipette/definitions/2/liquid/eight_channel/p50/default/3_3.json +0 -99
  389. package/lib/pipette/definitions/2/liquid/eight_channel/p50/default/3_4.json +0 -99
  390. package/lib/pipette/definitions/2/liquid/eight_channel/p50/default/3_5.json +0 -91
  391. package/lib/pipette/definitions/2/liquid/eight_channel/p50/lowVolumeDefault/3_0.json +0 -94
  392. package/lib/pipette/definitions/2/liquid/eight_channel/p50/lowVolumeDefault/3_3.json +0 -89
  393. package/lib/pipette/definitions/2/liquid/eight_channel/p50/lowVolumeDefault/3_4.json +0 -89
  394. package/lib/pipette/definitions/2/liquid/eight_channel/p50/lowVolumeDefault/3_5.json +0 -89
  395. package/lib/pipette/definitions/2/liquid/ninety_six_channel/p1000/default/1_0.json +0 -188
  396. package/lib/pipette/definitions/2/liquid/ninety_six_channel/p1000/default/3_0.json +0 -188
  397. package/lib/pipette/definitions/2/liquid/ninety_six_channel/p1000/default/3_3.json +0 -188
  398. package/lib/pipette/definitions/2/liquid/ninety_six_channel/p1000/default/3_4.json +0 -188
  399. package/lib/pipette/definitions/2/liquid/ninety_six_channel/p1000/default/3_5.json +0 -188
  400. package/lib/pipette/definitions/2/liquid/single_channel/p10/default/1_0.json +0 -59
  401. package/lib/pipette/definitions/2/liquid/single_channel/p10/default/1_3.json +0 -59
  402. package/lib/pipette/definitions/2/liquid/single_channel/p10/default/1_4.json +0 -56
  403. package/lib/pipette/definitions/2/liquid/single_channel/p10/default/1_5.json +0 -54
  404. package/lib/pipette/definitions/2/liquid/single_channel/p1000/default/1_0.json +0 -48
  405. package/lib/pipette/definitions/2/liquid/single_channel/p1000/default/1_3.json +0 -48
  406. package/lib/pipette/definitions/2/liquid/single_channel/p1000/default/1_4.json +0 -48
  407. package/lib/pipette/definitions/2/liquid/single_channel/p1000/default/1_5.json +0 -48
  408. package/lib/pipette/definitions/2/liquid/single_channel/p1000/default/2_0.json +0 -105
  409. package/lib/pipette/definitions/2/liquid/single_channel/p1000/default/2_1.json +0 -107
  410. package/lib/pipette/definitions/2/liquid/single_channel/p1000/default/2_2.json +0 -107
  411. package/lib/pipette/definitions/2/liquid/single_channel/p1000/default/3_0.json +0 -356
  412. package/lib/pipette/definitions/2/liquid/single_channel/p1000/default/3_3.json +0 -356
  413. package/lib/pipette/definitions/2/liquid/single_channel/p1000/default/3_4.json +0 -282
  414. package/lib/pipette/definitions/2/liquid/single_channel/p1000/default/3_5.json +0 -204
  415. package/lib/pipette/definitions/2/liquid/single_channel/p1000/default/3_6.json +0 -204
  416. package/lib/pipette/definitions/2/liquid/single_channel/p20/default/2_0.json +0 -431
  417. package/lib/pipette/definitions/2/liquid/single_channel/p20/default/2_1.json +0 -251
  418. package/lib/pipette/definitions/2/liquid/single_channel/p20/default/2_2.json +0 -311
  419. package/lib/pipette/definitions/2/liquid/single_channel/p300/default/1_0.json +0 -99
  420. package/lib/pipette/definitions/2/liquid/single_channel/p300/default/1_3.json +0 -99
  421. package/lib/pipette/definitions/2/liquid/single_channel/p300/default/1_4.json +0 -99
  422. package/lib/pipette/definitions/2/liquid/single_channel/p300/default/1_5.json +0 -75
  423. package/lib/pipette/definitions/2/liquid/single_channel/p300/default/2_0.json +0 -188
  424. package/lib/pipette/definitions/2/liquid/single_channel/p300/default/2_1.json +0 -188
  425. package/lib/pipette/definitions/2/liquid/single_channel/p50/default/1_0.json +0 -119
  426. package/lib/pipette/definitions/2/liquid/single_channel/p50/default/1_3.json +0 -128
  427. package/lib/pipette/definitions/2/liquid/single_channel/p50/default/1_4.json +0 -128
  428. package/lib/pipette/definitions/2/liquid/single_channel/p50/default/1_5.json +0 -104
  429. package/lib/pipette/definitions/2/liquid/single_channel/p50/default/3_0.json +0 -98
  430. package/lib/pipette/definitions/2/liquid/single_channel/p50/default/3_3.json +0 -98
  431. package/lib/pipette/definitions/2/liquid/single_channel/p50/default/3_4.json +0 -100
  432. package/lib/pipette/definitions/2/liquid/single_channel/p50/default/3_5.json +0 -80
  433. package/lib/pipette/definitions/2/liquid/single_channel/p50/lowVolumeDefault/3_0.json +0 -78
  434. package/lib/pipette/definitions/2/liquid/single_channel/p50/lowVolumeDefault/3_3.json +0 -78
  435. package/lib/pipette/definitions/2/liquid/single_channel/p50/lowVolumeDefault/3_4.json +0 -78
  436. package/lib/pipette/definitions/2/liquid/single_channel/p50/lowVolumeDefault/3_5.json +0 -76
  437. package/lib/pipette/fixtures/name/pipetteNameSpecFixtures.json +0 -170
  438. package/lib/pipette/schemas/1/pipetteModelSpecsSchema.json +0 -153
  439. package/lib/pipette/schemas/1/pipetteNameSpecsSchema.json +0 -89
  440. package/lib/pipette/schemas/2/pipetteGeometrySchema.json +0 -81
  441. package/lib/pipette/schemas/2/pipetteLiquidPropertiesSchema.json +0 -120
  442. package/lib/pipette/schemas/2/pipettePropertiesSchema.json +0 -287
  443. package/lib/protocol/fixtures/1/simple.json +0 -73
  444. package/lib/protocol/fixtures/3/simple.json +0 -1307
  445. package/lib/protocol/fixtures/3/testAllAtomicSingleV3.json +0 -2281
  446. package/lib/protocol/fixtures/3/testTrickyLabwareV3.json +0 -2576
  447. package/lib/protocol/fixtures/3/unusedPipette.json +0 -1311
  448. package/lib/protocol/fixtures/4/pipetteMultiChannelProtocolV4.json +0 -2561
  449. package/lib/protocol/fixtures/4/simpleV4.json +0 -1309
  450. package/lib/protocol/fixtures/4/testMagneticModuleV4.json +0 -2156
  451. package/lib/protocol/fixtures/4/testModulesProtocol.json +0 -2561
  452. package/lib/protocol/fixtures/4/testTemperatureModuleV4.json +0 -1480
  453. package/lib/protocol/fixtures/4/testThermocyclerModuleV4.json +0 -2182
  454. package/lib/protocol/fixtures/4/transferSettings.json +0 -5482
  455. package/lib/protocol/fixtures/5/multipleTipracks.json +0 -2476
  456. package/lib/protocol/fixtures/5/multipleTipracksWithTC.json +0 -3544
  457. package/lib/protocol/fixtures/5/simpleV5.json +0 -1328
  458. package/lib/protocol/fixtures/6/heaterShakerCommands.json +0 -1421
  459. package/lib/protocol/fixtures/6/heaterShakerCommandsWithResultsKey.json +0 -4725
  460. package/lib/protocol/fixtures/6/multipleTempModules.json +0 -11060
  461. package/lib/protocol/fixtures/6/multipleTipracks.json +0 -5020
  462. package/lib/protocol/fixtures/6/multipleTipracksWithTC.json +0 -7057
  463. package/lib/protocol/fixtures/6/oneTiprack.json +0 -1388
  464. package/lib/protocol/fixtures/6/simpleV6.json +0 -1493
  465. package/lib/protocol/fixtures/6/tempAndMagModuleCommands.json +0 -1412
  466. package/lib/protocol/fixtures/6/transferSettings.json +0 -11060
  467. package/lib/protocol/fixtures/7/moveLabware.json +0 -1303
  468. package/lib/protocol/fixtures/7/simpleV7.json +0 -1495
  469. package/lib/protocol/fixtures/8/moveLabware8.json +0 -1309
  470. package/lib/protocol/fixtures/8/moveLabwareFlex8.json +0 -1309
  471. package/lib/protocol/fixtures/8/simpleFlexV8.json +0 -1475
  472. package/lib/protocol/fixtures/8/simpleV8.json +0 -1473
  473. package/lib/protocol/index.d.ts +0 -10
  474. package/lib/protocol/schemas/1.json +0 -365
  475. package/lib/protocol/schemas/2.json +0 -390
  476. package/lib/protocol/schemas/3.json +0 -336
  477. package/lib/protocol/schemas/4.json +0 -620
  478. package/lib/protocol/schemas/5.json +0 -658
  479. package/lib/protocol/schemas/6.json +0 -1166
  480. package/lib/protocol/schemas/7.json +0 -270
  481. package/lib/protocol/schemas/8.json +0 -141
  482. package/lib/protocol/types/schemaV1.d.ts +0 -89
  483. package/lib/protocol/types/schemaV3.d.ts +0 -100
  484. package/lib/protocol/types/schemaV4.d.ts +0 -102
  485. package/lib/protocol/types/schemaV5.d.ts +0 -24
  486. package/lib/protocol/types/schemaV5Addendum.d.ts +0 -13
  487. package/lib/protocol/types/schemaV6/command/gantry.d.ts +0 -110
  488. package/lib/protocol/types/schemaV6/command/index.d.ts +0 -46
  489. package/lib/protocol/types/schemaV6/command/module.d.ts +0 -187
  490. package/lib/protocol/types/schemaV6/command/pipetting.d.ts +0 -75
  491. package/lib/protocol/types/schemaV6/command/setup.d.ts +0 -96
  492. package/lib/protocol/types/schemaV6/command/timing.d.ts +0 -39
  493. package/lib/protocol/types/schemaV6/index.d.ts +0 -110
  494. package/lib/protocol/types/schemaV7/command/annotation.d.ts +0 -24
  495. package/lib/protocol/types/schemaV7/command/calibration.d.ts +0 -58
  496. package/lib/protocol/types/schemaV7/command/gantry.d.ts +0 -111
  497. package/lib/protocol/types/schemaV7/command/incidental.d.ts +0 -15
  498. package/lib/protocol/types/schemaV7/command/index.d.ts +0 -40
  499. package/lib/protocol/types/schemaV7/command/module.d.ts +0 -191
  500. package/lib/protocol/types/schemaV7/command/pipetting.d.ts +0 -119
  501. package/lib/protocol/types/schemaV7/command/setup.d.ts +0 -122
  502. package/lib/protocol/types/schemaV7/command/timing.d.ts +0 -39
  503. package/lib/protocol/types/schemaV7/index.d.ts +0 -94
  504. package/lib/protocol/types/schemaV8/index.d.ts +0 -126
@@ -1,3301 +0,0 @@
1
- {
2
- "title": "CreateCommandUnion",
3
- "description": "Model that validates a union of all CommandCreate models.",
4
- "anyOf": [
5
- {
6
- "$ref": "#/definitions/AspirateCreate"
7
- },
8
- {
9
- "$ref": "#/definitions/AspirateInPlaceCreate"
10
- },
11
- {
12
- "$ref": "#/definitions/CommentCreate"
13
- },
14
- {
15
- "$ref": "#/definitions/ConfigureForVolumeCreate"
16
- },
17
- {
18
- "$ref": "#/definitions/CustomCreate"
19
- },
20
- {
21
- "$ref": "#/definitions/DispenseCreate"
22
- },
23
- {
24
- "$ref": "#/definitions/DispenseInPlaceCreate"
25
- },
26
- {
27
- "$ref": "#/definitions/BlowOutCreate"
28
- },
29
- {
30
- "$ref": "#/definitions/BlowOutInPlaceCreate"
31
- },
32
- {
33
- "$ref": "#/definitions/DropTipCreate"
34
- },
35
- {
36
- "$ref": "#/definitions/DropTipInPlaceCreate"
37
- },
38
- {
39
- "$ref": "#/definitions/HomeCreate"
40
- },
41
- {
42
- "$ref": "#/definitions/RetractAxisCreate"
43
- },
44
- {
45
- "$ref": "#/definitions/LoadLabwareCreate"
46
- },
47
- {
48
- "$ref": "#/definitions/LoadLiquidCreate"
49
- },
50
- {
51
- "$ref": "#/definitions/LoadModuleCreate"
52
- },
53
- {
54
- "$ref": "#/definitions/LoadPipetteCreate"
55
- },
56
- {
57
- "$ref": "#/definitions/MoveLabwareCreate"
58
- },
59
- {
60
- "$ref": "#/definitions/MoveRelativeCreate"
61
- },
62
- {
63
- "$ref": "#/definitions/MoveToCoordinatesCreate"
64
- },
65
- {
66
- "$ref": "#/definitions/MoveToWellCreate"
67
- },
68
- {
69
- "$ref": "#/definitions/WaitForResumeCreate"
70
- },
71
- {
72
- "$ref": "#/definitions/WaitForDurationCreate"
73
- },
74
- {
75
- "$ref": "#/definitions/PickUpTipCreate"
76
- },
77
- {
78
- "$ref": "#/definitions/SavePositionCreate"
79
- },
80
- {
81
- "$ref": "#/definitions/SetRailLightsCreate"
82
- },
83
- {
84
- "$ref": "#/definitions/TouchTipCreate"
85
- },
86
- {
87
- "$ref": "#/definitions/SetStatusBarCreate"
88
- },
89
- {
90
- "$ref": "#/definitions/opentrons__protocol_engine__commands__heater_shaker__wait_for_temperature__WaitForTemperatureCreate"
91
- },
92
- {
93
- "$ref": "#/definitions/opentrons__protocol_engine__commands__heater_shaker__set_target_temperature__SetTargetTemperatureCreate"
94
- },
95
- {
96
- "$ref": "#/definitions/DeactivateHeaterCreate"
97
- },
98
- {
99
- "$ref": "#/definitions/SetAndWaitForShakeSpeedCreate"
100
- },
101
- {
102
- "$ref": "#/definitions/DeactivateShakerCreate"
103
- },
104
- {
105
- "$ref": "#/definitions/OpenLabwareLatchCreate"
106
- },
107
- {
108
- "$ref": "#/definitions/CloseLabwareLatchCreate"
109
- },
110
- {
111
- "$ref": "#/definitions/DisengageCreate"
112
- },
113
- {
114
- "$ref": "#/definitions/EngageCreate"
115
- },
116
- {
117
- "$ref": "#/definitions/opentrons__protocol_engine__commands__temperature_module__set_target_temperature__SetTargetTemperatureCreate"
118
- },
119
- {
120
- "$ref": "#/definitions/opentrons__protocol_engine__commands__temperature_module__wait_for_temperature__WaitForTemperatureCreate"
121
- },
122
- {
123
- "$ref": "#/definitions/DeactivateTemperatureCreate"
124
- },
125
- {
126
- "$ref": "#/definitions/SetTargetBlockTemperatureCreate"
127
- },
128
- {
129
- "$ref": "#/definitions/WaitForBlockTemperatureCreate"
130
- },
131
- {
132
- "$ref": "#/definitions/SetTargetLidTemperatureCreate"
133
- },
134
- {
135
- "$ref": "#/definitions/WaitForLidTemperatureCreate"
136
- },
137
- {
138
- "$ref": "#/definitions/DeactivateBlockCreate"
139
- },
140
- {
141
- "$ref": "#/definitions/DeactivateLidCreate"
142
- },
143
- {
144
- "$ref": "#/definitions/OpenLidCreate"
145
- },
146
- {
147
- "$ref": "#/definitions/CloseLidCreate"
148
- },
149
- {
150
- "$ref": "#/definitions/RunProfileCreate"
151
- },
152
- {
153
- "$ref": "#/definitions/CalibrateGripperCreate"
154
- },
155
- {
156
- "$ref": "#/definitions/CalibratePipetteCreate"
157
- },
158
- {
159
- "$ref": "#/definitions/CalibrateModuleCreate"
160
- },
161
- {
162
- "$ref": "#/definitions/MoveToMaintenancePositionCreate"
163
- }
164
- ],
165
- "definitions": {
166
- "WellOrigin": {
167
- "title": "WellOrigin",
168
- "description": "Origin of WellLocation offset.\n\nProps:\n TOP: the top-center of the well\n BOTTOM: the bottom-center of the well\n CENTER: the middle-center of the well",
169
- "enum": ["top", "bottom", "center"],
170
- "type": "string"
171
- },
172
- "WellOffset": {
173
- "title": "WellOffset",
174
- "description": "An offset vector in (x, y, z).",
175
- "type": "object",
176
- "properties": {
177
- "x": {
178
- "title": "X",
179
- "default": 0,
180
- "type": "number"
181
- },
182
- "y": {
183
- "title": "Y",
184
- "default": 0,
185
- "type": "number"
186
- },
187
- "z": {
188
- "title": "Z",
189
- "default": 0,
190
- "type": "number"
191
- }
192
- }
193
- },
194
- "WellLocation": {
195
- "title": "WellLocation",
196
- "description": "A relative location in reference to a well's location.",
197
- "type": "object",
198
- "properties": {
199
- "origin": {
200
- "default": "top",
201
- "allOf": [
202
- {
203
- "$ref": "#/definitions/WellOrigin"
204
- }
205
- ]
206
- },
207
- "offset": {
208
- "$ref": "#/definitions/WellOffset"
209
- }
210
- }
211
- },
212
- "AspirateParams": {
213
- "title": "AspirateParams",
214
- "description": "Parameters required to aspirate from a specific well.",
215
- "type": "object",
216
- "properties": {
217
- "labwareId": {
218
- "title": "Labwareid",
219
- "description": "Identifier of labware to use.",
220
- "type": "string"
221
- },
222
- "wellName": {
223
- "title": "Wellname",
224
- "description": "Name of well to use in labware.",
225
- "type": "string"
226
- },
227
- "wellLocation": {
228
- "title": "Welllocation",
229
- "description": "Relative well location at which to perform the operation",
230
- "allOf": [
231
- {
232
- "$ref": "#/definitions/WellLocation"
233
- }
234
- ]
235
- },
236
- "flowRate": {
237
- "title": "Flowrate",
238
- "description": "Speed in \u00b5L/s configured for the pipette",
239
- "exclusiveMinimum": 0,
240
- "type": "number"
241
- },
242
- "volume": {
243
- "title": "Volume",
244
- "description": "Amount of liquid in uL. Must be greater than 0 and less than a pipette-specific maximum volume.",
245
- "exclusiveMinimum": 0,
246
- "type": "number"
247
- },
248
- "pipetteId": {
249
- "title": "Pipetteid",
250
- "description": "Identifier of pipette to use for liquid handling.",
251
- "type": "string"
252
- }
253
- },
254
- "required": ["labwareId", "wellName", "flowRate", "volume", "pipetteId"]
255
- },
256
- "CommandIntent": {
257
- "title": "CommandIntent",
258
- "description": "Run intent for a given command.\n\nProps:\n PROTOCOL: the command is part of the protocol run itself.\n SETUP: the command is part of the setup phase of a run.",
259
- "enum": ["protocol", "setup"],
260
- "type": "string"
261
- },
262
- "AspirateCreate": {
263
- "title": "AspirateCreate",
264
- "description": "Create aspirate command request model.",
265
- "type": "object",
266
- "properties": {
267
- "commandType": {
268
- "title": "Commandtype",
269
- "default": "aspirate",
270
- "enum": ["aspirate"],
271
- "type": "string"
272
- },
273
- "params": {
274
- "$ref": "#/definitions/AspirateParams"
275
- },
276
- "intent": {
277
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
278
- "allOf": [
279
- {
280
- "$ref": "#/definitions/CommandIntent"
281
- }
282
- ]
283
- },
284
- "key": {
285
- "title": "Key",
286
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
287
- "type": "string"
288
- }
289
- },
290
- "required": ["params"]
291
- },
292
- "AspirateInPlaceParams": {
293
- "title": "AspirateInPlaceParams",
294
- "description": "Payload required to aspirate in place.",
295
- "type": "object",
296
- "properties": {
297
- "flowRate": {
298
- "title": "Flowrate",
299
- "description": "Speed in \u00b5L/s configured for the pipette",
300
- "exclusiveMinimum": 0,
301
- "type": "number"
302
- },
303
- "volume": {
304
- "title": "Volume",
305
- "description": "Amount of liquid in uL. Must be greater than 0 and less than a pipette-specific maximum volume.",
306
- "exclusiveMinimum": 0,
307
- "type": "number"
308
- },
309
- "pipetteId": {
310
- "title": "Pipetteid",
311
- "description": "Identifier of pipette to use for liquid handling.",
312
- "type": "string"
313
- }
314
- },
315
- "required": ["flowRate", "volume", "pipetteId"]
316
- },
317
- "AspirateInPlaceCreate": {
318
- "title": "AspirateInPlaceCreate",
319
- "description": "AspirateInPlace command request model.",
320
- "type": "object",
321
- "properties": {
322
- "commandType": {
323
- "title": "Commandtype",
324
- "default": "aspirateInPlace",
325
- "enum": ["aspirateInPlace"],
326
- "type": "string"
327
- },
328
- "params": {
329
- "$ref": "#/definitions/AspirateInPlaceParams"
330
- },
331
- "intent": {
332
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
333
- "allOf": [
334
- {
335
- "$ref": "#/definitions/CommandIntent"
336
- }
337
- ]
338
- },
339
- "key": {
340
- "title": "Key",
341
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
342
- "type": "string"
343
- }
344
- },
345
- "required": ["params"]
346
- },
347
- "CommentParams": {
348
- "title": "CommentParams",
349
- "description": "Payload required to annotate execution with a comment.",
350
- "type": "object",
351
- "properties": {
352
- "message": {
353
- "title": "Message",
354
- "description": "A user-facing message",
355
- "type": "string"
356
- }
357
- },
358
- "required": ["message"]
359
- },
360
- "CommentCreate": {
361
- "title": "CommentCreate",
362
- "description": "Comment command request model.",
363
- "type": "object",
364
- "properties": {
365
- "commandType": {
366
- "title": "Commandtype",
367
- "default": "comment",
368
- "enum": ["comment"],
369
- "type": "string"
370
- },
371
- "params": {
372
- "$ref": "#/definitions/CommentParams"
373
- },
374
- "intent": {
375
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
376
- "allOf": [
377
- {
378
- "$ref": "#/definitions/CommandIntent"
379
- }
380
- ]
381
- },
382
- "key": {
383
- "title": "Key",
384
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
385
- "type": "string"
386
- }
387
- },
388
- "required": ["params"]
389
- },
390
- "ConfigureForVolumeParams": {
391
- "title": "ConfigureForVolumeParams",
392
- "description": "Parameters required to configure volume for a specific pipette.",
393
- "type": "object",
394
- "properties": {
395
- "volume": {
396
- "title": "Volume",
397
- "description": "Amount of liquid in uL. Must be greater than 0 and less than a pipette-specific maximum volume.",
398
- "exclusiveMinimum": 0,
399
- "type": "number"
400
- },
401
- "pipetteId": {
402
- "title": "Pipetteid",
403
- "description": "Identifier of pipette to use for liquid handling.",
404
- "type": "string"
405
- }
406
- },
407
- "required": ["volume", "pipetteId"]
408
- },
409
- "ConfigureForVolumeCreate": {
410
- "title": "ConfigureForVolumeCreate",
411
- "description": "Configure for volume command creation request model.",
412
- "type": "object",
413
- "properties": {
414
- "commandType": {
415
- "title": "Commandtype",
416
- "default": "configureForVolume",
417
- "enum": ["configureForVolume"],
418
- "type": "string"
419
- },
420
- "params": {
421
- "$ref": "#/definitions/ConfigureForVolumeParams"
422
- },
423
- "intent": {
424
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
425
- "allOf": [
426
- {
427
- "$ref": "#/definitions/CommandIntent"
428
- }
429
- ]
430
- },
431
- "key": {
432
- "title": "Key",
433
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
434
- "type": "string"
435
- }
436
- },
437
- "required": ["params"]
438
- },
439
- "CustomParams": {
440
- "title": "CustomParams",
441
- "description": "Payload used by a custom command.",
442
- "type": "object",
443
- "properties": {}
444
- },
445
- "CustomCreate": {
446
- "title": "CustomCreate",
447
- "description": "A request to create a custom command.",
448
- "type": "object",
449
- "properties": {
450
- "commandType": {
451
- "title": "Commandtype",
452
- "default": "custom",
453
- "enum": ["custom"],
454
- "type": "string"
455
- },
456
- "params": {
457
- "$ref": "#/definitions/CustomParams"
458
- },
459
- "intent": {
460
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
461
- "allOf": [
462
- {
463
- "$ref": "#/definitions/CommandIntent"
464
- }
465
- ]
466
- },
467
- "key": {
468
- "title": "Key",
469
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
470
- "type": "string"
471
- }
472
- },
473
- "required": ["params"]
474
- },
475
- "DispenseParams": {
476
- "title": "DispenseParams",
477
- "description": "Payload required to dispense to a specific well.",
478
- "type": "object",
479
- "properties": {
480
- "labwareId": {
481
- "title": "Labwareid",
482
- "description": "Identifier of labware to use.",
483
- "type": "string"
484
- },
485
- "wellName": {
486
- "title": "Wellname",
487
- "description": "Name of well to use in labware.",
488
- "type": "string"
489
- },
490
- "wellLocation": {
491
- "title": "Welllocation",
492
- "description": "Relative well location at which to perform the operation",
493
- "allOf": [
494
- {
495
- "$ref": "#/definitions/WellLocation"
496
- }
497
- ]
498
- },
499
- "flowRate": {
500
- "title": "Flowrate",
501
- "description": "Speed in \u00b5L/s configured for the pipette",
502
- "exclusiveMinimum": 0,
503
- "type": "number"
504
- },
505
- "volume": {
506
- "title": "Volume",
507
- "description": "Amount of liquid in uL. Must be greater than 0 and less than a pipette-specific maximum volume.",
508
- "exclusiveMinimum": 0,
509
- "type": "number"
510
- },
511
- "pipetteId": {
512
- "title": "Pipetteid",
513
- "description": "Identifier of pipette to use for liquid handling.",
514
- "type": "string"
515
- },
516
- "pushOut": {
517
- "title": "Pushout",
518
- "description": "push the plunger a small amount farther than necessary for accurate low-volume dispensing",
519
- "type": "number"
520
- }
521
- },
522
- "required": ["labwareId", "wellName", "flowRate", "volume", "pipetteId"]
523
- },
524
- "DispenseCreate": {
525
- "title": "DispenseCreate",
526
- "description": "Create dispense command request model.",
527
- "type": "object",
528
- "properties": {
529
- "commandType": {
530
- "title": "Commandtype",
531
- "default": "dispense",
532
- "enum": ["dispense"],
533
- "type": "string"
534
- },
535
- "params": {
536
- "$ref": "#/definitions/DispenseParams"
537
- },
538
- "intent": {
539
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
540
- "allOf": [
541
- {
542
- "$ref": "#/definitions/CommandIntent"
543
- }
544
- ]
545
- },
546
- "key": {
547
- "title": "Key",
548
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
549
- "type": "string"
550
- }
551
- },
552
- "required": ["params"]
553
- },
554
- "DispenseInPlaceParams": {
555
- "title": "DispenseInPlaceParams",
556
- "description": "Payload required to dispense in place.",
557
- "type": "object",
558
- "properties": {
559
- "flowRate": {
560
- "title": "Flowrate",
561
- "description": "Speed in \u00b5L/s configured for the pipette",
562
- "exclusiveMinimum": 0,
563
- "type": "number"
564
- },
565
- "volume": {
566
- "title": "Volume",
567
- "description": "Amount of liquid in uL. Must be greater than 0 and less than a pipette-specific maximum volume.",
568
- "exclusiveMinimum": 0,
569
- "type": "number"
570
- },
571
- "pipetteId": {
572
- "title": "Pipetteid",
573
- "description": "Identifier of pipette to use for liquid handling.",
574
- "type": "string"
575
- },
576
- "pushOut": {
577
- "title": "Pushout",
578
- "description": "push the plunger a small amount farther than necessary for accurate low-volume dispensing",
579
- "type": "number"
580
- }
581
- },
582
- "required": ["flowRate", "volume", "pipetteId"]
583
- },
584
- "DispenseInPlaceCreate": {
585
- "title": "DispenseInPlaceCreate",
586
- "description": "DispenseInPlace command request model.",
587
- "type": "object",
588
- "properties": {
589
- "commandType": {
590
- "title": "Commandtype",
591
- "default": "dispenseInPlace",
592
- "enum": ["dispenseInPlace"],
593
- "type": "string"
594
- },
595
- "params": {
596
- "$ref": "#/definitions/DispenseInPlaceParams"
597
- },
598
- "intent": {
599
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
600
- "allOf": [
601
- {
602
- "$ref": "#/definitions/CommandIntent"
603
- }
604
- ]
605
- },
606
- "key": {
607
- "title": "Key",
608
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
609
- "type": "string"
610
- }
611
- },
612
- "required": ["params"]
613
- },
614
- "BlowOutParams": {
615
- "title": "BlowOutParams",
616
- "description": "Payload required to blow-out a specific well.",
617
- "type": "object",
618
- "properties": {
619
- "labwareId": {
620
- "title": "Labwareid",
621
- "description": "Identifier of labware to use.",
622
- "type": "string"
623
- },
624
- "wellName": {
625
- "title": "Wellname",
626
- "description": "Name of well to use in labware.",
627
- "type": "string"
628
- },
629
- "wellLocation": {
630
- "title": "Welllocation",
631
- "description": "Relative well location at which to perform the operation",
632
- "allOf": [
633
- {
634
- "$ref": "#/definitions/WellLocation"
635
- }
636
- ]
637
- },
638
- "flowRate": {
639
- "title": "Flowrate",
640
- "description": "Speed in \u00b5L/s configured for the pipette",
641
- "exclusiveMinimum": 0,
642
- "type": "number"
643
- },
644
- "pipetteId": {
645
- "title": "Pipetteid",
646
- "description": "Identifier of pipette to use for liquid handling.",
647
- "type": "string"
648
- }
649
- },
650
- "required": ["labwareId", "wellName", "flowRate", "pipetteId"]
651
- },
652
- "BlowOutCreate": {
653
- "title": "BlowOutCreate",
654
- "description": "Create blow-out command request model.",
655
- "type": "object",
656
- "properties": {
657
- "commandType": {
658
- "title": "Commandtype",
659
- "default": "blowout",
660
- "enum": ["blowout"],
661
- "type": "string"
662
- },
663
- "params": {
664
- "$ref": "#/definitions/BlowOutParams"
665
- },
666
- "intent": {
667
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
668
- "allOf": [
669
- {
670
- "$ref": "#/definitions/CommandIntent"
671
- }
672
- ]
673
- },
674
- "key": {
675
- "title": "Key",
676
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
677
- "type": "string"
678
- }
679
- },
680
- "required": ["params"]
681
- },
682
- "BlowOutInPlaceParams": {
683
- "title": "BlowOutInPlaceParams",
684
- "description": "Payload required to blow-out in place.",
685
- "type": "object",
686
- "properties": {
687
- "flowRate": {
688
- "title": "Flowrate",
689
- "description": "Speed in \u00b5L/s configured for the pipette",
690
- "exclusiveMinimum": 0,
691
- "type": "number"
692
- },
693
- "pipetteId": {
694
- "title": "Pipetteid",
695
- "description": "Identifier of pipette to use for liquid handling.",
696
- "type": "string"
697
- }
698
- },
699
- "required": ["flowRate", "pipetteId"]
700
- },
701
- "BlowOutInPlaceCreate": {
702
- "title": "BlowOutInPlaceCreate",
703
- "description": "BlowOutInPlace command request model.",
704
- "type": "object",
705
- "properties": {
706
- "commandType": {
707
- "title": "Commandtype",
708
- "default": "blowOutInPlace",
709
- "enum": ["blowOutInPlace"],
710
- "type": "string"
711
- },
712
- "params": {
713
- "$ref": "#/definitions/BlowOutInPlaceParams"
714
- },
715
- "intent": {
716
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
717
- "allOf": [
718
- {
719
- "$ref": "#/definitions/CommandIntent"
720
- }
721
- ]
722
- },
723
- "key": {
724
- "title": "Key",
725
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
726
- "type": "string"
727
- }
728
- },
729
- "required": ["params"]
730
- },
731
- "DropTipWellOrigin": {
732
- "title": "DropTipWellOrigin",
733
- "description": "The origin of a DropTipWellLocation offset.\n\nProps:\n TOP: the top-center of the well\n BOTTOM: the bottom-center of the well\n CENTER: the middle-center of the well\n DEFAULT: the default drop-tip location of the well,\n based on pipette configuration and length of the tip.",
734
- "enum": ["top", "bottom", "center", "default"],
735
- "type": "string"
736
- },
737
- "DropTipWellLocation": {
738
- "title": "DropTipWellLocation",
739
- "description": "Like WellLocation, but for dropping tips.\n\nUnlike a typical WellLocation, the location for a drop tip\ndefaults to location based on the tip length rather than the well's top.",
740
- "type": "object",
741
- "properties": {
742
- "origin": {
743
- "default": "default",
744
- "allOf": [
745
- {
746
- "$ref": "#/definitions/DropTipWellOrigin"
747
- }
748
- ]
749
- },
750
- "offset": {
751
- "$ref": "#/definitions/WellOffset"
752
- }
753
- }
754
- },
755
- "DropTipParams": {
756
- "title": "DropTipParams",
757
- "description": "Payload required to drop a tip in a specific well.",
758
- "type": "object",
759
- "properties": {
760
- "pipetteId": {
761
- "title": "Pipetteid",
762
- "description": "Identifier of pipette to use for liquid handling.",
763
- "type": "string"
764
- },
765
- "labwareId": {
766
- "title": "Labwareid",
767
- "description": "Identifier of labware to use.",
768
- "type": "string"
769
- },
770
- "wellName": {
771
- "title": "Wellname",
772
- "description": "Name of well to use in labware.",
773
- "type": "string"
774
- },
775
- "wellLocation": {
776
- "title": "Welllocation",
777
- "description": "Relative well location at which to drop the tip.",
778
- "allOf": [
779
- {
780
- "$ref": "#/definitions/DropTipWellLocation"
781
- }
782
- ]
783
- },
784
- "homeAfter": {
785
- "title": "Homeafter",
786
- "description": "Whether to home this pipette's plunger after dropping the tip. You should normally leave this unspecified to let the robot choose a safe default depending on its hardware.",
787
- "type": "boolean"
788
- },
789
- "alternateDropLocation": {
790
- "title": "Alternatedroplocation",
791
- "description": "Whether to alternate location where tip is dropped within the labware. If True, this command will ignore the wellLocation provided and alternate between dropping tips at two predetermined locations inside the specified labware well. If False, the tip will be dropped at the top center of the well.",
792
- "default": false,
793
- "type": "boolean"
794
- }
795
- },
796
- "required": ["pipetteId", "labwareId", "wellName"]
797
- },
798
- "DropTipCreate": {
799
- "title": "DropTipCreate",
800
- "description": "Drop tip command creation request model.",
801
- "type": "object",
802
- "properties": {
803
- "commandType": {
804
- "title": "Commandtype",
805
- "default": "dropTip",
806
- "enum": ["dropTip"],
807
- "type": "string"
808
- },
809
- "params": {
810
- "$ref": "#/definitions/DropTipParams"
811
- },
812
- "intent": {
813
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
814
- "allOf": [
815
- {
816
- "$ref": "#/definitions/CommandIntent"
817
- }
818
- ]
819
- },
820
- "key": {
821
- "title": "Key",
822
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
823
- "type": "string"
824
- }
825
- },
826
- "required": ["params"]
827
- },
828
- "DropTipInPlaceParams": {
829
- "title": "DropTipInPlaceParams",
830
- "description": "Payload required to drop a tip in place.",
831
- "type": "object",
832
- "properties": {
833
- "pipetteId": {
834
- "title": "Pipetteid",
835
- "description": "Identifier of pipette to use for liquid handling.",
836
- "type": "string"
837
- },
838
- "homeAfter": {
839
- "title": "Homeafter",
840
- "description": "Whether to home this pipette's plunger after dropping the tip. You should normally leave this unspecified to let the robot choose a safe default depending on its hardware.",
841
- "type": "boolean"
842
- }
843
- },
844
- "required": ["pipetteId"]
845
- },
846
- "DropTipInPlaceCreate": {
847
- "title": "DropTipInPlaceCreate",
848
- "description": "Drop tip in place command creation request model.",
849
- "type": "object",
850
- "properties": {
851
- "commandType": {
852
- "title": "Commandtype",
853
- "default": "dropTipInPlace",
854
- "enum": ["dropTipInPlace"],
855
- "type": "string"
856
- },
857
- "params": {
858
- "$ref": "#/definitions/DropTipInPlaceParams"
859
- },
860
- "intent": {
861
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
862
- "allOf": [
863
- {
864
- "$ref": "#/definitions/CommandIntent"
865
- }
866
- ]
867
- },
868
- "key": {
869
- "title": "Key",
870
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
871
- "type": "string"
872
- }
873
- },
874
- "required": ["params"]
875
- },
876
- "MotorAxis": {
877
- "title": "MotorAxis",
878
- "description": "Motor axis on which to issue a home command.",
879
- "enum": [
880
- "x",
881
- "y",
882
- "leftZ",
883
- "rightZ",
884
- "leftPlunger",
885
- "rightPlunger",
886
- "extensionZ",
887
- "extensionJaw"
888
- ],
889
- "type": "string"
890
- },
891
- "MountType": {
892
- "title": "MountType",
893
- "description": "An enumeration.",
894
- "enum": ["left", "right", "extension"],
895
- "type": "string"
896
- },
897
- "HomeParams": {
898
- "title": "HomeParams",
899
- "description": "Payload required for a Home command.",
900
- "type": "object",
901
- "properties": {
902
- "axes": {
903
- "description": "Axes to return to their home positions. If omitted, will home all motors. Extra axes may be implicitly homed to ensure accurate homing of the explicitly specified axes.",
904
- "type": "array",
905
- "items": {
906
- "$ref": "#/definitions/MotorAxis"
907
- }
908
- },
909
- "skipIfMountPositionOk": {
910
- "description": "If this parameter is provided, the gantry will only be homed if the specified mount has an invalid position. If omitted, the homing action will be executed unconditionally.",
911
- "allOf": [
912
- {
913
- "$ref": "#/definitions/MountType"
914
- }
915
- ]
916
- }
917
- }
918
- },
919
- "HomeCreate": {
920
- "title": "HomeCreate",
921
- "description": "Data to create a Home command.",
922
- "type": "object",
923
- "properties": {
924
- "commandType": {
925
- "title": "Commandtype",
926
- "default": "home",
927
- "enum": ["home"],
928
- "type": "string"
929
- },
930
- "params": {
931
- "$ref": "#/definitions/HomeParams"
932
- },
933
- "intent": {
934
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
935
- "allOf": [
936
- {
937
- "$ref": "#/definitions/CommandIntent"
938
- }
939
- ]
940
- },
941
- "key": {
942
- "title": "Key",
943
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
944
- "type": "string"
945
- }
946
- },
947
- "required": ["params"]
948
- },
949
- "RetractAxisParams": {
950
- "title": "RetractAxisParams",
951
- "description": "Payload required for a Retract Axis command.",
952
- "type": "object",
953
- "properties": {
954
- "axis": {
955
- "description": "Axis to retract to its home position as quickly as safely possible. The difference between retracting an axis and homing an axis using the home command is that a home will always probe the limit switch and will work as the first motion command a robot will need to execute; On the other hand, retraction will rely on this previously determined home position to move to it as fast as safely possible. So on the Flex, it will move (fast) the axis to the previously recorded home position and on the OT2, it will move (fast) the axis a safe distance from the previously recorded home position, and then slowly approach the limit switch.",
956
- "allOf": [
957
- {
958
- "$ref": "#/definitions/MotorAxis"
959
- }
960
- ]
961
- }
962
- },
963
- "required": ["axis"]
964
- },
965
- "RetractAxisCreate": {
966
- "title": "RetractAxisCreate",
967
- "description": "Data to create a Retract Axis command.",
968
- "type": "object",
969
- "properties": {
970
- "commandType": {
971
- "title": "Commandtype",
972
- "default": "retractAxis",
973
- "enum": ["retractAxis"],
974
- "type": "string"
975
- },
976
- "params": {
977
- "$ref": "#/definitions/RetractAxisParams"
978
- },
979
- "intent": {
980
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
981
- "allOf": [
982
- {
983
- "$ref": "#/definitions/CommandIntent"
984
- }
985
- ]
986
- },
987
- "key": {
988
- "title": "Key",
989
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
990
- "type": "string"
991
- }
992
- },
993
- "required": ["params"]
994
- },
995
- "DeckSlotName": {
996
- "title": "DeckSlotName",
997
- "description": "Deck slot identifiers.",
998
- "enum": [
999
- "1",
1000
- "2",
1001
- "3",
1002
- "4",
1003
- "5",
1004
- "6",
1005
- "7",
1006
- "8",
1007
- "9",
1008
- "10",
1009
- "11",
1010
- "12",
1011
- "A1",
1012
- "A2",
1013
- "A3",
1014
- "B1",
1015
- "B2",
1016
- "B3",
1017
- "C1",
1018
- "C2",
1019
- "C3",
1020
- "D1",
1021
- "D2",
1022
- "D3"
1023
- ]
1024
- },
1025
- "DeckSlotLocation": {
1026
- "title": "DeckSlotLocation",
1027
- "description": "The location of something placed in a single deck slot.",
1028
- "type": "object",
1029
- "properties": {
1030
- "slotName": {
1031
- "description": "A slot on the robot's deck.\n\nThe plain numbers like `\"5\"` are for the OT-2, and the coordinates like `\"C2\"` are for the Flex.\n\nWhen you provide one of these values, you can use either style. It will automatically be converted to match the robot.\n\nWhen one of these values is returned, it will always match the robot.",
1032
- "allOf": [
1033
- {
1034
- "$ref": "#/definitions/DeckSlotName"
1035
- }
1036
- ]
1037
- }
1038
- },
1039
- "required": ["slotName"]
1040
- },
1041
- "ModuleLocation": {
1042
- "title": "ModuleLocation",
1043
- "description": "The location of something placed atop a hardware module.",
1044
- "type": "object",
1045
- "properties": {
1046
- "moduleId": {
1047
- "title": "Moduleid",
1048
- "description": "The ID of a loaded module from a prior `loadModule` command.",
1049
- "type": "string"
1050
- }
1051
- },
1052
- "required": ["moduleId"]
1053
- },
1054
- "OnLabwareLocation": {
1055
- "title": "OnLabwareLocation",
1056
- "description": "The location of something placed atop another labware.",
1057
- "type": "object",
1058
- "properties": {
1059
- "labwareId": {
1060
- "title": "Labwareid",
1061
- "description": "The ID of a loaded Labware from a prior `loadLabware` command.",
1062
- "type": "string"
1063
- }
1064
- },
1065
- "required": ["labwareId"]
1066
- },
1067
- "LoadLabwareParams": {
1068
- "title": "LoadLabwareParams",
1069
- "description": "Payload required to load a labware into a slot.",
1070
- "type": "object",
1071
- "properties": {
1072
- "location": {
1073
- "title": "Location",
1074
- "description": "Location the labware should be loaded into.",
1075
- "anyOf": [
1076
- {
1077
- "$ref": "#/definitions/DeckSlotLocation"
1078
- },
1079
- {
1080
- "$ref": "#/definitions/ModuleLocation"
1081
- },
1082
- {
1083
- "$ref": "#/definitions/OnLabwareLocation"
1084
- },
1085
- {
1086
- "enum": ["offDeck"],
1087
- "type": "string"
1088
- }
1089
- ]
1090
- },
1091
- "loadName": {
1092
- "title": "Loadname",
1093
- "description": "Name used to reference a labware definition.",
1094
- "type": "string"
1095
- },
1096
- "namespace": {
1097
- "title": "Namespace",
1098
- "description": "The namespace the labware definition belongs to.",
1099
- "type": "string"
1100
- },
1101
- "version": {
1102
- "title": "Version",
1103
- "description": "The labware definition version.",
1104
- "type": "integer"
1105
- },
1106
- "labwareId": {
1107
- "title": "Labwareid",
1108
- "description": "An optional ID to assign to this labware. If None, an ID will be generated.",
1109
- "type": "string"
1110
- },
1111
- "displayName": {
1112
- "title": "Displayname",
1113
- "description": "An optional user-specified display name or label for this labware.",
1114
- "type": "string"
1115
- }
1116
- },
1117
- "required": ["location", "loadName", "namespace", "version"]
1118
- },
1119
- "LoadLabwareCreate": {
1120
- "title": "LoadLabwareCreate",
1121
- "description": "Load labware command creation request.",
1122
- "type": "object",
1123
- "properties": {
1124
- "commandType": {
1125
- "title": "Commandtype",
1126
- "default": "loadLabware",
1127
- "enum": ["loadLabware"],
1128
- "type": "string"
1129
- },
1130
- "params": {
1131
- "$ref": "#/definitions/LoadLabwareParams"
1132
- },
1133
- "intent": {
1134
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
1135
- "allOf": [
1136
- {
1137
- "$ref": "#/definitions/CommandIntent"
1138
- }
1139
- ]
1140
- },
1141
- "key": {
1142
- "title": "Key",
1143
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
1144
- "type": "string"
1145
- }
1146
- },
1147
- "required": ["params"]
1148
- },
1149
- "LoadLiquidParams": {
1150
- "title": "LoadLiquidParams",
1151
- "description": "Payload required to load a liquid into a well.",
1152
- "type": "object",
1153
- "properties": {
1154
- "liquidId": {
1155
- "title": "Liquidid",
1156
- "description": "Unique identifier of the liquid to load.",
1157
- "type": "string"
1158
- },
1159
- "labwareId": {
1160
- "title": "Labwareid",
1161
- "description": "Unique identifier of labware to load liquid into.",
1162
- "type": "string"
1163
- },
1164
- "volumeByWell": {
1165
- "title": "Volumebywell",
1166
- "description": "Volume of liquid, in \u00b5L, loaded into each well by name, in this labware.",
1167
- "type": "object",
1168
- "additionalProperties": {
1169
- "type": "number"
1170
- }
1171
- }
1172
- },
1173
- "required": ["liquidId", "labwareId", "volumeByWell"]
1174
- },
1175
- "LoadLiquidCreate": {
1176
- "title": "LoadLiquidCreate",
1177
- "description": "Load liquid command creation request.",
1178
- "type": "object",
1179
- "properties": {
1180
- "commandType": {
1181
- "title": "Commandtype",
1182
- "default": "loadLiquid",
1183
- "enum": ["loadLiquid"],
1184
- "type": "string"
1185
- },
1186
- "params": {
1187
- "$ref": "#/definitions/LoadLiquidParams"
1188
- },
1189
- "intent": {
1190
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
1191
- "allOf": [
1192
- {
1193
- "$ref": "#/definitions/CommandIntent"
1194
- }
1195
- ]
1196
- },
1197
- "key": {
1198
- "title": "Key",
1199
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
1200
- "type": "string"
1201
- }
1202
- },
1203
- "required": ["params"]
1204
- },
1205
- "ModuleModel": {
1206
- "title": "ModuleModel",
1207
- "description": "All available modules' models.",
1208
- "enum": [
1209
- "temperatureModuleV1",
1210
- "temperatureModuleV2",
1211
- "magneticModuleV1",
1212
- "magneticModuleV2",
1213
- "thermocyclerModuleV1",
1214
- "thermocyclerModuleV2",
1215
- "heaterShakerModuleV1",
1216
- "magneticBlockV1"
1217
- ],
1218
- "type": "string"
1219
- },
1220
- "LoadModuleParams": {
1221
- "title": "LoadModuleParams",
1222
- "description": "Payload required to load a module.",
1223
- "type": "object",
1224
- "properties": {
1225
- "model": {
1226
- "description": "The model name of the module to load.\n\nProtocol Engine will look for a connected module that either exactly matches this one, or is compatible.\n\n For example, if you request a `temperatureModuleV1` here, Protocol Engine might load a `temperatureModuleV1` or a `temperatureModuleV2`.\n\n The model that it finds connected will be available through `result.model`.",
1227
- "allOf": [
1228
- {
1229
- "$ref": "#/definitions/ModuleModel"
1230
- }
1231
- ]
1232
- },
1233
- "location": {
1234
- "title": "Location",
1235
- "description": "The location into which this module should be loaded.\n\nFor the Thermocycler Module, which occupies multiple deck slots, this should be the front-most occupied slot (normally slot 7).",
1236
- "allOf": [
1237
- {
1238
- "$ref": "#/definitions/DeckSlotLocation"
1239
- }
1240
- ]
1241
- },
1242
- "moduleId": {
1243
- "title": "Moduleid",
1244
- "description": "An optional ID to assign to this module. If None, an ID will be generated.",
1245
- "type": "string"
1246
- }
1247
- },
1248
- "required": ["model", "location"]
1249
- },
1250
- "LoadModuleCreate": {
1251
- "title": "LoadModuleCreate",
1252
- "description": "The model for a creation request for a load module command.",
1253
- "type": "object",
1254
- "properties": {
1255
- "commandType": {
1256
- "title": "Commandtype",
1257
- "default": "loadModule",
1258
- "enum": ["loadModule"],
1259
- "type": "string"
1260
- },
1261
- "params": {
1262
- "$ref": "#/definitions/LoadModuleParams"
1263
- },
1264
- "intent": {
1265
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
1266
- "allOf": [
1267
- {
1268
- "$ref": "#/definitions/CommandIntent"
1269
- }
1270
- ]
1271
- },
1272
- "key": {
1273
- "title": "Key",
1274
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
1275
- "type": "string"
1276
- }
1277
- },
1278
- "required": ["params"]
1279
- },
1280
- "PipetteNameType": {
1281
- "title": "PipetteNameType",
1282
- "description": "Pipette load name values.",
1283
- "enum": [
1284
- "p10_single",
1285
- "p10_multi",
1286
- "p20_single_gen2",
1287
- "p20_multi_gen2",
1288
- "p50_single",
1289
- "p50_multi",
1290
- "p50_single_flex",
1291
- "p50_multi_flex",
1292
- "p300_single",
1293
- "p300_multi",
1294
- "p300_single_gen2",
1295
- "p300_multi_gen2",
1296
- "p1000_single",
1297
- "p1000_single_gen2",
1298
- "p1000_single_flex",
1299
- "p1000_multi_flex",
1300
- "p1000_96"
1301
- ],
1302
- "type": "string"
1303
- },
1304
- "LoadPipetteParams": {
1305
- "title": "LoadPipetteParams",
1306
- "description": "Payload needed to load a pipette on to a mount.",
1307
- "type": "object",
1308
- "properties": {
1309
- "pipetteName": {
1310
- "description": "The load name of the pipette to be required.",
1311
- "allOf": [
1312
- {
1313
- "$ref": "#/definitions/PipetteNameType"
1314
- }
1315
- ]
1316
- },
1317
- "mount": {
1318
- "description": "The mount the pipette should be present on.",
1319
- "allOf": [
1320
- {
1321
- "$ref": "#/definitions/MountType"
1322
- }
1323
- ]
1324
- },
1325
- "pipetteId": {
1326
- "title": "Pipetteid",
1327
- "description": "An optional ID to assign to this pipette. If None, an ID will be generated.",
1328
- "type": "string"
1329
- }
1330
- },
1331
- "required": ["pipetteName", "mount"]
1332
- },
1333
- "LoadPipetteCreate": {
1334
- "title": "LoadPipetteCreate",
1335
- "description": "Load pipette command creation request model.",
1336
- "type": "object",
1337
- "properties": {
1338
- "commandType": {
1339
- "title": "Commandtype",
1340
- "default": "loadPipette",
1341
- "enum": ["loadPipette"],
1342
- "type": "string"
1343
- },
1344
- "params": {
1345
- "$ref": "#/definitions/LoadPipetteParams"
1346
- },
1347
- "intent": {
1348
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
1349
- "allOf": [
1350
- {
1351
- "$ref": "#/definitions/CommandIntent"
1352
- }
1353
- ]
1354
- },
1355
- "key": {
1356
- "title": "Key",
1357
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
1358
- "type": "string"
1359
- }
1360
- },
1361
- "required": ["params"]
1362
- },
1363
- "LabwareMovementStrategy": {
1364
- "title": "LabwareMovementStrategy",
1365
- "description": "Strategy to use for labware movement.",
1366
- "enum": ["usingGripper", "manualMoveWithPause", "manualMoveWithoutPause"],
1367
- "type": "string"
1368
- },
1369
- "LabwareOffsetVector": {
1370
- "title": "LabwareOffsetVector",
1371
- "description": "Offset, in deck coordinates from nominal to actual position.",
1372
- "type": "object",
1373
- "properties": {
1374
- "x": {
1375
- "title": "X",
1376
- "type": "number"
1377
- },
1378
- "y": {
1379
- "title": "Y",
1380
- "type": "number"
1381
- },
1382
- "z": {
1383
- "title": "Z",
1384
- "type": "number"
1385
- }
1386
- },
1387
- "required": ["x", "y", "z"]
1388
- },
1389
- "MoveLabwareParams": {
1390
- "title": "MoveLabwareParams",
1391
- "description": "Input parameters for a ``moveLabware`` command.",
1392
- "type": "object",
1393
- "properties": {
1394
- "labwareId": {
1395
- "title": "Labwareid",
1396
- "description": "The ID of the labware to move.",
1397
- "type": "string"
1398
- },
1399
- "newLocation": {
1400
- "title": "Newlocation",
1401
- "description": "Where to move the labware.",
1402
- "anyOf": [
1403
- {
1404
- "$ref": "#/definitions/DeckSlotLocation"
1405
- },
1406
- {
1407
- "$ref": "#/definitions/ModuleLocation"
1408
- },
1409
- {
1410
- "$ref": "#/definitions/OnLabwareLocation"
1411
- },
1412
- {
1413
- "enum": ["offDeck"],
1414
- "type": "string"
1415
- }
1416
- ]
1417
- },
1418
- "strategy": {
1419
- "description": "Whether to use the gripper to perform the labware movement or to perform a manual movement with an option to pause.",
1420
- "allOf": [
1421
- {
1422
- "$ref": "#/definitions/LabwareMovementStrategy"
1423
- }
1424
- ]
1425
- },
1426
- "pickUpOffset": {
1427
- "title": "Pickupoffset",
1428
- "description": "Offset to use when picking up labware. Experimental param, subject to change",
1429
- "allOf": [
1430
- {
1431
- "$ref": "#/definitions/LabwareOffsetVector"
1432
- }
1433
- ]
1434
- },
1435
- "dropOffset": {
1436
- "title": "Dropoffset",
1437
- "description": "Offset to use when dropping off labware. Experimental param, subject to change",
1438
- "allOf": [
1439
- {
1440
- "$ref": "#/definitions/LabwareOffsetVector"
1441
- }
1442
- ]
1443
- }
1444
- },
1445
- "required": ["labwareId", "newLocation", "strategy"]
1446
- },
1447
- "MoveLabwareCreate": {
1448
- "title": "MoveLabwareCreate",
1449
- "description": "A request to create a ``moveLabware`` command.",
1450
- "type": "object",
1451
- "properties": {
1452
- "commandType": {
1453
- "title": "Commandtype",
1454
- "default": "moveLabware",
1455
- "enum": ["moveLabware"],
1456
- "type": "string"
1457
- },
1458
- "params": {
1459
- "$ref": "#/definitions/MoveLabwareParams"
1460
- },
1461
- "intent": {
1462
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
1463
- "allOf": [
1464
- {
1465
- "$ref": "#/definitions/CommandIntent"
1466
- }
1467
- ]
1468
- },
1469
- "key": {
1470
- "title": "Key",
1471
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
1472
- "type": "string"
1473
- }
1474
- },
1475
- "required": ["params"]
1476
- },
1477
- "MovementAxis": {
1478
- "title": "MovementAxis",
1479
- "description": "Axis on which to issue a relative movement.",
1480
- "enum": ["x", "y", "z"],
1481
- "type": "string"
1482
- },
1483
- "MoveRelativeParams": {
1484
- "title": "MoveRelativeParams",
1485
- "description": "Payload required for a MoveRelative command.",
1486
- "type": "object",
1487
- "properties": {
1488
- "pipetteId": {
1489
- "title": "Pipetteid",
1490
- "description": "Pipette to move.",
1491
- "type": "string"
1492
- },
1493
- "axis": {
1494
- "description": "Axis along which to move.",
1495
- "allOf": [
1496
- {
1497
- "$ref": "#/definitions/MovementAxis"
1498
- }
1499
- ]
1500
- },
1501
- "distance": {
1502
- "title": "Distance",
1503
- "description": "Distance to move in millimeters. A positive number will move towards the right (x), back (y), top (z) of the deck.",
1504
- "type": "number"
1505
- }
1506
- },
1507
- "required": ["pipetteId", "axis", "distance"]
1508
- },
1509
- "MoveRelativeCreate": {
1510
- "title": "MoveRelativeCreate",
1511
- "description": "Data to create a MoveRelative command.",
1512
- "type": "object",
1513
- "properties": {
1514
- "commandType": {
1515
- "title": "Commandtype",
1516
- "default": "moveRelative",
1517
- "enum": ["moveRelative"],
1518
- "type": "string"
1519
- },
1520
- "params": {
1521
- "$ref": "#/definitions/MoveRelativeParams"
1522
- },
1523
- "intent": {
1524
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
1525
- "allOf": [
1526
- {
1527
- "$ref": "#/definitions/CommandIntent"
1528
- }
1529
- ]
1530
- },
1531
- "key": {
1532
- "title": "Key",
1533
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
1534
- "type": "string"
1535
- }
1536
- },
1537
- "required": ["params"]
1538
- },
1539
- "DeckPoint": {
1540
- "title": "DeckPoint",
1541
- "description": "Coordinates of a point in deck space.",
1542
- "type": "object",
1543
- "properties": {
1544
- "x": {
1545
- "title": "X",
1546
- "type": "number"
1547
- },
1548
- "y": {
1549
- "title": "Y",
1550
- "type": "number"
1551
- },
1552
- "z": {
1553
- "title": "Z",
1554
- "type": "number"
1555
- }
1556
- },
1557
- "required": ["x", "y", "z"]
1558
- },
1559
- "MoveToCoordinatesParams": {
1560
- "title": "MoveToCoordinatesParams",
1561
- "description": "Payload required to move a pipette to coordinates.",
1562
- "type": "object",
1563
- "properties": {
1564
- "minimumZHeight": {
1565
- "title": "Minimumzheight",
1566
- "description": "Optional minimal Z margin in mm. If this is larger than the API's default safe Z margin, it will make the arc higher. If it's smaller, it will have no effect.",
1567
- "type": "number"
1568
- },
1569
- "forceDirect": {
1570
- "title": "Forcedirect",
1571
- "description": "If true, moving from one labware/well to another will not arc to the default safe z, but instead will move directly to the specified location. This will also force the `minimumZHeight` param to be ignored. A 'direct' movement is in X/Y/Z simultaneously.",
1572
- "default": false,
1573
- "type": "boolean"
1574
- },
1575
- "speed": {
1576
- "title": "Speed",
1577
- "description": "Override the travel speed in mm/s. This controls the straight linear speed of motion.",
1578
- "type": "number"
1579
- },
1580
- "pipetteId": {
1581
- "title": "Pipetteid",
1582
- "description": "Identifier of pipette to use for liquid handling.",
1583
- "type": "string"
1584
- },
1585
- "coordinates": {
1586
- "title": "Coordinates",
1587
- "description": "X, Y and Z coordinates in mm from deck's origin location (left-front-bottom corner of work space)",
1588
- "allOf": [
1589
- {
1590
- "$ref": "#/definitions/DeckPoint"
1591
- }
1592
- ]
1593
- }
1594
- },
1595
- "required": ["pipetteId", "coordinates"]
1596
- },
1597
- "MoveToCoordinatesCreate": {
1598
- "title": "MoveToCoordinatesCreate",
1599
- "description": "Move to coordinates command creation request model.",
1600
- "type": "object",
1601
- "properties": {
1602
- "commandType": {
1603
- "title": "Commandtype",
1604
- "default": "moveToCoordinates",
1605
- "enum": ["moveToCoordinates"],
1606
- "type": "string"
1607
- },
1608
- "params": {
1609
- "$ref": "#/definitions/MoveToCoordinatesParams"
1610
- },
1611
- "intent": {
1612
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
1613
- "allOf": [
1614
- {
1615
- "$ref": "#/definitions/CommandIntent"
1616
- }
1617
- ]
1618
- },
1619
- "key": {
1620
- "title": "Key",
1621
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
1622
- "type": "string"
1623
- }
1624
- },
1625
- "required": ["params"]
1626
- },
1627
- "MoveToWellParams": {
1628
- "title": "MoveToWellParams",
1629
- "description": "Payload required to move a pipette to a specific well.",
1630
- "type": "object",
1631
- "properties": {
1632
- "minimumZHeight": {
1633
- "title": "Minimumzheight",
1634
- "description": "Optional minimal Z margin in mm. If this is larger than the API's default safe Z margin, it will make the arc higher. If it's smaller, it will have no effect.",
1635
- "type": "number"
1636
- },
1637
- "forceDirect": {
1638
- "title": "Forcedirect",
1639
- "description": "If true, moving from one labware/well to another will not arc to the default safe z, but instead will move directly to the specified location. This will also force the `minimumZHeight` param to be ignored. A 'direct' movement is in X/Y/Z simultaneously.",
1640
- "default": false,
1641
- "type": "boolean"
1642
- },
1643
- "speed": {
1644
- "title": "Speed",
1645
- "description": "Override the travel speed in mm/s. This controls the straight linear speed of motion.",
1646
- "type": "number"
1647
- },
1648
- "labwareId": {
1649
- "title": "Labwareid",
1650
- "description": "Identifier of labware to use.",
1651
- "type": "string"
1652
- },
1653
- "wellName": {
1654
- "title": "Wellname",
1655
- "description": "Name of well to use in labware.",
1656
- "type": "string"
1657
- },
1658
- "wellLocation": {
1659
- "title": "Welllocation",
1660
- "description": "Relative well location at which to perform the operation",
1661
- "allOf": [
1662
- {
1663
- "$ref": "#/definitions/WellLocation"
1664
- }
1665
- ]
1666
- },
1667
- "pipetteId": {
1668
- "title": "Pipetteid",
1669
- "description": "Identifier of pipette to use for liquid handling.",
1670
- "type": "string"
1671
- }
1672
- },
1673
- "required": ["labwareId", "wellName", "pipetteId"]
1674
- },
1675
- "MoveToWellCreate": {
1676
- "title": "MoveToWellCreate",
1677
- "description": "Move to well command creation request model.",
1678
- "type": "object",
1679
- "properties": {
1680
- "commandType": {
1681
- "title": "Commandtype",
1682
- "default": "moveToWell",
1683
- "enum": ["moveToWell"],
1684
- "type": "string"
1685
- },
1686
- "params": {
1687
- "$ref": "#/definitions/MoveToWellParams"
1688
- },
1689
- "intent": {
1690
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
1691
- "allOf": [
1692
- {
1693
- "$ref": "#/definitions/CommandIntent"
1694
- }
1695
- ]
1696
- },
1697
- "key": {
1698
- "title": "Key",
1699
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
1700
- "type": "string"
1701
- }
1702
- },
1703
- "required": ["params"]
1704
- },
1705
- "WaitForResumeParams": {
1706
- "title": "WaitForResumeParams",
1707
- "description": "Payload required to pause the protocol.",
1708
- "type": "object",
1709
- "properties": {
1710
- "message": {
1711
- "title": "Message",
1712
- "description": "A user-facing message associated with the pause",
1713
- "type": "string"
1714
- }
1715
- }
1716
- },
1717
- "WaitForResumeCreate": {
1718
- "title": "WaitForResumeCreate",
1719
- "description": "Wait for resume command request model.",
1720
- "type": "object",
1721
- "properties": {
1722
- "commandType": {
1723
- "title": "Commandtype",
1724
- "default": "waitForResume",
1725
- "enum": ["waitForResume", "pause"],
1726
- "type": "string"
1727
- },
1728
- "params": {
1729
- "$ref": "#/definitions/WaitForResumeParams"
1730
- },
1731
- "intent": {
1732
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
1733
- "allOf": [
1734
- {
1735
- "$ref": "#/definitions/CommandIntent"
1736
- }
1737
- ]
1738
- },
1739
- "key": {
1740
- "title": "Key",
1741
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
1742
- "type": "string"
1743
- }
1744
- },
1745
- "required": ["params"]
1746
- },
1747
- "WaitForDurationParams": {
1748
- "title": "WaitForDurationParams",
1749
- "description": "Payload required to pause the protocol.",
1750
- "type": "object",
1751
- "properties": {
1752
- "seconds": {
1753
- "title": "Seconds",
1754
- "description": "Duration, in seconds, to wait for.",
1755
- "type": "number"
1756
- },
1757
- "message": {
1758
- "title": "Message",
1759
- "description": "A user-facing message associated with the pause",
1760
- "type": "string"
1761
- }
1762
- },
1763
- "required": ["seconds"]
1764
- },
1765
- "WaitForDurationCreate": {
1766
- "title": "WaitForDurationCreate",
1767
- "description": "Wait for duration command request model.",
1768
- "type": "object",
1769
- "properties": {
1770
- "commandType": {
1771
- "title": "Commandtype",
1772
- "default": "waitForDuration",
1773
- "enum": ["waitForDuration"],
1774
- "type": "string"
1775
- },
1776
- "params": {
1777
- "$ref": "#/definitions/WaitForDurationParams"
1778
- },
1779
- "intent": {
1780
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
1781
- "allOf": [
1782
- {
1783
- "$ref": "#/definitions/CommandIntent"
1784
- }
1785
- ]
1786
- },
1787
- "key": {
1788
- "title": "Key",
1789
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
1790
- "type": "string"
1791
- }
1792
- },
1793
- "required": ["params"]
1794
- },
1795
- "PickUpTipParams": {
1796
- "title": "PickUpTipParams",
1797
- "description": "Payload needed to move a pipette to a specific well.",
1798
- "type": "object",
1799
- "properties": {
1800
- "labwareId": {
1801
- "title": "Labwareid",
1802
- "description": "Identifier of labware to use.",
1803
- "type": "string"
1804
- },
1805
- "wellName": {
1806
- "title": "Wellname",
1807
- "description": "Name of well to use in labware.",
1808
- "type": "string"
1809
- },
1810
- "wellLocation": {
1811
- "title": "Welllocation",
1812
- "description": "Relative well location at which to perform the operation",
1813
- "allOf": [
1814
- {
1815
- "$ref": "#/definitions/WellLocation"
1816
- }
1817
- ]
1818
- },
1819
- "pipetteId": {
1820
- "title": "Pipetteid",
1821
- "description": "Identifier of pipette to use for liquid handling.",
1822
- "type": "string"
1823
- }
1824
- },
1825
- "required": ["labwareId", "wellName", "pipetteId"]
1826
- },
1827
- "PickUpTipCreate": {
1828
- "title": "PickUpTipCreate",
1829
- "description": "Pick up tip command creation request model.",
1830
- "type": "object",
1831
- "properties": {
1832
- "commandType": {
1833
- "title": "Commandtype",
1834
- "default": "pickUpTip",
1835
- "enum": ["pickUpTip"],
1836
- "type": "string"
1837
- },
1838
- "params": {
1839
- "$ref": "#/definitions/PickUpTipParams"
1840
- },
1841
- "intent": {
1842
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
1843
- "allOf": [
1844
- {
1845
- "$ref": "#/definitions/CommandIntent"
1846
- }
1847
- ]
1848
- },
1849
- "key": {
1850
- "title": "Key",
1851
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
1852
- "type": "string"
1853
- }
1854
- },
1855
- "required": ["params"]
1856
- },
1857
- "SavePositionParams": {
1858
- "title": "SavePositionParams",
1859
- "description": "Payload needed to save a pipette's current position.",
1860
- "type": "object",
1861
- "properties": {
1862
- "pipetteId": {
1863
- "title": "Pipetteid",
1864
- "description": "Unique identifier of the pipette in question.",
1865
- "type": "string"
1866
- },
1867
- "positionId": {
1868
- "title": "Positionid",
1869
- "description": "An optional ID to assign to this command instance. Auto-assigned if not defined.",
1870
- "type": "string"
1871
- }
1872
- },
1873
- "required": ["pipetteId"]
1874
- },
1875
- "SavePositionCreate": {
1876
- "title": "SavePositionCreate",
1877
- "description": "Save position command creation request model.",
1878
- "type": "object",
1879
- "properties": {
1880
- "commandType": {
1881
- "title": "Commandtype",
1882
- "default": "savePosition",
1883
- "enum": ["savePosition"],
1884
- "type": "string"
1885
- },
1886
- "params": {
1887
- "$ref": "#/definitions/SavePositionParams"
1888
- },
1889
- "intent": {
1890
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
1891
- "allOf": [
1892
- {
1893
- "$ref": "#/definitions/CommandIntent"
1894
- }
1895
- ]
1896
- },
1897
- "key": {
1898
- "title": "Key",
1899
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
1900
- "type": "string"
1901
- }
1902
- },
1903
- "required": ["params"]
1904
- },
1905
- "SetRailLightsParams": {
1906
- "title": "SetRailLightsParams",
1907
- "description": "Payload required to set the rail lights on or off.",
1908
- "type": "object",
1909
- "properties": {
1910
- "on": {
1911
- "title": "On",
1912
- "description": "The field that determines if the light is turned off or on.",
1913
- "type": "boolean"
1914
- }
1915
- },
1916
- "required": ["on"]
1917
- },
1918
- "SetRailLightsCreate": {
1919
- "title": "SetRailLightsCreate",
1920
- "description": "setRailLights command request model.",
1921
- "type": "object",
1922
- "properties": {
1923
- "commandType": {
1924
- "title": "Commandtype",
1925
- "default": "setRailLights",
1926
- "enum": ["setRailLights"],
1927
- "type": "string"
1928
- },
1929
- "params": {
1930
- "$ref": "#/definitions/SetRailLightsParams"
1931
- },
1932
- "intent": {
1933
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
1934
- "allOf": [
1935
- {
1936
- "$ref": "#/definitions/CommandIntent"
1937
- }
1938
- ]
1939
- },
1940
- "key": {
1941
- "title": "Key",
1942
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
1943
- "type": "string"
1944
- }
1945
- },
1946
- "required": ["params"]
1947
- },
1948
- "TouchTipParams": {
1949
- "title": "TouchTipParams",
1950
- "description": "Payload needed to touch a pipette tip the sides of a specific well.",
1951
- "type": "object",
1952
- "properties": {
1953
- "labwareId": {
1954
- "title": "Labwareid",
1955
- "description": "Identifier of labware to use.",
1956
- "type": "string"
1957
- },
1958
- "wellName": {
1959
- "title": "Wellname",
1960
- "description": "Name of well to use in labware.",
1961
- "type": "string"
1962
- },
1963
- "wellLocation": {
1964
- "title": "Welllocation",
1965
- "description": "Relative well location at which to perform the operation",
1966
- "allOf": [
1967
- {
1968
- "$ref": "#/definitions/WellLocation"
1969
- }
1970
- ]
1971
- },
1972
- "pipetteId": {
1973
- "title": "Pipetteid",
1974
- "description": "Identifier of pipette to use for liquid handling.",
1975
- "type": "string"
1976
- },
1977
- "radius": {
1978
- "title": "Radius",
1979
- "description": "The proportion of the target well's radius the pipette tip will move towards.",
1980
- "default": 1.0,
1981
- "type": "number"
1982
- },
1983
- "speed": {
1984
- "title": "Speed",
1985
- "description": "Override the travel speed in mm/s. This controls the straight linear speed of motion.",
1986
- "type": "number"
1987
- }
1988
- },
1989
- "required": ["labwareId", "wellName", "pipetteId"]
1990
- },
1991
- "TouchTipCreate": {
1992
- "title": "TouchTipCreate",
1993
- "description": "Touch tip command creation request model.",
1994
- "type": "object",
1995
- "properties": {
1996
- "commandType": {
1997
- "title": "Commandtype",
1998
- "default": "touchTip",
1999
- "enum": ["touchTip"],
2000
- "type": "string"
2001
- },
2002
- "params": {
2003
- "$ref": "#/definitions/TouchTipParams"
2004
- },
2005
- "intent": {
2006
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
2007
- "allOf": [
2008
- {
2009
- "$ref": "#/definitions/CommandIntent"
2010
- }
2011
- ]
2012
- },
2013
- "key": {
2014
- "title": "Key",
2015
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
2016
- "type": "string"
2017
- }
2018
- },
2019
- "required": ["params"]
2020
- },
2021
- "StatusBarAnimation": {
2022
- "title": "StatusBarAnimation",
2023
- "description": "Status Bar animation options.",
2024
- "enum": ["idle", "confirm", "updating", "disco", "off"]
2025
- },
2026
- "SetStatusBarParams": {
2027
- "title": "SetStatusBarParams",
2028
- "description": "Payload required to set the status bar to run an animation.",
2029
- "type": "object",
2030
- "properties": {
2031
- "animation": {
2032
- "description": "The animation that should be executed on the status bar.",
2033
- "allOf": [
2034
- {
2035
- "$ref": "#/definitions/StatusBarAnimation"
2036
- }
2037
- ]
2038
- }
2039
- },
2040
- "required": ["animation"]
2041
- },
2042
- "SetStatusBarCreate": {
2043
- "title": "SetStatusBarCreate",
2044
- "description": "setStatusBar command request model.",
2045
- "type": "object",
2046
- "properties": {
2047
- "commandType": {
2048
- "title": "Commandtype",
2049
- "default": "setStatusBar",
2050
- "enum": ["setStatusBar"],
2051
- "type": "string"
2052
- },
2053
- "params": {
2054
- "$ref": "#/definitions/SetStatusBarParams"
2055
- },
2056
- "intent": {
2057
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
2058
- "allOf": [
2059
- {
2060
- "$ref": "#/definitions/CommandIntent"
2061
- }
2062
- ]
2063
- },
2064
- "key": {
2065
- "title": "Key",
2066
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
2067
- "type": "string"
2068
- }
2069
- },
2070
- "required": ["params"]
2071
- },
2072
- "opentrons__protocol_engine__commands__heater_shaker__wait_for_temperature__WaitForTemperatureParams": {
2073
- "title": "WaitForTemperatureParams",
2074
- "description": "Input parameters to wait for a Heater-Shaker's target temperature.",
2075
- "type": "object",
2076
- "properties": {
2077
- "moduleId": {
2078
- "title": "Moduleid",
2079
- "description": "Unique ID of the Heater-Shaker Module.",
2080
- "type": "string"
2081
- },
2082
- "celsius": {
2083
- "title": "Celsius",
2084
- "description": "Target temperature in \u00b0C. If not specified, will default to the module's target temperature. Specifying a celsius parameter other than the target temperature could lead to unpredictable behavior and hence is not recommended for use. This parameter can be removed in a future version without prior notice.",
2085
- "type": "number"
2086
- }
2087
- },
2088
- "required": ["moduleId"]
2089
- },
2090
- "opentrons__protocol_engine__commands__heater_shaker__wait_for_temperature__WaitForTemperatureCreate": {
2091
- "title": "WaitForTemperatureCreate",
2092
- "description": "A request to create a Heater-Shaker's wait for temperature command.",
2093
- "type": "object",
2094
- "properties": {
2095
- "commandType": {
2096
- "title": "Commandtype",
2097
- "default": "heaterShaker/waitForTemperature",
2098
- "enum": ["heaterShaker/waitForTemperature"],
2099
- "type": "string"
2100
- },
2101
- "params": {
2102
- "$ref": "#/definitions/opentrons__protocol_engine__commands__heater_shaker__wait_for_temperature__WaitForTemperatureParams"
2103
- },
2104
- "intent": {
2105
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
2106
- "allOf": [
2107
- {
2108
- "$ref": "#/definitions/CommandIntent"
2109
- }
2110
- ]
2111
- },
2112
- "key": {
2113
- "title": "Key",
2114
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
2115
- "type": "string"
2116
- }
2117
- },
2118
- "required": ["params"]
2119
- },
2120
- "opentrons__protocol_engine__commands__heater_shaker__set_target_temperature__SetTargetTemperatureParams": {
2121
- "title": "SetTargetTemperatureParams",
2122
- "description": "Input parameters to set a Heater-Shaker's target temperature.",
2123
- "type": "object",
2124
- "properties": {
2125
- "moduleId": {
2126
- "title": "Moduleid",
2127
- "description": "Unique ID of the Heater-Shaker Module.",
2128
- "type": "string"
2129
- },
2130
- "celsius": {
2131
- "title": "Celsius",
2132
- "description": "Target temperature in \u00b0C.",
2133
- "type": "number"
2134
- }
2135
- },
2136
- "required": ["moduleId", "celsius"]
2137
- },
2138
- "opentrons__protocol_engine__commands__heater_shaker__set_target_temperature__SetTargetTemperatureCreate": {
2139
- "title": "SetTargetTemperatureCreate",
2140
- "description": "A request to create a Heater-Shaker's set temperature command.",
2141
- "type": "object",
2142
- "properties": {
2143
- "commandType": {
2144
- "title": "Commandtype",
2145
- "default": "heaterShaker/setTargetTemperature",
2146
- "enum": ["heaterShaker/setTargetTemperature"],
2147
- "type": "string"
2148
- },
2149
- "params": {
2150
- "$ref": "#/definitions/opentrons__protocol_engine__commands__heater_shaker__set_target_temperature__SetTargetTemperatureParams"
2151
- },
2152
- "intent": {
2153
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
2154
- "allOf": [
2155
- {
2156
- "$ref": "#/definitions/CommandIntent"
2157
- }
2158
- ]
2159
- },
2160
- "key": {
2161
- "title": "Key",
2162
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
2163
- "type": "string"
2164
- }
2165
- },
2166
- "required": ["params"]
2167
- },
2168
- "DeactivateHeaterParams": {
2169
- "title": "DeactivateHeaterParams",
2170
- "description": "Input parameters to unset a Heater-Shaker's target temperature.",
2171
- "type": "object",
2172
- "properties": {
2173
- "moduleId": {
2174
- "title": "Moduleid",
2175
- "description": "Unique ID of the Heater-Shaker Module.",
2176
- "type": "string"
2177
- }
2178
- },
2179
- "required": ["moduleId"]
2180
- },
2181
- "DeactivateHeaterCreate": {
2182
- "title": "DeactivateHeaterCreate",
2183
- "description": "A request to create a Heater-Shaker's deactivate heater command.",
2184
- "type": "object",
2185
- "properties": {
2186
- "commandType": {
2187
- "title": "Commandtype",
2188
- "default": "heaterShaker/deactivateHeater",
2189
- "enum": ["heaterShaker/deactivateHeater"],
2190
- "type": "string"
2191
- },
2192
- "params": {
2193
- "$ref": "#/definitions/DeactivateHeaterParams"
2194
- },
2195
- "intent": {
2196
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
2197
- "allOf": [
2198
- {
2199
- "$ref": "#/definitions/CommandIntent"
2200
- }
2201
- ]
2202
- },
2203
- "key": {
2204
- "title": "Key",
2205
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
2206
- "type": "string"
2207
- }
2208
- },
2209
- "required": ["params"]
2210
- },
2211
- "SetAndWaitForShakeSpeedParams": {
2212
- "title": "SetAndWaitForShakeSpeedParams",
2213
- "description": "Input parameters to set and wait for a shake speed for a Heater-Shaker Module.",
2214
- "type": "object",
2215
- "properties": {
2216
- "moduleId": {
2217
- "title": "Moduleid",
2218
- "description": "Unique ID of the Heater-Shaker Module.",
2219
- "type": "string"
2220
- },
2221
- "rpm": {
2222
- "title": "Rpm",
2223
- "description": "Target speed in rotations per minute.",
2224
- "type": "number"
2225
- }
2226
- },
2227
- "required": ["moduleId", "rpm"]
2228
- },
2229
- "SetAndWaitForShakeSpeedCreate": {
2230
- "title": "SetAndWaitForShakeSpeedCreate",
2231
- "description": "A request to create a Heater-Shaker's set and wait for shake speed command.",
2232
- "type": "object",
2233
- "properties": {
2234
- "commandType": {
2235
- "title": "Commandtype",
2236
- "default": "heaterShaker/setAndWaitForShakeSpeed",
2237
- "enum": ["heaterShaker/setAndWaitForShakeSpeed"],
2238
- "type": "string"
2239
- },
2240
- "params": {
2241
- "$ref": "#/definitions/SetAndWaitForShakeSpeedParams"
2242
- },
2243
- "intent": {
2244
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
2245
- "allOf": [
2246
- {
2247
- "$ref": "#/definitions/CommandIntent"
2248
- }
2249
- ]
2250
- },
2251
- "key": {
2252
- "title": "Key",
2253
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
2254
- "type": "string"
2255
- }
2256
- },
2257
- "required": ["params"]
2258
- },
2259
- "DeactivateShakerParams": {
2260
- "title": "DeactivateShakerParams",
2261
- "description": "Input parameters to deactivate shaker for a Heater-Shaker Module.",
2262
- "type": "object",
2263
- "properties": {
2264
- "moduleId": {
2265
- "title": "Moduleid",
2266
- "description": "Unique ID of the Heater-Shaker Module.",
2267
- "type": "string"
2268
- }
2269
- },
2270
- "required": ["moduleId"]
2271
- },
2272
- "DeactivateShakerCreate": {
2273
- "title": "DeactivateShakerCreate",
2274
- "description": "A request to create a Heater-Shaker's deactivate shaker command.",
2275
- "type": "object",
2276
- "properties": {
2277
- "commandType": {
2278
- "title": "Commandtype",
2279
- "default": "heaterShaker/deactivateShaker",
2280
- "enum": ["heaterShaker/deactivateShaker"],
2281
- "type": "string"
2282
- },
2283
- "params": {
2284
- "$ref": "#/definitions/DeactivateShakerParams"
2285
- },
2286
- "intent": {
2287
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
2288
- "allOf": [
2289
- {
2290
- "$ref": "#/definitions/CommandIntent"
2291
- }
2292
- ]
2293
- },
2294
- "key": {
2295
- "title": "Key",
2296
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
2297
- "type": "string"
2298
- }
2299
- },
2300
- "required": ["params"]
2301
- },
2302
- "OpenLabwareLatchParams": {
2303
- "title": "OpenLabwareLatchParams",
2304
- "description": "Input parameters to open a Heater-Shaker Module's labware latch.",
2305
- "type": "object",
2306
- "properties": {
2307
- "moduleId": {
2308
- "title": "Moduleid",
2309
- "description": "Unique ID of the Heater-Shaker Module.",
2310
- "type": "string"
2311
- }
2312
- },
2313
- "required": ["moduleId"]
2314
- },
2315
- "OpenLabwareLatchCreate": {
2316
- "title": "OpenLabwareLatchCreate",
2317
- "description": "A request to create a Heater-Shaker's open labware latch command.",
2318
- "type": "object",
2319
- "properties": {
2320
- "commandType": {
2321
- "title": "Commandtype",
2322
- "default": "heaterShaker/openLabwareLatch",
2323
- "enum": ["heaterShaker/openLabwareLatch"],
2324
- "type": "string"
2325
- },
2326
- "params": {
2327
- "$ref": "#/definitions/OpenLabwareLatchParams"
2328
- },
2329
- "intent": {
2330
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
2331
- "allOf": [
2332
- {
2333
- "$ref": "#/definitions/CommandIntent"
2334
- }
2335
- ]
2336
- },
2337
- "key": {
2338
- "title": "Key",
2339
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
2340
- "type": "string"
2341
- }
2342
- },
2343
- "required": ["params"]
2344
- },
2345
- "CloseLabwareLatchParams": {
2346
- "title": "CloseLabwareLatchParams",
2347
- "description": "Input parameters to close a Heater-Shaker Module's labware latch.",
2348
- "type": "object",
2349
- "properties": {
2350
- "moduleId": {
2351
- "title": "Moduleid",
2352
- "description": "Unique ID of the Heater-Shaker Module.",
2353
- "type": "string"
2354
- }
2355
- },
2356
- "required": ["moduleId"]
2357
- },
2358
- "CloseLabwareLatchCreate": {
2359
- "title": "CloseLabwareLatchCreate",
2360
- "description": "A request to create a Heater-Shaker's close latch command.",
2361
- "type": "object",
2362
- "properties": {
2363
- "commandType": {
2364
- "title": "Commandtype",
2365
- "default": "heaterShaker/closeLabwareLatch",
2366
- "enum": ["heaterShaker/closeLabwareLatch"],
2367
- "type": "string"
2368
- },
2369
- "params": {
2370
- "$ref": "#/definitions/CloseLabwareLatchParams"
2371
- },
2372
- "intent": {
2373
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
2374
- "allOf": [
2375
- {
2376
- "$ref": "#/definitions/CommandIntent"
2377
- }
2378
- ]
2379
- },
2380
- "key": {
2381
- "title": "Key",
2382
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
2383
- "type": "string"
2384
- }
2385
- },
2386
- "required": ["params"]
2387
- },
2388
- "DisengageParams": {
2389
- "title": "DisengageParams",
2390
- "description": "Input data to disengage a Magnetic Module's magnets.",
2391
- "type": "object",
2392
- "properties": {
2393
- "moduleId": {
2394
- "title": "Moduleid",
2395
- "description": "The ID of the Magnetic Module whose magnets you want to disengage, from a prior `loadModule` command.",
2396
- "type": "string"
2397
- }
2398
- },
2399
- "required": ["moduleId"]
2400
- },
2401
- "DisengageCreate": {
2402
- "title": "DisengageCreate",
2403
- "description": "A request to create a Magnetic Module disengage command.",
2404
- "type": "object",
2405
- "properties": {
2406
- "commandType": {
2407
- "title": "Commandtype",
2408
- "default": "magneticModule/disengage",
2409
- "enum": ["magneticModule/disengage"],
2410
- "type": "string"
2411
- },
2412
- "params": {
2413
- "$ref": "#/definitions/DisengageParams"
2414
- },
2415
- "intent": {
2416
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
2417
- "allOf": [
2418
- {
2419
- "$ref": "#/definitions/CommandIntent"
2420
- }
2421
- ]
2422
- },
2423
- "key": {
2424
- "title": "Key",
2425
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
2426
- "type": "string"
2427
- }
2428
- },
2429
- "required": ["params"]
2430
- },
2431
- "EngageParams": {
2432
- "title": "EngageParams",
2433
- "description": "Input data to engage a Magnetic Module.",
2434
- "type": "object",
2435
- "properties": {
2436
- "moduleId": {
2437
- "title": "Moduleid",
2438
- "description": "The ID of the Magnetic Module whose magnets you want to raise, from a prior `loadModule` command.",
2439
- "type": "string"
2440
- },
2441
- "height": {
2442
- "title": "Height",
2443
- "description": "How high, in millimeters, to raise the magnets.\n\nZero means the tops of the magnets are level with the ledge that the labware rests on. This will be slightly above the magnets' minimum height, the hardware home position. Negative values are allowed, to put the magnets below the ledge.\n\nUnits are always true millimeters. This is unlike certain labware definitions, engage commands in the Python Protocol API, and engage commands in older versions of the JSON protocol schema. Take care to convert properly.",
2444
- "type": "number"
2445
- }
2446
- },
2447
- "required": ["moduleId", "height"]
2448
- },
2449
- "EngageCreate": {
2450
- "title": "EngageCreate",
2451
- "description": "A request to create a Magnetic Module engage command.",
2452
- "type": "object",
2453
- "properties": {
2454
- "commandType": {
2455
- "title": "Commandtype",
2456
- "default": "magneticModule/engage",
2457
- "enum": ["magneticModule/engage"],
2458
- "type": "string"
2459
- },
2460
- "params": {
2461
- "$ref": "#/definitions/EngageParams"
2462
- },
2463
- "intent": {
2464
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
2465
- "allOf": [
2466
- {
2467
- "$ref": "#/definitions/CommandIntent"
2468
- }
2469
- ]
2470
- },
2471
- "key": {
2472
- "title": "Key",
2473
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
2474
- "type": "string"
2475
- }
2476
- },
2477
- "required": ["params"]
2478
- },
2479
- "opentrons__protocol_engine__commands__temperature_module__set_target_temperature__SetTargetTemperatureParams": {
2480
- "title": "SetTargetTemperatureParams",
2481
- "description": "Input parameters to set a Temperature Module's target temperature.",
2482
- "type": "object",
2483
- "properties": {
2484
- "moduleId": {
2485
- "title": "Moduleid",
2486
- "description": "Unique ID of the Temperature Module.",
2487
- "type": "string"
2488
- },
2489
- "celsius": {
2490
- "title": "Celsius",
2491
- "description": "Target temperature in \u00b0C.",
2492
- "type": "number"
2493
- }
2494
- },
2495
- "required": ["moduleId", "celsius"]
2496
- },
2497
- "opentrons__protocol_engine__commands__temperature_module__set_target_temperature__SetTargetTemperatureCreate": {
2498
- "title": "SetTargetTemperatureCreate",
2499
- "description": "A request to create a Temperature Module's set temperature command.",
2500
- "type": "object",
2501
- "properties": {
2502
- "commandType": {
2503
- "title": "Commandtype",
2504
- "default": "temperatureModule/setTargetTemperature",
2505
- "enum": ["temperatureModule/setTargetTemperature"],
2506
- "type": "string"
2507
- },
2508
- "params": {
2509
- "$ref": "#/definitions/opentrons__protocol_engine__commands__temperature_module__set_target_temperature__SetTargetTemperatureParams"
2510
- },
2511
- "intent": {
2512
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
2513
- "allOf": [
2514
- {
2515
- "$ref": "#/definitions/CommandIntent"
2516
- }
2517
- ]
2518
- },
2519
- "key": {
2520
- "title": "Key",
2521
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
2522
- "type": "string"
2523
- }
2524
- },
2525
- "required": ["params"]
2526
- },
2527
- "opentrons__protocol_engine__commands__temperature_module__wait_for_temperature__WaitForTemperatureParams": {
2528
- "title": "WaitForTemperatureParams",
2529
- "description": "Input parameters to wait for a Temperature Module's target temperature.",
2530
- "type": "object",
2531
- "properties": {
2532
- "moduleId": {
2533
- "title": "Moduleid",
2534
- "description": "Unique ID of the Temperature Module.",
2535
- "type": "string"
2536
- },
2537
- "celsius": {
2538
- "title": "Celsius",
2539
- "description": "Target temperature in \u00b0C. If not specified, will default to the module's target temperature. Specifying a celsius parameter other than the target temperature could lead to unpredictable behavior and hence is not recommended for use. This parameter can be removed in a future version without prior notice.",
2540
- "type": "number"
2541
- }
2542
- },
2543
- "required": ["moduleId"]
2544
- },
2545
- "opentrons__protocol_engine__commands__temperature_module__wait_for_temperature__WaitForTemperatureCreate": {
2546
- "title": "WaitForTemperatureCreate",
2547
- "description": "A request to create a Temperature Module's wait for temperature command.",
2548
- "type": "object",
2549
- "properties": {
2550
- "commandType": {
2551
- "title": "Commandtype",
2552
- "default": "temperatureModule/waitForTemperature",
2553
- "enum": ["temperatureModule/waitForTemperature"],
2554
- "type": "string"
2555
- },
2556
- "params": {
2557
- "$ref": "#/definitions/opentrons__protocol_engine__commands__temperature_module__wait_for_temperature__WaitForTemperatureParams"
2558
- },
2559
- "intent": {
2560
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
2561
- "allOf": [
2562
- {
2563
- "$ref": "#/definitions/CommandIntent"
2564
- }
2565
- ]
2566
- },
2567
- "key": {
2568
- "title": "Key",
2569
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
2570
- "type": "string"
2571
- }
2572
- },
2573
- "required": ["params"]
2574
- },
2575
- "DeactivateTemperatureParams": {
2576
- "title": "DeactivateTemperatureParams",
2577
- "description": "Input parameters to deactivate a Temperature Module.",
2578
- "type": "object",
2579
- "properties": {
2580
- "moduleId": {
2581
- "title": "Moduleid",
2582
- "description": "Unique ID of the Temperature Module.",
2583
- "type": "string"
2584
- }
2585
- },
2586
- "required": ["moduleId"]
2587
- },
2588
- "DeactivateTemperatureCreate": {
2589
- "title": "DeactivateTemperatureCreate",
2590
- "description": "A request to deactivate a Temperature Module.",
2591
- "type": "object",
2592
- "properties": {
2593
- "commandType": {
2594
- "title": "Commandtype",
2595
- "default": "temperatureModule/deactivate",
2596
- "enum": ["temperatureModule/deactivate"],
2597
- "type": "string"
2598
- },
2599
- "params": {
2600
- "$ref": "#/definitions/DeactivateTemperatureParams"
2601
- },
2602
- "intent": {
2603
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
2604
- "allOf": [
2605
- {
2606
- "$ref": "#/definitions/CommandIntent"
2607
- }
2608
- ]
2609
- },
2610
- "key": {
2611
- "title": "Key",
2612
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
2613
- "type": "string"
2614
- }
2615
- },
2616
- "required": ["params"]
2617
- },
2618
- "SetTargetBlockTemperatureParams": {
2619
- "title": "SetTargetBlockTemperatureParams",
2620
- "description": "Input parameters to set a Thermocycler's target block temperature.",
2621
- "type": "object",
2622
- "properties": {
2623
- "moduleId": {
2624
- "title": "Moduleid",
2625
- "description": "Unique ID of the Thermocycler Module.",
2626
- "type": "string"
2627
- },
2628
- "celsius": {
2629
- "title": "Celsius",
2630
- "description": "Target temperature in \u00b0C.",
2631
- "type": "number"
2632
- },
2633
- "blockMaxVolumeUl": {
2634
- "title": "Blockmaxvolumeul",
2635
- "description": "Amount of liquid in uL of the most-full well in labware loaded onto the thermocycler.",
2636
- "type": "number"
2637
- },
2638
- "holdTimeSeconds": {
2639
- "title": "Holdtimeseconds",
2640
- "description": "Amount of time, in seconds, to hold the temperature for. If specified, a waitForBlockTemperature command will block until the given hold time has elapsed.",
2641
- "type": "number"
2642
- }
2643
- },
2644
- "required": ["moduleId", "celsius"]
2645
- },
2646
- "SetTargetBlockTemperatureCreate": {
2647
- "title": "SetTargetBlockTemperatureCreate",
2648
- "description": "A request to create a Thermocycler's set block temperature command.",
2649
- "type": "object",
2650
- "properties": {
2651
- "commandType": {
2652
- "title": "Commandtype",
2653
- "default": "thermocycler/setTargetBlockTemperature",
2654
- "enum": ["thermocycler/setTargetBlockTemperature"],
2655
- "type": "string"
2656
- },
2657
- "params": {
2658
- "$ref": "#/definitions/SetTargetBlockTemperatureParams"
2659
- },
2660
- "intent": {
2661
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
2662
- "allOf": [
2663
- {
2664
- "$ref": "#/definitions/CommandIntent"
2665
- }
2666
- ]
2667
- },
2668
- "key": {
2669
- "title": "Key",
2670
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
2671
- "type": "string"
2672
- }
2673
- },
2674
- "required": ["params"]
2675
- },
2676
- "WaitForBlockTemperatureParams": {
2677
- "title": "WaitForBlockTemperatureParams",
2678
- "description": "Input parameters to wait for Thermocycler's target block temperature.",
2679
- "type": "object",
2680
- "properties": {
2681
- "moduleId": {
2682
- "title": "Moduleid",
2683
- "description": "Unique ID of the Thermocycler Module.",
2684
- "type": "string"
2685
- }
2686
- },
2687
- "required": ["moduleId"]
2688
- },
2689
- "WaitForBlockTemperatureCreate": {
2690
- "title": "WaitForBlockTemperatureCreate",
2691
- "description": "A request to create Thermocycler's wait for block temperature command.",
2692
- "type": "object",
2693
- "properties": {
2694
- "commandType": {
2695
- "title": "Commandtype",
2696
- "default": "thermocycler/waitForBlockTemperature",
2697
- "enum": ["thermocycler/waitForBlockTemperature"],
2698
- "type": "string"
2699
- },
2700
- "params": {
2701
- "$ref": "#/definitions/WaitForBlockTemperatureParams"
2702
- },
2703
- "intent": {
2704
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
2705
- "allOf": [
2706
- {
2707
- "$ref": "#/definitions/CommandIntent"
2708
- }
2709
- ]
2710
- },
2711
- "key": {
2712
- "title": "Key",
2713
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
2714
- "type": "string"
2715
- }
2716
- },
2717
- "required": ["params"]
2718
- },
2719
- "SetTargetLidTemperatureParams": {
2720
- "title": "SetTargetLidTemperatureParams",
2721
- "description": "Input parameters to set a Thermocycler's target lid temperature.",
2722
- "type": "object",
2723
- "properties": {
2724
- "moduleId": {
2725
- "title": "Moduleid",
2726
- "description": "Unique ID of the Thermocycler Module.",
2727
- "type": "string"
2728
- },
2729
- "celsius": {
2730
- "title": "Celsius",
2731
- "description": "Target temperature in \u00b0C.",
2732
- "type": "number"
2733
- }
2734
- },
2735
- "required": ["moduleId", "celsius"]
2736
- },
2737
- "SetTargetLidTemperatureCreate": {
2738
- "title": "SetTargetLidTemperatureCreate",
2739
- "description": "A request to create a Thermocycler's set lid temperature command.",
2740
- "type": "object",
2741
- "properties": {
2742
- "commandType": {
2743
- "title": "Commandtype",
2744
- "default": "thermocycler/setTargetLidTemperature",
2745
- "enum": ["thermocycler/setTargetLidTemperature"],
2746
- "type": "string"
2747
- },
2748
- "params": {
2749
- "$ref": "#/definitions/SetTargetLidTemperatureParams"
2750
- },
2751
- "intent": {
2752
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
2753
- "allOf": [
2754
- {
2755
- "$ref": "#/definitions/CommandIntent"
2756
- }
2757
- ]
2758
- },
2759
- "key": {
2760
- "title": "Key",
2761
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
2762
- "type": "string"
2763
- }
2764
- },
2765
- "required": ["params"]
2766
- },
2767
- "WaitForLidTemperatureParams": {
2768
- "title": "WaitForLidTemperatureParams",
2769
- "description": "Input parameters to wait for Thermocycler's lid temperature.",
2770
- "type": "object",
2771
- "properties": {
2772
- "moduleId": {
2773
- "title": "Moduleid",
2774
- "description": "Unique ID of the Thermocycler Module.",
2775
- "type": "string"
2776
- }
2777
- },
2778
- "required": ["moduleId"]
2779
- },
2780
- "WaitForLidTemperatureCreate": {
2781
- "title": "WaitForLidTemperatureCreate",
2782
- "description": "A request to create Thermocycler's wait for lid temperature command.",
2783
- "type": "object",
2784
- "properties": {
2785
- "commandType": {
2786
- "title": "Commandtype",
2787
- "default": "thermocycler/waitForLidTemperature",
2788
- "enum": ["thermocycler/waitForLidTemperature"],
2789
- "type": "string"
2790
- },
2791
- "params": {
2792
- "$ref": "#/definitions/WaitForLidTemperatureParams"
2793
- },
2794
- "intent": {
2795
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
2796
- "allOf": [
2797
- {
2798
- "$ref": "#/definitions/CommandIntent"
2799
- }
2800
- ]
2801
- },
2802
- "key": {
2803
- "title": "Key",
2804
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
2805
- "type": "string"
2806
- }
2807
- },
2808
- "required": ["params"]
2809
- },
2810
- "DeactivateBlockParams": {
2811
- "title": "DeactivateBlockParams",
2812
- "description": "Input parameters to unset a Thermocycler's target block temperature.",
2813
- "type": "object",
2814
- "properties": {
2815
- "moduleId": {
2816
- "title": "Moduleid",
2817
- "description": "Unique ID of the Thermocycler.",
2818
- "type": "string"
2819
- }
2820
- },
2821
- "required": ["moduleId"]
2822
- },
2823
- "DeactivateBlockCreate": {
2824
- "title": "DeactivateBlockCreate",
2825
- "description": "A request to create a Thermocycler's deactivate block command.",
2826
- "type": "object",
2827
- "properties": {
2828
- "commandType": {
2829
- "title": "Commandtype",
2830
- "default": "thermocycler/deactivateBlock",
2831
- "enum": ["thermocycler/deactivateBlock"],
2832
- "type": "string"
2833
- },
2834
- "params": {
2835
- "$ref": "#/definitions/DeactivateBlockParams"
2836
- },
2837
- "intent": {
2838
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
2839
- "allOf": [
2840
- {
2841
- "$ref": "#/definitions/CommandIntent"
2842
- }
2843
- ]
2844
- },
2845
- "key": {
2846
- "title": "Key",
2847
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
2848
- "type": "string"
2849
- }
2850
- },
2851
- "required": ["params"]
2852
- },
2853
- "DeactivateLidParams": {
2854
- "title": "DeactivateLidParams",
2855
- "description": "Input parameters to unset a Thermocycler's target lid temperature.",
2856
- "type": "object",
2857
- "properties": {
2858
- "moduleId": {
2859
- "title": "Moduleid",
2860
- "description": "Unique ID of the Thermocycler.",
2861
- "type": "string"
2862
- }
2863
- },
2864
- "required": ["moduleId"]
2865
- },
2866
- "DeactivateLidCreate": {
2867
- "title": "DeactivateLidCreate",
2868
- "description": "A request to create a Thermocycler's deactivate lid command.",
2869
- "type": "object",
2870
- "properties": {
2871
- "commandType": {
2872
- "title": "Commandtype",
2873
- "default": "thermocycler/deactivateLid",
2874
- "enum": ["thermocycler/deactivateLid"],
2875
- "type": "string"
2876
- },
2877
- "params": {
2878
- "$ref": "#/definitions/DeactivateLidParams"
2879
- },
2880
- "intent": {
2881
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
2882
- "allOf": [
2883
- {
2884
- "$ref": "#/definitions/CommandIntent"
2885
- }
2886
- ]
2887
- },
2888
- "key": {
2889
- "title": "Key",
2890
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
2891
- "type": "string"
2892
- }
2893
- },
2894
- "required": ["params"]
2895
- },
2896
- "OpenLidParams": {
2897
- "title": "OpenLidParams",
2898
- "description": "Input parameters to open a Thermocycler's lid.",
2899
- "type": "object",
2900
- "properties": {
2901
- "moduleId": {
2902
- "title": "Moduleid",
2903
- "description": "Unique ID of the Thermocycler.",
2904
- "type": "string"
2905
- }
2906
- },
2907
- "required": ["moduleId"]
2908
- },
2909
- "OpenLidCreate": {
2910
- "title": "OpenLidCreate",
2911
- "description": "A request to open a Thermocycler's lid.",
2912
- "type": "object",
2913
- "properties": {
2914
- "commandType": {
2915
- "title": "Commandtype",
2916
- "default": "thermocycler/openLid",
2917
- "enum": ["thermocycler/openLid"],
2918
- "type": "string"
2919
- },
2920
- "params": {
2921
- "$ref": "#/definitions/OpenLidParams"
2922
- },
2923
- "intent": {
2924
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
2925
- "allOf": [
2926
- {
2927
- "$ref": "#/definitions/CommandIntent"
2928
- }
2929
- ]
2930
- },
2931
- "key": {
2932
- "title": "Key",
2933
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
2934
- "type": "string"
2935
- }
2936
- },
2937
- "required": ["params"]
2938
- },
2939
- "CloseLidParams": {
2940
- "title": "CloseLidParams",
2941
- "description": "Input parameters to close a Thermocycler's lid.",
2942
- "type": "object",
2943
- "properties": {
2944
- "moduleId": {
2945
- "title": "Moduleid",
2946
- "description": "Unique ID of the Thermocycler.",
2947
- "type": "string"
2948
- }
2949
- },
2950
- "required": ["moduleId"]
2951
- },
2952
- "CloseLidCreate": {
2953
- "title": "CloseLidCreate",
2954
- "description": "A request to close a Thermocycler's lid.",
2955
- "type": "object",
2956
- "properties": {
2957
- "commandType": {
2958
- "title": "Commandtype",
2959
- "default": "thermocycler/closeLid",
2960
- "enum": ["thermocycler/closeLid"],
2961
- "type": "string"
2962
- },
2963
- "params": {
2964
- "$ref": "#/definitions/CloseLidParams"
2965
- },
2966
- "intent": {
2967
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
2968
- "allOf": [
2969
- {
2970
- "$ref": "#/definitions/CommandIntent"
2971
- }
2972
- ]
2973
- },
2974
- "key": {
2975
- "title": "Key",
2976
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
2977
- "type": "string"
2978
- }
2979
- },
2980
- "required": ["params"]
2981
- },
2982
- "RunProfileStepParams": {
2983
- "title": "RunProfileStepParams",
2984
- "description": "Input parameters for an individual Thermocycler profile step.",
2985
- "type": "object",
2986
- "properties": {
2987
- "celsius": {
2988
- "title": "Celsius",
2989
- "description": "Target temperature in \u00b0C.",
2990
- "type": "number"
2991
- },
2992
- "holdSeconds": {
2993
- "title": "Holdseconds",
2994
- "description": "Time to hold target temperature at in seconds.",
2995
- "type": "number"
2996
- }
2997
- },
2998
- "required": ["celsius", "holdSeconds"]
2999
- },
3000
- "RunProfileParams": {
3001
- "title": "RunProfileParams",
3002
- "description": "Input parameters to run a Thermocycler profile.",
3003
- "type": "object",
3004
- "properties": {
3005
- "moduleId": {
3006
- "title": "Moduleid",
3007
- "description": "Unique ID of the Thermocycler.",
3008
- "type": "string"
3009
- },
3010
- "profile": {
3011
- "title": "Profile",
3012
- "description": "Array of profile steps with target temperature and temperature hold time.",
3013
- "type": "array",
3014
- "items": {
3015
- "$ref": "#/definitions/RunProfileStepParams"
3016
- }
3017
- },
3018
- "blockMaxVolumeUl": {
3019
- "title": "Blockmaxvolumeul",
3020
- "description": "Amount of liquid in uL of the most-full well in labware loaded onto the thermocycler.",
3021
- "type": "number"
3022
- }
3023
- },
3024
- "required": ["moduleId", "profile"]
3025
- },
3026
- "RunProfileCreate": {
3027
- "title": "RunProfileCreate",
3028
- "description": "A request to execute a Thermocycler profile run.",
3029
- "type": "object",
3030
- "properties": {
3031
- "commandType": {
3032
- "title": "Commandtype",
3033
- "default": "thermocycler/runProfile",
3034
- "enum": ["thermocycler/runProfile"],
3035
- "type": "string"
3036
- },
3037
- "params": {
3038
- "$ref": "#/definitions/RunProfileParams"
3039
- },
3040
- "intent": {
3041
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
3042
- "allOf": [
3043
- {
3044
- "$ref": "#/definitions/CommandIntent"
3045
- }
3046
- ]
3047
- },
3048
- "key": {
3049
- "title": "Key",
3050
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
3051
- "type": "string"
3052
- }
3053
- },
3054
- "required": ["params"]
3055
- },
3056
- "CalibrateGripperParamsJaw": {
3057
- "title": "CalibrateGripperParamsJaw",
3058
- "description": "An enumeration.",
3059
- "enum": ["front", "rear"]
3060
- },
3061
- "Vec3f": {
3062
- "title": "Vec3f",
3063
- "description": "A 3D vector of floats.",
3064
- "type": "object",
3065
- "properties": {
3066
- "x": {
3067
- "title": "X",
3068
- "type": "number"
3069
- },
3070
- "y": {
3071
- "title": "Y",
3072
- "type": "number"
3073
- },
3074
- "z": {
3075
- "title": "Z",
3076
- "type": "number"
3077
- }
3078
- },
3079
- "required": ["x", "y", "z"]
3080
- },
3081
- "CalibrateGripperParams": {
3082
- "title": "CalibrateGripperParams",
3083
- "description": "Parameters for a `calibrateGripper` command.",
3084
- "type": "object",
3085
- "properties": {
3086
- "jaw": {
3087
- "description": "Which of the gripper's jaws to use to measure its offset. The robot will assume that a human operator has already attached the capacitive probe to the jaw and none is attached to the other jaw.",
3088
- "allOf": [
3089
- {
3090
- "$ref": "#/definitions/CalibrateGripperParamsJaw"
3091
- }
3092
- ]
3093
- },
3094
- "otherJawOffset": {
3095
- "title": "Otherjawoffset",
3096
- "description": "If an offset for the other probe is already found, then specifying it here will enable the CalibrateGripper command to complete the calibration process by calculating the total offset and saving it to disk. If this param is not specified then the command will only find and return the offset for the specified probe.",
3097
- "allOf": [
3098
- {
3099
- "$ref": "#/definitions/Vec3f"
3100
- }
3101
- ]
3102
- }
3103
- },
3104
- "required": ["jaw"]
3105
- },
3106
- "CalibrateGripperCreate": {
3107
- "title": "CalibrateGripperCreate",
3108
- "description": "A request to create a `calibrateGripper` command.",
3109
- "type": "object",
3110
- "properties": {
3111
- "commandType": {
3112
- "title": "Commandtype",
3113
- "default": "calibration/calibrateGripper",
3114
- "enum": ["calibration/calibrateGripper"],
3115
- "type": "string"
3116
- },
3117
- "params": {
3118
- "$ref": "#/definitions/CalibrateGripperParams"
3119
- },
3120
- "intent": {
3121
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
3122
- "allOf": [
3123
- {
3124
- "$ref": "#/definitions/CommandIntent"
3125
- }
3126
- ]
3127
- },
3128
- "key": {
3129
- "title": "Key",
3130
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
3131
- "type": "string"
3132
- }
3133
- },
3134
- "required": ["params"]
3135
- },
3136
- "CalibratePipetteParams": {
3137
- "title": "CalibratePipetteParams",
3138
- "description": "Payload required to calibrate-pipette.",
3139
- "type": "object",
3140
- "properties": {
3141
- "mount": {
3142
- "description": "Instrument mount to calibrate.",
3143
- "allOf": [
3144
- {
3145
- "$ref": "#/definitions/MountType"
3146
- }
3147
- ]
3148
- }
3149
- },
3150
- "required": ["mount"]
3151
- },
3152
- "CalibratePipetteCreate": {
3153
- "title": "CalibratePipetteCreate",
3154
- "description": "Create calibrate-pipette command request model.",
3155
- "type": "object",
3156
- "properties": {
3157
- "commandType": {
3158
- "title": "Commandtype",
3159
- "default": "calibration/calibratePipette",
3160
- "enum": ["calibration/calibratePipette"],
3161
- "type": "string"
3162
- },
3163
- "params": {
3164
- "$ref": "#/definitions/CalibratePipetteParams"
3165
- },
3166
- "intent": {
3167
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
3168
- "allOf": [
3169
- {
3170
- "$ref": "#/definitions/CommandIntent"
3171
- }
3172
- ]
3173
- },
3174
- "key": {
3175
- "title": "Key",
3176
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
3177
- "type": "string"
3178
- }
3179
- },
3180
- "required": ["params"]
3181
- },
3182
- "CalibrateModuleParams": {
3183
- "title": "CalibrateModuleParams",
3184
- "description": "Payload required to calibrate-module.",
3185
- "type": "object",
3186
- "properties": {
3187
- "moduleId": {
3188
- "title": "Moduleid",
3189
- "description": "The unique id of module to calibrate.",
3190
- "type": "string"
3191
- },
3192
- "labwareId": {
3193
- "title": "Labwareid",
3194
- "description": "The unique id of module calibration adapter labware.",
3195
- "type": "string"
3196
- },
3197
- "mount": {
3198
- "description": "The instrument mount used to calibrate the module.",
3199
- "allOf": [
3200
- {
3201
- "$ref": "#/definitions/MountType"
3202
- }
3203
- ]
3204
- }
3205
- },
3206
- "required": ["moduleId", "labwareId", "mount"]
3207
- },
3208
- "CalibrateModuleCreate": {
3209
- "title": "CalibrateModuleCreate",
3210
- "description": "Create calibrate-module command request model.",
3211
- "type": "object",
3212
- "properties": {
3213
- "commandType": {
3214
- "title": "Commandtype",
3215
- "default": "calibration/calibrateModule",
3216
- "enum": ["calibration/calibrateModule"],
3217
- "type": "string"
3218
- },
3219
- "params": {
3220
- "$ref": "#/definitions/CalibrateModuleParams"
3221
- },
3222
- "intent": {
3223
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
3224
- "allOf": [
3225
- {
3226
- "$ref": "#/definitions/CommandIntent"
3227
- }
3228
- ]
3229
- },
3230
- "key": {
3231
- "title": "Key",
3232
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
3233
- "type": "string"
3234
- }
3235
- },
3236
- "required": ["params"]
3237
- },
3238
- "MaintenancePosition": {
3239
- "title": "MaintenancePosition",
3240
- "description": "Maintenance position options.",
3241
- "enum": ["attachPlate", "attachInstrument"]
3242
- },
3243
- "MoveToMaintenancePositionParams": {
3244
- "title": "MoveToMaintenancePositionParams",
3245
- "description": "Calibration set up position command parameters.",
3246
- "type": "object",
3247
- "properties": {
3248
- "mount": {
3249
- "description": "Gantry mount to move maintenance position.",
3250
- "allOf": [
3251
- {
3252
- "$ref": "#/definitions/MountType"
3253
- }
3254
- ]
3255
- },
3256
- "maintenancePosition": {
3257
- "description": "The position the gantry mount needs to move to.",
3258
- "default": "attachInstrument",
3259
- "allOf": [
3260
- {
3261
- "$ref": "#/definitions/MaintenancePosition"
3262
- }
3263
- ]
3264
- }
3265
- },
3266
- "required": ["mount"]
3267
- },
3268
- "MoveToMaintenancePositionCreate": {
3269
- "title": "MoveToMaintenancePositionCreate",
3270
- "description": "Calibration set up position command creation request model.",
3271
- "type": "object",
3272
- "properties": {
3273
- "commandType": {
3274
- "title": "Commandtype",
3275
- "default": "calibration/moveToMaintenancePosition",
3276
- "enum": ["calibration/moveToMaintenancePosition"],
3277
- "type": "string"
3278
- },
3279
- "params": {
3280
- "$ref": "#/definitions/MoveToMaintenancePositionParams"
3281
- },
3282
- "intent": {
3283
- "description": "The reason the command was added. If not specified or `protocol`, the command will be treated as part of the protocol run itself, and added to the end of the existing command queue.\n\nIf `setup`, the command will be treated as part of run setup. A setup command may only be enqueued if the run has not started.\n\nUse setup commands for activities like pre-run calibration checks and module setup, like pre-heating.",
3284
- "allOf": [
3285
- {
3286
- "$ref": "#/definitions/CommandIntent"
3287
- }
3288
- ]
3289
- },
3290
- "key": {
3291
- "title": "Key",
3292
- "description": "A key value, unique in this run, that can be used to track the same logical command across multiple runs of the same protocol. If a value is not provided, one will be generated.",
3293
- "type": "string"
3294
- }
3295
- },
3296
- "required": ["params"]
3297
- }
3298
- },
3299
- "$id": "opentronsCommandSchemaV7",
3300
- "$schema": "http://json-schema.org/draft-07/schema#"
3301
- }