-
Notifications
You must be signed in to change notification settings - Fork 180
/
Copy path11.json
6267 lines (6267 loc) · 246 KB
/
11.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"$defs": {
"AddressableAreaLocation": {
"description": "The location of something place in an addressable area. This is a superset of deck slots.",
"properties": {
"addressableAreaName": {
"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).",
"title": "Addressableareaname",
"type": "string"
}
},
"required": ["addressableAreaName"],
"title": "AddressableAreaLocation",
"type": "object"
},
"AddressableOffsetVector": {
"description": "Offset, in deck coordinates, from nominal to actual position of an addressable area.",
"properties": {
"x": {
"title": "X",
"type": "number"
},
"y": {
"title": "Y",
"type": "number"
},
"z": {
"title": "Z",
"type": "number"
}
},
"required": ["x", "y", "z"],
"title": "AddressableOffsetVector",
"type": "object"
},
"AirGapInPlaceCreate": {
"description": "AirGapInPlace command request model.",
"properties": {
"commandType": {
"const": "airGapInPlace",
"default": "airGapInPlace",
"enum": ["airGapInPlace"],
"title": "Commandtype",
"type": "string"
},
"intent": {
"$ref": "#/$defs/CommandIntent",
"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.",
"title": "Intent"
},
"key": {
"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.",
"title": "Key",
"type": "string"
},
"params": {
"$ref": "#/$defs/AirGapInPlaceParams"
}
},
"required": ["params"],
"title": "AirGapInPlaceCreate",
"type": "object"
},
"AirGapInPlaceParams": {
"description": "Payload required to air gap in place.",
"properties": {
"flowRate": {
"description": "Speed in \u00b5L/s configured for the pipette",
"exclusiveMinimum": 0.0,
"title": "Flowrate",
"type": "number"
},
"pipetteId": {
"description": "Identifier of pipette to use for liquid handling.",
"title": "Pipetteid",
"type": "string"
},
"volume": {
"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.",
"minimum": 0.0,
"title": "Volume",
"type": "number"
}
},
"required": ["flowRate", "volume", "pipetteId"],
"title": "AirGapInPlaceParams",
"type": "object"
},
"AllNozzleLayoutConfiguration": {
"description": "All basemodel to represent a reset to the nozzle configuration. Sending no parameters resets to default.",
"properties": {
"style": {
"const": "ALL",
"default": "ALL",
"enum": ["ALL"],
"title": "Style",
"type": "string"
}
},
"title": "AllNozzleLayoutConfiguration",
"type": "object"
},
"AspirateCreate": {
"description": "Create aspirate command request model.",
"properties": {
"commandType": {
"const": "aspirate",
"default": "aspirate",
"enum": ["aspirate"],
"title": "Commandtype",
"type": "string"
},
"intent": {
"$ref": "#/$defs/CommandIntent",
"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.",
"title": "Intent"
},
"key": {
"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.",
"title": "Key",
"type": "string"
},
"params": {
"$ref": "#/$defs/AspirateParams"
}
},
"required": ["params"],
"title": "AspirateCreate",
"type": "object"
},
"AspirateInPlaceCreate": {
"description": "AspirateInPlace command request model.",
"properties": {
"commandType": {
"const": "aspirateInPlace",
"default": "aspirateInPlace",
"enum": ["aspirateInPlace"],
"title": "Commandtype",
"type": "string"
},
"intent": {
"$ref": "#/$defs/CommandIntent",
"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.",
"title": "Intent"
},
"key": {
"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.",
"title": "Key",
"type": "string"
},
"params": {
"$ref": "#/$defs/AspirateInPlaceParams"
}
},
"required": ["params"],
"title": "AspirateInPlaceCreate",
"type": "object"
},
"AspirateInPlaceParams": {
"description": "Payload required to aspirate in place.",
"properties": {
"flowRate": {
"description": "Speed in \u00b5L/s configured for the pipette",
"exclusiveMinimum": 0.0,
"title": "Flowrate",
"type": "number"
},
"pipetteId": {
"description": "Identifier of pipette to use for liquid handling.",
"title": "Pipetteid",
"type": "string"
},
"volume": {
"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.",
"minimum": 0.0,
"title": "Volume",
"type": "number"
}
},
"required": ["flowRate", "volume", "pipetteId"],
"title": "AspirateInPlaceParams",
"type": "object"
},
"AspirateParams": {
"description": "Parameters required to aspirate from a specific well.",
"properties": {
"flowRate": {
"description": "Speed in \u00b5L/s configured for the pipette",
"exclusiveMinimum": 0.0,
"title": "Flowrate",
"type": "number"
},
"labwareId": {
"description": "Identifier of labware to use.",
"title": "Labwareid",
"type": "string"
},
"pipetteId": {
"description": "Identifier of pipette to use for liquid handling.",
"title": "Pipetteid",
"type": "string"
},
"volume": {
"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.",
"minimum": 0.0,
"title": "Volume",
"type": "number"
},
"wellLocation": {
"$ref": "#/$defs/LiquidHandlingWellLocation",
"description": "Relative well location at which to perform the operation"
},
"wellName": {
"description": "Name of well to use in labware.",
"title": "Wellname",
"type": "string"
}
},
"required": ["labwareId", "wellName", "flowRate", "volume", "pipetteId"],
"title": "AspirateParams",
"type": "object"
},
"AspirateProperties": {
"description": "Properties specific to the aspirate function.",
"properties": {
"correctionByVolume": {
"description": "Settings for volume correction keyed by by target aspiration volume, representing additional volume the plunger should move to accurately hit target volume.",
"items": {
"maxItems": 2,
"minItems": 2,
"prefixItems": [
{
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"minimum": 0.0,
"type": "number"
}
]
},
{
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
]
}
],
"type": "array"
},
"title": "Correctionbyvolume",
"type": "array"
},
"delay": {
"$ref": "#/$defs/DelayProperties",
"description": "Delay settings after an aspirate"
},
"flowRateByVolume": {
"description": "Settings for flow rate keyed by target aspiration volume.",
"items": {
"maxItems": 2,
"minItems": 2,
"prefixItems": [
{
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"minimum": 0.0,
"type": "number"
}
]
},
{
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"minimum": 0.0,
"type": "number"
}
]
}
],
"type": "array"
},
"title": "Flowratebyvolume",
"type": "array"
},
"mix": {
"$ref": "#/$defs/MixProperties",
"description": "Mixing settings for before an aspirate"
},
"offset": {
"$ref": "#/$defs/Coordinate",
"description": "Relative offset for aspiration."
},
"positionReference": {
"$ref": "#/$defs/PositionReference",
"description": "Position reference for aspiration."
},
"preWet": {
"description": "Whether to perform a pre-wet action.",
"title": "Prewet",
"type": "boolean"
},
"retract": {
"$ref": "#/$defs/RetractAspirate",
"description": "Pipette retract settings after an aspirate."
},
"submerge": {
"$ref": "#/$defs/Submerge",
"description": "Submerge settings for aspirate."
}
},
"required": [
"submerge",
"retract",
"positionReference",
"offset",
"flowRateByVolume",
"correctionByVolume",
"preWet",
"mix",
"delay"
],
"title": "AspirateProperties",
"type": "object"
},
"BlowOutCreate": {
"description": "Create blow-out command request model.",
"properties": {
"commandType": {
"const": "blowout",
"default": "blowout",
"enum": ["blowout"],
"title": "Commandtype",
"type": "string"
},
"intent": {
"$ref": "#/$defs/CommandIntent",
"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.",
"title": "Intent"
},
"key": {
"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.",
"title": "Key",
"type": "string"
},
"params": {
"$ref": "#/$defs/BlowOutParams"
}
},
"required": ["params"],
"title": "BlowOutCreate",
"type": "object"
},
"BlowOutInPlaceCreate": {
"description": "BlowOutInPlace command request model.",
"properties": {
"commandType": {
"const": "blowOutInPlace",
"default": "blowOutInPlace",
"enum": ["blowOutInPlace"],
"title": "Commandtype",
"type": "string"
},
"intent": {
"$ref": "#/$defs/CommandIntent",
"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.",
"title": "Intent"
},
"key": {
"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.",
"title": "Key",
"type": "string"
},
"params": {
"$ref": "#/$defs/BlowOutInPlaceParams"
}
},
"required": ["params"],
"title": "BlowOutInPlaceCreate",
"type": "object"
},
"BlowOutInPlaceParams": {
"description": "Payload required to blow-out in place.",
"properties": {
"flowRate": {
"description": "Speed in \u00b5L/s configured for the pipette",
"exclusiveMinimum": 0.0,
"title": "Flowrate",
"type": "number"
},
"pipetteId": {
"description": "Identifier of pipette to use for liquid handling.",
"title": "Pipetteid",
"type": "string"
}
},
"required": ["flowRate", "pipetteId"],
"title": "BlowOutInPlaceParams",
"type": "object"
},
"BlowOutParams": {
"description": "Payload required to blow-out a specific well.",
"properties": {
"flowRate": {
"description": "Speed in \u00b5L/s configured for the pipette",
"exclusiveMinimum": 0.0,
"title": "Flowrate",
"type": "number"
},
"labwareId": {
"description": "Identifier of labware to use.",
"title": "Labwareid",
"type": "string"
},
"pipetteId": {
"description": "Identifier of pipette to use for liquid handling.",
"title": "Pipetteid",
"type": "string"
},
"wellLocation": {
"$ref": "#/$defs/WellLocation",
"description": "Relative well location at which to perform the operation"
},
"wellName": {
"description": "Name of well to use in labware.",
"title": "Wellname",
"type": "string"
}
},
"required": ["labwareId", "wellName", "flowRate", "pipetteId"],
"title": "BlowOutParams",
"type": "object"
},
"BlowoutLocation": {
"description": "Location for blowout during a transfer function.",
"enum": ["source", "destination", "trash"],
"title": "BlowoutLocation",
"type": "string"
},
"BlowoutParams": {
"description": "Parameters for blowout.",
"properties": {
"flowRate": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"minimum": 0.0,
"type": "number"
}
],
"description": "Flow rate for blow out, in microliters per second.",
"title": "Flowrate"
},
"location": {
"$ref": "#/$defs/BlowoutLocation",
"description": "Location well or trash entity for blow out."
}
},
"required": ["location", "flowRate"],
"title": "BlowoutParams",
"type": "object"
},
"BlowoutProperties": {
"description": "Blowout properties.",
"properties": {
"enable": {
"description": "Whether blow-out is enabled.",
"title": "Enable",
"type": "boolean"
},
"params": {
"$ref": "#/$defs/BlowoutParams",
"description": "Parameters for the blowout function.",
"title": "Params"
}
},
"required": ["enable"],
"title": "BlowoutProperties",
"type": "object"
},
"CalibrateGripperCreate": {
"description": "A request to create a `calibrateGripper` command.",
"properties": {
"commandType": {
"const": "calibration/calibrateGripper",
"default": "calibration/calibrateGripper",
"enum": ["calibration/calibrateGripper"],
"title": "Commandtype",
"type": "string"
},
"intent": {
"$ref": "#/$defs/CommandIntent",
"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.",
"title": "Intent"
},
"key": {
"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.",
"title": "Key",
"type": "string"
},
"params": {
"$ref": "#/$defs/CalibrateGripperParams"
}
},
"required": ["params"],
"title": "CalibrateGripperCreate",
"type": "object"
},
"CalibrateGripperParams": {
"description": "Parameters for a `calibrateGripper` command.",
"properties": {
"jaw": {
"$ref": "#/$defs/CalibrateGripperParamsJaw",
"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."
},
"otherJawOffset": {
"$ref": "#/$defs/Vec3f",
"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.",
"title": "Otherjawoffset"
}
},
"required": ["jaw"],
"title": "CalibrateGripperParams",
"type": "object"
},
"CalibrateGripperParamsJaw": {
"enum": ["front", "rear"],
"title": "CalibrateGripperParamsJaw",
"type": "string"
},
"CalibrateModuleCreate": {
"description": "Create calibrate-module command request model.",
"properties": {
"commandType": {
"const": "calibration/calibrateModule",
"default": "calibration/calibrateModule",
"enum": ["calibration/calibrateModule"],
"title": "Commandtype",
"type": "string"
},
"intent": {
"$ref": "#/$defs/CommandIntent",
"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.",
"title": "Intent"
},
"key": {
"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.",
"title": "Key",
"type": "string"
},
"params": {
"$ref": "#/$defs/CalibrateModuleParams"
}
},
"required": ["params"],
"title": "CalibrateModuleCreate",
"type": "object"
},
"CalibrateModuleParams": {
"description": "Payload required to calibrate-module.",
"properties": {
"labwareId": {
"description": "The unique id of module calibration adapter labware.",
"title": "Labwareid",
"type": "string"
},
"moduleId": {
"description": "The unique id of module to calibrate.",
"title": "Moduleid",
"type": "string"
},
"mount": {
"$ref": "#/$defs/MountType",
"description": "The instrument mount used to calibrate the module."
}
},
"required": ["moduleId", "labwareId", "mount"],
"title": "CalibrateModuleParams",
"type": "object"
},
"CalibratePipetteCreate": {
"description": "Create calibrate-pipette command request model.",
"properties": {
"commandType": {
"const": "calibration/calibratePipette",
"default": "calibration/calibratePipette",
"enum": ["calibration/calibratePipette"],
"title": "Commandtype",
"type": "string"
},
"intent": {
"$ref": "#/$defs/CommandIntent",
"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.",
"title": "Intent"
},
"key": {
"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.",
"title": "Key",
"type": "string"
},
"params": {
"$ref": "#/$defs/CalibratePipetteParams"
}
},
"required": ["params"],
"title": "CalibratePipetteCreate",
"type": "object"
},
"CalibratePipetteParams": {
"description": "Payload required to calibrate-pipette.",
"properties": {
"mount": {
"$ref": "#/$defs/MountType",
"description": "Instrument mount to calibrate."
}
},
"required": ["mount"],
"title": "CalibratePipetteParams",
"type": "object"
},
"CloseLabwareLatchCreate": {
"description": "A request to create a Heater-Shaker's close latch command.",
"properties": {
"commandType": {
"const": "heaterShaker/closeLabwareLatch",
"default": "heaterShaker/closeLabwareLatch",
"enum": ["heaterShaker/closeLabwareLatch"],
"title": "Commandtype",
"type": "string"
},
"intent": {
"$ref": "#/$defs/CommandIntent",
"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.",
"title": "Intent"
},
"key": {
"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.",
"title": "Key",
"type": "string"
},
"params": {
"$ref": "#/$defs/CloseLabwareLatchParams"
}
},
"required": ["params"],
"title": "CloseLabwareLatchCreate",
"type": "object"
},
"CloseLabwareLatchParams": {
"description": "Input parameters to close a Heater-Shaker Module's labware latch.",
"properties": {
"moduleId": {
"description": "Unique ID of the Heater-Shaker Module.",
"title": "Moduleid",
"type": "string"
}
},
"required": ["moduleId"],
"title": "CloseLabwareLatchParams",
"type": "object"
},
"ColumnNozzleLayoutConfiguration": {
"description": "Information required for nozzle configurations of type ROW and COLUMN.",
"properties": {
"primaryNozzle": {
"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.",
"enum": ["A1", "H1", "A12", "H12"],
"title": "Primarynozzle",
"type": "string"
},
"style": {
"const": "COLUMN",
"default": "COLUMN",
"enum": ["COLUMN"],
"title": "Style",
"type": "string"
}
},
"required": ["primaryNozzle"],
"title": "ColumnNozzleLayoutConfiguration",
"type": "object"
},
"CommandIntent": {
"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.",
"enum": ["protocol", "setup", "fixit"],
"title": "CommandIntent",
"type": "string"
},
"CommentCreate": {
"description": "Comment command request model.",
"properties": {
"commandType": {
"const": "comment",
"default": "comment",
"enum": ["comment"],
"title": "Commandtype",
"type": "string"
},
"intent": {
"$ref": "#/$defs/CommandIntent",
"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.",
"title": "Intent"
},
"key": {
"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.",
"title": "Key",
"type": "string"
},
"params": {
"$ref": "#/$defs/CommentParams"
}
},
"required": ["params"],
"title": "CommentCreate",
"type": "object"
},
"CommentParams": {
"description": "Payload required to annotate execution with a comment.",
"properties": {
"message": {
"description": "A user-facing message",
"title": "Message",
"type": "string"
}
},
"required": ["message"],
"title": "CommentParams",
"type": "object"
},
"ConfigureForVolumeCreate": {
"description": "Configure for volume command creation request model.",
"properties": {
"commandType": {
"const": "configureForVolume",
"default": "configureForVolume",
"enum": ["configureForVolume"],
"title": "Commandtype",
"type": "string"
},
"intent": {
"$ref": "#/$defs/CommandIntent",
"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.",
"title": "Intent"
},
"key": {
"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.",
"title": "Key",
"type": "string"
},
"params": {
"$ref": "#/$defs/ConfigureForVolumeParams"
}
},
"required": ["params"],
"title": "ConfigureForVolumeCreate",
"type": "object"
},
"ConfigureForVolumeParams": {
"description": "Parameters required to configure volume for a specific pipette.",
"properties": {
"pipetteId": {
"description": "Identifier of pipette to use for liquid handling.",
"title": "Pipetteid",
"type": "string"
},
"tipOverlapNotAfterVersion": {
"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.",
"title": "Tipoverlapnotafterversion",
"type": "string"
},
"volume": {
"description": "Amount of liquid in uL. Must be at least 0 and no greater than a pipette-specific maximum volume.",
"minimum": 0.0,
"title": "Volume",
"type": "number"
}
},
"required": ["pipetteId", "volume"],
"title": "ConfigureForVolumeParams",
"type": "object"
},
"ConfigureNozzleLayoutCreate": {
"description": "Configure nozzle layout creation request model.",
"properties": {
"commandType": {
"const": "configureNozzleLayout",
"default": "configureNozzleLayout",
"enum": ["configureNozzleLayout"],
"title": "Commandtype",
"type": "string"
},
"intent": {
"$ref": "#/$defs/CommandIntent",
"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.",
"title": "Intent"
},
"key": {
"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.",
"title": "Key",
"type": "string"
},
"params": {
"$ref": "#/$defs/ConfigureNozzleLayoutParams"
}
},
"required": ["params"],
"title": "ConfigureNozzleLayoutCreate",
"type": "object"
},
"ConfigureNozzleLayoutParams": {
"description": "Parameters required to configure the nozzle layout for a specific pipette.",
"properties": {
"configurationParams": {
"anyOf": [
{
"$ref": "#/$defs/AllNozzleLayoutConfiguration"
},
{
"$ref": "#/$defs/SingleNozzleLayoutConfiguration"
},
{
"$ref": "#/$defs/RowNozzleLayoutConfiguration"
},
{
"$ref": "#/$defs/ColumnNozzleLayoutConfiguration"
},
{
"$ref": "#/$defs/QuadrantNozzleLayoutConfiguration"
}
],
"title": "Configurationparams"
},
"pipetteId": {
"description": "Identifier of pipette to use for liquid handling.",
"title": "Pipetteid",
"type": "string"
}
},
"required": ["pipetteId", "configurationParams"],
"title": "ConfigureNozzleLayoutParams",
"type": "object"
},
"Coordinate": {
"description": "Three-dimensional coordinates.",
"properties": {
"x": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"title": "X"
},
"y": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"title": "Y"
},
"z": {
"anyOf": [
{
"type": "integer"
},
{
"type": "number"
}
],
"title": "Z"
}
},
"required": ["x", "y", "z"],
"title": "Coordinate",
"type": "object"
},
"CustomCreate": {
"description": "A request to create a custom command.",
"properties": {
"commandType": {
"const": "custom",
"default": "custom",
"enum": ["custom"],
"title": "Commandtype",
"type": "string"
},
"intent": {
"$ref": "#/$defs/CommandIntent",
"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.",
"title": "Intent"
},
"key": {
"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.",
"title": "Key",
"type": "string"
},
"params": {
"$ref": "#/$defs/CustomParams"
}
},
"required": ["params"],
"title": "CustomCreate",
"type": "object"
},
"CustomParams": {
"additionalProperties": true,
"description": "Payload used by a custom command.",
"properties": {},
"title": "CustomParams",
"type": "object"
},
"DeactivateBlockCreate": {
"description": "A request to create a Thermocycler's deactivate block command.",
"properties": {
"commandType": {
"const": "thermocycler/deactivateBlock",
"default": "thermocycler/deactivateBlock",
"enum": ["thermocycler/deactivateBlock"],
"title": "Commandtype",
"type": "string"
},
"intent": {
"$ref": "#/$defs/CommandIntent",
"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.",
"title": "Intent"
},
"key": {
"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.",
"title": "Key",
"type": "string"
},
"params": {
"$ref": "#/$defs/DeactivateBlockParams"
}
},
"required": ["params"],
"title": "DeactivateBlockCreate",
"type": "object"
},
"DeactivateBlockParams": {
"description": "Input parameters to unset a Thermocycler's target block temperature.",
"properties": {
"moduleId": {
"description": "Unique ID of the Thermocycler.",
"title": "Moduleid",
"type": "string"
}
},
"required": ["moduleId"],
"title": "DeactivateBlockParams",
"type": "object"
},
"DeactivateHeaterCreate": {
"description": "A request to create a Heater-Shaker's deactivate heater command.",
"properties": {
"commandType": {
"const": "heaterShaker/deactivateHeater",
"default": "heaterShaker/deactivateHeater",
"enum": ["heaterShaker/deactivateHeater"],
"title": "Commandtype",
"type": "string"
},
"intent": {
"$ref": "#/$defs/CommandIntent",
"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.",
"title": "Intent"
},
"key": {
"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.",
"title": "Key",
"type": "string"
},
"params": {
"$ref": "#/$defs/DeactivateHeaterParams"
}
},