@opentrons/shared-data 0.1.6-alpha.18 → 0.1.6-alpha.21

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 (565) hide show
  1. package/package.json +1 -1
  2. package/lib/command/schemas/10.json +0 -4879
  3. package/lib/command/schemas/11.json +0 -6309
  4. package/lib/command/schemas/7.json +0 -3301
  5. package/lib/command/schemas/8.json +0 -4321
  6. package/lib/command/schemas/9.json +0 -4430
  7. package/lib/commandAnnotation/schemas/1.json +0 -74
  8. package/lib/deck/definitions/3/ot2_short_trash.json +0 -477
  9. package/lib/deck/definitions/3/ot2_standard.json +0 -477
  10. package/lib/deck/definitions/3/ot3_standard.json +0 -989
  11. package/lib/deck/definitions/4/ot2_short_trash.json +0 -405
  12. package/lib/deck/definitions/4/ot2_standard.json +0 -410
  13. package/lib/deck/definitions/4/ot3_standard.json +0 -608
  14. package/lib/deck/definitions/5/ot2_short_trash.json +0 -409
  15. package/lib/deck/definitions/5/ot2_standard.json +0 -409
  16. package/lib/deck/definitions/5/ot3_standard.json +0 -1144
  17. package/lib/deck/fixtures/3/deckExample.json +0 -481
  18. package/lib/deck/schemas/1.json +0 -229
  19. package/lib/deck/schemas/2.json +0 -239
  20. package/lib/deck/schemas/3.json +0 -296
  21. package/lib/deck/schemas/4.json +0 -319
  22. package/lib/deck/schemas/5.json +0 -339
  23. package/lib/errors/definitions/1/errors.json +0 -258
  24. package/lib/errors/schemas/1.json +0 -49
  25. package/lib/gripper/definitions/1/gripperV1.1.json +0 -29
  26. package/lib/gripper/definitions/1/gripperV1.2.json +0 -29
  27. package/lib/gripper/definitions/1/gripperV1.3.json +0 -29
  28. package/lib/gripper/definitions/1/gripperV1.json +0 -28
  29. package/lib/gripper/schemas/1.json +0 -186
  30. package/lib/labware/definitions/1/12-well-plate.json +0 -147
  31. package/lib/labware/definitions/1/24-vial-rack.json +0 -281
  32. package/lib/labware/definitions/1/24-well-plate.json +0 -281
  33. package/lib/labware/definitions/1/384-plate.json +0 -4667
  34. package/lib/labware/definitions/1/48-vial-plate.json +0 -547
  35. package/lib/labware/definitions/1/48-well-plate.json +0 -547
  36. package/lib/labware/definitions/1/5ml-3x4.json +0 -147
  37. package/lib/labware/definitions/1/6-well-plate.json +0 -80
  38. package/lib/labware/definitions/1/96-PCR-flat.json +0 -1079
  39. package/lib/labware/definitions/1/96-PCR-tall.json +0 -1079
  40. package/lib/labware/definitions/1/96-deep-well.json +0 -1079
  41. package/lib/labware/definitions/1/96-flat.json +0 -1079
  42. package/lib/labware/definitions/1/96-well-plate-20mm.json +0 -1079
  43. package/lib/labware/definitions/1/MALDI-plate.json +0 -4282
  44. package/lib/labware/definitions/1/PCR-strip-tall.json +0 -1079
  45. package/lib/labware/definitions/1/T25-flask.json +0 -20
  46. package/lib/labware/definitions/1/T75-flask.json +0 -20
  47. package/lib/labware/definitions/1/alum-block-pcr-strips.json +0 -188
  48. package/lib/labware/definitions/1/biorad-hardshell-96-PCR.json +0 -1079
  49. package/lib/labware/definitions/1/e-gelgol.json +0 -1078
  50. package/lib/labware/definitions/1/fixed-trash.json +0 -19
  51. package/lib/labware/definitions/1/hampton-1ml-deep-block.json +0 -1078
  52. package/lib/labware/definitions/1/opentrons-aluminum-block-2ml-eppendorf.json +0 -281
  53. package/lib/labware/definitions/1/opentrons-aluminum-block-2ml-screwcap.json +0 -281
  54. package/lib/labware/definitions/1/opentrons-aluminum-block-96-PCR-plate.json +0 -1079
  55. package/lib/labware/definitions/1/opentrons-aluminum-block-PCR-strips-200ul.json +0 -1079
  56. package/lib/labware/definitions/1/opentrons-tiprack-10ul.json +0 -986
  57. package/lib/labware/definitions/1/opentrons-tiprack-300ul.json +0 -986
  58. package/lib/labware/definitions/1/opentrons-tuberack-1.5ml-eppendorf.json +0 -281
  59. package/lib/labware/definitions/1/opentrons-tuberack-15_50ml.json +0 -125
  60. package/lib/labware/definitions/1/opentrons-tuberack-15ml.json +0 -181
  61. package/lib/labware/definitions/1/opentrons-tuberack-2ml-eppendorf.json +0 -281
  62. package/lib/labware/definitions/1/opentrons-tuberack-2ml-screwcap.json +0 -281
  63. package/lib/labware/definitions/1/opentrons-tuberack-50ml.json +0 -80
  64. package/lib/labware/definitions/1/point.json +0 -18
  65. package/lib/labware/definitions/1/rigaku-compact-crystallization-plate.json +0 -2146
  66. package/lib/labware/definitions/1/small_vial_rack_16x45.json +0 -280
  67. package/lib/labware/definitions/1/tall-fixed-trash.json +0 -19
  68. package/lib/labware/definitions/1/tiprack-1000ul-H.json +0 -503
  69. package/lib/labware/definitions/1/tiprack-1000ul-chem.json +0 -1034
  70. package/lib/labware/definitions/1/tiprack-1000ul.json +0 -986
  71. package/lib/labware/definitions/1/tiprack-10ul-H.json +0 -503
  72. package/lib/labware/definitions/1/tiprack-10ul.json +0 -986
  73. package/lib/labware/definitions/1/tiprack-200ul.json +0 -986
  74. package/lib/labware/definitions/1/trash-box.json +0 -20
  75. package/lib/labware/definitions/1/trough-12row-short.json +0 -143
  76. package/lib/labware/definitions/1/trough-12row.json +0 -143
  77. package/lib/labware/definitions/1/trough-1row-25ml.json +0 -21
  78. package/lib/labware/definitions/1/tube-rack-.75ml.json +0 -281
  79. package/lib/labware/definitions/1/tube-rack-15_50ml.json +0 -125
  80. package/lib/labware/definitions/1/tube-rack-2ml-9x9.json +0 -911
  81. package/lib/labware/definitions/1/tube-rack-2ml.json +0 -281
  82. package/lib/labware/definitions/1/tube-rack-5ml-96.json +0 -1079
  83. package/lib/labware/definitions/1/tube-rack-80well.json +0 -907
  84. package/lib/labware/definitions/1/wheaton_vial_rack.json +0 -565
  85. package/lib/labware/definitions/2/agilent_1_reservoir_290ml/1.json +0 -54
  86. package/lib/labware/definitions/2/appliedbiosystemsmicroamp_384_wellplate_40ul/1.json +0 -4320
  87. package/lib/labware/definitions/2/armadillo_96_wellplate_200ul_pcr_full_skirt/1.json +0 -1019
  88. package/lib/labware/definitions/2/armadillo_96_wellplate_200ul_pcr_full_skirt/2.json +0 -1045
  89. package/lib/labware/definitions/2/axygen_1_reservoir_90ml/1.json +0 -56
  90. package/lib/labware/definitions/2/biorad_384_wellplate_50ul/1.json +0 -4329
  91. package/lib/labware/definitions/2/biorad_384_wellplate_50ul/2.json +0 -4331
  92. package/lib/labware/definitions/2/biorad_96_wellplate_200ul_pcr/1.json +0 -1020
  93. package/lib/labware/definitions/2/biorad_96_wellplate_200ul_pcr/2.json +0 -1046
  94. package/lib/labware/definitions/2/corning_12_wellplate_6.9ml_flat/1.json +0 -171
  95. package/lib/labware/definitions/2/corning_12_wellplate_6.9ml_flat/2.json +0 -180
  96. package/lib/labware/definitions/2/corning_24_wellplate_3.4ml_flat/1.json +0 -293
  97. package/lib/labware/definitions/2/corning_24_wellplate_3.4ml_flat/2.json +0 -300
  98. package/lib/labware/definitions/2/corning_384_wellplate_112ul_flat/1.json +0 -4703
  99. package/lib/labware/definitions/2/corning_384_wellplate_112ul_flat/2.json +0 -4717
  100. package/lib/labware/definitions/2/corning_48_wellplate_1.6ml_flat/1.json +0 -535
  101. package/lib/labware/definitions/2/corning_48_wellplate_1.6ml_flat/2.json +0 -544
  102. package/lib/labware/definitions/2/corning_6_wellplate_16.8ml_flat/1.json +0 -103
  103. package/lib/labware/definitions/2/corning_6_wellplate_16.8ml_flat/2.json +0 -110
  104. package/lib/labware/definitions/2/corning_96_wellplate_360ul_flat/1.json +0 -1049
  105. package/lib/labware/definitions/2/corning_96_wellplate_360ul_flat/2.json +0 -1063
  106. package/lib/labware/definitions/2/eppendorf_96_tiprack_1000ul_eptips/1.json +0 -1019
  107. package/lib/labware/definitions/2/eppendorf_96_tiprack_10ul_eptips/1.json +0 -1019
  108. package/lib/labware/definitions/2/geb_96_tiprack_1000ul/1.json +0 -1017
  109. package/lib/labware/definitions/2/geb_96_tiprack_10ul/1.json +0 -1017
  110. package/lib/labware/definitions/2/nest_12_reservoir_15ml/1.json +0 -190
  111. package/lib/labware/definitions/2/nest_1_reservoir_195ml/1.json +0 -54
  112. package/lib/labware/definitions/2/nest_1_reservoir_195ml/2.json +0 -56
  113. package/lib/labware/definitions/2/nest_1_reservoir_290ml/1.json +0 -54
  114. package/lib/labware/definitions/2/nest_96_wellplate_100ul_pcr_full_skirt/1.json +0 -1018
  115. package/lib/labware/definitions/2/nest_96_wellplate_100ul_pcr_full_skirt/2.json +0 -1039
  116. package/lib/labware/definitions/2/nest_96_wellplate_200ul_flat/1.json +0 -1017
  117. package/lib/labware/definitions/2/nest_96_wellplate_200ul_flat/2.json +0 -1031
  118. package/lib/labware/definitions/2/nest_96_wellplate_2ml_deep/1.json +0 -1121
  119. package/lib/labware/definitions/2/nest_96_wellplate_2ml_deep/2.json +0 -1142
  120. package/lib/labware/definitions/2/opentrons_10_tuberack_falcon_4x50ml_6x15ml_conical/1.json +0 -164
  121. package/lib/labware/definitions/2/opentrons_10_tuberack_falcon_4x50ml_6x15ml_conical_acrylic/1.json +0 -162
  122. package/lib/labware/definitions/2/opentrons_10_tuberack_nest_4x50ml_6x15ml_conical/1.json +0 -160
  123. package/lib/labware/definitions/2/opentrons_15_tuberack_falcon_15ml_conical/1.json +0 -211
  124. package/lib/labware/definitions/2/opentrons_15_tuberack_nest_15ml_conical/1.json +0 -209
  125. package/lib/labware/definitions/2/opentrons_1_trash_1100ml_fixed/1.json +0 -50
  126. package/lib/labware/definitions/2/opentrons_1_trash_3200ml_fixed/1.json +0 -50
  127. package/lib/labware/definitions/2/opentrons_1_trash_850ml_fixed/1.json +0 -50
  128. package/lib/labware/definitions/2/opentrons_24_aluminumblock_generic_2ml_screwcap/1.json +0 -300
  129. package/lib/labware/definitions/2/opentrons_24_aluminumblock_generic_2ml_screwcap/2.json +0 -301
  130. package/lib/labware/definitions/2/opentrons_24_aluminumblock_nest_0.5ml_screwcap/1.json +0 -299
  131. package/lib/labware/definitions/2/opentrons_24_aluminumblock_nest_1.5ml_screwcap/1.json +0 -299
  132. package/lib/labware/definitions/2/opentrons_24_aluminumblock_nest_1.5ml_snapcap/1.json +0 -301
  133. package/lib/labware/definitions/2/opentrons_24_aluminumblock_nest_2ml_screwcap/1.json +0 -299
  134. package/lib/labware/definitions/2/opentrons_24_aluminumblock_nest_2ml_snapcap/1.json +0 -301
  135. package/lib/labware/definitions/2/opentrons_24_tuberack_eppendorf_1.5ml_safelock_snapcap/1.json +0 -312
  136. package/lib/labware/definitions/2/opentrons_24_tuberack_eppendorf_2ml_safelock_snapcap/1.json +0 -311
  137. package/lib/labware/definitions/2/opentrons_24_tuberack_eppendorf_2ml_safelock_snapcap_acrylic/1.json +0 -309
  138. package/lib/labware/definitions/2/opentrons_24_tuberack_generic_0.75ml_snapcap_acrylic/1.json +0 -298
  139. package/lib/labware/definitions/2/opentrons_24_tuberack_generic_2ml_screwcap/1.json +0 -300
  140. package/lib/labware/definitions/2/opentrons_24_tuberack_nest_0.5ml_screwcap/1.json +0 -300
  141. package/lib/labware/definitions/2/opentrons_24_tuberack_nest_1.5ml_screwcap/1.json +0 -300
  142. package/lib/labware/definitions/2/opentrons_24_tuberack_nest_1.5ml_snapcap/1.json +0 -302
  143. package/lib/labware/definitions/2/opentrons_24_tuberack_nest_2ml_screwcap/1.json +0 -300
  144. package/lib/labware/definitions/2/opentrons_24_tuberack_nest_2ml_snapcap/1.json +0 -302
  145. package/lib/labware/definitions/2/opentrons_40_aluminumblock_eppendorf_24x2ml_safelock_snapcap_generic_16x0.2ml_pcr_strip/1.json +0 -481
  146. package/lib/labware/definitions/2/opentrons_6_tuberack_falcon_50ml_conical/1.json +0 -112
  147. package/lib/labware/definitions/2/opentrons_6_tuberack_nest_50ml_conical/1.json +0 -110
  148. package/lib/labware/definitions/2/opentrons_96_aluminumblock_biorad_wellplate_200ul/1.json +0 -1029
  149. package/lib/labware/definitions/2/opentrons_96_aluminumblock_generic_pcr_strip_200ul/1.json +0 -1026
  150. package/lib/labware/definitions/2/opentrons_96_aluminumblock_generic_pcr_strip_200ul/2.json +0 -1027
  151. package/lib/labware/definitions/2/opentrons_96_aluminumblock_nest_wellplate_100ul/1.json +0 -1027
  152. package/lib/labware/definitions/2/opentrons_96_deep_well_adapter/1.json +0 -41
  153. package/lib/labware/definitions/2/opentrons_96_deep_well_adapter_nest_wellplate_2ml_deep/1.json +0 -1121
  154. package/lib/labware/definitions/2/opentrons_96_deep_well_temp_mod_adapter/1.json +0 -41
  155. package/lib/labware/definitions/2/opentrons_96_filtertiprack_1000ul/1.json +0 -1017
  156. package/lib/labware/definitions/2/opentrons_96_filtertiprack_10ul/1.json +0 -1017
  157. package/lib/labware/definitions/2/opentrons_96_filtertiprack_200ul/1.json +0 -1017
  158. package/lib/labware/definitions/2/opentrons_96_filtertiprack_20ul/1.json +0 -1017
  159. package/lib/labware/definitions/2/opentrons_96_flat_bottom_adapter/1.json +0 -41
  160. package/lib/labware/definitions/2/opentrons_96_flat_bottom_adapter_nest_wellplate_200ul_flat/1.json +0 -1027
  161. package/lib/labware/definitions/2/opentrons_96_pcr_adapter/1.json +0 -1032
  162. package/lib/labware/definitions/2/opentrons_96_pcr_adapter_armadillo_wellplate_200ul/1.json +0 -1027
  163. package/lib/labware/definitions/2/opentrons_96_pcr_adapter_nest_wellplate_100ul_pcr_full_skirt/1.json +0 -1025
  164. package/lib/labware/definitions/2/opentrons_96_tiprack_1000ul/1.json +0 -1019
  165. package/lib/labware/definitions/2/opentrons_96_tiprack_10ul/1.json +0 -1019
  166. package/lib/labware/definitions/2/opentrons_96_tiprack_20ul/1.json +0 -1019
  167. package/lib/labware/definitions/2/opentrons_96_tiprack_300ul/1.json +0 -1019
  168. package/lib/labware/definitions/2/opentrons_96_well_aluminum_block/1.json +0 -1032
  169. package/lib/labware/definitions/2/opentrons_96_wellplate_200ul_pcr_full_skirt/1.json +0 -1019
  170. package/lib/labware/definitions/2/opentrons_96_wellplate_200ul_pcr_full_skirt/2.json +0 -1045
  171. package/lib/labware/definitions/2/opentrons_aluminum_flat_bottom_plate/1.json +0 -41
  172. package/lib/labware/definitions/2/opentrons_calibration_adapter_heatershaker_module/1.json +0 -62
  173. package/lib/labware/definitions/2/opentrons_calibration_adapter_temperature_module/1.json +0 -62
  174. package/lib/labware/definitions/2/opentrons_calibration_adapter_thermocycler_module/1.json +0 -69
  175. package/lib/labware/definitions/2/opentrons_calibrationblock_short_side_left/1.json +0 -71
  176. package/lib/labware/definitions/2/opentrons_calibrationblock_short_side_right/1.json +0 -71
  177. package/lib/labware/definitions/2/opentrons_flex_96_filtertiprack_1000ul/1.json +0 -1026
  178. package/lib/labware/definitions/2/opentrons_flex_96_filtertiprack_200ul/1.json +0 -1026
  179. package/lib/labware/definitions/2/opentrons_flex_96_filtertiprack_50ul/1.json +0 -1026
  180. package/lib/labware/definitions/2/opentrons_flex_96_tiprack_1000ul/1.json +0 -1026
  181. package/lib/labware/definitions/2/opentrons_flex_96_tiprack_200ul/1.json +0 -1026
  182. package/lib/labware/definitions/2/opentrons_flex_96_tiprack_50ul/1.json +0 -1026
  183. package/lib/labware/definitions/2/opentrons_flex_96_tiprack_adapter/1.json +0 -41
  184. package/lib/labware/definitions/2/opentrons_flex_deck_riser/1.json +0 -41
  185. package/lib/labware/definitions/2/opentrons_flex_lid_absorbance_plate_reader_module/1.json +0 -57
  186. package/lib/labware/definitions/2/opentrons_tough_pcr_auto_sealing_lid/1.json +0 -120
  187. package/lib/labware/definitions/2/opentrons_universal_flat_adapter/1.json +0 -151
  188. package/lib/labware/definitions/2/opentrons_universal_flat_adapter_corning_384_wellplate_112ul_flat/1.json +0 -4710
  189. package/lib/labware/definitions/2/thermoscientificnunc_96_wellplate_1300ul/1.json +0 -1019
  190. package/lib/labware/definitions/2/thermoscientificnunc_96_wellplate_2000ul/1.json +0 -1019
  191. package/lib/labware/definitions/2/tipone_96_tiprack_200ul/1.json +0 -1017
  192. package/lib/labware/definitions/2/usascientific_12_reservoir_22ml/1.json +0 -192
  193. package/lib/labware/definitions/2/usascientific_96_wellplate_2.4ml_deep/1.json +0 -1116
  194. package/lib/labware/definitions/3/agilent_1_reservoir_290ml/2.json +0 -80
  195. package/lib/labware/definitions/3/appliedbiosystemsmicroamp_384_wellplate_40ul/2.json +0 -4730
  196. package/lib/labware/definitions/3/armadillo_96_wellplate_200ul_pcr_full_skirt/3.json +0 -1167
  197. package/lib/labware/definitions/3/axygen_1_reservoir_90ml/2.json +0 -72
  198. package/lib/labware/definitions/3/biorad_384_wellplate_50ul/3.json +0 -4741
  199. package/lib/labware/definitions/3/biorad_96_wellplate_200ul_pcr/3.json +0 -1182
  200. package/lib/labware/definitions/3/corning_12_wellplate_6.9ml_flat/3.json +0 -205
  201. package/lib/labware/definitions/3/corning_24_wellplate_3.4ml_flat/3.json +0 -337
  202. package/lib/labware/definitions/3/corning_384_wellplate_112ul_flat/3.json +0 -5114
  203. package/lib/labware/definitions/3/corning_48_wellplate_1.6ml_flat/3.json +0 -605
  204. package/lib/labware/definitions/3/corning_6_wellplate_16.8ml_flat/3.json +0 -129
  205. package/lib/labware/definitions/3/corning_96_wellplate_360ul_flat/3.json +0 -1172
  206. package/lib/labware/definitions/3/nest_12_reservoir_15ml/2.json +0 -226
  207. package/lib/labware/definitions/3/nest_1_reservoir_195ml/3.json +0 -83
  208. package/lib/labware/definitions/3/nest_1_reservoir_290ml/2.json +0 -70
  209. package/lib/labware/definitions/3/nest_96_wellplate_100ul_pcr_full_skirt/3.json +0 -1161
  210. package/lib/labware/definitions/3/nest_96_wellplate_200ul_flat/3.json +0 -1140
  211. package/lib/labware/definitions/3/nest_96_wellplate_2ml_deep/3.json +0 -1262
  212. package/lib/labware/definitions/3/opentrons_10_tuberack_falcon_4x50ml_6x15ml_conical/2.json +0 -232
  213. package/lib/labware/definitions/3/opentrons_10_tuberack_falcon_4x50ml_6x15ml_conical_acrylic/2.json +0 -230
  214. package/lib/labware/definitions/3/opentrons_10_tuberack_nest_4x50ml_6x15ml_conical/2.json +0 -222
  215. package/lib/labware/definitions/3/opentrons_15_tuberack_falcon_15ml_conical/2.json +0 -259
  216. package/lib/labware/definitions/3/opentrons_15_tuberack_nest_15ml_conical/2.json +0 -251
  217. package/lib/labware/definitions/3/opentrons_24_aluminumblock_generic_2ml_screwcap/3.json +0 -330
  218. package/lib/labware/definitions/3/opentrons_24_aluminumblock_nest_0.5ml_screwcap/2.json +0 -370
  219. package/lib/labware/definitions/3/opentrons_24_aluminumblock_nest_1.5ml_screwcap/2.json +0 -356
  220. package/lib/labware/definitions/3/opentrons_24_aluminumblock_nest_1.5ml_snapcap/2.json +0 -351
  221. package/lib/labware/definitions/3/opentrons_24_aluminumblock_nest_2ml_screwcap/2.json +0 -350
  222. package/lib/labware/definitions/3/opentrons_24_aluminumblock_nest_2ml_snapcap/2.json +0 -379
  223. package/lib/labware/definitions/3/opentrons_24_tuberack_eppendorf_1.5ml_safelock_snapcap/2.json +0 -418
  224. package/lib/labware/definitions/3/opentrons_24_tuberack_eppendorf_2ml_safelock_snapcap/2.json +0 -340
  225. package/lib/labware/definitions/3/opentrons_24_tuberack_eppendorf_2ml_safelock_snapcap_acrylic/2.json +0 -338
  226. package/lib/labware/definitions/3/opentrons_24_tuberack_generic_0.75ml_snapcap_acrylic/2.json +0 -327
  227. package/lib/labware/definitions/3/opentrons_24_tuberack_generic_2ml_screwcap/2.json +0 -329
  228. package/lib/labware/definitions/3/opentrons_24_tuberack_nest_0.5ml_screwcap/2.json +0 -371
  229. package/lib/labware/definitions/3/opentrons_24_tuberack_nest_1.5ml_screwcap/2.json +0 -357
  230. package/lib/labware/definitions/3/opentrons_24_tuberack_nest_1.5ml_snapcap/2.json +0 -352
  231. package/lib/labware/definitions/3/opentrons_24_tuberack_nest_2ml_screwcap/2.json +0 -351
  232. package/lib/labware/definitions/3/opentrons_24_tuberack_nest_2ml_snapcap/2.json +0 -380
  233. package/lib/labware/definitions/3/opentrons_40_aluminumblock_eppendorf_24x2ml_safelock_snapcap_generic_16x0.2ml_pcr_strip/2.json +0 -526
  234. package/lib/labware/definitions/3/opentrons_6_tuberack_falcon_50ml_conical/2.json +0 -145
  235. package/lib/labware/definitions/3/opentrons_6_tuberack_nest_50ml_conical/2.json +0 -143
  236. package/lib/labware/definitions/3/opentrons_96_aluminumblock_biorad_wellplate_200ul/2.json +0 -1165
  237. package/lib/labware/definitions/3/opentrons_96_aluminumblock_generic_pcr_strip_200ul/3.json +0 -1128
  238. package/lib/labware/definitions/3/opentrons_96_aluminumblock_nest_wellplate_100ul/2.json +0 -1149
  239. package/lib/labware/definitions/3/opentrons_96_deep_well_adapter_nest_wellplate_2ml_deep/2.json +0 -1241
  240. package/lib/labware/definitions/3/opentrons_96_flat_bottom_adapter_nest_wellplate_200ul_flat/2.json +0 -1136
  241. package/lib/labware/definitions/3/opentrons_96_pcr_adapter_armadillo_wellplate_200ul/2.json +0 -1149
  242. package/lib/labware/definitions/3/opentrons_96_pcr_adapter_nest_wellplate_100ul_pcr_full_skirt/2.json +0 -1147
  243. package/lib/labware/definitions/3/opentrons_96_wellplate_200ul_pcr_full_skirt/3.json +0 -1167
  244. package/lib/labware/definitions/3/opentrons_universal_flat_adapter_corning_384_wellplate_112ul_flat/2.json +0 -5107
  245. package/lib/labware/definitions/3/thermoscientificnunc_96_wellplate_1300ul/2.json +0 -1134
  246. package/lib/labware/definitions/3/thermoscientificnunc_96_wellplate_2000ul/2.json +0 -1134
  247. package/lib/labware/definitions/3/usascientific_12_reservoir_22ml/2.json +0 -229
  248. package/lib/labware/definitions/3/usascientific_96_wellplate_2.4ml_deep/2.json +0 -1217
  249. package/lib/labware/fixtures/1/fixture_tiprack.json +0 -986
  250. package/lib/labware/fixtures/2/fixture_12_trough.json +0 -188
  251. package/lib/labware/fixtures/2/fixture_12_trough_v2.json +0 -188
  252. package/lib/labware/fixtures/2/fixture_24_tuberack.json +0 -295
  253. package/lib/labware/fixtures/2/fixture_384_plate.json +0 -4316
  254. package/lib/labware/fixtures/2/fixture_96_plate.json +0 -1015
  255. package/lib/labware/fixtures/2/fixture_calibration_block.json +0 -71
  256. package/lib/labware/fixtures/2/fixture_corning_96_wellplate_360_flat.json +0 -1058
  257. package/lib/labware/fixtures/2/fixture_flex_96_tiprack_1000ul.json +0 -1026
  258. package/lib/labware/fixtures/2/fixture_flex_96_tiprack_adapter.json +0 -41
  259. package/lib/labware/fixtures/2/fixture_irregular_example_1.json +0 -600
  260. package/lib/labware/fixtures/2/fixture_overlappy_wellplate.json +0 -1113
  261. package/lib/labware/fixtures/2/fixture_regular_example_1.json +0 -57
  262. package/lib/labware/fixtures/2/fixture_regular_example_2.json +0 -95
  263. package/lib/labware/fixtures/2/fixture_tiprack_1000_ul.json +0 -1015
  264. package/lib/labware/fixtures/2/fixture_tiprack_10_ul.json +0 -1015
  265. package/lib/labware/fixtures/2/fixture_tiprack_300_ul.json +0 -1014
  266. package/lib/labware/fixtures/2/fixture_trash.json +0 -50
  267. package/lib/labware/fixtures/2/fixture_universal_flat_bottom_adapter.json +0 -151
  268. package/lib/labware/fixtures/3/fixture_2_plate.json +0 -95
  269. package/lib/labware/fixtures/3/fixture_corning_24_plate.json +0 -337
  270. package/lib/labware/repository/fixtures/1/exampleLabwareRepository.json +0 -43
  271. package/lib/labware/repository/schemas/1.json +0 -81
  272. package/lib/labware/schemas/2.json +0 -389
  273. package/lib/labware/schemas/3.json +0 -621
  274. package/lib/liquid/schemas/1.json +0 -21
  275. package/lib/liquid-class/definitions/1/water.json +0 -2409
  276. package/lib/liquid-class/fixtures/1/fixture_glycerol50.json +0 -236
  277. package/lib/liquid-class/schemas/1.json +0 -508
  278. package/lib/module/definitions/1.json +0 -57
  279. package/lib/module/definitions/2/magneticModuleV1.json +0 -22
  280. package/lib/module/definitions/2/magneticModuleV2.json +0 -69
  281. package/lib/module/definitions/2/temperatureModuleV1.json +0 -22
  282. package/lib/module/definitions/2/temperatureModuleV2.json +0 -69
  283. package/lib/module/definitions/2/thermocyclerModuleV1.json +0 -23
  284. package/lib/module/definitions/3/absorbanceReaderV1.json +0 -184
  285. package/lib/module/definitions/3/heaterShakerModuleV1.json +0 -530
  286. package/lib/module/definitions/3/magneticBlockV1.json +0 -200
  287. package/lib/module/definitions/3/magneticModuleV1.json +0 -436
  288. package/lib/module/definitions/3/magneticModuleV2.json +0 -489
  289. package/lib/module/definitions/3/temperatureModuleV1.json +0 -191
  290. package/lib/module/definitions/3/temperatureModuleV2.json +0 -324
  291. package/lib/module/definitions/3/thermocyclerModuleV1.json +0 -1381
  292. package/lib/module/definitions/3/thermocyclerModuleV2.json +0 -3687
  293. package/lib/module/fixtures/3/compatibleGenerationV1.json +0 -69
  294. package/lib/module/fixtures/3/compatibleGenerationV2.json +0 -69
  295. package/lib/module/fixtures/3/incompatibleGenerationV1.json +0 -22
  296. package/lib/module/fixtures/3/incompatibleGenerationV2.json +0 -69
  297. package/lib/module/schemas/1.json +0 -54
  298. package/lib/module/schemas/2.json +0 -112
  299. package/lib/module/schemas/3.json +0 -215
  300. package/lib/pipette/definitions/1/pipetteModelSpecs.json +0 -10650
  301. package/lib/pipette/definitions/1/pipetteNameSpecs.json +0 -694
  302. package/lib/pipette/definitions/2/general/eight_channel/p10/1_0.json +0 -206
  303. package/lib/pipette/definitions/2/general/eight_channel/p10/1_3.json +0 -206
  304. package/lib/pipette/definitions/2/general/eight_channel/p10/1_4.json +0 -206
  305. package/lib/pipette/definitions/2/general/eight_channel/p10/1_5.json +0 -206
  306. package/lib/pipette/definitions/2/general/eight_channel/p10/1_6.json +0 -206
  307. package/lib/pipette/definitions/2/general/eight_channel/p1000/1_0.json +0 -206
  308. package/lib/pipette/definitions/2/general/eight_channel/p1000/3_0.json +0 -233
  309. package/lib/pipette/definitions/2/general/eight_channel/p1000/3_3.json +0 -233
  310. package/lib/pipette/definitions/2/general/eight_channel/p1000/3_4.json +0 -323
  311. package/lib/pipette/definitions/2/general/eight_channel/p1000/3_5.json +0 -323
  312. package/lib/pipette/definitions/2/general/eight_channel/p20/2_0.json +0 -224
  313. package/lib/pipette/definitions/2/general/eight_channel/p20/2_1.json +0 -224
  314. package/lib/pipette/definitions/2/general/eight_channel/p300/1_0.json +0 -197
  315. package/lib/pipette/definitions/2/general/eight_channel/p300/1_3.json +0 -197
  316. package/lib/pipette/definitions/2/general/eight_channel/p300/1_4.json +0 -197
  317. package/lib/pipette/definitions/2/general/eight_channel/p300/1_5.json +0 -197
  318. package/lib/pipette/definitions/2/general/eight_channel/p300/2_0.json +0 -188
  319. package/lib/pipette/definitions/2/general/eight_channel/p300/2_1.json +0 -188
  320. package/lib/pipette/definitions/2/general/eight_channel/p50/1_0.json +0 -197
  321. package/lib/pipette/definitions/2/general/eight_channel/p50/1_3.json +0 -197
  322. package/lib/pipette/definitions/2/general/eight_channel/p50/1_4.json +0 -197
  323. package/lib/pipette/definitions/2/general/eight_channel/p50/1_5.json +0 -197
  324. package/lib/pipette/definitions/2/general/eight_channel/p50/3_0.json +0 -203
  325. package/lib/pipette/definitions/2/general/eight_channel/p50/3_3.json +0 -203
  326. package/lib/pipette/definitions/2/general/eight_channel/p50/3_4.json +0 -253
  327. package/lib/pipette/definitions/2/general/eight_channel/p50/3_5.json +0 -253
  328. package/lib/pipette/definitions/2/general/eight_channel_em/p1000/3_0.json +0 -320
  329. package/lib/pipette/definitions/2/general/ninety_six_channel/p1000/1_0.json +0 -556
  330. package/lib/pipette/definitions/2/general/ninety_six_channel/p1000/3_0.json +0 -561
  331. package/lib/pipette/definitions/2/general/ninety_six_channel/p1000/3_3.json +0 -556
  332. package/lib/pipette/definitions/2/general/ninety_six_channel/p1000/3_4.json +0 -724
  333. package/lib/pipette/definitions/2/general/ninety_six_channel/p1000/3_5.json +0 -858
  334. package/lib/pipette/definitions/2/general/ninety_six_channel/p1000/3_6.json +0 -818
  335. package/lib/pipette/definitions/2/general/ninety_six_channel/p200/3_0.json +0 -660
  336. package/lib/pipette/definitions/2/general/single_channel/p10/1_0.json +0 -70
  337. package/lib/pipette/definitions/2/general/single_channel/p10/1_3.json +0 -70
  338. package/lib/pipette/definitions/2/general/single_channel/p10/1_4.json +0 -70
  339. package/lib/pipette/definitions/2/general/single_channel/p10/1_5.json +0 -70
  340. package/lib/pipette/definitions/2/general/single_channel/p1000/1_0.json +0 -70
  341. package/lib/pipette/definitions/2/general/single_channel/p1000/1_3.json +0 -70
  342. package/lib/pipette/definitions/2/general/single_channel/p1000/1_4.json +0 -70
  343. package/lib/pipette/definitions/2/general/single_channel/p1000/1_5.json +0 -70
  344. package/lib/pipette/definitions/2/general/single_channel/p1000/2_0.json +0 -69
  345. package/lib/pipette/definitions/2/general/single_channel/p1000/2_1.json +0 -69
  346. package/lib/pipette/definitions/2/general/single_channel/p1000/2_2.json +0 -69
  347. package/lib/pipette/definitions/2/general/single_channel/p1000/3_0.json +0 -81
  348. package/lib/pipette/definitions/2/general/single_channel/p1000/3_3.json +0 -81
  349. package/lib/pipette/definitions/2/general/single_channel/p1000/3_4.json +0 -90
  350. package/lib/pipette/definitions/2/general/single_channel/p1000/3_5.json +0 -90
  351. package/lib/pipette/definitions/2/general/single_channel/p1000/3_6.json +0 -90
  352. package/lib/pipette/definitions/2/general/single_channel/p1000/3_7.json +0 -81
  353. package/lib/pipette/definitions/2/general/single_channel/p20/2_0.json +0 -72
  354. package/lib/pipette/definitions/2/general/single_channel/p20/2_1.json +0 -72
  355. package/lib/pipette/definitions/2/general/single_channel/p20/2_2.json +0 -72
  356. package/lib/pipette/definitions/2/general/single_channel/p300/1_0.json +0 -69
  357. package/lib/pipette/definitions/2/general/single_channel/p300/1_3.json +0 -69
  358. package/lib/pipette/definitions/2/general/single_channel/p300/1_4.json +0 -69
  359. package/lib/pipette/definitions/2/general/single_channel/p300/1_5.json +0 -69
  360. package/lib/pipette/definitions/2/general/single_channel/p300/2_0.json +0 -68
  361. package/lib/pipette/definitions/2/general/single_channel/p300/2_1.json +0 -68
  362. package/lib/pipette/definitions/2/general/single_channel/p50/1_0.json +0 -69
  363. package/lib/pipette/definitions/2/general/single_channel/p50/1_3.json +0 -69
  364. package/lib/pipette/definitions/2/general/single_channel/p50/1_4.json +0 -69
  365. package/lib/pipette/definitions/2/general/single_channel/p50/1_5.json +0 -69
  366. package/lib/pipette/definitions/2/general/single_channel/p50/3_0.json +0 -83
  367. package/lib/pipette/definitions/2/general/single_channel/p50/3_3.json +0 -83
  368. package/lib/pipette/definitions/2/general/single_channel/p50/3_4.json +0 -88
  369. package/lib/pipette/definitions/2/general/single_channel/p50/3_5.json +0 -88
  370. package/lib/pipette/definitions/2/general/single_channel/p50/3_6.json +0 -88
  371. package/lib/pipette/definitions/2/geometry/eight_channel/p10/1_0.json +0 -42
  372. package/lib/pipette/definitions/2/geometry/eight_channel/p10/1_3.json +0 -42
  373. package/lib/pipette/definitions/2/geometry/eight_channel/p10/1_4.json +0 -42
  374. package/lib/pipette/definitions/2/geometry/eight_channel/p10/1_5.json +0 -42
  375. package/lib/pipette/definitions/2/geometry/eight_channel/p10/1_6.json +0 -42
  376. package/lib/pipette/definitions/2/geometry/eight_channel/p1000/1_0.json +0 -42
  377. package/lib/pipette/definitions/2/geometry/eight_channel/p1000/3_0.json +0 -55
  378. package/lib/pipette/definitions/2/geometry/eight_channel/p1000/3_3.json +0 -55
  379. package/lib/pipette/definitions/2/geometry/eight_channel/p1000/3_4.json +0 -55
  380. package/lib/pipette/definitions/2/geometry/eight_channel/p1000/3_5.json +0 -55
  381. package/lib/pipette/definitions/2/geometry/eight_channel/p20/2_0.json +0 -42
  382. package/lib/pipette/definitions/2/geometry/eight_channel/p20/2_1.json +0 -42
  383. package/lib/pipette/definitions/2/geometry/eight_channel/p300/1_0.json +0 -42
  384. package/lib/pipette/definitions/2/geometry/eight_channel/p300/1_3.json +0 -42
  385. package/lib/pipette/definitions/2/geometry/eight_channel/p300/1_4.json +0 -42
  386. package/lib/pipette/definitions/2/geometry/eight_channel/p300/1_5.json +0 -42
  387. package/lib/pipette/definitions/2/geometry/eight_channel/p300/2_0.json +0 -42
  388. package/lib/pipette/definitions/2/geometry/eight_channel/p300/2_1.json +0 -42
  389. package/lib/pipette/definitions/2/geometry/eight_channel/p50/1_0.json +0 -42
  390. package/lib/pipette/definitions/2/geometry/eight_channel/p50/1_3.json +0 -42
  391. package/lib/pipette/definitions/2/geometry/eight_channel/p50/1_4.json +0 -42
  392. package/lib/pipette/definitions/2/geometry/eight_channel/p50/1_5.json +0 -42
  393. package/lib/pipette/definitions/2/geometry/eight_channel/p50/3_0.json +0 -47
  394. package/lib/pipette/definitions/2/geometry/eight_channel/p50/3_3.json +0 -47
  395. package/lib/pipette/definitions/2/geometry/eight_channel/p50/3_4.json +0 -47
  396. package/lib/pipette/definitions/2/geometry/eight_channel/p50/3_5.json +0 -47
  397. package/lib/pipette/definitions/2/geometry/eight_channel_em/p1000/3_0.json +0 -55
  398. package/lib/pipette/definitions/2/geometry/ninety_six_channel/p1000/1_0.json +0 -296
  399. package/lib/pipette/definitions/2/geometry/ninety_six_channel/p1000/3_0.json +0 -309
  400. package/lib/pipette/definitions/2/geometry/ninety_six_channel/p1000/3_3.json +0 -309
  401. package/lib/pipette/definitions/2/geometry/ninety_six_channel/p1000/3_4.json +0 -309
  402. package/lib/pipette/definitions/2/geometry/ninety_six_channel/p1000/3_5.json +0 -309
  403. package/lib/pipette/definitions/2/geometry/ninety_six_channel/p1000/3_6.json +0 -309
  404. package/lib/pipette/definitions/2/geometry/ninety_six_channel/p200/3_0.json +0 -305
  405. package/lib/pipette/definitions/2/geometry/single_channel/p10/1_0.json +0 -15
  406. package/lib/pipette/definitions/2/geometry/single_channel/p10/1_3.json +0 -15
  407. package/lib/pipette/definitions/2/geometry/single_channel/p10/1_4.json +0 -15
  408. package/lib/pipette/definitions/2/geometry/single_channel/p10/1_5.json +0 -15
  409. package/lib/pipette/definitions/2/geometry/single_channel/p1000/1_0.json +0 -15
  410. package/lib/pipette/definitions/2/geometry/single_channel/p1000/1_3.json +0 -15
  411. package/lib/pipette/definitions/2/geometry/single_channel/p1000/1_4.json +0 -15
  412. package/lib/pipette/definitions/2/geometry/single_channel/p1000/1_5.json +0 -15
  413. package/lib/pipette/definitions/2/geometry/single_channel/p1000/2_0.json +0 -15
  414. package/lib/pipette/definitions/2/geometry/single_channel/p1000/2_1.json +0 -15
  415. package/lib/pipette/definitions/2/geometry/single_channel/p1000/2_2.json +0 -15
  416. package/lib/pipette/definitions/2/geometry/single_channel/p1000/3_0.json +0 -28
  417. package/lib/pipette/definitions/2/geometry/single_channel/p1000/3_3.json +0 -28
  418. package/lib/pipette/definitions/2/geometry/single_channel/p1000/3_4.json +0 -28
  419. package/lib/pipette/definitions/2/geometry/single_channel/p1000/3_5.json +0 -28
  420. package/lib/pipette/definitions/2/geometry/single_channel/p1000/3_6.json +0 -28
  421. package/lib/pipette/definitions/2/geometry/single_channel/p1000/3_7.json +0 -28
  422. package/lib/pipette/definitions/2/geometry/single_channel/p20/2_0.json +0 -15
  423. package/lib/pipette/definitions/2/geometry/single_channel/p20/2_1.json +0 -15
  424. package/lib/pipette/definitions/2/geometry/single_channel/p20/2_2.json +0 -15
  425. package/lib/pipette/definitions/2/geometry/single_channel/p300/1_0.json +0 -15
  426. package/lib/pipette/definitions/2/geometry/single_channel/p300/1_3.json +0 -15
  427. package/lib/pipette/definitions/2/geometry/single_channel/p300/1_4.json +0 -15
  428. package/lib/pipette/definitions/2/geometry/single_channel/p300/1_5.json +0 -15
  429. package/lib/pipette/definitions/2/geometry/single_channel/p300/2_0.json +0 -15
  430. package/lib/pipette/definitions/2/geometry/single_channel/p300/2_1.json +0 -15
  431. package/lib/pipette/definitions/2/geometry/single_channel/p50/1_0.json +0 -15
  432. package/lib/pipette/definitions/2/geometry/single_channel/p50/1_3.json +0 -15
  433. package/lib/pipette/definitions/2/geometry/single_channel/p50/1_4.json +0 -15
  434. package/lib/pipette/definitions/2/geometry/single_channel/p50/1_5.json +0 -15
  435. package/lib/pipette/definitions/2/geometry/single_channel/p50/3_0.json +0 -20
  436. package/lib/pipette/definitions/2/geometry/single_channel/p50/3_3.json +0 -20
  437. package/lib/pipette/definitions/2/geometry/single_channel/p50/3_4.json +0 -20
  438. package/lib/pipette/definitions/2/geometry/single_channel/p50/3_5.json +0 -20
  439. package/lib/pipette/definitions/2/geometry/single_channel/p50/3_6.json +0 -20
  440. package/lib/pipette/definitions/2/liquid/eight_channel/p10/default/1_0.json +0 -51
  441. package/lib/pipette/definitions/2/liquid/eight_channel/p10/default/1_3.json +0 -51
  442. package/lib/pipette/definitions/2/liquid/eight_channel/p10/default/1_4.json +0 -51
  443. package/lib/pipette/definitions/2/liquid/eight_channel/p10/default/1_5.json +0 -40
  444. package/lib/pipette/definitions/2/liquid/eight_channel/p10/default/1_6.json +0 -48
  445. package/lib/pipette/definitions/2/liquid/eight_channel/p1000/default/1_0.json +0 -350
  446. package/lib/pipette/definitions/2/liquid/eight_channel/p1000/default/3_0.json +0 -353
  447. package/lib/pipette/definitions/2/liquid/eight_channel/p1000/default/3_3.json +0 -356
  448. package/lib/pipette/definitions/2/liquid/eight_channel/p1000/default/3_4.json +0 -356
  449. package/lib/pipette/definitions/2/liquid/eight_channel/p1000/default/3_5.json +0 -236
  450. package/lib/pipette/definitions/2/liquid/eight_channel/p20/default/2_0.json +0 -302
  451. package/lib/pipette/definitions/2/liquid/eight_channel/p20/default/2_1.json +0 -184
  452. package/lib/pipette/definitions/2/liquid/eight_channel/p300/default/1_0.json +0 -61
  453. package/lib/pipette/definitions/2/liquid/eight_channel/p300/default/1_3.json +0 -61
  454. package/lib/pipette/definitions/2/liquid/eight_channel/p300/default/1_4.json +0 -61
  455. package/lib/pipette/definitions/2/liquid/eight_channel/p300/default/1_5.json +0 -61
  456. package/lib/pipette/definitions/2/liquid/eight_channel/p300/default/2_0.json +0 -185
  457. package/lib/pipette/definitions/2/liquid/eight_channel/p300/default/2_1.json +0 -187
  458. package/lib/pipette/definitions/2/liquid/eight_channel/p50/default/1_0.json +0 -122
  459. package/lib/pipette/definitions/2/liquid/eight_channel/p50/default/1_3.json +0 -122
  460. package/lib/pipette/definitions/2/liquid/eight_channel/p50/default/1_4.json +0 -122
  461. package/lib/pipette/definitions/2/liquid/eight_channel/p50/default/1_5.json +0 -104
  462. package/lib/pipette/definitions/2/liquid/eight_channel/p50/default/3_0.json +0 -97
  463. package/lib/pipette/definitions/2/liquid/eight_channel/p50/default/3_3.json +0 -98
  464. package/lib/pipette/definitions/2/liquid/eight_channel/p50/default/3_4.json +0 -98
  465. package/lib/pipette/definitions/2/liquid/eight_channel/p50/default/3_5.json +0 -90
  466. package/lib/pipette/definitions/2/liquid/eight_channel/p50/lowVolumeDefault/3_0.json +0 -92
  467. package/lib/pipette/definitions/2/liquid/eight_channel/p50/lowVolumeDefault/3_3.json +0 -88
  468. package/lib/pipette/definitions/2/liquid/eight_channel/p50/lowVolumeDefault/3_4.json +0 -88
  469. package/lib/pipette/definitions/2/liquid/eight_channel/p50/lowVolumeDefault/3_5.json +0 -88
  470. package/lib/pipette/definitions/2/liquid/eight_channel_em/p1000/default/3_0.json +0 -236
  471. package/lib/pipette/definitions/2/liquid/ninety_six_channel/p1000/default/1_0.json +0 -185
  472. package/lib/pipette/definitions/2/liquid/ninety_six_channel/p1000/default/3_0.json +0 -185
  473. package/lib/pipette/definitions/2/liquid/ninety_six_channel/p1000/default/3_3.json +0 -188
  474. package/lib/pipette/definitions/2/liquid/ninety_six_channel/p1000/default/3_4.json +0 -188
  475. package/lib/pipette/definitions/2/liquid/ninety_six_channel/p1000/default/3_5.json +0 -188
  476. package/lib/pipette/definitions/2/liquid/ninety_six_channel/p1000/default/3_6.json +0 -188
  477. package/lib/pipette/definitions/2/liquid/ninety_six_channel/p200/default/3_0.json +0 -121
  478. package/lib/pipette/definitions/2/liquid/single_channel/p10/default/1_0.json +0 -52
  479. package/lib/pipette/definitions/2/liquid/single_channel/p10/default/1_3.json +0 -52
  480. package/lib/pipette/definitions/2/liquid/single_channel/p10/default/1_4.json +0 -49
  481. package/lib/pipette/definitions/2/liquid/single_channel/p10/default/1_5.json +0 -47
  482. package/lib/pipette/definitions/2/liquid/single_channel/p1000/default/1_0.json +0 -41
  483. package/lib/pipette/definitions/2/liquid/single_channel/p1000/default/1_3.json +0 -41
  484. package/lib/pipette/definitions/2/liquid/single_channel/p1000/default/1_4.json +0 -41
  485. package/lib/pipette/definitions/2/liquid/single_channel/p1000/default/1_5.json +0 -41
  486. package/lib/pipette/definitions/2/liquid/single_channel/p1000/default/2_0.json +0 -99
  487. package/lib/pipette/definitions/2/liquid/single_channel/p1000/default/2_1.json +0 -102
  488. package/lib/pipette/definitions/2/liquid/single_channel/p1000/default/2_2.json +0 -102
  489. package/lib/pipette/definitions/2/liquid/single_channel/p1000/default/3_0.json +0 -353
  490. package/lib/pipette/definitions/2/liquid/single_channel/p1000/default/3_3.json +0 -356
  491. package/lib/pipette/definitions/2/liquid/single_channel/p1000/default/3_4.json +0 -282
  492. package/lib/pipette/definitions/2/liquid/single_channel/p1000/default/3_5.json +0 -204
  493. package/lib/pipette/definitions/2/liquid/single_channel/p1000/default/3_6.json +0 -204
  494. package/lib/pipette/definitions/2/liquid/single_channel/p1000/default/3_7.json +0 -204
  495. package/lib/pipette/definitions/2/liquid/single_channel/p20/default/2_0.json +0 -422
  496. package/lib/pipette/definitions/2/liquid/single_channel/p20/default/2_1.json +0 -244
  497. package/lib/pipette/definitions/2/liquid/single_channel/p20/default/2_2.json +0 -304
  498. package/lib/pipette/definitions/2/liquid/single_channel/p300/default/1_0.json +0 -93
  499. package/lib/pipette/definitions/2/liquid/single_channel/p300/default/1_3.json +0 -93
  500. package/lib/pipette/definitions/2/liquid/single_channel/p300/default/1_4.json +0 -93
  501. package/lib/pipette/definitions/2/liquid/single_channel/p300/default/1_5.json +0 -69
  502. package/lib/pipette/definitions/2/liquid/single_channel/p300/default/2_0.json +0 -183
  503. package/lib/pipette/definitions/2/liquid/single_channel/p300/default/2_1.json +0 -185
  504. package/lib/pipette/definitions/2/liquid/single_channel/p50/default/1_0.json +0 -113
  505. package/lib/pipette/definitions/2/liquid/single_channel/p50/default/1_3.json +0 -122
  506. package/lib/pipette/definitions/2/liquid/single_channel/p50/default/1_4.json +0 -122
  507. package/lib/pipette/definitions/2/liquid/single_channel/p50/default/1_5.json +0 -98
  508. package/lib/pipette/definitions/2/liquid/single_channel/p50/default/3_0.json +0 -97
  509. package/lib/pipette/definitions/2/liquid/single_channel/p50/default/3_3.json +0 -98
  510. package/lib/pipette/definitions/2/liquid/single_channel/p50/default/3_4.json +0 -100
  511. package/lib/pipette/definitions/2/liquid/single_channel/p50/default/3_5.json +0 -80
  512. package/lib/pipette/definitions/2/liquid/single_channel/p50/default/3_6.json +0 -80
  513. package/lib/pipette/definitions/2/liquid/single_channel/p50/lowVolumeDefault/3_0.json +0 -77
  514. package/lib/pipette/definitions/2/liquid/single_channel/p50/lowVolumeDefault/3_3.json +0 -78
  515. package/lib/pipette/definitions/2/liquid/single_channel/p50/lowVolumeDefault/3_4.json +0 -78
  516. package/lib/pipette/definitions/2/liquid/single_channel/p50/lowVolumeDefault/3_5.json +0 -76
  517. package/lib/pipette/definitions/2/liquid/single_channel/p50/lowVolumeDefault/3_6.json +0 -78
  518. package/lib/pipette/fixtures/name/pipetteNameSpecFixtures.json +0 -170
  519. package/lib/pipette/schemas/1/pipetteModelSpecsSchema.json +0 -153
  520. package/lib/pipette/schemas/1/pipetteNameSpecsSchema.json +0 -89
  521. package/lib/pipette/schemas/2/pipetteGeometrySchema.json +0 -117
  522. package/lib/pipette/schemas/2/pipetteLiquidPropertiesSchema.json +0 -117
  523. package/lib/pipette/schemas/2/pipettePropertiesSchema.json +0 -323
  524. package/lib/protocol/fixtures/1/simple.json +0 -73
  525. package/lib/protocol/fixtures/3/simple.json +0 -1307
  526. package/lib/protocol/fixtures/3/testAllAtomicSingleV3.json +0 -2281
  527. package/lib/protocol/fixtures/3/testTrickyLabwareV3.json +0 -2576
  528. package/lib/protocol/fixtures/3/unusedPipette.json +0 -1311
  529. package/lib/protocol/fixtures/4/pipetteMultiChannelProtocolV4.json +0 -2561
  530. package/lib/protocol/fixtures/4/simpleV4.json +0 -1309
  531. package/lib/protocol/fixtures/4/testMagneticModuleV4.json +0 -2156
  532. package/lib/protocol/fixtures/4/testModulesProtocol.json +0 -2561
  533. package/lib/protocol/fixtures/4/testTemperatureModuleV4.json +0 -1480
  534. package/lib/protocol/fixtures/4/testThermocyclerModuleV4.json +0 -2182
  535. package/lib/protocol/fixtures/4/transferSettings.json +0 -5482
  536. package/lib/protocol/fixtures/5/multipleTipracks.json +0 -2476
  537. package/lib/protocol/fixtures/5/multipleTipracksWithTC.json +0 -3544
  538. package/lib/protocol/fixtures/5/simpleV5.json +0 -1328
  539. package/lib/protocol/fixtures/6/heaterShakerCommands.json +0 -1421
  540. package/lib/protocol/fixtures/6/heaterShakerCommandsWithResultsKey.json +0 -4725
  541. package/lib/protocol/fixtures/6/multipleTempModules.json +0 -11060
  542. package/lib/protocol/fixtures/6/multipleTipracks.json +0 -4942
  543. package/lib/protocol/fixtures/6/multipleTipracksWithTC.json +0 -7057
  544. package/lib/protocol/fixtures/6/oneTiprack.json +0 -1388
  545. package/lib/protocol/fixtures/6/simpleV6.json +0 -1493
  546. package/lib/protocol/fixtures/6/tempAndMagModuleCommands.json +0 -1412
  547. package/lib/protocol/fixtures/6/transferSettings.json +0 -11060
  548. package/lib/protocol/fixtures/7/moveLabware.json +0 -1303
  549. package/lib/protocol/fixtures/7/simpleV7.json +0 -1495
  550. package/lib/protocol/fixtures/8/moveLabware8.json +0 -1309
  551. package/lib/protocol/fixtures/8/moveLabwareFlex8.json +0 -1309
  552. package/lib/protocol/fixtures/8/simpleFlexV10CommandsV8.json +0 -1475
  553. package/lib/protocol/fixtures/8/simpleFlexV8.json +0 -1475
  554. package/lib/protocol/fixtures/8/simpleFlexV9CommandsV8.json +0 -1475
  555. package/lib/protocol/fixtures/8/simpleV10CommandsV8.json +0 -1473
  556. package/lib/protocol/fixtures/8/simpleV8.json +0 -1473
  557. package/lib/protocol/fixtures/8/simpleV9CommandsV8.json +0 -1473
  558. package/lib/protocol/schemas/1.json +0 -365
  559. package/lib/protocol/schemas/2.json +0 -390
  560. package/lib/protocol/schemas/3.json +0 -336
  561. package/lib/protocol/schemas/4.json +0 -620
  562. package/lib/protocol/schemas/5.json +0 -658
  563. package/lib/protocol/schemas/6.json +0 -1166
  564. package/lib/protocol/schemas/7.json +0 -270
  565. package/lib/protocol/schemas/8.json +0 -141
@@ -1,4430 +0,0 @@
1
- {
2
- "title": "CreateCommandUnion",
3
- "description": "Model that validates a union of all CommandCreate models.",
4
- "discriminator": {
5
- "propertyName": "commandType",
6
- "mapping": {
7
- "aspirate": "#/definitions/AspirateCreate",
8
- "aspirateInPlace": "#/definitions/AspirateInPlaceCreate",
9
- "comment": "#/definitions/CommentCreate",
10
- "configureForVolume": "#/definitions/ConfigureForVolumeCreate",
11
- "configureNozzleLayout": "#/definitions/ConfigureNozzleLayoutCreate",
12
- "custom": "#/definitions/CustomCreate",
13
- "dispense": "#/definitions/DispenseCreate",
14
- "dispenseInPlace": "#/definitions/DispenseInPlaceCreate",
15
- "blowout": "#/definitions/BlowOutCreate",
16
- "blowOutInPlace": "#/definitions/BlowOutInPlaceCreate",
17
- "dropTip": "#/definitions/DropTipCreate",
18
- "dropTipInPlace": "#/definitions/DropTipInPlaceCreate",
19
- "home": "#/definitions/HomeCreate",
20
- "retractAxis": "#/definitions/RetractAxisCreate",
21
- "loadLabware": "#/definitions/LoadLabwareCreate",
22
- "reloadLabware": "#/definitions/ReloadLabwareCreate",
23
- "loadLiquid": "#/definitions/LoadLiquidCreate",
24
- "loadModule": "#/definitions/LoadModuleCreate",
25
- "loadPipette": "#/definitions/LoadPipetteCreate",
26
- "moveLabware": "#/definitions/MoveLabwareCreate",
27
- "moveRelative": "#/definitions/MoveRelativeCreate",
28
- "moveToCoordinates": "#/definitions/MoveToCoordinatesCreate",
29
- "moveToWell": "#/definitions/MoveToWellCreate",
30
- "moveToAddressableArea": "#/definitions/MoveToAddressableAreaCreate",
31
- "moveToAddressableAreaForDropTip": "#/definitions/MoveToAddressableAreaForDropTipCreate",
32
- "prepareToAspirate": "#/definitions/PrepareToAspirateCreate",
33
- "waitForResume": "#/definitions/WaitForResumeCreate",
34
- "pause": "#/definitions/WaitForResumeCreate",
35
- "waitForDuration": "#/definitions/WaitForDurationCreate",
36
- "pickUpTip": "#/definitions/PickUpTipCreate",
37
- "savePosition": "#/definitions/SavePositionCreate",
38
- "setRailLights": "#/definitions/SetRailLightsCreate",
39
- "touchTip": "#/definitions/TouchTipCreate",
40
- "setStatusBar": "#/definitions/SetStatusBarCreate",
41
- "verifyTipPresence": "#/definitions/VerifyTipPresenceCreate",
42
- "getTipPresence": "#/definitions/GetTipPresenceCreate",
43
- "liquidProbe": "#/definitions/LiquidProbeCreate",
44
- "tryLiquidProbe": "#/definitions/TryLiquidProbeCreate",
45
- "heaterShaker/waitForTemperature": "#/definitions/opentrons__protocol_engine__commands__heater_shaker__wait_for_temperature__WaitForTemperatureCreate",
46
- "heaterShaker/setTargetTemperature": "#/definitions/opentrons__protocol_engine__commands__heater_shaker__set_target_temperature__SetTargetTemperatureCreate",
47
- "heaterShaker/deactivateHeater": "#/definitions/DeactivateHeaterCreate",
48
- "heaterShaker/setAndWaitForShakeSpeed": "#/definitions/SetAndWaitForShakeSpeedCreate",
49
- "heaterShaker/deactivateShaker": "#/definitions/DeactivateShakerCreate",
50
- "heaterShaker/openLabwareLatch": "#/definitions/OpenLabwareLatchCreate",
51
- "heaterShaker/closeLabwareLatch": "#/definitions/CloseLabwareLatchCreate",
52
- "magneticModule/disengage": "#/definitions/DisengageCreate",
53
- "magneticModule/engage": "#/definitions/EngageCreate",
54
- "temperatureModule/setTargetTemperature": "#/definitions/opentrons__protocol_engine__commands__temperature_module__set_target_temperature__SetTargetTemperatureCreate",
55
- "temperatureModule/waitForTemperature": "#/definitions/opentrons__protocol_engine__commands__temperature_module__wait_for_temperature__WaitForTemperatureCreate",
56
- "temperatureModule/deactivate": "#/definitions/DeactivateTemperatureCreate",
57
- "thermocycler/setTargetBlockTemperature": "#/definitions/SetTargetBlockTemperatureCreate",
58
- "thermocycler/waitForBlockTemperature": "#/definitions/WaitForBlockTemperatureCreate",
59
- "thermocycler/setTargetLidTemperature": "#/definitions/SetTargetLidTemperatureCreate",
60
- "thermocycler/waitForLidTemperature": "#/definitions/WaitForLidTemperatureCreate",
61
- "thermocycler/deactivateBlock": "#/definitions/DeactivateBlockCreate",
62
- "thermocycler/deactivateLid": "#/definitions/DeactivateLidCreate",
63
- "thermocycler/openLid": "#/definitions/OpenLidCreate",
64
- "thermocycler/closeLid": "#/definitions/CloseLidCreate",
65
- "thermocycler/runProfile": "#/definitions/RunProfileCreate",
66
- "absorbanceReader/initialize": "#/definitions/InitializeCreate",
67
- "absorbanceReader/measure": "#/definitions/MeasureAbsorbanceCreate",
68
- "calibration/calibrateGripper": "#/definitions/CalibrateGripperCreate",
69
- "calibration/calibratePipette": "#/definitions/CalibratePipetteCreate",
70
- "calibration/calibrateModule": "#/definitions/CalibrateModuleCreate",
71
- "calibration/moveToMaintenancePosition": "#/definitions/MoveToMaintenancePositionCreate",
72
- "unsafe/blowOutInPlace": "#/definitions/UnsafeBlowOutInPlaceCreate",
73
- "unsafe/dropTipInPlace": "#/definitions/UnsafeDropTipInPlaceCreate",
74
- "unsafe/updatePositionEstimators": "#/definitions/UpdatePositionEstimatorsCreate",
75
- "unsafe/engageAxes": "#/definitions/UnsafeEngageAxesCreate"
76
- }
77
- },
78
- "oneOf": [
79
- {
80
- "$ref": "#/definitions/AspirateCreate"
81
- },
82
- {
83
- "$ref": "#/definitions/AspirateInPlaceCreate"
84
- },
85
- {
86
- "$ref": "#/definitions/CommentCreate"
87
- },
88
- {
89
- "$ref": "#/definitions/ConfigureForVolumeCreate"
90
- },
91
- {
92
- "$ref": "#/definitions/ConfigureNozzleLayoutCreate"
93
- },
94
- {
95
- "$ref": "#/definitions/CustomCreate"
96
- },
97
- {
98
- "$ref": "#/definitions/DispenseCreate"
99
- },
100
- {
101
- "$ref": "#/definitions/DispenseInPlaceCreate"
102
- },
103
- {
104
- "$ref": "#/definitions/BlowOutCreate"
105
- },
106
- {
107
- "$ref": "#/definitions/BlowOutInPlaceCreate"
108
- },
109
- {
110
- "$ref": "#/definitions/DropTipCreate"
111
- },
112
- {
113
- "$ref": "#/definitions/DropTipInPlaceCreate"
114
- },
115
- {
116
- "$ref": "#/definitions/HomeCreate"
117
- },
118
- {
119
- "$ref": "#/definitions/RetractAxisCreate"
120
- },
121
- {
122
- "$ref": "#/definitions/LoadLabwareCreate"
123
- },
124
- {
125
- "$ref": "#/definitions/ReloadLabwareCreate"
126
- },
127
- {
128
- "$ref": "#/definitions/LoadLiquidCreate"
129
- },
130
- {
131
- "$ref": "#/definitions/LoadModuleCreate"
132
- },
133
- {
134
- "$ref": "#/definitions/LoadPipetteCreate"
135
- },
136
- {
137
- "$ref": "#/definitions/MoveLabwareCreate"
138
- },
139
- {
140
- "$ref": "#/definitions/MoveRelativeCreate"
141
- },
142
- {
143
- "$ref": "#/definitions/MoveToCoordinatesCreate"
144
- },
145
- {
146
- "$ref": "#/definitions/MoveToWellCreate"
147
- },
148
- {
149
- "$ref": "#/definitions/MoveToAddressableAreaCreate"
150
- },
151
- {
152
- "$ref": "#/definitions/MoveToAddressableAreaForDropTipCreate"
153
- },
154
- {
155
- "$ref": "#/definitions/PrepareToAspirateCreate"
156
- },
157
- {
158
- "$ref": "#/definitions/WaitForResumeCreate"
159
- },
160
- {
161
- "$ref": "#/definitions/WaitForDurationCreate"
162
- },
163
- {
164
- "$ref": "#/definitions/PickUpTipCreate"
165
- },
166
- {
167
- "$ref": "#/definitions/SavePositionCreate"
168
- },
169
- {
170
- "$ref": "#/definitions/SetRailLightsCreate"
171
- },
172
- {
173
- "$ref": "#/definitions/TouchTipCreate"
174
- },
175
- {
176
- "$ref": "#/definitions/SetStatusBarCreate"
177
- },
178
- {
179
- "$ref": "#/definitions/VerifyTipPresenceCreate"
180
- },
181
- {
182
- "$ref": "#/definitions/GetTipPresenceCreate"
183
- },
184
- {
185
- "$ref": "#/definitions/LiquidProbeCreate"
186
- },
187
- {
188
- "$ref": "#/definitions/TryLiquidProbeCreate"
189
- },
190
- {
191
- "$ref": "#/definitions/opentrons__protocol_engine__commands__heater_shaker__wait_for_temperature__WaitForTemperatureCreate"
192
- },
193
- {
194
- "$ref": "#/definitions/opentrons__protocol_engine__commands__heater_shaker__set_target_temperature__SetTargetTemperatureCreate"
195
- },
196
- {
197
- "$ref": "#/definitions/DeactivateHeaterCreate"
198
- },
199
- {
200
- "$ref": "#/definitions/SetAndWaitForShakeSpeedCreate"
201
- },
202
- {
203
- "$ref": "#/definitions/DeactivateShakerCreate"
204
- },
205
- {
206
- "$ref": "#/definitions/OpenLabwareLatchCreate"
207
- },
208
- {
209
- "$ref": "#/definitions/CloseLabwareLatchCreate"
210
- },
211
- {
212
- "$ref": "#/definitions/DisengageCreate"
213
- },
214
- {
215
- "$ref": "#/definitions/EngageCreate"
216
- },
217
- {
218
- "$ref": "#/definitions/opentrons__protocol_engine__commands__temperature_module__set_target_temperature__SetTargetTemperatureCreate"
219
- },
220
- {
221
- "$ref": "#/definitions/opentrons__protocol_engine__commands__temperature_module__wait_for_temperature__WaitForTemperatureCreate"
222
- },
223
- {
224
- "$ref": "#/definitions/DeactivateTemperatureCreate"
225
- },
226
- {
227
- "$ref": "#/definitions/SetTargetBlockTemperatureCreate"
228
- },
229
- {
230
- "$ref": "#/definitions/WaitForBlockTemperatureCreate"
231
- },
232
- {
233
- "$ref": "#/definitions/SetTargetLidTemperatureCreate"
234
- },
235
- {
236
- "$ref": "#/definitions/WaitForLidTemperatureCreate"
237
- },
238
- {
239
- "$ref": "#/definitions/DeactivateBlockCreate"
240
- },
241
- {
242
- "$ref": "#/definitions/DeactivateLidCreate"
243
- },
244
- {
245
- "$ref": "#/definitions/OpenLidCreate"
246
- },
247
- {
248
- "$ref": "#/definitions/CloseLidCreate"
249
- },
250
- {
251
- "$ref": "#/definitions/RunProfileCreate"
252
- },
253
- {
254
- "$ref": "#/definitions/InitializeCreate"
255
- },
256
- {
257
- "$ref": "#/definitions/MeasureAbsorbanceCreate"
258
- },
259
- {
260
- "$ref": "#/definitions/CalibrateGripperCreate"
261
- },
262
- {
263
- "$ref": "#/definitions/CalibratePipetteCreate"
264
- },
265
- {
266
- "$ref": "#/definitions/CalibrateModuleCreate"
267
- },
268
- {
269
- "$ref": "#/definitions/MoveToMaintenancePositionCreate"
270
- },
271
- {
272
- "$ref": "#/definitions/UnsafeBlowOutInPlaceCreate"
273
- },
274
- {
275
- "$ref": "#/definitions/UnsafeDropTipInPlaceCreate"
276
- },
277
- {
278
- "$ref": "#/definitions/UpdatePositionEstimatorsCreate"
279
- },
280
- {
281
- "$ref": "#/definitions/UnsafeEngageAxesCreate"
282
- }
283
- ],
284
- "definitions": {
285
- "WellOrigin": {
286
- "title": "WellOrigin",
287
- "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",
288
- "enum": ["top", "bottom", "center"],
289
- "type": "string"
290
- },
291
- "WellOffset": {
292
- "title": "WellOffset",
293
- "description": "An offset vector in (x, y, z).",
294
- "type": "object",
295
- "properties": {
296
- "x": {
297
- "title": "X",
298
- "default": 0,
299
- "type": "number"
300
- },
301
- "y": {
302
- "title": "Y",
303
- "default": 0,
304
- "type": "number"
305
- },
306
- "z": {
307
- "title": "Z",
308
- "default": 0,
309
- "type": "number"
310
- }
311
- }
312
- },
313
- "WellLocation": {
314
- "title": "WellLocation",
315
- "description": "A relative location in reference to a well's location.",
316
- "type": "object",
317
- "properties": {
318
- "origin": {
319
- "default": "top",
320
- "allOf": [
321
- {
322
- "$ref": "#/definitions/WellOrigin"
323
- }
324
- ]
325
- },
326
- "offset": {
327
- "$ref": "#/definitions/WellOffset"
328
- }
329
- }
330
- },
331
- "AspirateParams": {
332
- "title": "AspirateParams",
333
- "description": "Parameters required to aspirate from a specific well.",
334
- "type": "object",
335
- "properties": {
336
- "labwareId": {
337
- "title": "Labwareid",
338
- "description": "Identifier of labware to use.",
339
- "type": "string"
340
- },
341
- "wellName": {
342
- "title": "Wellname",
343
- "description": "Name of well to use in labware.",
344
- "type": "string"
345
- },
346
- "wellLocation": {
347
- "title": "Welllocation",
348
- "description": "Relative well location at which to perform the operation",
349
- "allOf": [
350
- {
351
- "$ref": "#/definitions/WellLocation"
352
- }
353
- ]
354
- },
355
- "flowRate": {
356
- "title": "Flowrate",
357
- "description": "Speed in \u00b5L/s configured for the pipette",
358
- "exclusiveMinimum": 0,
359
- "type": "number"
360
- },
361
- "volume": {
362
- "title": "Volume",
363
- "description": "The amount of liquid to aspirate, in \u00b5L. Must not be greater than the remaining available amount, which depends on the pipette (see `loadPipette`), its configuration (see `configureForVolume`), the tip (see `pickUpTip`), and the amount you've aspirated so far. There is some tolerance for floating point rounding errors.",
364
- "minimum": 0,
365
- "type": "number"
366
- },
367
- "pipetteId": {
368
- "title": "Pipetteid",
369
- "description": "Identifier of pipette to use for liquid handling.",
370
- "type": "string"
371
- }
372
- },
373
- "required": ["labwareId", "wellName", "flowRate", "volume", "pipetteId"]
374
- },
375
- "CommandIntent": {
376
- "title": "CommandIntent",
377
- "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.",
378
- "enum": ["protocol", "setup", "fixit"],
379
- "type": "string"
380
- },
381
- "AspirateCreate": {
382
- "title": "AspirateCreate",
383
- "description": "Create aspirate command request model.",
384
- "type": "object",
385
- "properties": {
386
- "commandType": {
387
- "title": "Commandtype",
388
- "default": "aspirate",
389
- "enum": ["aspirate"],
390
- "type": "string"
391
- },
392
- "params": {
393
- "$ref": "#/definitions/AspirateParams"
394
- },
395
- "intent": {
396
- "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.",
397
- "allOf": [
398
- {
399
- "$ref": "#/definitions/CommandIntent"
400
- }
401
- ]
402
- },
403
- "key": {
404
- "title": "Key",
405
- "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.",
406
- "type": "string"
407
- }
408
- },
409
- "required": ["params"]
410
- },
411
- "AspirateInPlaceParams": {
412
- "title": "AspirateInPlaceParams",
413
- "description": "Payload required to aspirate in place.",
414
- "type": "object",
415
- "properties": {
416
- "flowRate": {
417
- "title": "Flowrate",
418
- "description": "Speed in \u00b5L/s configured for the pipette",
419
- "exclusiveMinimum": 0,
420
- "type": "number"
421
- },
422
- "volume": {
423
- "title": "Volume",
424
- "description": "The amount of liquid to aspirate, in \u00b5L. Must not be greater than the remaining available amount, which depends on the pipette (see `loadPipette`), its configuration (see `configureForVolume`), the tip (see `pickUpTip`), and the amount you've aspirated so far. There is some tolerance for floating point rounding errors.",
425
- "minimum": 0,
426
- "type": "number"
427
- },
428
- "pipetteId": {
429
- "title": "Pipetteid",
430
- "description": "Identifier of pipette to use for liquid handling.",
431
- "type": "string"
432
- }
433
- },
434
- "required": ["flowRate", "volume", "pipetteId"]
435
- },
436
- "AspirateInPlaceCreate": {
437
- "title": "AspirateInPlaceCreate",
438
- "description": "AspirateInPlace command request model.",
439
- "type": "object",
440
- "properties": {
441
- "commandType": {
442
- "title": "Commandtype",
443
- "default": "aspirateInPlace",
444
- "enum": ["aspirateInPlace"],
445
- "type": "string"
446
- },
447
- "params": {
448
- "$ref": "#/definitions/AspirateInPlaceParams"
449
- },
450
- "intent": {
451
- "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.",
452
- "allOf": [
453
- {
454
- "$ref": "#/definitions/CommandIntent"
455
- }
456
- ]
457
- },
458
- "key": {
459
- "title": "Key",
460
- "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.",
461
- "type": "string"
462
- }
463
- },
464
- "required": ["params"]
465
- },
466
- "CommentParams": {
467
- "title": "CommentParams",
468
- "description": "Payload required to annotate execution with a comment.",
469
- "type": "object",
470
- "properties": {
471
- "message": {
472
- "title": "Message",
473
- "description": "A user-facing message",
474
- "type": "string"
475
- }
476
- },
477
- "required": ["message"]
478
- },
479
- "CommentCreate": {
480
- "title": "CommentCreate",
481
- "description": "Comment command request model.",
482
- "type": "object",
483
- "properties": {
484
- "commandType": {
485
- "title": "Commandtype",
486
- "default": "comment",
487
- "enum": ["comment"],
488
- "type": "string"
489
- },
490
- "params": {
491
- "$ref": "#/definitions/CommentParams"
492
- },
493
- "intent": {
494
- "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.",
495
- "allOf": [
496
- {
497
- "$ref": "#/definitions/CommandIntent"
498
- }
499
- ]
500
- },
501
- "key": {
502
- "title": "Key",
503
- "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.",
504
- "type": "string"
505
- }
506
- },
507
- "required": ["params"]
508
- },
509
- "ConfigureForVolumeParams": {
510
- "title": "ConfigureForVolumeParams",
511
- "description": "Parameters required to configure volume for a specific pipette.",
512
- "type": "object",
513
- "properties": {
514
- "pipetteId": {
515
- "title": "Pipetteid",
516
- "description": "Identifier of pipette to use for liquid handling.",
517
- "type": "string"
518
- },
519
- "volume": {
520
- "title": "Volume",
521
- "description": "Amount of liquid in uL. Must be at least 0 and no greater than a pipette-specific maximum volume.",
522
- "minimum": 0,
523
- "type": "number"
524
- },
525
- "tipOverlapNotAfterVersion": {
526
- "title": "Tipoverlapnotafterversion",
527
- "description": "A version of tip overlap data to not exceed. The highest-versioned tip overlap data that does not exceed this version will be used. Versions are expressed as vN where N is an integer, counting up from v0. If None, the current highest version will be used.",
528
- "type": "string"
529
- }
530
- },
531
- "required": ["pipetteId", "volume"]
532
- },
533
- "ConfigureForVolumeCreate": {
534
- "title": "ConfigureForVolumeCreate",
535
- "description": "Configure for volume command creation request model.",
536
- "type": "object",
537
- "properties": {
538
- "commandType": {
539
- "title": "Commandtype",
540
- "default": "configureForVolume",
541
- "enum": ["configureForVolume"],
542
- "type": "string"
543
- },
544
- "params": {
545
- "$ref": "#/definitions/ConfigureForVolumeParams"
546
- },
547
- "intent": {
548
- "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.",
549
- "allOf": [
550
- {
551
- "$ref": "#/definitions/CommandIntent"
552
- }
553
- ]
554
- },
555
- "key": {
556
- "title": "Key",
557
- "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.",
558
- "type": "string"
559
- }
560
- },
561
- "required": ["params"]
562
- },
563
- "AllNozzleLayoutConfiguration": {
564
- "title": "AllNozzleLayoutConfiguration",
565
- "description": "All basemodel to represent a reset to the nozzle configuration. Sending no parameters resets to default.",
566
- "type": "object",
567
- "properties": {
568
- "style": {
569
- "title": "Style",
570
- "default": "ALL",
571
- "enum": ["ALL"],
572
- "type": "string"
573
- }
574
- }
575
- },
576
- "SingleNozzleLayoutConfiguration": {
577
- "title": "SingleNozzleLayoutConfiguration",
578
- "description": "Minimum information required for a new nozzle configuration.",
579
- "type": "object",
580
- "properties": {
581
- "style": {
582
- "title": "Style",
583
- "default": "SINGLE",
584
- "enum": ["SINGLE"],
585
- "type": "string"
586
- },
587
- "primaryNozzle": {
588
- "title": "Primarynozzle",
589
- "description": "The primary nozzle to use in the layout configuration. This nozzle will update the critical point of the current pipette. For now, this is also the back left corner of your rectangle.",
590
- "enum": ["A1", "H1", "A12", "H12"],
591
- "type": "string"
592
- }
593
- },
594
- "required": ["primaryNozzle"]
595
- },
596
- "RowNozzleLayoutConfiguration": {
597
- "title": "RowNozzleLayoutConfiguration",
598
- "description": "Minimum information required for a new nozzle configuration.",
599
- "type": "object",
600
- "properties": {
601
- "style": {
602
- "title": "Style",
603
- "default": "ROW",
604
- "enum": ["ROW"],
605
- "type": "string"
606
- },
607
- "primaryNozzle": {
608
- "title": "Primarynozzle",
609
- "description": "The primary nozzle to use in the layout configuration. This nozzle will update the critical point of the current pipette. For now, this is also the back left corner of your rectangle.",
610
- "enum": ["A1", "H1", "A12", "H12"],
611
- "type": "string"
612
- }
613
- },
614
- "required": ["primaryNozzle"]
615
- },
616
- "ColumnNozzleLayoutConfiguration": {
617
- "title": "ColumnNozzleLayoutConfiguration",
618
- "description": "Information required for nozzle configurations of type ROW and COLUMN.",
619
- "type": "object",
620
- "properties": {
621
- "style": {
622
- "title": "Style",
623
- "default": "COLUMN",
624
- "enum": ["COLUMN"],
625
- "type": "string"
626
- },
627
- "primaryNozzle": {
628
- "title": "Primarynozzle",
629
- "description": "The primary nozzle to use in the layout configuration. This nozzle will update the critical point of the current pipette. For now, this is also the back left corner of your rectangle.",
630
- "enum": ["A1", "H1", "A12", "H12"],
631
- "type": "string"
632
- }
633
- },
634
- "required": ["primaryNozzle"]
635
- },
636
- "QuadrantNozzleLayoutConfiguration": {
637
- "title": "QuadrantNozzleLayoutConfiguration",
638
- "description": "Information required for nozzle configurations of type QUADRANT.",
639
- "type": "object",
640
- "properties": {
641
- "style": {
642
- "title": "Style",
643
- "default": "QUADRANT",
644
- "enum": ["QUADRANT"],
645
- "type": "string"
646
- },
647
- "primaryNozzle": {
648
- "title": "Primarynozzle",
649
- "description": "The primary nozzle to use in the layout configuration. This nozzle will update the critical point of the current pipette. For now, this is also the back left corner of your rectangle.",
650
- "enum": ["A1", "H1", "A12", "H12"],
651
- "type": "string"
652
- },
653
- "frontRightNozzle": {
654
- "title": "Frontrightnozzle",
655
- "description": "The front right nozzle in your configuration.",
656
- "pattern": "[A-Z]\\d{1,2}",
657
- "type": "string"
658
- },
659
- "backLeftNozzle": {
660
- "title": "Backleftnozzle",
661
- "description": "The back left nozzle in your configuration.",
662
- "pattern": "[A-Z]\\d{1,2}",
663
- "type": "string"
664
- }
665
- },
666
- "required": ["primaryNozzle", "frontRightNozzle", "backLeftNozzle"]
667
- },
668
- "ConfigureNozzleLayoutParams": {
669
- "title": "ConfigureNozzleLayoutParams",
670
- "description": "Parameters required to configure the nozzle layout for a specific pipette.",
671
- "type": "object",
672
- "properties": {
673
- "pipetteId": {
674
- "title": "Pipetteid",
675
- "description": "Identifier of pipette to use for liquid handling.",
676
- "type": "string"
677
- },
678
- "configurationParams": {
679
- "title": "Configurationparams",
680
- "anyOf": [
681
- {
682
- "$ref": "#/definitions/AllNozzleLayoutConfiguration"
683
- },
684
- {
685
- "$ref": "#/definitions/SingleNozzleLayoutConfiguration"
686
- },
687
- {
688
- "$ref": "#/definitions/RowNozzleLayoutConfiguration"
689
- },
690
- {
691
- "$ref": "#/definitions/ColumnNozzleLayoutConfiguration"
692
- },
693
- {
694
- "$ref": "#/definitions/QuadrantNozzleLayoutConfiguration"
695
- }
696
- ]
697
- }
698
- },
699
- "required": ["pipetteId", "configurationParams"]
700
- },
701
- "ConfigureNozzleLayoutCreate": {
702
- "title": "ConfigureNozzleLayoutCreate",
703
- "description": "Configure nozzle layout creation request model.",
704
- "type": "object",
705
- "properties": {
706
- "commandType": {
707
- "title": "Commandtype",
708
- "default": "configureNozzleLayout",
709
- "enum": ["configureNozzleLayout"],
710
- "type": "string"
711
- },
712
- "params": {
713
- "$ref": "#/definitions/ConfigureNozzleLayoutParams"
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
- "CustomParams": {
732
- "title": "CustomParams",
733
- "description": "Payload used by a custom command.",
734
- "type": "object",
735
- "properties": {}
736
- },
737
- "CustomCreate": {
738
- "title": "CustomCreate",
739
- "description": "A request to create a custom command.",
740
- "type": "object",
741
- "properties": {
742
- "commandType": {
743
- "title": "Commandtype",
744
- "default": "custom",
745
- "enum": ["custom"],
746
- "type": "string"
747
- },
748
- "params": {
749
- "$ref": "#/definitions/CustomParams"
750
- },
751
- "intent": {
752
- "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.",
753
- "allOf": [
754
- {
755
- "$ref": "#/definitions/CommandIntent"
756
- }
757
- ]
758
- },
759
- "key": {
760
- "title": "Key",
761
- "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.",
762
- "type": "string"
763
- }
764
- },
765
- "required": ["params"]
766
- },
767
- "DispenseParams": {
768
- "title": "DispenseParams",
769
- "description": "Payload required to dispense to a specific well.",
770
- "type": "object",
771
- "properties": {
772
- "labwareId": {
773
- "title": "Labwareid",
774
- "description": "Identifier of labware to use.",
775
- "type": "string"
776
- },
777
- "wellName": {
778
- "title": "Wellname",
779
- "description": "Name of well to use in labware.",
780
- "type": "string"
781
- },
782
- "wellLocation": {
783
- "title": "Welllocation",
784
- "description": "Relative well location at which to perform the operation",
785
- "allOf": [
786
- {
787
- "$ref": "#/definitions/WellLocation"
788
- }
789
- ]
790
- },
791
- "flowRate": {
792
- "title": "Flowrate",
793
- "description": "Speed in \u00b5L/s configured for the pipette",
794
- "exclusiveMinimum": 0,
795
- "type": "number"
796
- },
797
- "volume": {
798
- "title": "Volume",
799
- "description": "The amount of liquid to dispense, in \u00b5L. Must not be greater than the currently aspirated volume. There is some tolerance for floating point rounding errors.",
800
- "minimum": 0,
801
- "type": "number"
802
- },
803
- "pipetteId": {
804
- "title": "Pipetteid",
805
- "description": "Identifier of pipette to use for liquid handling.",
806
- "type": "string"
807
- },
808
- "pushOut": {
809
- "title": "Pushout",
810
- "description": "push the plunger a small amount farther than necessary for accurate low-volume dispensing",
811
- "type": "number"
812
- }
813
- },
814
- "required": ["labwareId", "wellName", "flowRate", "volume", "pipetteId"]
815
- },
816
- "DispenseCreate": {
817
- "title": "DispenseCreate",
818
- "description": "Create dispense command request model.",
819
- "type": "object",
820
- "properties": {
821
- "commandType": {
822
- "title": "Commandtype",
823
- "default": "dispense",
824
- "enum": ["dispense"],
825
- "type": "string"
826
- },
827
- "params": {
828
- "$ref": "#/definitions/DispenseParams"
829
- },
830
- "intent": {
831
- "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.",
832
- "allOf": [
833
- {
834
- "$ref": "#/definitions/CommandIntent"
835
- }
836
- ]
837
- },
838
- "key": {
839
- "title": "Key",
840
- "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.",
841
- "type": "string"
842
- }
843
- },
844
- "required": ["params"]
845
- },
846
- "DispenseInPlaceParams": {
847
- "title": "DispenseInPlaceParams",
848
- "description": "Payload required to dispense in place.",
849
- "type": "object",
850
- "properties": {
851
- "flowRate": {
852
- "title": "Flowrate",
853
- "description": "Speed in \u00b5L/s configured for the pipette",
854
- "exclusiveMinimum": 0,
855
- "type": "number"
856
- },
857
- "volume": {
858
- "title": "Volume",
859
- "description": "The amount of liquid to dispense, in \u00b5L. Must not be greater than the currently aspirated volume. There is some tolerance for floating point rounding errors.",
860
- "minimum": 0,
861
- "type": "number"
862
- },
863
- "pipetteId": {
864
- "title": "Pipetteid",
865
- "description": "Identifier of pipette to use for liquid handling.",
866
- "type": "string"
867
- },
868
- "pushOut": {
869
- "title": "Pushout",
870
- "description": "push the plunger a small amount farther than necessary for accurate low-volume dispensing",
871
- "type": "number"
872
- }
873
- },
874
- "required": ["flowRate", "volume", "pipetteId"]
875
- },
876
- "DispenseInPlaceCreate": {
877
- "title": "DispenseInPlaceCreate",
878
- "description": "DispenseInPlace command request model.",
879
- "type": "object",
880
- "properties": {
881
- "commandType": {
882
- "title": "Commandtype",
883
- "default": "dispenseInPlace",
884
- "enum": ["dispenseInPlace"],
885
- "type": "string"
886
- },
887
- "params": {
888
- "$ref": "#/definitions/DispenseInPlaceParams"
889
- },
890
- "intent": {
891
- "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.",
892
- "allOf": [
893
- {
894
- "$ref": "#/definitions/CommandIntent"
895
- }
896
- ]
897
- },
898
- "key": {
899
- "title": "Key",
900
- "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.",
901
- "type": "string"
902
- }
903
- },
904
- "required": ["params"]
905
- },
906
- "BlowOutParams": {
907
- "title": "BlowOutParams",
908
- "description": "Payload required to blow-out a specific well.",
909
- "type": "object",
910
- "properties": {
911
- "labwareId": {
912
- "title": "Labwareid",
913
- "description": "Identifier of labware to use.",
914
- "type": "string"
915
- },
916
- "wellName": {
917
- "title": "Wellname",
918
- "description": "Name of well to use in labware.",
919
- "type": "string"
920
- },
921
- "wellLocation": {
922
- "title": "Welllocation",
923
- "description": "Relative well location at which to perform the operation",
924
- "allOf": [
925
- {
926
- "$ref": "#/definitions/WellLocation"
927
- }
928
- ]
929
- },
930
- "flowRate": {
931
- "title": "Flowrate",
932
- "description": "Speed in \u00b5L/s configured for the pipette",
933
- "exclusiveMinimum": 0,
934
- "type": "number"
935
- },
936
- "pipetteId": {
937
- "title": "Pipetteid",
938
- "description": "Identifier of pipette to use for liquid handling.",
939
- "type": "string"
940
- }
941
- },
942
- "required": ["labwareId", "wellName", "flowRate", "pipetteId"]
943
- },
944
- "BlowOutCreate": {
945
- "title": "BlowOutCreate",
946
- "description": "Create blow-out command request model.",
947
- "type": "object",
948
- "properties": {
949
- "commandType": {
950
- "title": "Commandtype",
951
- "default": "blowout",
952
- "enum": ["blowout"],
953
- "type": "string"
954
- },
955
- "params": {
956
- "$ref": "#/definitions/BlowOutParams"
957
- },
958
- "intent": {
959
- "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.",
960
- "allOf": [
961
- {
962
- "$ref": "#/definitions/CommandIntent"
963
- }
964
- ]
965
- },
966
- "key": {
967
- "title": "Key",
968
- "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.",
969
- "type": "string"
970
- }
971
- },
972
- "required": ["params"]
973
- },
974
- "BlowOutInPlaceParams": {
975
- "title": "BlowOutInPlaceParams",
976
- "description": "Payload required to blow-out in place.",
977
- "type": "object",
978
- "properties": {
979
- "flowRate": {
980
- "title": "Flowrate",
981
- "description": "Speed in \u00b5L/s configured for the pipette",
982
- "exclusiveMinimum": 0,
983
- "type": "number"
984
- },
985
- "pipetteId": {
986
- "title": "Pipetteid",
987
- "description": "Identifier of pipette to use for liquid handling.",
988
- "type": "string"
989
- }
990
- },
991
- "required": ["flowRate", "pipetteId"]
992
- },
993
- "BlowOutInPlaceCreate": {
994
- "title": "BlowOutInPlaceCreate",
995
- "description": "BlowOutInPlace command request model.",
996
- "type": "object",
997
- "properties": {
998
- "commandType": {
999
- "title": "Commandtype",
1000
- "default": "blowOutInPlace",
1001
- "enum": ["blowOutInPlace"],
1002
- "type": "string"
1003
- },
1004
- "params": {
1005
- "$ref": "#/definitions/BlowOutInPlaceParams"
1006
- },
1007
- "intent": {
1008
- "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.",
1009
- "allOf": [
1010
- {
1011
- "$ref": "#/definitions/CommandIntent"
1012
- }
1013
- ]
1014
- },
1015
- "key": {
1016
- "title": "Key",
1017
- "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.",
1018
- "type": "string"
1019
- }
1020
- },
1021
- "required": ["params"]
1022
- },
1023
- "DropTipWellOrigin": {
1024
- "title": "DropTipWellOrigin",
1025
- "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.",
1026
- "enum": ["top", "bottom", "center", "default"],
1027
- "type": "string"
1028
- },
1029
- "DropTipWellLocation": {
1030
- "title": "DropTipWellLocation",
1031
- "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.",
1032
- "type": "object",
1033
- "properties": {
1034
- "origin": {
1035
- "default": "default",
1036
- "allOf": [
1037
- {
1038
- "$ref": "#/definitions/DropTipWellOrigin"
1039
- }
1040
- ]
1041
- },
1042
- "offset": {
1043
- "$ref": "#/definitions/WellOffset"
1044
- }
1045
- }
1046
- },
1047
- "DropTipParams": {
1048
- "title": "DropTipParams",
1049
- "description": "Payload required to drop a tip in a specific well.",
1050
- "type": "object",
1051
- "properties": {
1052
- "pipetteId": {
1053
- "title": "Pipetteid",
1054
- "description": "Identifier of pipette to use for liquid handling.",
1055
- "type": "string"
1056
- },
1057
- "labwareId": {
1058
- "title": "Labwareid",
1059
- "description": "Identifier of labware to use.",
1060
- "type": "string"
1061
- },
1062
- "wellName": {
1063
- "title": "Wellname",
1064
- "description": "Name of well to use in labware.",
1065
- "type": "string"
1066
- },
1067
- "wellLocation": {
1068
- "title": "Welllocation",
1069
- "description": "Relative well location at which to drop the tip.",
1070
- "allOf": [
1071
- {
1072
- "$ref": "#/definitions/DropTipWellLocation"
1073
- }
1074
- ]
1075
- },
1076
- "homeAfter": {
1077
- "title": "Homeafter",
1078
- "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.",
1079
- "type": "boolean"
1080
- },
1081
- "alternateDropLocation": {
1082
- "title": "Alternatedroplocation",
1083
- "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.",
1084
- "default": false,
1085
- "type": "boolean"
1086
- }
1087
- },
1088
- "required": ["pipetteId", "labwareId", "wellName"]
1089
- },
1090
- "DropTipCreate": {
1091
- "title": "DropTipCreate",
1092
- "description": "Drop tip command creation request model.",
1093
- "type": "object",
1094
- "properties": {
1095
- "commandType": {
1096
- "title": "Commandtype",
1097
- "default": "dropTip",
1098
- "enum": ["dropTip"],
1099
- "type": "string"
1100
- },
1101
- "params": {
1102
- "$ref": "#/definitions/DropTipParams"
1103
- },
1104
- "intent": {
1105
- "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.",
1106
- "allOf": [
1107
- {
1108
- "$ref": "#/definitions/CommandIntent"
1109
- }
1110
- ]
1111
- },
1112
- "key": {
1113
- "title": "Key",
1114
- "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.",
1115
- "type": "string"
1116
- }
1117
- },
1118
- "required": ["params"]
1119
- },
1120
- "DropTipInPlaceParams": {
1121
- "title": "DropTipInPlaceParams",
1122
- "description": "Payload required to drop a tip in place.",
1123
- "type": "object",
1124
- "properties": {
1125
- "pipetteId": {
1126
- "title": "Pipetteid",
1127
- "description": "Identifier of pipette to use for liquid handling.",
1128
- "type": "string"
1129
- },
1130
- "homeAfter": {
1131
- "title": "Homeafter",
1132
- "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.",
1133
- "type": "boolean"
1134
- }
1135
- },
1136
- "required": ["pipetteId"]
1137
- },
1138
- "DropTipInPlaceCreate": {
1139
- "title": "DropTipInPlaceCreate",
1140
- "description": "Drop tip in place command creation request model.",
1141
- "type": "object",
1142
- "properties": {
1143
- "commandType": {
1144
- "title": "Commandtype",
1145
- "default": "dropTipInPlace",
1146
- "enum": ["dropTipInPlace"],
1147
- "type": "string"
1148
- },
1149
- "params": {
1150
- "$ref": "#/definitions/DropTipInPlaceParams"
1151
- },
1152
- "intent": {
1153
- "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.",
1154
- "allOf": [
1155
- {
1156
- "$ref": "#/definitions/CommandIntent"
1157
- }
1158
- ]
1159
- },
1160
- "key": {
1161
- "title": "Key",
1162
- "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.",
1163
- "type": "string"
1164
- }
1165
- },
1166
- "required": ["params"]
1167
- },
1168
- "MotorAxis": {
1169
- "title": "MotorAxis",
1170
- "description": "Motor axis on which to issue a home command.",
1171
- "enum": [
1172
- "x",
1173
- "y",
1174
- "leftZ",
1175
- "rightZ",
1176
- "leftPlunger",
1177
- "rightPlunger",
1178
- "extensionZ",
1179
- "extensionJaw"
1180
- ],
1181
- "type": "string"
1182
- },
1183
- "MountType": {
1184
- "title": "MountType",
1185
- "description": "An enumeration.",
1186
- "enum": ["left", "right", "extension"],
1187
- "type": "string"
1188
- },
1189
- "HomeParams": {
1190
- "title": "HomeParams",
1191
- "description": "Payload required for a Home command.",
1192
- "type": "object",
1193
- "properties": {
1194
- "axes": {
1195
- "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.",
1196
- "type": "array",
1197
- "items": {
1198
- "$ref": "#/definitions/MotorAxis"
1199
- }
1200
- },
1201
- "skipIfMountPositionOk": {
1202
- "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.",
1203
- "allOf": [
1204
- {
1205
- "$ref": "#/definitions/MountType"
1206
- }
1207
- ]
1208
- }
1209
- }
1210
- },
1211
- "HomeCreate": {
1212
- "title": "HomeCreate",
1213
- "description": "Data to create a Home command.",
1214
- "type": "object",
1215
- "properties": {
1216
- "commandType": {
1217
- "title": "Commandtype",
1218
- "default": "home",
1219
- "enum": ["home"],
1220
- "type": "string"
1221
- },
1222
- "params": {
1223
- "$ref": "#/definitions/HomeParams"
1224
- },
1225
- "intent": {
1226
- "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.",
1227
- "allOf": [
1228
- {
1229
- "$ref": "#/definitions/CommandIntent"
1230
- }
1231
- ]
1232
- },
1233
- "key": {
1234
- "title": "Key",
1235
- "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.",
1236
- "type": "string"
1237
- }
1238
- },
1239
- "required": ["params"]
1240
- },
1241
- "RetractAxisParams": {
1242
- "title": "RetractAxisParams",
1243
- "description": "Payload required for a Retract Axis command.",
1244
- "type": "object",
1245
- "properties": {
1246
- "axis": {
1247
- "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.",
1248
- "allOf": [
1249
- {
1250
- "$ref": "#/definitions/MotorAxis"
1251
- }
1252
- ]
1253
- }
1254
- },
1255
- "required": ["axis"]
1256
- },
1257
- "RetractAxisCreate": {
1258
- "title": "RetractAxisCreate",
1259
- "description": "Data to create a Retract Axis command.",
1260
- "type": "object",
1261
- "properties": {
1262
- "commandType": {
1263
- "title": "Commandtype",
1264
- "default": "retractAxis",
1265
- "enum": ["retractAxis"],
1266
- "type": "string"
1267
- },
1268
- "params": {
1269
- "$ref": "#/definitions/RetractAxisParams"
1270
- },
1271
- "intent": {
1272
- "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.",
1273
- "allOf": [
1274
- {
1275
- "$ref": "#/definitions/CommandIntent"
1276
- }
1277
- ]
1278
- },
1279
- "key": {
1280
- "title": "Key",
1281
- "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.",
1282
- "type": "string"
1283
- }
1284
- },
1285
- "required": ["params"]
1286
- },
1287
- "DeckSlotName": {
1288
- "title": "DeckSlotName",
1289
- "description": "Deck slot identifiers.",
1290
- "enum": [
1291
- "1",
1292
- "2",
1293
- "3",
1294
- "4",
1295
- "5",
1296
- "6",
1297
- "7",
1298
- "8",
1299
- "9",
1300
- "10",
1301
- "11",
1302
- "12",
1303
- "A1",
1304
- "A2",
1305
- "A3",
1306
- "B1",
1307
- "B2",
1308
- "B3",
1309
- "C1",
1310
- "C2",
1311
- "C3",
1312
- "D1",
1313
- "D2",
1314
- "D3"
1315
- ]
1316
- },
1317
- "DeckSlotLocation": {
1318
- "title": "DeckSlotLocation",
1319
- "description": "The location of something placed in a single deck slot.",
1320
- "type": "object",
1321
- "properties": {
1322
- "slotName": {
1323
- "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.",
1324
- "allOf": [
1325
- {
1326
- "$ref": "#/definitions/DeckSlotName"
1327
- }
1328
- ]
1329
- }
1330
- },
1331
- "required": ["slotName"]
1332
- },
1333
- "ModuleLocation": {
1334
- "title": "ModuleLocation",
1335
- "description": "The location of something placed atop a hardware module.",
1336
- "type": "object",
1337
- "properties": {
1338
- "moduleId": {
1339
- "title": "Moduleid",
1340
- "description": "The ID of a loaded module from a prior `loadModule` command.",
1341
- "type": "string"
1342
- }
1343
- },
1344
- "required": ["moduleId"]
1345
- },
1346
- "OnLabwareLocation": {
1347
- "title": "OnLabwareLocation",
1348
- "description": "The location of something placed atop another labware.",
1349
- "type": "object",
1350
- "properties": {
1351
- "labwareId": {
1352
- "title": "Labwareid",
1353
- "description": "The ID of a loaded Labware from a prior `loadLabware` command.",
1354
- "type": "string"
1355
- }
1356
- },
1357
- "required": ["labwareId"]
1358
- },
1359
- "AddressableAreaLocation": {
1360
- "title": "AddressableAreaLocation",
1361
- "description": "The location of something place in an addressable area. This is a superset of deck slots.",
1362
- "type": "object",
1363
- "properties": {
1364
- "addressableAreaName": {
1365
- "title": "Addressableareaname",
1366
- "description": "The name of the addressable area that you want to use. Valid values are the `id`s of `addressableArea`s in the [deck definition](https://github.com/Opentrons/opentrons/tree/edge/shared-data/deck).",
1367
- "type": "string"
1368
- }
1369
- },
1370
- "required": ["addressableAreaName"]
1371
- },
1372
- "LoadLabwareParams": {
1373
- "title": "LoadLabwareParams",
1374
- "description": "Payload required to load a labware into a slot.",
1375
- "type": "object",
1376
- "properties": {
1377
- "location": {
1378
- "title": "Location",
1379
- "description": "Location the labware should be loaded into.",
1380
- "anyOf": [
1381
- {
1382
- "$ref": "#/definitions/DeckSlotLocation"
1383
- },
1384
- {
1385
- "$ref": "#/definitions/ModuleLocation"
1386
- },
1387
- {
1388
- "$ref": "#/definitions/OnLabwareLocation"
1389
- },
1390
- {
1391
- "enum": ["offDeck"],
1392
- "type": "string"
1393
- },
1394
- {
1395
- "$ref": "#/definitions/AddressableAreaLocation"
1396
- }
1397
- ]
1398
- },
1399
- "loadName": {
1400
- "title": "Loadname",
1401
- "description": "Name used to reference a labware definition.",
1402
- "type": "string"
1403
- },
1404
- "namespace": {
1405
- "title": "Namespace",
1406
- "description": "The namespace the labware definition belongs to.",
1407
- "type": "string"
1408
- },
1409
- "version": {
1410
- "title": "Version",
1411
- "description": "The labware definition version.",
1412
- "type": "integer"
1413
- },
1414
- "labwareId": {
1415
- "title": "Labwareid",
1416
- "description": "An optional ID to assign to this labware. If None, an ID will be generated.",
1417
- "type": "string"
1418
- },
1419
- "displayName": {
1420
- "title": "Displayname",
1421
- "description": "An optional user-specified display name or label for this labware.",
1422
- "type": "string"
1423
- }
1424
- },
1425
- "required": ["location", "loadName", "namespace", "version"]
1426
- },
1427
- "LoadLabwareCreate": {
1428
- "title": "LoadLabwareCreate",
1429
- "description": "Load labware command creation request.",
1430
- "type": "object",
1431
- "properties": {
1432
- "commandType": {
1433
- "title": "Commandtype",
1434
- "default": "loadLabware",
1435
- "enum": ["loadLabware"],
1436
- "type": "string"
1437
- },
1438
- "params": {
1439
- "$ref": "#/definitions/LoadLabwareParams"
1440
- },
1441
- "intent": {
1442
- "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.",
1443
- "allOf": [
1444
- {
1445
- "$ref": "#/definitions/CommandIntent"
1446
- }
1447
- ]
1448
- },
1449
- "key": {
1450
- "title": "Key",
1451
- "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.",
1452
- "type": "string"
1453
- }
1454
- },
1455
- "required": ["params"]
1456
- },
1457
- "ReloadLabwareParams": {
1458
- "title": "ReloadLabwareParams",
1459
- "description": "Payload required to load a labware into a slot.",
1460
- "type": "object",
1461
- "properties": {
1462
- "labwareId": {
1463
- "title": "Labwareid",
1464
- "description": "The already-loaded labware instance to update.",
1465
- "type": "string"
1466
- }
1467
- },
1468
- "required": ["labwareId"]
1469
- },
1470
- "ReloadLabwareCreate": {
1471
- "title": "ReloadLabwareCreate",
1472
- "description": "Reload labware command creation request.",
1473
- "type": "object",
1474
- "properties": {
1475
- "commandType": {
1476
- "title": "Commandtype",
1477
- "default": "reloadLabware",
1478
- "enum": ["reloadLabware"],
1479
- "type": "string"
1480
- },
1481
- "params": {
1482
- "$ref": "#/definitions/ReloadLabwareParams"
1483
- },
1484
- "intent": {
1485
- "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.",
1486
- "allOf": [
1487
- {
1488
- "$ref": "#/definitions/CommandIntent"
1489
- }
1490
- ]
1491
- },
1492
- "key": {
1493
- "title": "Key",
1494
- "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.",
1495
- "type": "string"
1496
- }
1497
- },
1498
- "required": ["params"]
1499
- },
1500
- "LoadLiquidParams": {
1501
- "title": "LoadLiquidParams",
1502
- "description": "Payload required to load a liquid into a well.",
1503
- "type": "object",
1504
- "properties": {
1505
- "liquidId": {
1506
- "title": "Liquidid",
1507
- "description": "Unique identifier of the liquid to load.",
1508
- "type": "string"
1509
- },
1510
- "labwareId": {
1511
- "title": "Labwareid",
1512
- "description": "Unique identifier of labware to load liquid into.",
1513
- "type": "string"
1514
- },
1515
- "volumeByWell": {
1516
- "title": "Volumebywell",
1517
- "description": "Volume of liquid, in \u00b5L, loaded into each well by name, in this labware.",
1518
- "type": "object",
1519
- "additionalProperties": {
1520
- "type": "number"
1521
- }
1522
- }
1523
- },
1524
- "required": ["liquidId", "labwareId", "volumeByWell"]
1525
- },
1526
- "LoadLiquidCreate": {
1527
- "title": "LoadLiquidCreate",
1528
- "description": "Load liquid command creation request.",
1529
- "type": "object",
1530
- "properties": {
1531
- "commandType": {
1532
- "title": "Commandtype",
1533
- "default": "loadLiquid",
1534
- "enum": ["loadLiquid"],
1535
- "type": "string"
1536
- },
1537
- "params": {
1538
- "$ref": "#/definitions/LoadLiquidParams"
1539
- },
1540
- "intent": {
1541
- "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.",
1542
- "allOf": [
1543
- {
1544
- "$ref": "#/definitions/CommandIntent"
1545
- }
1546
- ]
1547
- },
1548
- "key": {
1549
- "title": "Key",
1550
- "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.",
1551
- "type": "string"
1552
- }
1553
- },
1554
- "required": ["params"]
1555
- },
1556
- "ModuleModel": {
1557
- "title": "ModuleModel",
1558
- "description": "All available modules' models.",
1559
- "enum": [
1560
- "temperatureModuleV1",
1561
- "temperatureModuleV2",
1562
- "magneticModuleV1",
1563
- "magneticModuleV2",
1564
- "thermocyclerModuleV1",
1565
- "thermocyclerModuleV2",
1566
- "heaterShakerModuleV1",
1567
- "magneticBlockV1",
1568
- "absorbanceReaderV1"
1569
- ],
1570
- "type": "string"
1571
- },
1572
- "LoadModuleParams": {
1573
- "title": "LoadModuleParams",
1574
- "description": "Payload required to load a module.",
1575
- "type": "object",
1576
- "properties": {
1577
- "model": {
1578
- "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`.",
1579
- "allOf": [
1580
- {
1581
- "$ref": "#/definitions/ModuleModel"
1582
- }
1583
- ]
1584
- },
1585
- "location": {
1586
- "title": "Location",
1587
- "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).",
1588
- "allOf": [
1589
- {
1590
- "$ref": "#/definitions/DeckSlotLocation"
1591
- }
1592
- ]
1593
- },
1594
- "moduleId": {
1595
- "title": "Moduleid",
1596
- "description": "An optional ID to assign to this module. If None, an ID will be generated.",
1597
- "type": "string"
1598
- }
1599
- },
1600
- "required": ["model", "location"]
1601
- },
1602
- "LoadModuleCreate": {
1603
- "title": "LoadModuleCreate",
1604
- "description": "The model for a creation request for a load module command.",
1605
- "type": "object",
1606
- "properties": {
1607
- "commandType": {
1608
- "title": "Commandtype",
1609
- "default": "loadModule",
1610
- "enum": ["loadModule"],
1611
- "type": "string"
1612
- },
1613
- "params": {
1614
- "$ref": "#/definitions/LoadModuleParams"
1615
- },
1616
- "intent": {
1617
- "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.",
1618
- "allOf": [
1619
- {
1620
- "$ref": "#/definitions/CommandIntent"
1621
- }
1622
- ]
1623
- },
1624
- "key": {
1625
- "title": "Key",
1626
- "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.",
1627
- "type": "string"
1628
- }
1629
- },
1630
- "required": ["params"]
1631
- },
1632
- "PipetteNameType": {
1633
- "title": "PipetteNameType",
1634
- "description": "Pipette load name values.",
1635
- "enum": [
1636
- "p10_single",
1637
- "p10_multi",
1638
- "p20_single_gen2",
1639
- "p20_multi_gen2",
1640
- "p50_single",
1641
- "p50_multi",
1642
- "p50_single_flex",
1643
- "p50_multi_flex",
1644
- "p300_single",
1645
- "p300_multi",
1646
- "p300_single_gen2",
1647
- "p300_multi_gen2",
1648
- "p1000_single",
1649
- "p1000_single_gen2",
1650
- "p1000_single_flex",
1651
- "p1000_multi_flex",
1652
- "p1000_96"
1653
- ],
1654
- "type": "string"
1655
- },
1656
- "LoadPipetteParams": {
1657
- "title": "LoadPipetteParams",
1658
- "description": "Payload needed to load a pipette on to a mount.",
1659
- "type": "object",
1660
- "properties": {
1661
- "pipetteName": {
1662
- "description": "The load name of the pipette to be required.",
1663
- "allOf": [
1664
- {
1665
- "$ref": "#/definitions/PipetteNameType"
1666
- }
1667
- ]
1668
- },
1669
- "mount": {
1670
- "description": "The mount the pipette should be present on.",
1671
- "allOf": [
1672
- {
1673
- "$ref": "#/definitions/MountType"
1674
- }
1675
- ]
1676
- },
1677
- "pipetteId": {
1678
- "title": "Pipetteid",
1679
- "description": "An optional ID to assign to this pipette. If None, an ID will be generated.",
1680
- "type": "string"
1681
- },
1682
- "tipOverlapNotAfterVersion": {
1683
- "title": "Tipoverlapnotafterversion",
1684
- "description": "A version of tip overlap data to not exceed. The highest-versioned tip overlap data that does not exceed this version will be used. Versions are expressed as vN where N is an integer, counting up from v0. If None, the current highest version will be used.",
1685
- "type": "string"
1686
- },
1687
- "liquidPresenceDetection": {
1688
- "title": "Liquidpresencedetection",
1689
- "description": "Enable liquid presence detection for this pipette. Defaults to False.",
1690
- "type": "boolean"
1691
- }
1692
- },
1693
- "required": ["pipetteName", "mount"]
1694
- },
1695
- "LoadPipetteCreate": {
1696
- "title": "LoadPipetteCreate",
1697
- "description": "Load pipette command creation request model.",
1698
- "type": "object",
1699
- "properties": {
1700
- "commandType": {
1701
- "title": "Commandtype",
1702
- "default": "loadPipette",
1703
- "enum": ["loadPipette"],
1704
- "type": "string"
1705
- },
1706
- "params": {
1707
- "$ref": "#/definitions/LoadPipetteParams"
1708
- },
1709
- "intent": {
1710
- "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.",
1711
- "allOf": [
1712
- {
1713
- "$ref": "#/definitions/CommandIntent"
1714
- }
1715
- ]
1716
- },
1717
- "key": {
1718
- "title": "Key",
1719
- "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.",
1720
- "type": "string"
1721
- }
1722
- },
1723
- "required": ["params"]
1724
- },
1725
- "LabwareMovementStrategy": {
1726
- "title": "LabwareMovementStrategy",
1727
- "description": "Strategy to use for labware movement.",
1728
- "enum": ["usingGripper", "manualMoveWithPause", "manualMoveWithoutPause"],
1729
- "type": "string"
1730
- },
1731
- "LabwareOffsetVector": {
1732
- "title": "LabwareOffsetVector",
1733
- "description": "Offset, in deck coordinates from nominal to actual position.",
1734
- "type": "object",
1735
- "properties": {
1736
- "x": {
1737
- "title": "X",
1738
- "type": "number"
1739
- },
1740
- "y": {
1741
- "title": "Y",
1742
- "type": "number"
1743
- },
1744
- "z": {
1745
- "title": "Z",
1746
- "type": "number"
1747
- }
1748
- },
1749
- "required": ["x", "y", "z"]
1750
- },
1751
- "MoveLabwareParams": {
1752
- "title": "MoveLabwareParams",
1753
- "description": "Input parameters for a ``moveLabware`` command.",
1754
- "type": "object",
1755
- "properties": {
1756
- "labwareId": {
1757
- "title": "Labwareid",
1758
- "description": "The ID of the labware to move.",
1759
- "type": "string"
1760
- },
1761
- "newLocation": {
1762
- "title": "Newlocation",
1763
- "description": "Where to move the labware.",
1764
- "anyOf": [
1765
- {
1766
- "$ref": "#/definitions/DeckSlotLocation"
1767
- },
1768
- {
1769
- "$ref": "#/definitions/ModuleLocation"
1770
- },
1771
- {
1772
- "$ref": "#/definitions/OnLabwareLocation"
1773
- },
1774
- {
1775
- "enum": ["offDeck"],
1776
- "type": "string"
1777
- },
1778
- {
1779
- "$ref": "#/definitions/AddressableAreaLocation"
1780
- }
1781
- ]
1782
- },
1783
- "strategy": {
1784
- "description": "Whether to use the gripper to perform the labware movement or to perform a manual movement with an option to pause.",
1785
- "allOf": [
1786
- {
1787
- "$ref": "#/definitions/LabwareMovementStrategy"
1788
- }
1789
- ]
1790
- },
1791
- "pickUpOffset": {
1792
- "title": "Pickupoffset",
1793
- "description": "Offset to use when picking up labware. Experimental param, subject to change",
1794
- "allOf": [
1795
- {
1796
- "$ref": "#/definitions/LabwareOffsetVector"
1797
- }
1798
- ]
1799
- },
1800
- "dropOffset": {
1801
- "title": "Dropoffset",
1802
- "description": "Offset to use when dropping off labware. Experimental param, subject to change",
1803
- "allOf": [
1804
- {
1805
- "$ref": "#/definitions/LabwareOffsetVector"
1806
- }
1807
- ]
1808
- }
1809
- },
1810
- "required": ["labwareId", "newLocation", "strategy"]
1811
- },
1812
- "MoveLabwareCreate": {
1813
- "title": "MoveLabwareCreate",
1814
- "description": "A request to create a ``moveLabware`` command.",
1815
- "type": "object",
1816
- "properties": {
1817
- "commandType": {
1818
- "title": "Commandtype",
1819
- "default": "moveLabware",
1820
- "enum": ["moveLabware"],
1821
- "type": "string"
1822
- },
1823
- "params": {
1824
- "$ref": "#/definitions/MoveLabwareParams"
1825
- },
1826
- "intent": {
1827
- "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.",
1828
- "allOf": [
1829
- {
1830
- "$ref": "#/definitions/CommandIntent"
1831
- }
1832
- ]
1833
- },
1834
- "key": {
1835
- "title": "Key",
1836
- "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.",
1837
- "type": "string"
1838
- }
1839
- },
1840
- "required": ["params"]
1841
- },
1842
- "MovementAxis": {
1843
- "title": "MovementAxis",
1844
- "description": "Axis on which to issue a relative movement.",
1845
- "enum": ["x", "y", "z"],
1846
- "type": "string"
1847
- },
1848
- "MoveRelativeParams": {
1849
- "title": "MoveRelativeParams",
1850
- "description": "Payload required for a MoveRelative command.",
1851
- "type": "object",
1852
- "properties": {
1853
- "pipetteId": {
1854
- "title": "Pipetteid",
1855
- "description": "Pipette to move.",
1856
- "type": "string"
1857
- },
1858
- "axis": {
1859
- "description": "Axis along which to move.",
1860
- "allOf": [
1861
- {
1862
- "$ref": "#/definitions/MovementAxis"
1863
- }
1864
- ]
1865
- },
1866
- "distance": {
1867
- "title": "Distance",
1868
- "description": "Distance to move in millimeters. A positive number will move towards the right (x), back (y), top (z) of the deck.",
1869
- "type": "number"
1870
- }
1871
- },
1872
- "required": ["pipetteId", "axis", "distance"]
1873
- },
1874
- "MoveRelativeCreate": {
1875
- "title": "MoveRelativeCreate",
1876
- "description": "Data to create a MoveRelative command.",
1877
- "type": "object",
1878
- "properties": {
1879
- "commandType": {
1880
- "title": "Commandtype",
1881
- "default": "moveRelative",
1882
- "enum": ["moveRelative"],
1883
- "type": "string"
1884
- },
1885
- "params": {
1886
- "$ref": "#/definitions/MoveRelativeParams"
1887
- },
1888
- "intent": {
1889
- "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.",
1890
- "allOf": [
1891
- {
1892
- "$ref": "#/definitions/CommandIntent"
1893
- }
1894
- ]
1895
- },
1896
- "key": {
1897
- "title": "Key",
1898
- "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.",
1899
- "type": "string"
1900
- }
1901
- },
1902
- "required": ["params"]
1903
- },
1904
- "DeckPoint": {
1905
- "title": "DeckPoint",
1906
- "description": "Coordinates of a point in deck space.",
1907
- "type": "object",
1908
- "properties": {
1909
- "x": {
1910
- "title": "X",
1911
- "type": "number"
1912
- },
1913
- "y": {
1914
- "title": "Y",
1915
- "type": "number"
1916
- },
1917
- "z": {
1918
- "title": "Z",
1919
- "type": "number"
1920
- }
1921
- },
1922
- "required": ["x", "y", "z"]
1923
- },
1924
- "MoveToCoordinatesParams": {
1925
- "title": "MoveToCoordinatesParams",
1926
- "description": "Payload required to move a pipette to coordinates.",
1927
- "type": "object",
1928
- "properties": {
1929
- "minimumZHeight": {
1930
- "title": "Minimumzheight",
1931
- "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.",
1932
- "type": "number"
1933
- },
1934
- "forceDirect": {
1935
- "title": "Forcedirect",
1936
- "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.",
1937
- "default": false,
1938
- "type": "boolean"
1939
- },
1940
- "speed": {
1941
- "title": "Speed",
1942
- "description": "Override the travel speed in mm/s. This controls the straight linear speed of motion.",
1943
- "type": "number"
1944
- },
1945
- "pipetteId": {
1946
- "title": "Pipetteid",
1947
- "description": "Identifier of pipette to use for liquid handling.",
1948
- "type": "string"
1949
- },
1950
- "coordinates": {
1951
- "title": "Coordinates",
1952
- "description": "X, Y and Z coordinates in mm from deck's origin location (left-front-bottom corner of work space)",
1953
- "allOf": [
1954
- {
1955
- "$ref": "#/definitions/DeckPoint"
1956
- }
1957
- ]
1958
- }
1959
- },
1960
- "required": ["pipetteId", "coordinates"]
1961
- },
1962
- "MoveToCoordinatesCreate": {
1963
- "title": "MoveToCoordinatesCreate",
1964
- "description": "Move to coordinates command creation request model.",
1965
- "type": "object",
1966
- "properties": {
1967
- "commandType": {
1968
- "title": "Commandtype",
1969
- "default": "moveToCoordinates",
1970
- "enum": ["moveToCoordinates"],
1971
- "type": "string"
1972
- },
1973
- "params": {
1974
- "$ref": "#/definitions/MoveToCoordinatesParams"
1975
- },
1976
- "intent": {
1977
- "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.",
1978
- "allOf": [
1979
- {
1980
- "$ref": "#/definitions/CommandIntent"
1981
- }
1982
- ]
1983
- },
1984
- "key": {
1985
- "title": "Key",
1986
- "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.",
1987
- "type": "string"
1988
- }
1989
- },
1990
- "required": ["params"]
1991
- },
1992
- "MoveToWellParams": {
1993
- "title": "MoveToWellParams",
1994
- "description": "Payload required to move a pipette to a specific well.",
1995
- "type": "object",
1996
- "properties": {
1997
- "minimumZHeight": {
1998
- "title": "Minimumzheight",
1999
- "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.",
2000
- "type": "number"
2001
- },
2002
- "forceDirect": {
2003
- "title": "Forcedirect",
2004
- "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.",
2005
- "default": false,
2006
- "type": "boolean"
2007
- },
2008
- "speed": {
2009
- "title": "Speed",
2010
- "description": "Override the travel speed in mm/s. This controls the straight linear speed of motion.",
2011
- "type": "number"
2012
- },
2013
- "labwareId": {
2014
- "title": "Labwareid",
2015
- "description": "Identifier of labware to use.",
2016
- "type": "string"
2017
- },
2018
- "wellName": {
2019
- "title": "Wellname",
2020
- "description": "Name of well to use in labware.",
2021
- "type": "string"
2022
- },
2023
- "wellLocation": {
2024
- "title": "Welllocation",
2025
- "description": "Relative well location at which to perform the operation",
2026
- "allOf": [
2027
- {
2028
- "$ref": "#/definitions/WellLocation"
2029
- }
2030
- ]
2031
- },
2032
- "pipetteId": {
2033
- "title": "Pipetteid",
2034
- "description": "Identifier of pipette to use for liquid handling.",
2035
- "type": "string"
2036
- }
2037
- },
2038
- "required": ["labwareId", "wellName", "pipetteId"]
2039
- },
2040
- "MoveToWellCreate": {
2041
- "title": "MoveToWellCreate",
2042
- "description": "Move to well command creation request model.",
2043
- "type": "object",
2044
- "properties": {
2045
- "commandType": {
2046
- "title": "Commandtype",
2047
- "default": "moveToWell",
2048
- "enum": ["moveToWell"],
2049
- "type": "string"
2050
- },
2051
- "params": {
2052
- "$ref": "#/definitions/MoveToWellParams"
2053
- },
2054
- "intent": {
2055
- "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.",
2056
- "allOf": [
2057
- {
2058
- "$ref": "#/definitions/CommandIntent"
2059
- }
2060
- ]
2061
- },
2062
- "key": {
2063
- "title": "Key",
2064
- "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.",
2065
- "type": "string"
2066
- }
2067
- },
2068
- "required": ["params"]
2069
- },
2070
- "AddressableOffsetVector": {
2071
- "title": "AddressableOffsetVector",
2072
- "description": "Offset, in deck coordinates, from nominal to actual position of an addressable area.",
2073
- "type": "object",
2074
- "properties": {
2075
- "x": {
2076
- "title": "X",
2077
- "type": "number"
2078
- },
2079
- "y": {
2080
- "title": "Y",
2081
- "type": "number"
2082
- },
2083
- "z": {
2084
- "title": "Z",
2085
- "type": "number"
2086
- }
2087
- },
2088
- "required": ["x", "y", "z"]
2089
- },
2090
- "MoveToAddressableAreaParams": {
2091
- "title": "MoveToAddressableAreaParams",
2092
- "description": "Payload required to move a pipette to a specific addressable area.\n\nAn *addressable area* is a space in the robot that may or may not be usable depending on how\nthe robot's deck is configured. For example, if a Flex is configured with a waste chute, it will\nhave additional addressable areas representing the opening of the waste chute, where tips and\nlabware can be dropped.\n\nThis moves the pipette so all of its nozzles are centered over the addressable area.\nIf the pipette is currently configured with a partial tip layout, this centering is over all\nthe pipette's physical nozzles, not just the nozzles that are active.\n\nThe z-position will be chosen to put the bottom of the tips---or the bottom of the nozzles,\nif there are no tips---level with the top of the addressable area.\n\nWhen this command is executed, Protocol Engine will make sure the robot's deck is configured\nsuch that the requested addressable area actually exists. For example, if you request\nthe addressable area B4, it will make sure the robot is set up with a B3/B4 staging area slot.\nIf that's not the case, the command will fail.",
2093
- "type": "object",
2094
- "properties": {
2095
- "minimumZHeight": {
2096
- "title": "Minimumzheight",
2097
- "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.",
2098
- "type": "number"
2099
- },
2100
- "forceDirect": {
2101
- "title": "Forcedirect",
2102
- "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.",
2103
- "default": false,
2104
- "type": "boolean"
2105
- },
2106
- "speed": {
2107
- "title": "Speed",
2108
- "description": "Override the travel speed in mm/s. This controls the straight linear speed of motion.",
2109
- "type": "number"
2110
- },
2111
- "pipetteId": {
2112
- "title": "Pipetteid",
2113
- "description": "Identifier of pipette to use for liquid handling.",
2114
- "type": "string"
2115
- },
2116
- "addressableAreaName": {
2117
- "title": "Addressableareaname",
2118
- "description": "The name of the addressable area that you want to use. Valid values are the `id`s of `addressableArea`s in the [deck definition](https://github.com/Opentrons/opentrons/tree/edge/shared-data/deck).",
2119
- "type": "string"
2120
- },
2121
- "offset": {
2122
- "title": "Offset",
2123
- "description": "Relative offset of addressable area to move pipette's critical point.",
2124
- "default": {
2125
- "x": 0.0,
2126
- "y": 0.0,
2127
- "z": 0.0
2128
- },
2129
- "allOf": [
2130
- {
2131
- "$ref": "#/definitions/AddressableOffsetVector"
2132
- }
2133
- ]
2134
- },
2135
- "stayAtHighestPossibleZ": {
2136
- "title": "Stayathighestpossiblez",
2137
- "description": "If `true`, the pipette will retract to its highest possible height and stay there instead of descending to the destination. `minimumZHeight` will be ignored.",
2138
- "default": false,
2139
- "type": "boolean"
2140
- }
2141
- },
2142
- "required": ["pipetteId", "addressableAreaName"]
2143
- },
2144
- "MoveToAddressableAreaCreate": {
2145
- "title": "MoveToAddressableAreaCreate",
2146
- "description": "Move to addressable area command creation request model.",
2147
- "type": "object",
2148
- "properties": {
2149
- "commandType": {
2150
- "title": "Commandtype",
2151
- "default": "moveToAddressableArea",
2152
- "enum": ["moveToAddressableArea"],
2153
- "type": "string"
2154
- },
2155
- "params": {
2156
- "$ref": "#/definitions/MoveToAddressableAreaParams"
2157
- },
2158
- "intent": {
2159
- "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.",
2160
- "allOf": [
2161
- {
2162
- "$ref": "#/definitions/CommandIntent"
2163
- }
2164
- ]
2165
- },
2166
- "key": {
2167
- "title": "Key",
2168
- "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.",
2169
- "type": "string"
2170
- }
2171
- },
2172
- "required": ["params"]
2173
- },
2174
- "MoveToAddressableAreaForDropTipParams": {
2175
- "title": "MoveToAddressableAreaForDropTipParams",
2176
- "description": "Payload required to move a pipette to a specific addressable area.\n\nAn *addressable area* is a space in the robot that may or may not be usable depending on how\nthe robot's deck is configured. For example, if a Flex is configured with a waste chute, it will\nhave additional addressable areas representing the opening of the waste chute, where tips and\nlabware can be dropped.\n\nThis moves the pipette so all of its nozzles are centered over the addressable area.\nIf the pipette is currently configured with a partial tip layout, this centering is over all\nthe pipette's physical nozzles, not just the nozzles that are active.\n\nThe z-position will be chosen to put the bottom of the tips---or the bottom of the nozzles,\nif there are no tips---level with the top of the addressable area.\n\nWhen this command is executed, Protocol Engine will make sure the robot's deck is configured\nsuch that the requested addressable area actually exists. For example, if you request\nthe addressable area B4, it will make sure the robot is set up with a B3/B4 staging area slot.\nIf that's not the case, the command will fail.",
2177
- "type": "object",
2178
- "properties": {
2179
- "minimumZHeight": {
2180
- "title": "Minimumzheight",
2181
- "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.",
2182
- "type": "number"
2183
- },
2184
- "forceDirect": {
2185
- "title": "Forcedirect",
2186
- "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.",
2187
- "default": false,
2188
- "type": "boolean"
2189
- },
2190
- "speed": {
2191
- "title": "Speed",
2192
- "description": "Override the travel speed in mm/s. This controls the straight linear speed of motion.",
2193
- "type": "number"
2194
- },
2195
- "pipetteId": {
2196
- "title": "Pipetteid",
2197
- "description": "Identifier of pipette to use for liquid handling.",
2198
- "type": "string"
2199
- },
2200
- "addressableAreaName": {
2201
- "title": "Addressableareaname",
2202
- "description": "The name of the addressable area that you want to use. Valid values are the `id`s of `addressableArea`s in the [deck definition](https://github.com/Opentrons/opentrons/tree/edge/shared-data/deck).",
2203
- "type": "string"
2204
- },
2205
- "offset": {
2206
- "title": "Offset",
2207
- "description": "Relative offset of addressable area to move pipette's critical point.",
2208
- "default": {
2209
- "x": 0.0,
2210
- "y": 0.0,
2211
- "z": 0.0
2212
- },
2213
- "allOf": [
2214
- {
2215
- "$ref": "#/definitions/AddressableOffsetVector"
2216
- }
2217
- ]
2218
- },
2219
- "alternateDropLocation": {
2220
- "title": "Alternatedroplocation",
2221
- "description": "Whether to alternate location where tip is dropped within the addressable area. If True, this command will ignore the offset 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 area.",
2222
- "default": false,
2223
- "type": "boolean"
2224
- },
2225
- "ignoreTipConfiguration": {
2226
- "title": "Ignoretipconfiguration",
2227
- "description": "Whether to utilize the critical point of the tip configuraiton when moving to an addressable area. If True, this command will ignore the tip configuration and use the center of the entire instrument as the critical point for movement. If False, this command will use the critical point provided by the current tip configuration.",
2228
- "default": true,
2229
- "type": "boolean"
2230
- }
2231
- },
2232
- "required": ["pipetteId", "addressableAreaName"]
2233
- },
2234
- "MoveToAddressableAreaForDropTipCreate": {
2235
- "title": "MoveToAddressableAreaForDropTipCreate",
2236
- "description": "Move to addressable area for drop tip command creation request model.",
2237
- "type": "object",
2238
- "properties": {
2239
- "commandType": {
2240
- "title": "Commandtype",
2241
- "default": "moveToAddressableAreaForDropTip",
2242
- "enum": ["moveToAddressableAreaForDropTip"],
2243
- "type": "string"
2244
- },
2245
- "params": {
2246
- "$ref": "#/definitions/MoveToAddressableAreaForDropTipParams"
2247
- },
2248
- "intent": {
2249
- "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.",
2250
- "allOf": [
2251
- {
2252
- "$ref": "#/definitions/CommandIntent"
2253
- }
2254
- ]
2255
- },
2256
- "key": {
2257
- "title": "Key",
2258
- "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.",
2259
- "type": "string"
2260
- }
2261
- },
2262
- "required": ["params"]
2263
- },
2264
- "PrepareToAspirateParams": {
2265
- "title": "PrepareToAspirateParams",
2266
- "description": "Parameters required to prepare a specific pipette for aspiration.",
2267
- "type": "object",
2268
- "properties": {
2269
- "pipetteId": {
2270
- "title": "Pipetteid",
2271
- "description": "Identifier of pipette to use for liquid handling.",
2272
- "type": "string"
2273
- }
2274
- },
2275
- "required": ["pipetteId"]
2276
- },
2277
- "PrepareToAspirateCreate": {
2278
- "title": "PrepareToAspirateCreate",
2279
- "description": "Prepare for aspirate command creation request model.",
2280
- "type": "object",
2281
- "properties": {
2282
- "commandType": {
2283
- "title": "Commandtype",
2284
- "default": "prepareToAspirate",
2285
- "enum": ["prepareToAspirate"],
2286
- "type": "string"
2287
- },
2288
- "params": {
2289
- "$ref": "#/definitions/PrepareToAspirateParams"
2290
- },
2291
- "intent": {
2292
- "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.",
2293
- "allOf": [
2294
- {
2295
- "$ref": "#/definitions/CommandIntent"
2296
- }
2297
- ]
2298
- },
2299
- "key": {
2300
- "title": "Key",
2301
- "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.",
2302
- "type": "string"
2303
- }
2304
- },
2305
- "required": ["params"]
2306
- },
2307
- "WaitForResumeParams": {
2308
- "title": "WaitForResumeParams",
2309
- "description": "Payload required to pause the protocol.",
2310
- "type": "object",
2311
- "properties": {
2312
- "message": {
2313
- "title": "Message",
2314
- "description": "A user-facing message associated with the pause",
2315
- "type": "string"
2316
- }
2317
- }
2318
- },
2319
- "WaitForResumeCreate": {
2320
- "title": "WaitForResumeCreate",
2321
- "description": "Wait for resume command request model.",
2322
- "type": "object",
2323
- "properties": {
2324
- "commandType": {
2325
- "title": "Commandtype",
2326
- "default": "waitForResume",
2327
- "enum": ["waitForResume", "pause"],
2328
- "type": "string"
2329
- },
2330
- "params": {
2331
- "$ref": "#/definitions/WaitForResumeParams"
2332
- },
2333
- "intent": {
2334
- "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.",
2335
- "allOf": [
2336
- {
2337
- "$ref": "#/definitions/CommandIntent"
2338
- }
2339
- ]
2340
- },
2341
- "key": {
2342
- "title": "Key",
2343
- "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.",
2344
- "type": "string"
2345
- }
2346
- },
2347
- "required": ["params"]
2348
- },
2349
- "WaitForDurationParams": {
2350
- "title": "WaitForDurationParams",
2351
- "description": "Payload required to pause the protocol.",
2352
- "type": "object",
2353
- "properties": {
2354
- "seconds": {
2355
- "title": "Seconds",
2356
- "description": "Duration, in seconds, to wait for.",
2357
- "type": "number"
2358
- },
2359
- "message": {
2360
- "title": "Message",
2361
- "description": "A user-facing message associated with the pause",
2362
- "type": "string"
2363
- }
2364
- },
2365
- "required": ["seconds"]
2366
- },
2367
- "WaitForDurationCreate": {
2368
- "title": "WaitForDurationCreate",
2369
- "description": "Wait for duration command request model.",
2370
- "type": "object",
2371
- "properties": {
2372
- "commandType": {
2373
- "title": "Commandtype",
2374
- "default": "waitForDuration",
2375
- "enum": ["waitForDuration"],
2376
- "type": "string"
2377
- },
2378
- "params": {
2379
- "$ref": "#/definitions/WaitForDurationParams"
2380
- },
2381
- "intent": {
2382
- "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.",
2383
- "allOf": [
2384
- {
2385
- "$ref": "#/definitions/CommandIntent"
2386
- }
2387
- ]
2388
- },
2389
- "key": {
2390
- "title": "Key",
2391
- "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.",
2392
- "type": "string"
2393
- }
2394
- },
2395
- "required": ["params"]
2396
- },
2397
- "PickUpTipParams": {
2398
- "title": "PickUpTipParams",
2399
- "description": "Payload needed to move a pipette to a specific well.",
2400
- "type": "object",
2401
- "properties": {
2402
- "labwareId": {
2403
- "title": "Labwareid",
2404
- "description": "Identifier of labware to use.",
2405
- "type": "string"
2406
- },
2407
- "wellName": {
2408
- "title": "Wellname",
2409
- "description": "Name of well to use in labware.",
2410
- "type": "string"
2411
- },
2412
- "wellLocation": {
2413
- "title": "Welllocation",
2414
- "description": "Relative well location at which to perform the operation",
2415
- "allOf": [
2416
- {
2417
- "$ref": "#/definitions/WellLocation"
2418
- }
2419
- ]
2420
- },
2421
- "pipetteId": {
2422
- "title": "Pipetteid",
2423
- "description": "Identifier of pipette to use for liquid handling.",
2424
- "type": "string"
2425
- }
2426
- },
2427
- "required": ["labwareId", "wellName", "pipetteId"]
2428
- },
2429
- "PickUpTipCreate": {
2430
- "title": "PickUpTipCreate",
2431
- "description": "Pick up tip command creation request model.",
2432
- "type": "object",
2433
- "properties": {
2434
- "commandType": {
2435
- "title": "Commandtype",
2436
- "default": "pickUpTip",
2437
- "enum": ["pickUpTip"],
2438
- "type": "string"
2439
- },
2440
- "params": {
2441
- "$ref": "#/definitions/PickUpTipParams"
2442
- },
2443
- "intent": {
2444
- "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.",
2445
- "allOf": [
2446
- {
2447
- "$ref": "#/definitions/CommandIntent"
2448
- }
2449
- ]
2450
- },
2451
- "key": {
2452
- "title": "Key",
2453
- "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.",
2454
- "type": "string"
2455
- }
2456
- },
2457
- "required": ["params"]
2458
- },
2459
- "SavePositionParams": {
2460
- "title": "SavePositionParams",
2461
- "description": "Payload needed to save a pipette's current position.",
2462
- "type": "object",
2463
- "properties": {
2464
- "pipetteId": {
2465
- "title": "Pipetteid",
2466
- "description": "Unique identifier of the pipette in question.",
2467
- "type": "string"
2468
- },
2469
- "positionId": {
2470
- "title": "Positionid",
2471
- "description": "An optional ID to assign to this command instance. Auto-assigned if not defined.",
2472
- "type": "string"
2473
- },
2474
- "failOnNotHomed": {
2475
- "title": "Failonnothomed",
2476
- "default": true,
2477
- "descrption": "Require all axes to be homed before saving position.",
2478
- "type": "boolean"
2479
- }
2480
- },
2481
- "required": ["pipetteId"]
2482
- },
2483
- "SavePositionCreate": {
2484
- "title": "SavePositionCreate",
2485
- "description": "Save position command creation request model.",
2486
- "type": "object",
2487
- "properties": {
2488
- "commandType": {
2489
- "title": "Commandtype",
2490
- "default": "savePosition",
2491
- "enum": ["savePosition"],
2492
- "type": "string"
2493
- },
2494
- "params": {
2495
- "$ref": "#/definitions/SavePositionParams"
2496
- },
2497
- "intent": {
2498
- "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.",
2499
- "allOf": [
2500
- {
2501
- "$ref": "#/definitions/CommandIntent"
2502
- }
2503
- ]
2504
- },
2505
- "key": {
2506
- "title": "Key",
2507
- "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.",
2508
- "type": "string"
2509
- }
2510
- },
2511
- "required": ["params"]
2512
- },
2513
- "SetRailLightsParams": {
2514
- "title": "SetRailLightsParams",
2515
- "description": "Payload required to set the rail lights on or off.",
2516
- "type": "object",
2517
- "properties": {
2518
- "on": {
2519
- "title": "On",
2520
- "description": "The field that determines if the light is turned off or on.",
2521
- "type": "boolean"
2522
- }
2523
- },
2524
- "required": ["on"]
2525
- },
2526
- "SetRailLightsCreate": {
2527
- "title": "SetRailLightsCreate",
2528
- "description": "setRailLights command request model.",
2529
- "type": "object",
2530
- "properties": {
2531
- "commandType": {
2532
- "title": "Commandtype",
2533
- "default": "setRailLights",
2534
- "enum": ["setRailLights"],
2535
- "type": "string"
2536
- },
2537
- "params": {
2538
- "$ref": "#/definitions/SetRailLightsParams"
2539
- },
2540
- "intent": {
2541
- "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.",
2542
- "allOf": [
2543
- {
2544
- "$ref": "#/definitions/CommandIntent"
2545
- }
2546
- ]
2547
- },
2548
- "key": {
2549
- "title": "Key",
2550
- "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.",
2551
- "type": "string"
2552
- }
2553
- },
2554
- "required": ["params"]
2555
- },
2556
- "TouchTipParams": {
2557
- "title": "TouchTipParams",
2558
- "description": "Payload needed to touch a pipette tip the sides of a specific well.",
2559
- "type": "object",
2560
- "properties": {
2561
- "labwareId": {
2562
- "title": "Labwareid",
2563
- "description": "Identifier of labware to use.",
2564
- "type": "string"
2565
- },
2566
- "wellName": {
2567
- "title": "Wellname",
2568
- "description": "Name of well to use in labware.",
2569
- "type": "string"
2570
- },
2571
- "wellLocation": {
2572
- "title": "Welllocation",
2573
- "description": "Relative well location at which to perform the operation",
2574
- "allOf": [
2575
- {
2576
- "$ref": "#/definitions/WellLocation"
2577
- }
2578
- ]
2579
- },
2580
- "pipetteId": {
2581
- "title": "Pipetteid",
2582
- "description": "Identifier of pipette to use for liquid handling.",
2583
- "type": "string"
2584
- },
2585
- "radius": {
2586
- "title": "Radius",
2587
- "description": "The proportion of the target well's radius the pipette tip will move towards.",
2588
- "default": 1.0,
2589
- "type": "number"
2590
- },
2591
- "speed": {
2592
- "title": "Speed",
2593
- "description": "Override the travel speed in mm/s. This controls the straight linear speed of motion.",
2594
- "type": "number"
2595
- }
2596
- },
2597
- "required": ["labwareId", "wellName", "pipetteId"]
2598
- },
2599
- "TouchTipCreate": {
2600
- "title": "TouchTipCreate",
2601
- "description": "Touch tip command creation request model.",
2602
- "type": "object",
2603
- "properties": {
2604
- "commandType": {
2605
- "title": "Commandtype",
2606
- "default": "touchTip",
2607
- "enum": ["touchTip"],
2608
- "type": "string"
2609
- },
2610
- "params": {
2611
- "$ref": "#/definitions/TouchTipParams"
2612
- },
2613
- "intent": {
2614
- "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.",
2615
- "allOf": [
2616
- {
2617
- "$ref": "#/definitions/CommandIntent"
2618
- }
2619
- ]
2620
- },
2621
- "key": {
2622
- "title": "Key",
2623
- "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.",
2624
- "type": "string"
2625
- }
2626
- },
2627
- "required": ["params"]
2628
- },
2629
- "StatusBarAnimation": {
2630
- "title": "StatusBarAnimation",
2631
- "description": "Status Bar animation options.",
2632
- "enum": ["idle", "confirm", "updating", "disco", "off"]
2633
- },
2634
- "SetStatusBarParams": {
2635
- "title": "SetStatusBarParams",
2636
- "description": "Payload required to set the status bar to run an animation.",
2637
- "type": "object",
2638
- "properties": {
2639
- "animation": {
2640
- "description": "The animation that should be executed on the status bar.",
2641
- "allOf": [
2642
- {
2643
- "$ref": "#/definitions/StatusBarAnimation"
2644
- }
2645
- ]
2646
- }
2647
- },
2648
- "required": ["animation"]
2649
- },
2650
- "SetStatusBarCreate": {
2651
- "title": "SetStatusBarCreate",
2652
- "description": "setStatusBar command request model.",
2653
- "type": "object",
2654
- "properties": {
2655
- "commandType": {
2656
- "title": "Commandtype",
2657
- "default": "setStatusBar",
2658
- "enum": ["setStatusBar"],
2659
- "type": "string"
2660
- },
2661
- "params": {
2662
- "$ref": "#/definitions/SetStatusBarParams"
2663
- },
2664
- "intent": {
2665
- "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.",
2666
- "allOf": [
2667
- {
2668
- "$ref": "#/definitions/CommandIntent"
2669
- }
2670
- ]
2671
- },
2672
- "key": {
2673
- "title": "Key",
2674
- "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.",
2675
- "type": "string"
2676
- }
2677
- },
2678
- "required": ["params"]
2679
- },
2680
- "TipPresenceStatus": {
2681
- "title": "TipPresenceStatus",
2682
- "description": "Tip presence status reported by a pipette.",
2683
- "enum": ["present", "absent", "unknown"],
2684
- "type": "string"
2685
- },
2686
- "InstrumentSensorId": {
2687
- "title": "InstrumentSensorId",
2688
- "description": "Primary and secondary sensor ids.",
2689
- "enum": ["primary", "secondary", "both"],
2690
- "type": "string"
2691
- },
2692
- "VerifyTipPresenceParams": {
2693
- "title": "VerifyTipPresenceParams",
2694
- "description": "Payload required for a VerifyTipPresence command.",
2695
- "type": "object",
2696
- "properties": {
2697
- "pipetteId": {
2698
- "title": "Pipetteid",
2699
- "description": "Identifier of pipette to use for liquid handling.",
2700
- "type": "string"
2701
- },
2702
- "expectedState": {
2703
- "description": "The expected tip presence status on the pipette.",
2704
- "allOf": [
2705
- {
2706
- "$ref": "#/definitions/TipPresenceStatus"
2707
- }
2708
- ]
2709
- },
2710
- "followSingularSensor": {
2711
- "description": "The sensor id to follow if the other can be ignored.",
2712
- "allOf": [
2713
- {
2714
- "$ref": "#/definitions/InstrumentSensorId"
2715
- }
2716
- ]
2717
- }
2718
- },
2719
- "required": ["pipetteId", "expectedState"]
2720
- },
2721
- "VerifyTipPresenceCreate": {
2722
- "title": "VerifyTipPresenceCreate",
2723
- "description": "VerifyTipPresence command creation request model.",
2724
- "type": "object",
2725
- "properties": {
2726
- "commandType": {
2727
- "title": "Commandtype",
2728
- "default": "verifyTipPresence",
2729
- "enum": ["verifyTipPresence"],
2730
- "type": "string"
2731
- },
2732
- "params": {
2733
- "$ref": "#/definitions/VerifyTipPresenceParams"
2734
- },
2735
- "intent": {
2736
- "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.",
2737
- "allOf": [
2738
- {
2739
- "$ref": "#/definitions/CommandIntent"
2740
- }
2741
- ]
2742
- },
2743
- "key": {
2744
- "title": "Key",
2745
- "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.",
2746
- "type": "string"
2747
- }
2748
- },
2749
- "required": ["params"]
2750
- },
2751
- "GetTipPresenceParams": {
2752
- "title": "GetTipPresenceParams",
2753
- "description": "Payload required for a GetTipPresence command.",
2754
- "type": "object",
2755
- "properties": {
2756
- "pipetteId": {
2757
- "title": "Pipetteid",
2758
- "description": "Identifier of pipette to use for liquid handling.",
2759
- "type": "string"
2760
- }
2761
- },
2762
- "required": ["pipetteId"]
2763
- },
2764
- "GetTipPresenceCreate": {
2765
- "title": "GetTipPresenceCreate",
2766
- "description": "GetTipPresence command creation request model.",
2767
- "type": "object",
2768
- "properties": {
2769
- "commandType": {
2770
- "title": "Commandtype",
2771
- "default": "getTipPresence",
2772
- "enum": ["getTipPresence"],
2773
- "type": "string"
2774
- },
2775
- "params": {
2776
- "$ref": "#/definitions/GetTipPresenceParams"
2777
- },
2778
- "intent": {
2779
- "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.",
2780
- "allOf": [
2781
- {
2782
- "$ref": "#/definitions/CommandIntent"
2783
- }
2784
- ]
2785
- },
2786
- "key": {
2787
- "title": "Key",
2788
- "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.",
2789
- "type": "string"
2790
- }
2791
- },
2792
- "required": ["params"]
2793
- },
2794
- "LiquidProbeParams": {
2795
- "title": "LiquidProbeParams",
2796
- "description": "Parameters required for a `liquidProbe` command.",
2797
- "type": "object",
2798
- "properties": {
2799
- "labwareId": {
2800
- "title": "Labwareid",
2801
- "description": "Identifier of labware to use.",
2802
- "type": "string"
2803
- },
2804
- "wellName": {
2805
- "title": "Wellname",
2806
- "description": "Name of well to use in labware.",
2807
- "type": "string"
2808
- },
2809
- "wellLocation": {
2810
- "title": "Welllocation",
2811
- "description": "Relative well location at which to perform the operation",
2812
- "allOf": [
2813
- {
2814
- "$ref": "#/definitions/WellLocation"
2815
- }
2816
- ]
2817
- },
2818
- "pipetteId": {
2819
- "title": "Pipetteid",
2820
- "description": "Identifier of pipette to use for liquid handling.",
2821
- "type": "string"
2822
- }
2823
- },
2824
- "required": ["labwareId", "wellName", "pipetteId"]
2825
- },
2826
- "LiquidProbeCreate": {
2827
- "title": "LiquidProbeCreate",
2828
- "description": "The request model for a `liquidProbe` command.",
2829
- "type": "object",
2830
- "properties": {
2831
- "commandType": {
2832
- "title": "Commandtype",
2833
- "default": "liquidProbe",
2834
- "enum": ["liquidProbe"],
2835
- "type": "string"
2836
- },
2837
- "params": {
2838
- "$ref": "#/definitions/LiquidProbeParams"
2839
- },
2840
- "intent": {
2841
- "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.",
2842
- "allOf": [
2843
- {
2844
- "$ref": "#/definitions/CommandIntent"
2845
- }
2846
- ]
2847
- },
2848
- "key": {
2849
- "title": "Key",
2850
- "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.",
2851
- "type": "string"
2852
- }
2853
- },
2854
- "required": ["params"]
2855
- },
2856
- "TryLiquidProbeParams": {
2857
- "title": "TryLiquidProbeParams",
2858
- "description": "Parameters required for a `tryLiquidProbe` command.",
2859
- "type": "object",
2860
- "properties": {
2861
- "labwareId": {
2862
- "title": "Labwareid",
2863
- "description": "Identifier of labware to use.",
2864
- "type": "string"
2865
- },
2866
- "wellName": {
2867
- "title": "Wellname",
2868
- "description": "Name of well to use in labware.",
2869
- "type": "string"
2870
- },
2871
- "wellLocation": {
2872
- "title": "Welllocation",
2873
- "description": "Relative well location at which to perform the operation",
2874
- "allOf": [
2875
- {
2876
- "$ref": "#/definitions/WellLocation"
2877
- }
2878
- ]
2879
- },
2880
- "pipetteId": {
2881
- "title": "Pipetteid",
2882
- "description": "Identifier of pipette to use for liquid handling.",
2883
- "type": "string"
2884
- }
2885
- },
2886
- "required": ["labwareId", "wellName", "pipetteId"]
2887
- },
2888
- "TryLiquidProbeCreate": {
2889
- "title": "TryLiquidProbeCreate",
2890
- "description": "The request model for a `tryLiquidProbe` command.",
2891
- "type": "object",
2892
- "properties": {
2893
- "commandType": {
2894
- "title": "Commandtype",
2895
- "default": "tryLiquidProbe",
2896
- "enum": ["tryLiquidProbe"],
2897
- "type": "string"
2898
- },
2899
- "params": {
2900
- "$ref": "#/definitions/TryLiquidProbeParams"
2901
- },
2902
- "intent": {
2903
- "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.",
2904
- "allOf": [
2905
- {
2906
- "$ref": "#/definitions/CommandIntent"
2907
- }
2908
- ]
2909
- },
2910
- "key": {
2911
- "title": "Key",
2912
- "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.",
2913
- "type": "string"
2914
- }
2915
- },
2916
- "required": ["params"]
2917
- },
2918
- "opentrons__protocol_engine__commands__heater_shaker__wait_for_temperature__WaitForTemperatureParams": {
2919
- "title": "WaitForTemperatureParams",
2920
- "description": "Input parameters to wait for a Heater-Shaker's target temperature.",
2921
- "type": "object",
2922
- "properties": {
2923
- "moduleId": {
2924
- "title": "Moduleid",
2925
- "description": "Unique ID of the Heater-Shaker Module.",
2926
- "type": "string"
2927
- },
2928
- "celsius": {
2929
- "title": "Celsius",
2930
- "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.",
2931
- "type": "number"
2932
- }
2933
- },
2934
- "required": ["moduleId"]
2935
- },
2936
- "opentrons__protocol_engine__commands__heater_shaker__wait_for_temperature__WaitForTemperatureCreate": {
2937
- "title": "WaitForTemperatureCreate",
2938
- "description": "A request to create a Heater-Shaker's wait for temperature command.",
2939
- "type": "object",
2940
- "properties": {
2941
- "commandType": {
2942
- "title": "Commandtype",
2943
- "default": "heaterShaker/waitForTemperature",
2944
- "enum": ["heaterShaker/waitForTemperature"],
2945
- "type": "string"
2946
- },
2947
- "params": {
2948
- "$ref": "#/definitions/opentrons__protocol_engine__commands__heater_shaker__wait_for_temperature__WaitForTemperatureParams"
2949
- },
2950
- "intent": {
2951
- "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.",
2952
- "allOf": [
2953
- {
2954
- "$ref": "#/definitions/CommandIntent"
2955
- }
2956
- ]
2957
- },
2958
- "key": {
2959
- "title": "Key",
2960
- "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.",
2961
- "type": "string"
2962
- }
2963
- },
2964
- "required": ["params"]
2965
- },
2966
- "opentrons__protocol_engine__commands__heater_shaker__set_target_temperature__SetTargetTemperatureParams": {
2967
- "title": "SetTargetTemperatureParams",
2968
- "description": "Input parameters to set a Heater-Shaker's target temperature.",
2969
- "type": "object",
2970
- "properties": {
2971
- "moduleId": {
2972
- "title": "Moduleid",
2973
- "description": "Unique ID of the Heater-Shaker Module.",
2974
- "type": "string"
2975
- },
2976
- "celsius": {
2977
- "title": "Celsius",
2978
- "description": "Target temperature in \u00b0C.",
2979
- "type": "number"
2980
- }
2981
- },
2982
- "required": ["moduleId", "celsius"]
2983
- },
2984
- "opentrons__protocol_engine__commands__heater_shaker__set_target_temperature__SetTargetTemperatureCreate": {
2985
- "title": "SetTargetTemperatureCreate",
2986
- "description": "A request to create a Heater-Shaker's set temperature command.",
2987
- "type": "object",
2988
- "properties": {
2989
- "commandType": {
2990
- "title": "Commandtype",
2991
- "default": "heaterShaker/setTargetTemperature",
2992
- "enum": ["heaterShaker/setTargetTemperature"],
2993
- "type": "string"
2994
- },
2995
- "params": {
2996
- "$ref": "#/definitions/opentrons__protocol_engine__commands__heater_shaker__set_target_temperature__SetTargetTemperatureParams"
2997
- },
2998
- "intent": {
2999
- "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.",
3000
- "allOf": [
3001
- {
3002
- "$ref": "#/definitions/CommandIntent"
3003
- }
3004
- ]
3005
- },
3006
- "key": {
3007
- "title": "Key",
3008
- "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.",
3009
- "type": "string"
3010
- }
3011
- },
3012
- "required": ["params"]
3013
- },
3014
- "DeactivateHeaterParams": {
3015
- "title": "DeactivateHeaterParams",
3016
- "description": "Input parameters to unset a Heater-Shaker's target temperature.",
3017
- "type": "object",
3018
- "properties": {
3019
- "moduleId": {
3020
- "title": "Moduleid",
3021
- "description": "Unique ID of the Heater-Shaker Module.",
3022
- "type": "string"
3023
- }
3024
- },
3025
- "required": ["moduleId"]
3026
- },
3027
- "DeactivateHeaterCreate": {
3028
- "title": "DeactivateHeaterCreate",
3029
- "description": "A request to create a Heater-Shaker's deactivate heater command.",
3030
- "type": "object",
3031
- "properties": {
3032
- "commandType": {
3033
- "title": "Commandtype",
3034
- "default": "heaterShaker/deactivateHeater",
3035
- "enum": ["heaterShaker/deactivateHeater"],
3036
- "type": "string"
3037
- },
3038
- "params": {
3039
- "$ref": "#/definitions/DeactivateHeaterParams"
3040
- },
3041
- "intent": {
3042
- "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.",
3043
- "allOf": [
3044
- {
3045
- "$ref": "#/definitions/CommandIntent"
3046
- }
3047
- ]
3048
- },
3049
- "key": {
3050
- "title": "Key",
3051
- "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.",
3052
- "type": "string"
3053
- }
3054
- },
3055
- "required": ["params"]
3056
- },
3057
- "SetAndWaitForShakeSpeedParams": {
3058
- "title": "SetAndWaitForShakeSpeedParams",
3059
- "description": "Input parameters to set and wait for a shake speed for a Heater-Shaker Module.",
3060
- "type": "object",
3061
- "properties": {
3062
- "moduleId": {
3063
- "title": "Moduleid",
3064
- "description": "Unique ID of the Heater-Shaker Module.",
3065
- "type": "string"
3066
- },
3067
- "rpm": {
3068
- "title": "Rpm",
3069
- "description": "Target speed in rotations per minute.",
3070
- "type": "number"
3071
- }
3072
- },
3073
- "required": ["moduleId", "rpm"]
3074
- },
3075
- "SetAndWaitForShakeSpeedCreate": {
3076
- "title": "SetAndWaitForShakeSpeedCreate",
3077
- "description": "A request to create a Heater-Shaker's set and wait for shake speed command.",
3078
- "type": "object",
3079
- "properties": {
3080
- "commandType": {
3081
- "title": "Commandtype",
3082
- "default": "heaterShaker/setAndWaitForShakeSpeed",
3083
- "enum": ["heaterShaker/setAndWaitForShakeSpeed"],
3084
- "type": "string"
3085
- },
3086
- "params": {
3087
- "$ref": "#/definitions/SetAndWaitForShakeSpeedParams"
3088
- },
3089
- "intent": {
3090
- "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.",
3091
- "allOf": [
3092
- {
3093
- "$ref": "#/definitions/CommandIntent"
3094
- }
3095
- ]
3096
- },
3097
- "key": {
3098
- "title": "Key",
3099
- "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.",
3100
- "type": "string"
3101
- }
3102
- },
3103
- "required": ["params"]
3104
- },
3105
- "DeactivateShakerParams": {
3106
- "title": "DeactivateShakerParams",
3107
- "description": "Input parameters to deactivate shaker for a Heater-Shaker Module.",
3108
- "type": "object",
3109
- "properties": {
3110
- "moduleId": {
3111
- "title": "Moduleid",
3112
- "description": "Unique ID of the Heater-Shaker Module.",
3113
- "type": "string"
3114
- }
3115
- },
3116
- "required": ["moduleId"]
3117
- },
3118
- "DeactivateShakerCreate": {
3119
- "title": "DeactivateShakerCreate",
3120
- "description": "A request to create a Heater-Shaker's deactivate shaker command.",
3121
- "type": "object",
3122
- "properties": {
3123
- "commandType": {
3124
- "title": "Commandtype",
3125
- "default": "heaterShaker/deactivateShaker",
3126
- "enum": ["heaterShaker/deactivateShaker"],
3127
- "type": "string"
3128
- },
3129
- "params": {
3130
- "$ref": "#/definitions/DeactivateShakerParams"
3131
- },
3132
- "intent": {
3133
- "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.",
3134
- "allOf": [
3135
- {
3136
- "$ref": "#/definitions/CommandIntent"
3137
- }
3138
- ]
3139
- },
3140
- "key": {
3141
- "title": "Key",
3142
- "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.",
3143
- "type": "string"
3144
- }
3145
- },
3146
- "required": ["params"]
3147
- },
3148
- "OpenLabwareLatchParams": {
3149
- "title": "OpenLabwareLatchParams",
3150
- "description": "Input parameters to open a Heater-Shaker Module's labware latch.",
3151
- "type": "object",
3152
- "properties": {
3153
- "moduleId": {
3154
- "title": "Moduleid",
3155
- "description": "Unique ID of the Heater-Shaker Module.",
3156
- "type": "string"
3157
- }
3158
- },
3159
- "required": ["moduleId"]
3160
- },
3161
- "OpenLabwareLatchCreate": {
3162
- "title": "OpenLabwareLatchCreate",
3163
- "description": "A request to create a Heater-Shaker's open labware latch command.",
3164
- "type": "object",
3165
- "properties": {
3166
- "commandType": {
3167
- "title": "Commandtype",
3168
- "default": "heaterShaker/openLabwareLatch",
3169
- "enum": ["heaterShaker/openLabwareLatch"],
3170
- "type": "string"
3171
- },
3172
- "params": {
3173
- "$ref": "#/definitions/OpenLabwareLatchParams"
3174
- },
3175
- "intent": {
3176
- "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.",
3177
- "allOf": [
3178
- {
3179
- "$ref": "#/definitions/CommandIntent"
3180
- }
3181
- ]
3182
- },
3183
- "key": {
3184
- "title": "Key",
3185
- "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.",
3186
- "type": "string"
3187
- }
3188
- },
3189
- "required": ["params"]
3190
- },
3191
- "CloseLabwareLatchParams": {
3192
- "title": "CloseLabwareLatchParams",
3193
- "description": "Input parameters to close a Heater-Shaker Module's labware latch.",
3194
- "type": "object",
3195
- "properties": {
3196
- "moduleId": {
3197
- "title": "Moduleid",
3198
- "description": "Unique ID of the Heater-Shaker Module.",
3199
- "type": "string"
3200
- }
3201
- },
3202
- "required": ["moduleId"]
3203
- },
3204
- "CloseLabwareLatchCreate": {
3205
- "title": "CloseLabwareLatchCreate",
3206
- "description": "A request to create a Heater-Shaker's close latch command.",
3207
- "type": "object",
3208
- "properties": {
3209
- "commandType": {
3210
- "title": "Commandtype",
3211
- "default": "heaterShaker/closeLabwareLatch",
3212
- "enum": ["heaterShaker/closeLabwareLatch"],
3213
- "type": "string"
3214
- },
3215
- "params": {
3216
- "$ref": "#/definitions/CloseLabwareLatchParams"
3217
- },
3218
- "intent": {
3219
- "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.",
3220
- "allOf": [
3221
- {
3222
- "$ref": "#/definitions/CommandIntent"
3223
- }
3224
- ]
3225
- },
3226
- "key": {
3227
- "title": "Key",
3228
- "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.",
3229
- "type": "string"
3230
- }
3231
- },
3232
- "required": ["params"]
3233
- },
3234
- "DisengageParams": {
3235
- "title": "DisengageParams",
3236
- "description": "Input data to disengage a Magnetic Module's magnets.",
3237
- "type": "object",
3238
- "properties": {
3239
- "moduleId": {
3240
- "title": "Moduleid",
3241
- "description": "The ID of the Magnetic Module whose magnets you want to disengage, from a prior `loadModule` command.",
3242
- "type": "string"
3243
- }
3244
- },
3245
- "required": ["moduleId"]
3246
- },
3247
- "DisengageCreate": {
3248
- "title": "DisengageCreate",
3249
- "description": "A request to create a Magnetic Module disengage command.",
3250
- "type": "object",
3251
- "properties": {
3252
- "commandType": {
3253
- "title": "Commandtype",
3254
- "default": "magneticModule/disengage",
3255
- "enum": ["magneticModule/disengage"],
3256
- "type": "string"
3257
- },
3258
- "params": {
3259
- "$ref": "#/definitions/DisengageParams"
3260
- },
3261
- "intent": {
3262
- "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.",
3263
- "allOf": [
3264
- {
3265
- "$ref": "#/definitions/CommandIntent"
3266
- }
3267
- ]
3268
- },
3269
- "key": {
3270
- "title": "Key",
3271
- "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.",
3272
- "type": "string"
3273
- }
3274
- },
3275
- "required": ["params"]
3276
- },
3277
- "EngageParams": {
3278
- "title": "EngageParams",
3279
- "description": "Input data to engage a Magnetic Module.",
3280
- "type": "object",
3281
- "properties": {
3282
- "moduleId": {
3283
- "title": "Moduleid",
3284
- "description": "The ID of the Magnetic Module whose magnets you want to raise, from a prior `loadModule` command.",
3285
- "type": "string"
3286
- },
3287
- "height": {
3288
- "title": "Height",
3289
- "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.",
3290
- "type": "number"
3291
- }
3292
- },
3293
- "required": ["moduleId", "height"]
3294
- },
3295
- "EngageCreate": {
3296
- "title": "EngageCreate",
3297
- "description": "A request to create a Magnetic Module engage command.",
3298
- "type": "object",
3299
- "properties": {
3300
- "commandType": {
3301
- "title": "Commandtype",
3302
- "default": "magneticModule/engage",
3303
- "enum": ["magneticModule/engage"],
3304
- "type": "string"
3305
- },
3306
- "params": {
3307
- "$ref": "#/definitions/EngageParams"
3308
- },
3309
- "intent": {
3310
- "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.",
3311
- "allOf": [
3312
- {
3313
- "$ref": "#/definitions/CommandIntent"
3314
- }
3315
- ]
3316
- },
3317
- "key": {
3318
- "title": "Key",
3319
- "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.",
3320
- "type": "string"
3321
- }
3322
- },
3323
- "required": ["params"]
3324
- },
3325
- "opentrons__protocol_engine__commands__temperature_module__set_target_temperature__SetTargetTemperatureParams": {
3326
- "title": "SetTargetTemperatureParams",
3327
- "description": "Input parameters to set a Temperature Module's target temperature.",
3328
- "type": "object",
3329
- "properties": {
3330
- "moduleId": {
3331
- "title": "Moduleid",
3332
- "description": "Unique ID of the Temperature Module.",
3333
- "type": "string"
3334
- },
3335
- "celsius": {
3336
- "title": "Celsius",
3337
- "description": "Target temperature in \u00b0C.",
3338
- "type": "number"
3339
- }
3340
- },
3341
- "required": ["moduleId", "celsius"]
3342
- },
3343
- "opentrons__protocol_engine__commands__temperature_module__set_target_temperature__SetTargetTemperatureCreate": {
3344
- "title": "SetTargetTemperatureCreate",
3345
- "description": "A request to create a Temperature Module's set temperature command.",
3346
- "type": "object",
3347
- "properties": {
3348
- "commandType": {
3349
- "title": "Commandtype",
3350
- "default": "temperatureModule/setTargetTemperature",
3351
- "enum": ["temperatureModule/setTargetTemperature"],
3352
- "type": "string"
3353
- },
3354
- "params": {
3355
- "$ref": "#/definitions/opentrons__protocol_engine__commands__temperature_module__set_target_temperature__SetTargetTemperatureParams"
3356
- },
3357
- "intent": {
3358
- "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.",
3359
- "allOf": [
3360
- {
3361
- "$ref": "#/definitions/CommandIntent"
3362
- }
3363
- ]
3364
- },
3365
- "key": {
3366
- "title": "Key",
3367
- "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.",
3368
- "type": "string"
3369
- }
3370
- },
3371
- "required": ["params"]
3372
- },
3373
- "opentrons__protocol_engine__commands__temperature_module__wait_for_temperature__WaitForTemperatureParams": {
3374
- "title": "WaitForTemperatureParams",
3375
- "description": "Input parameters to wait for a Temperature Module's target temperature.",
3376
- "type": "object",
3377
- "properties": {
3378
- "moduleId": {
3379
- "title": "Moduleid",
3380
- "description": "Unique ID of the Temperature Module.",
3381
- "type": "string"
3382
- },
3383
- "celsius": {
3384
- "title": "Celsius",
3385
- "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.",
3386
- "type": "number"
3387
- }
3388
- },
3389
- "required": ["moduleId"]
3390
- },
3391
- "opentrons__protocol_engine__commands__temperature_module__wait_for_temperature__WaitForTemperatureCreate": {
3392
- "title": "WaitForTemperatureCreate",
3393
- "description": "A request to create a Temperature Module's wait for temperature command.",
3394
- "type": "object",
3395
- "properties": {
3396
- "commandType": {
3397
- "title": "Commandtype",
3398
- "default": "temperatureModule/waitForTemperature",
3399
- "enum": ["temperatureModule/waitForTemperature"],
3400
- "type": "string"
3401
- },
3402
- "params": {
3403
- "$ref": "#/definitions/opentrons__protocol_engine__commands__temperature_module__wait_for_temperature__WaitForTemperatureParams"
3404
- },
3405
- "intent": {
3406
- "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.",
3407
- "allOf": [
3408
- {
3409
- "$ref": "#/definitions/CommandIntent"
3410
- }
3411
- ]
3412
- },
3413
- "key": {
3414
- "title": "Key",
3415
- "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.",
3416
- "type": "string"
3417
- }
3418
- },
3419
- "required": ["params"]
3420
- },
3421
- "DeactivateTemperatureParams": {
3422
- "title": "DeactivateTemperatureParams",
3423
- "description": "Input parameters to deactivate a Temperature Module.",
3424
- "type": "object",
3425
- "properties": {
3426
- "moduleId": {
3427
- "title": "Moduleid",
3428
- "description": "Unique ID of the Temperature Module.",
3429
- "type": "string"
3430
- }
3431
- },
3432
- "required": ["moduleId"]
3433
- },
3434
- "DeactivateTemperatureCreate": {
3435
- "title": "DeactivateTemperatureCreate",
3436
- "description": "A request to deactivate a Temperature Module.",
3437
- "type": "object",
3438
- "properties": {
3439
- "commandType": {
3440
- "title": "Commandtype",
3441
- "default": "temperatureModule/deactivate",
3442
- "enum": ["temperatureModule/deactivate"],
3443
- "type": "string"
3444
- },
3445
- "params": {
3446
- "$ref": "#/definitions/DeactivateTemperatureParams"
3447
- },
3448
- "intent": {
3449
- "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.",
3450
- "allOf": [
3451
- {
3452
- "$ref": "#/definitions/CommandIntent"
3453
- }
3454
- ]
3455
- },
3456
- "key": {
3457
- "title": "Key",
3458
- "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.",
3459
- "type": "string"
3460
- }
3461
- },
3462
- "required": ["params"]
3463
- },
3464
- "SetTargetBlockTemperatureParams": {
3465
- "title": "SetTargetBlockTemperatureParams",
3466
- "description": "Input parameters to set a Thermocycler's target block temperature.",
3467
- "type": "object",
3468
- "properties": {
3469
- "moduleId": {
3470
- "title": "Moduleid",
3471
- "description": "Unique ID of the Thermocycler Module.",
3472
- "type": "string"
3473
- },
3474
- "celsius": {
3475
- "title": "Celsius",
3476
- "description": "Target temperature in \u00b0C.",
3477
- "type": "number"
3478
- },
3479
- "blockMaxVolumeUl": {
3480
- "title": "Blockmaxvolumeul",
3481
- "description": "Amount of liquid in uL of the most-full well in labware loaded onto the thermocycler.",
3482
- "type": "number"
3483
- },
3484
- "holdTimeSeconds": {
3485
- "title": "Holdtimeseconds",
3486
- "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.",
3487
- "type": "number"
3488
- }
3489
- },
3490
- "required": ["moduleId", "celsius"]
3491
- },
3492
- "SetTargetBlockTemperatureCreate": {
3493
- "title": "SetTargetBlockTemperatureCreate",
3494
- "description": "A request to create a Thermocycler's set block temperature command.",
3495
- "type": "object",
3496
- "properties": {
3497
- "commandType": {
3498
- "title": "Commandtype",
3499
- "default": "thermocycler/setTargetBlockTemperature",
3500
- "enum": ["thermocycler/setTargetBlockTemperature"],
3501
- "type": "string"
3502
- },
3503
- "params": {
3504
- "$ref": "#/definitions/SetTargetBlockTemperatureParams"
3505
- },
3506
- "intent": {
3507
- "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.",
3508
- "allOf": [
3509
- {
3510
- "$ref": "#/definitions/CommandIntent"
3511
- }
3512
- ]
3513
- },
3514
- "key": {
3515
- "title": "Key",
3516
- "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.",
3517
- "type": "string"
3518
- }
3519
- },
3520
- "required": ["params"]
3521
- },
3522
- "WaitForBlockTemperatureParams": {
3523
- "title": "WaitForBlockTemperatureParams",
3524
- "description": "Input parameters to wait for Thermocycler's target block temperature.",
3525
- "type": "object",
3526
- "properties": {
3527
- "moduleId": {
3528
- "title": "Moduleid",
3529
- "description": "Unique ID of the Thermocycler Module.",
3530
- "type": "string"
3531
- }
3532
- },
3533
- "required": ["moduleId"]
3534
- },
3535
- "WaitForBlockTemperatureCreate": {
3536
- "title": "WaitForBlockTemperatureCreate",
3537
- "description": "A request to create Thermocycler's wait for block temperature command.",
3538
- "type": "object",
3539
- "properties": {
3540
- "commandType": {
3541
- "title": "Commandtype",
3542
- "default": "thermocycler/waitForBlockTemperature",
3543
- "enum": ["thermocycler/waitForBlockTemperature"],
3544
- "type": "string"
3545
- },
3546
- "params": {
3547
- "$ref": "#/definitions/WaitForBlockTemperatureParams"
3548
- },
3549
- "intent": {
3550
- "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.",
3551
- "allOf": [
3552
- {
3553
- "$ref": "#/definitions/CommandIntent"
3554
- }
3555
- ]
3556
- },
3557
- "key": {
3558
- "title": "Key",
3559
- "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.",
3560
- "type": "string"
3561
- }
3562
- },
3563
- "required": ["params"]
3564
- },
3565
- "SetTargetLidTemperatureParams": {
3566
- "title": "SetTargetLidTemperatureParams",
3567
- "description": "Input parameters to set a Thermocycler's target lid temperature.",
3568
- "type": "object",
3569
- "properties": {
3570
- "moduleId": {
3571
- "title": "Moduleid",
3572
- "description": "Unique ID of the Thermocycler Module.",
3573
- "type": "string"
3574
- },
3575
- "celsius": {
3576
- "title": "Celsius",
3577
- "description": "Target temperature in \u00b0C.",
3578
- "type": "number"
3579
- }
3580
- },
3581
- "required": ["moduleId", "celsius"]
3582
- },
3583
- "SetTargetLidTemperatureCreate": {
3584
- "title": "SetTargetLidTemperatureCreate",
3585
- "description": "A request to create a Thermocycler's set lid temperature command.",
3586
- "type": "object",
3587
- "properties": {
3588
- "commandType": {
3589
- "title": "Commandtype",
3590
- "default": "thermocycler/setTargetLidTemperature",
3591
- "enum": ["thermocycler/setTargetLidTemperature"],
3592
- "type": "string"
3593
- },
3594
- "params": {
3595
- "$ref": "#/definitions/SetTargetLidTemperatureParams"
3596
- },
3597
- "intent": {
3598
- "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.",
3599
- "allOf": [
3600
- {
3601
- "$ref": "#/definitions/CommandIntent"
3602
- }
3603
- ]
3604
- },
3605
- "key": {
3606
- "title": "Key",
3607
- "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.",
3608
- "type": "string"
3609
- }
3610
- },
3611
- "required": ["params"]
3612
- },
3613
- "WaitForLidTemperatureParams": {
3614
- "title": "WaitForLidTemperatureParams",
3615
- "description": "Input parameters to wait for Thermocycler's lid temperature.",
3616
- "type": "object",
3617
- "properties": {
3618
- "moduleId": {
3619
- "title": "Moduleid",
3620
- "description": "Unique ID of the Thermocycler Module.",
3621
- "type": "string"
3622
- }
3623
- },
3624
- "required": ["moduleId"]
3625
- },
3626
- "WaitForLidTemperatureCreate": {
3627
- "title": "WaitForLidTemperatureCreate",
3628
- "description": "A request to create Thermocycler's wait for lid temperature command.",
3629
- "type": "object",
3630
- "properties": {
3631
- "commandType": {
3632
- "title": "Commandtype",
3633
- "default": "thermocycler/waitForLidTemperature",
3634
- "enum": ["thermocycler/waitForLidTemperature"],
3635
- "type": "string"
3636
- },
3637
- "params": {
3638
- "$ref": "#/definitions/WaitForLidTemperatureParams"
3639
- },
3640
- "intent": {
3641
- "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.",
3642
- "allOf": [
3643
- {
3644
- "$ref": "#/definitions/CommandIntent"
3645
- }
3646
- ]
3647
- },
3648
- "key": {
3649
- "title": "Key",
3650
- "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.",
3651
- "type": "string"
3652
- }
3653
- },
3654
- "required": ["params"]
3655
- },
3656
- "DeactivateBlockParams": {
3657
- "title": "DeactivateBlockParams",
3658
- "description": "Input parameters to unset a Thermocycler's target block temperature.",
3659
- "type": "object",
3660
- "properties": {
3661
- "moduleId": {
3662
- "title": "Moduleid",
3663
- "description": "Unique ID of the Thermocycler.",
3664
- "type": "string"
3665
- }
3666
- },
3667
- "required": ["moduleId"]
3668
- },
3669
- "DeactivateBlockCreate": {
3670
- "title": "DeactivateBlockCreate",
3671
- "description": "A request to create a Thermocycler's deactivate block command.",
3672
- "type": "object",
3673
- "properties": {
3674
- "commandType": {
3675
- "title": "Commandtype",
3676
- "default": "thermocycler/deactivateBlock",
3677
- "enum": ["thermocycler/deactivateBlock"],
3678
- "type": "string"
3679
- },
3680
- "params": {
3681
- "$ref": "#/definitions/DeactivateBlockParams"
3682
- },
3683
- "intent": {
3684
- "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.",
3685
- "allOf": [
3686
- {
3687
- "$ref": "#/definitions/CommandIntent"
3688
- }
3689
- ]
3690
- },
3691
- "key": {
3692
- "title": "Key",
3693
- "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.",
3694
- "type": "string"
3695
- }
3696
- },
3697
- "required": ["params"]
3698
- },
3699
- "DeactivateLidParams": {
3700
- "title": "DeactivateLidParams",
3701
- "description": "Input parameters to unset a Thermocycler's target lid temperature.",
3702
- "type": "object",
3703
- "properties": {
3704
- "moduleId": {
3705
- "title": "Moduleid",
3706
- "description": "Unique ID of the Thermocycler.",
3707
- "type": "string"
3708
- }
3709
- },
3710
- "required": ["moduleId"]
3711
- },
3712
- "DeactivateLidCreate": {
3713
- "title": "DeactivateLidCreate",
3714
- "description": "A request to create a Thermocycler's deactivate lid command.",
3715
- "type": "object",
3716
- "properties": {
3717
- "commandType": {
3718
- "title": "Commandtype",
3719
- "default": "thermocycler/deactivateLid",
3720
- "enum": ["thermocycler/deactivateLid"],
3721
- "type": "string"
3722
- },
3723
- "params": {
3724
- "$ref": "#/definitions/DeactivateLidParams"
3725
- },
3726
- "intent": {
3727
- "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.",
3728
- "allOf": [
3729
- {
3730
- "$ref": "#/definitions/CommandIntent"
3731
- }
3732
- ]
3733
- },
3734
- "key": {
3735
- "title": "Key",
3736
- "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.",
3737
- "type": "string"
3738
- }
3739
- },
3740
- "required": ["params"]
3741
- },
3742
- "OpenLidParams": {
3743
- "title": "OpenLidParams",
3744
- "description": "Input parameters to open a Thermocycler's lid.",
3745
- "type": "object",
3746
- "properties": {
3747
- "moduleId": {
3748
- "title": "Moduleid",
3749
- "description": "Unique ID of the Thermocycler.",
3750
- "type": "string"
3751
- }
3752
- },
3753
- "required": ["moduleId"]
3754
- },
3755
- "OpenLidCreate": {
3756
- "title": "OpenLidCreate",
3757
- "description": "A request to open a Thermocycler's lid.",
3758
- "type": "object",
3759
- "properties": {
3760
- "commandType": {
3761
- "title": "Commandtype",
3762
- "default": "thermocycler/openLid",
3763
- "enum": ["thermocycler/openLid"],
3764
- "type": "string"
3765
- },
3766
- "params": {
3767
- "$ref": "#/definitions/OpenLidParams"
3768
- },
3769
- "intent": {
3770
- "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.",
3771
- "allOf": [
3772
- {
3773
- "$ref": "#/definitions/CommandIntent"
3774
- }
3775
- ]
3776
- },
3777
- "key": {
3778
- "title": "Key",
3779
- "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.",
3780
- "type": "string"
3781
- }
3782
- },
3783
- "required": ["params"]
3784
- },
3785
- "CloseLidParams": {
3786
- "title": "CloseLidParams",
3787
- "description": "Input parameters to close a Thermocycler's lid.",
3788
- "type": "object",
3789
- "properties": {
3790
- "moduleId": {
3791
- "title": "Moduleid",
3792
- "description": "Unique ID of the Thermocycler.",
3793
- "type": "string"
3794
- }
3795
- },
3796
- "required": ["moduleId"]
3797
- },
3798
- "CloseLidCreate": {
3799
- "title": "CloseLidCreate",
3800
- "description": "A request to close a Thermocycler's lid.",
3801
- "type": "object",
3802
- "properties": {
3803
- "commandType": {
3804
- "title": "Commandtype",
3805
- "default": "thermocycler/closeLid",
3806
- "enum": ["thermocycler/closeLid"],
3807
- "type": "string"
3808
- },
3809
- "params": {
3810
- "$ref": "#/definitions/CloseLidParams"
3811
- },
3812
- "intent": {
3813
- "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.",
3814
- "allOf": [
3815
- {
3816
- "$ref": "#/definitions/CommandIntent"
3817
- }
3818
- ]
3819
- },
3820
- "key": {
3821
- "title": "Key",
3822
- "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.",
3823
- "type": "string"
3824
- }
3825
- },
3826
- "required": ["params"]
3827
- },
3828
- "RunProfileStepParams": {
3829
- "title": "RunProfileStepParams",
3830
- "description": "Input parameters for an individual Thermocycler profile step.",
3831
- "type": "object",
3832
- "properties": {
3833
- "celsius": {
3834
- "title": "Celsius",
3835
- "description": "Target temperature in \u00b0C.",
3836
- "type": "number"
3837
- },
3838
- "holdSeconds": {
3839
- "title": "Holdseconds",
3840
- "description": "Time to hold target temperature at in seconds.",
3841
- "type": "number"
3842
- }
3843
- },
3844
- "required": ["celsius", "holdSeconds"]
3845
- },
3846
- "RunProfileParams": {
3847
- "title": "RunProfileParams",
3848
- "description": "Input parameters to run a Thermocycler profile.",
3849
- "type": "object",
3850
- "properties": {
3851
- "moduleId": {
3852
- "title": "Moduleid",
3853
- "description": "Unique ID of the Thermocycler.",
3854
- "type": "string"
3855
- },
3856
- "profile": {
3857
- "title": "Profile",
3858
- "description": "Array of profile steps with target temperature and temperature hold time.",
3859
- "type": "array",
3860
- "items": {
3861
- "$ref": "#/definitions/RunProfileStepParams"
3862
- }
3863
- },
3864
- "blockMaxVolumeUl": {
3865
- "title": "Blockmaxvolumeul",
3866
- "description": "Amount of liquid in uL of the most-full well in labware loaded onto the thermocycler.",
3867
- "type": "number"
3868
- }
3869
- },
3870
- "required": ["moduleId", "profile"]
3871
- },
3872
- "RunProfileCreate": {
3873
- "title": "RunProfileCreate",
3874
- "description": "A request to execute a Thermocycler profile run.",
3875
- "type": "object",
3876
- "properties": {
3877
- "commandType": {
3878
- "title": "Commandtype",
3879
- "default": "thermocycler/runProfile",
3880
- "enum": ["thermocycler/runProfile"],
3881
- "type": "string"
3882
- },
3883
- "params": {
3884
- "$ref": "#/definitions/RunProfileParams"
3885
- },
3886
- "intent": {
3887
- "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.",
3888
- "allOf": [
3889
- {
3890
- "$ref": "#/definitions/CommandIntent"
3891
- }
3892
- ]
3893
- },
3894
- "key": {
3895
- "title": "Key",
3896
- "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.",
3897
- "type": "string"
3898
- }
3899
- },
3900
- "required": ["params"]
3901
- },
3902
- "InitializeParams": {
3903
- "title": "InitializeParams",
3904
- "description": "Input parameters to initialize an absorbance reading.",
3905
- "type": "object",
3906
- "properties": {
3907
- "moduleId": {
3908
- "title": "Moduleid",
3909
- "description": "Unique ID of the absorbance reader.",
3910
- "type": "string"
3911
- },
3912
- "sampleWavelength": {
3913
- "title": "Samplewavelength",
3914
- "description": "Sample wavelength in nm.",
3915
- "type": "integer"
3916
- }
3917
- },
3918
- "required": ["moduleId", "sampleWavelength"]
3919
- },
3920
- "InitializeCreate": {
3921
- "title": "InitializeCreate",
3922
- "description": "A request to execute an Absorbance Reader measurement.",
3923
- "type": "object",
3924
- "properties": {
3925
- "commandType": {
3926
- "title": "Commandtype",
3927
- "default": "absorbanceReader/initialize",
3928
- "enum": ["absorbanceReader/initialize"],
3929
- "type": "string"
3930
- },
3931
- "params": {
3932
- "$ref": "#/definitions/InitializeParams"
3933
- },
3934
- "intent": {
3935
- "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.",
3936
- "allOf": [
3937
- {
3938
- "$ref": "#/definitions/CommandIntent"
3939
- }
3940
- ]
3941
- },
3942
- "key": {
3943
- "title": "Key",
3944
- "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.",
3945
- "type": "string"
3946
- }
3947
- },
3948
- "required": ["params"]
3949
- },
3950
- "MeasureAbsorbanceParams": {
3951
- "title": "MeasureAbsorbanceParams",
3952
- "description": "Input parameters for a single absorbance reading.",
3953
- "type": "object",
3954
- "properties": {
3955
- "moduleId": {
3956
- "title": "Moduleid",
3957
- "description": "Unique ID of the Absorbance Reader.",
3958
- "type": "string"
3959
- },
3960
- "sampleWavelength": {
3961
- "title": "Samplewavelength",
3962
- "description": "Sample wavelength in nm.",
3963
- "type": "integer"
3964
- }
3965
- },
3966
- "required": ["moduleId", "sampleWavelength"]
3967
- },
3968
- "MeasureAbsorbanceCreate": {
3969
- "title": "MeasureAbsorbanceCreate",
3970
- "description": "A request to execute an Absorbance Reader measurement.",
3971
- "type": "object",
3972
- "properties": {
3973
- "commandType": {
3974
- "title": "Commandtype",
3975
- "default": "absorbanceReader/measure",
3976
- "enum": ["absorbanceReader/measure"],
3977
- "type": "string"
3978
- },
3979
- "params": {
3980
- "$ref": "#/definitions/MeasureAbsorbanceParams"
3981
- },
3982
- "intent": {
3983
- "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.",
3984
- "allOf": [
3985
- {
3986
- "$ref": "#/definitions/CommandIntent"
3987
- }
3988
- ]
3989
- },
3990
- "key": {
3991
- "title": "Key",
3992
- "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.",
3993
- "type": "string"
3994
- }
3995
- },
3996
- "required": ["params"]
3997
- },
3998
- "CalibrateGripperParamsJaw": {
3999
- "title": "CalibrateGripperParamsJaw",
4000
- "description": "An enumeration.",
4001
- "enum": ["front", "rear"]
4002
- },
4003
- "Vec3f": {
4004
- "title": "Vec3f",
4005
- "description": "A 3D vector of floats.",
4006
- "type": "object",
4007
- "properties": {
4008
- "x": {
4009
- "title": "X",
4010
- "type": "number"
4011
- },
4012
- "y": {
4013
- "title": "Y",
4014
- "type": "number"
4015
- },
4016
- "z": {
4017
- "title": "Z",
4018
- "type": "number"
4019
- }
4020
- },
4021
- "required": ["x", "y", "z"]
4022
- },
4023
- "CalibrateGripperParams": {
4024
- "title": "CalibrateGripperParams",
4025
- "description": "Parameters for a `calibrateGripper` command.",
4026
- "type": "object",
4027
- "properties": {
4028
- "jaw": {
4029
- "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.",
4030
- "allOf": [
4031
- {
4032
- "$ref": "#/definitions/CalibrateGripperParamsJaw"
4033
- }
4034
- ]
4035
- },
4036
- "otherJawOffset": {
4037
- "title": "Otherjawoffset",
4038
- "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.",
4039
- "allOf": [
4040
- {
4041
- "$ref": "#/definitions/Vec3f"
4042
- }
4043
- ]
4044
- }
4045
- },
4046
- "required": ["jaw"]
4047
- },
4048
- "CalibrateGripperCreate": {
4049
- "title": "CalibrateGripperCreate",
4050
- "description": "A request to create a `calibrateGripper` command.",
4051
- "type": "object",
4052
- "properties": {
4053
- "commandType": {
4054
- "title": "Commandtype",
4055
- "default": "calibration/calibrateGripper",
4056
- "enum": ["calibration/calibrateGripper"],
4057
- "type": "string"
4058
- },
4059
- "params": {
4060
- "$ref": "#/definitions/CalibrateGripperParams"
4061
- },
4062
- "intent": {
4063
- "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.",
4064
- "allOf": [
4065
- {
4066
- "$ref": "#/definitions/CommandIntent"
4067
- }
4068
- ]
4069
- },
4070
- "key": {
4071
- "title": "Key",
4072
- "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.",
4073
- "type": "string"
4074
- }
4075
- },
4076
- "required": ["params"]
4077
- },
4078
- "CalibratePipetteParams": {
4079
- "title": "CalibratePipetteParams",
4080
- "description": "Payload required to calibrate-pipette.",
4081
- "type": "object",
4082
- "properties": {
4083
- "mount": {
4084
- "description": "Instrument mount to calibrate.",
4085
- "allOf": [
4086
- {
4087
- "$ref": "#/definitions/MountType"
4088
- }
4089
- ]
4090
- }
4091
- },
4092
- "required": ["mount"]
4093
- },
4094
- "CalibratePipetteCreate": {
4095
- "title": "CalibratePipetteCreate",
4096
- "description": "Create calibrate-pipette command request model.",
4097
- "type": "object",
4098
- "properties": {
4099
- "commandType": {
4100
- "title": "Commandtype",
4101
- "default": "calibration/calibratePipette",
4102
- "enum": ["calibration/calibratePipette"],
4103
- "type": "string"
4104
- },
4105
- "params": {
4106
- "$ref": "#/definitions/CalibratePipetteParams"
4107
- },
4108
- "intent": {
4109
- "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.",
4110
- "allOf": [
4111
- {
4112
- "$ref": "#/definitions/CommandIntent"
4113
- }
4114
- ]
4115
- },
4116
- "key": {
4117
- "title": "Key",
4118
- "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.",
4119
- "type": "string"
4120
- }
4121
- },
4122
- "required": ["params"]
4123
- },
4124
- "CalibrateModuleParams": {
4125
- "title": "CalibrateModuleParams",
4126
- "description": "Payload required to calibrate-module.",
4127
- "type": "object",
4128
- "properties": {
4129
- "moduleId": {
4130
- "title": "Moduleid",
4131
- "description": "The unique id of module to calibrate.",
4132
- "type": "string"
4133
- },
4134
- "labwareId": {
4135
- "title": "Labwareid",
4136
- "description": "The unique id of module calibration adapter labware.",
4137
- "type": "string"
4138
- },
4139
- "mount": {
4140
- "description": "The instrument mount used to calibrate the module.",
4141
- "allOf": [
4142
- {
4143
- "$ref": "#/definitions/MountType"
4144
- }
4145
- ]
4146
- }
4147
- },
4148
- "required": ["moduleId", "labwareId", "mount"]
4149
- },
4150
- "CalibrateModuleCreate": {
4151
- "title": "CalibrateModuleCreate",
4152
- "description": "Create calibrate-module command request model.",
4153
- "type": "object",
4154
- "properties": {
4155
- "commandType": {
4156
- "title": "Commandtype",
4157
- "default": "calibration/calibrateModule",
4158
- "enum": ["calibration/calibrateModule"],
4159
- "type": "string"
4160
- },
4161
- "params": {
4162
- "$ref": "#/definitions/CalibrateModuleParams"
4163
- },
4164
- "intent": {
4165
- "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.",
4166
- "allOf": [
4167
- {
4168
- "$ref": "#/definitions/CommandIntent"
4169
- }
4170
- ]
4171
- },
4172
- "key": {
4173
- "title": "Key",
4174
- "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.",
4175
- "type": "string"
4176
- }
4177
- },
4178
- "required": ["params"]
4179
- },
4180
- "MaintenancePosition": {
4181
- "title": "MaintenancePosition",
4182
- "description": "Maintenance position options.",
4183
- "enum": ["attachPlate", "attachInstrument"]
4184
- },
4185
- "MoveToMaintenancePositionParams": {
4186
- "title": "MoveToMaintenancePositionParams",
4187
- "description": "Calibration set up position command parameters.",
4188
- "type": "object",
4189
- "properties": {
4190
- "mount": {
4191
- "description": "Gantry mount to move maintenance position.",
4192
- "allOf": [
4193
- {
4194
- "$ref": "#/definitions/MountType"
4195
- }
4196
- ]
4197
- },
4198
- "maintenancePosition": {
4199
- "description": "The position the gantry mount needs to move to.",
4200
- "default": "attachInstrument",
4201
- "allOf": [
4202
- {
4203
- "$ref": "#/definitions/MaintenancePosition"
4204
- }
4205
- ]
4206
- }
4207
- },
4208
- "required": ["mount"]
4209
- },
4210
- "MoveToMaintenancePositionCreate": {
4211
- "title": "MoveToMaintenancePositionCreate",
4212
- "description": "Calibration set up position command creation request model.",
4213
- "type": "object",
4214
- "properties": {
4215
- "commandType": {
4216
- "title": "Commandtype",
4217
- "default": "calibration/moveToMaintenancePosition",
4218
- "enum": ["calibration/moveToMaintenancePosition"],
4219
- "type": "string"
4220
- },
4221
- "params": {
4222
- "$ref": "#/definitions/MoveToMaintenancePositionParams"
4223
- },
4224
- "intent": {
4225
- "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.",
4226
- "allOf": [
4227
- {
4228
- "$ref": "#/definitions/CommandIntent"
4229
- }
4230
- ]
4231
- },
4232
- "key": {
4233
- "title": "Key",
4234
- "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.",
4235
- "type": "string"
4236
- }
4237
- },
4238
- "required": ["params"]
4239
- },
4240
- "UnsafeBlowOutInPlaceParams": {
4241
- "title": "UnsafeBlowOutInPlaceParams",
4242
- "description": "Payload required to blow-out in place while position is unknown.",
4243
- "type": "object",
4244
- "properties": {
4245
- "flowRate": {
4246
- "title": "Flowrate",
4247
- "description": "Speed in \u00b5L/s configured for the pipette",
4248
- "exclusiveMinimum": 0,
4249
- "type": "number"
4250
- },
4251
- "pipetteId": {
4252
- "title": "Pipetteid",
4253
- "description": "Identifier of pipette to use for liquid handling.",
4254
- "type": "string"
4255
- }
4256
- },
4257
- "required": ["flowRate", "pipetteId"]
4258
- },
4259
- "UnsafeBlowOutInPlaceCreate": {
4260
- "title": "UnsafeBlowOutInPlaceCreate",
4261
- "description": "UnsafeBlowOutInPlace command request model.",
4262
- "type": "object",
4263
- "properties": {
4264
- "commandType": {
4265
- "title": "Commandtype",
4266
- "default": "unsafe/blowOutInPlace",
4267
- "enum": ["unsafe/blowOutInPlace"],
4268
- "type": "string"
4269
- },
4270
- "params": {
4271
- "$ref": "#/definitions/UnsafeBlowOutInPlaceParams"
4272
- },
4273
- "intent": {
4274
- "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.",
4275
- "allOf": [
4276
- {
4277
- "$ref": "#/definitions/CommandIntent"
4278
- }
4279
- ]
4280
- },
4281
- "key": {
4282
- "title": "Key",
4283
- "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.",
4284
- "type": "string"
4285
- }
4286
- },
4287
- "required": ["params"]
4288
- },
4289
- "UnsafeDropTipInPlaceParams": {
4290
- "title": "UnsafeDropTipInPlaceParams",
4291
- "description": "Payload required to drop a tip in place even if the plunger position is not known.",
4292
- "type": "object",
4293
- "properties": {
4294
- "pipetteId": {
4295
- "title": "Pipetteid",
4296
- "description": "Identifier of pipette to use for liquid handling.",
4297
- "type": "string"
4298
- },
4299
- "homeAfter": {
4300
- "title": "Homeafter",
4301
- "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.",
4302
- "type": "boolean"
4303
- }
4304
- },
4305
- "required": ["pipetteId"]
4306
- },
4307
- "UnsafeDropTipInPlaceCreate": {
4308
- "title": "UnsafeDropTipInPlaceCreate",
4309
- "description": "Drop tip in place command creation request model.",
4310
- "type": "object",
4311
- "properties": {
4312
- "commandType": {
4313
- "title": "Commandtype",
4314
- "default": "unsafe/dropTipInPlace",
4315
- "enum": ["unsafe/dropTipInPlace"],
4316
- "type": "string"
4317
- },
4318
- "params": {
4319
- "$ref": "#/definitions/UnsafeDropTipInPlaceParams"
4320
- },
4321
- "intent": {
4322
- "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.",
4323
- "allOf": [
4324
- {
4325
- "$ref": "#/definitions/CommandIntent"
4326
- }
4327
- ]
4328
- },
4329
- "key": {
4330
- "title": "Key",
4331
- "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.",
4332
- "type": "string"
4333
- }
4334
- },
4335
- "required": ["params"]
4336
- },
4337
- "UpdatePositionEstimatorsParams": {
4338
- "title": "UpdatePositionEstimatorsParams",
4339
- "description": "Payload required for an UpdatePositionEstimators command.",
4340
- "type": "object",
4341
- "properties": {
4342
- "axes": {
4343
- "description": "The axes for which to update the position estimators.",
4344
- "type": "array",
4345
- "items": {
4346
- "$ref": "#/definitions/MotorAxis"
4347
- }
4348
- }
4349
- },
4350
- "required": ["axes"]
4351
- },
4352
- "UpdatePositionEstimatorsCreate": {
4353
- "title": "UpdatePositionEstimatorsCreate",
4354
- "description": "UpdatePositionEstimators command request model.",
4355
- "type": "object",
4356
- "properties": {
4357
- "commandType": {
4358
- "title": "Commandtype",
4359
- "default": "unsafe/updatePositionEstimators",
4360
- "enum": ["unsafe/updatePositionEstimators"],
4361
- "type": "string"
4362
- },
4363
- "params": {
4364
- "$ref": "#/definitions/UpdatePositionEstimatorsParams"
4365
- },
4366
- "intent": {
4367
- "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.",
4368
- "allOf": [
4369
- {
4370
- "$ref": "#/definitions/CommandIntent"
4371
- }
4372
- ]
4373
- },
4374
- "key": {
4375
- "title": "Key",
4376
- "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.",
4377
- "type": "string"
4378
- }
4379
- },
4380
- "required": ["params"]
4381
- },
4382
- "UnsafeEngageAxesParams": {
4383
- "title": "UnsafeEngageAxesParams",
4384
- "description": "Payload required for an UnsafeEngageAxes command.",
4385
- "type": "object",
4386
- "properties": {
4387
- "axes": {
4388
- "description": "The axes for which to enable.",
4389
- "type": "array",
4390
- "items": {
4391
- "$ref": "#/definitions/MotorAxis"
4392
- }
4393
- }
4394
- },
4395
- "required": ["axes"]
4396
- },
4397
- "UnsafeEngageAxesCreate": {
4398
- "title": "UnsafeEngageAxesCreate",
4399
- "description": "UnsafeEngageAxes command request model.",
4400
- "type": "object",
4401
- "properties": {
4402
- "commandType": {
4403
- "title": "Commandtype",
4404
- "default": "unsafe/engageAxes",
4405
- "enum": ["unsafe/engageAxes"],
4406
- "type": "string"
4407
- },
4408
- "params": {
4409
- "$ref": "#/definitions/UnsafeEngageAxesParams"
4410
- },
4411
- "intent": {
4412
- "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.",
4413
- "allOf": [
4414
- {
4415
- "$ref": "#/definitions/CommandIntent"
4416
- }
4417
- ]
4418
- },
4419
- "key": {
4420
- "title": "Key",
4421
- "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.",
4422
- "type": "string"
4423
- }
4424
- },
4425
- "required": ["params"]
4426
- }
4427
- },
4428
- "$id": "opentronsCommandSchemaV9",
4429
- "$schema": "http://json-schema.org/draft-07/schema#"
4430
- }