@opentrons/shared-data 0.1.7-alpha.0 → 0.1.7-alpha.1

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 (186) hide show
  1. package/command/index.ts +14 -2
  2. package/command/schemas/12.json +65 -0
  3. package/command/schemas/13.json +7207 -0
  4. package/command/types/annotation.ts +1 -1
  5. package/command/types/calibration.ts +7 -6
  6. package/command/types/gantry.ts +7 -6
  7. package/command/types/incidental.ts +1 -1
  8. package/command/types/index.ts +68 -20
  9. package/command/types/module.ts +76 -9
  10. package/command/types/pipetting.ts +9 -3
  11. package/command/types/robot.ts +98 -0
  12. package/command/types/setup.ts +3 -3
  13. package/command/types/support.ts +13 -2
  14. package/command/types/timing.ts +1 -1
  15. package/command/types/unsafe.ts +63 -1
  16. package/deck/index.ts +3 -6
  17. package/errors/definitions/1/errors.json +12 -0
  18. package/errors/index.ts +2 -1
  19. package/labware/definitions/2/agilent_1_reservoir_290ml/3.json +80 -0
  20. package/labware/definitions/2/corning_384_wellplate_112ul_flat/4.json +5116 -0
  21. package/labware/definitions/2/corning_48_wellplate_1.6ml_flat/4.json +605 -0
  22. package/labware/definitions/2/nest_1_reservoir_290ml/3.json +80 -0
  23. package/labware/definitions/2/opentrons_24_aluminumblock_nest_0.5ml_screwcap/3.json +370 -0
  24. package/labware/definitions/2/opentrons_24_tuberack_nest_0.5ml_screwcap/3.json +371 -0
  25. package/labware/definitions/2/opentrons_96_aluminumblock_generic_pcr_strip_200ul/4.json +1149 -0
  26. package/labware/definitions/2/opentrons_flex_tiprack_lid/1.json +8 -2
  27. package/labware/definitions/2/usascientific_12_reservoir_22ml/3.json +237 -0
  28. package/labware/definitions/3/schema3test_96_well_aluminum_block/999.json +1047 -0
  29. package/labware/definitions/3/schema3test_96_wellplate_200ul_pcr_full_skirt/999.json +1189 -0
  30. package/labware/definitions/3/schema3test_flex_96_tiprack_200ul/999.json +1041 -0
  31. package/labware/fixtures/2/index.ts +4 -4
  32. package/labware/fixtures/3/fixture_2_plate.json +25 -11
  33. package/labware/fixtures/3/fixture_corning_24_plate.json +47 -33
  34. package/labware/schemas/3.json +63 -25
  35. package/lib/command/index.d.ts +4156 -2078
  36. package/lib/command/schemas/12.json +65 -0
  37. package/lib/command/schemas/13.json +7207 -0
  38. package/lib/command/types/annotation.d.ts +1 -1
  39. package/lib/command/types/calibration.d.ts +5 -5
  40. package/lib/command/types/gantry.d.ts +5 -4
  41. package/lib/command/types/incidental.d.ts +1 -1
  42. package/lib/command/types/index.d.ts +52 -14
  43. package/lib/command/types/module.d.ts +59 -10
  44. package/lib/command/types/pipetting.d.ts +8 -3
  45. package/lib/command/types/robot.d.ts +71 -0
  46. package/lib/command/types/setup.d.ts +1 -1
  47. package/lib/command/types/support.d.ts +3 -2
  48. package/lib/command/types/timing.d.ts +1 -1
  49. package/lib/command/types/unsafe.d.ts +44 -3
  50. package/lib/deck/index.d.ts +3 -3
  51. package/lib/errors/definitions/1/errors.json +12 -0
  52. package/lib/errors/index.d.ts +1 -1
  53. package/lib/index.mjs +372042 -335507
  54. package/lib/js/constants.d.ts +17 -10
  55. package/lib/js/deck/index.d.ts +2 -2
  56. package/lib/js/fixtures.d.ts +1 -1
  57. package/lib/js/gripper.d.ts +1 -1
  58. package/lib/js/helpers/__tests__/getMmFromBottom.test.d.ts +1 -0
  59. package/lib/js/helpers/__tests__/liquidClasses.test.d.ts +1 -0
  60. package/lib/js/helpers/getLoadedLabwareDefinitionsByUri.d.ts +1 -1
  61. package/lib/js/helpers/getMmFromBottom.d.ts +2 -0
  62. package/lib/js/helpers/getSimplestFlexDeckConfig.d.ts +1 -1
  63. package/lib/js/helpers/getVectorDifference.d.ts +2 -2
  64. package/lib/js/helpers/getVectorSum.d.ts +2 -2
  65. package/lib/js/helpers/getWellRangeForLiquidLabwarePair.d.ts +6 -0
  66. package/lib/js/helpers/index.d.ts +4 -1
  67. package/lib/js/helpers/labwareInference.d.ts +1 -1
  68. package/lib/js/helpers/liquidClasses.d.ts +8 -0
  69. package/lib/js/helpers/parseAddressableArea.d.ts +1 -1
  70. package/lib/js/helpers/parseProtocolCommands.d.ts +2 -2
  71. package/lib/js/helpers/validateCustomLabwareHelper.d.ts +1 -1
  72. package/lib/js/labware.d.ts +6 -6
  73. package/lib/js/labwareTools/index.d.ts +1 -1
  74. package/lib/js/modules.d.ts +1 -1
  75. package/lib/js/pipettes.d.ts +3 -2
  76. package/lib/js/types.d.ts +45 -27
  77. package/lib/labware/definitions/2/agilent_1_reservoir_290ml/3.json +80 -0
  78. package/lib/labware/definitions/2/corning_384_wellplate_112ul_flat/4.json +5116 -0
  79. package/lib/labware/definitions/2/corning_48_wellplate_1.6ml_flat/4.json +605 -0
  80. package/lib/labware/definitions/2/nest_1_reservoir_290ml/3.json +80 -0
  81. package/lib/labware/definitions/2/opentrons_24_aluminumblock_nest_0.5ml_screwcap/3.json +370 -0
  82. package/lib/labware/definitions/2/opentrons_24_tuberack_nest_0.5ml_screwcap/3.json +371 -0
  83. package/lib/labware/definitions/2/opentrons_96_aluminumblock_generic_pcr_strip_200ul/4.json +1149 -0
  84. package/lib/labware/definitions/2/opentrons_flex_tiprack_lid/1.json +8 -2
  85. package/lib/labware/definitions/2/usascientific_12_reservoir_22ml/3.json +237 -0
  86. package/lib/labware/definitions/3/schema3test_96_well_aluminum_block/999.json +1047 -0
  87. package/lib/labware/definitions/3/schema3test_96_wellplate_200ul_pcr_full_skirt/999.json +1189 -0
  88. package/lib/labware/definitions/3/schema3test_flex_96_tiprack_200ul/999.json +1041 -0
  89. package/lib/labware/fixtures/2/index.d.ts +4 -4
  90. package/lib/labware/fixtures/3/fixture_2_plate.json +25 -11
  91. package/lib/labware/fixtures/3/fixture_corning_24_plate.json +47 -33
  92. package/lib/labware/schemas/3.json +63 -25
  93. package/lib/liquid-class/definitions/1/ethanol_80.json +1455 -1059
  94. package/lib/liquid-class/definitions/1/glycerol_50.json +1454 -1058
  95. package/lib/liquid-class/definitions/1/water.json +1459 -1063
  96. package/lib/liquid-class/fixtures/1/fixture_glycerol50.json +66 -48
  97. package/lib/liquid-class/schemas/1.json +34 -48
  98. package/lib/module/definitions/3/absorbanceReaderV1.json +1 -0
  99. package/lib/module/definitions/3/flexStackerModuleV1.json +6 -0
  100. package/lib/module/definitions/3/magneticBlockV1.json +1 -0
  101. package/lib/module/definitions/3/magneticModuleV1.json +1 -0
  102. package/lib/module/definitions/3/magneticModuleV2.json +1 -0
  103. package/lib/module/definitions/3/temperatureModuleV1.json +1 -0
  104. package/lib/module/definitions/3/temperatureModuleV2.json +1 -0
  105. package/lib/module/definitions/3/thermocyclerModuleV1.json +1 -0
  106. package/lib/module/definitions/3/thermocyclerModuleV2.json +1 -0
  107. package/lib/module/schemas/3.json +4 -0
  108. package/lib/pipette/definitions/2/geometry/eight_channel/p50/3_5.json +4 -0
  109. package/lib/pipette/definitions/2/geometry/ninety_six_channel/p200/3_0.json +4 -0
  110. package/lib/pipette/definitions/2/geometry/single_channel/p50/3_6.json +4 -0
  111. package/lib/pipette/definitions/2/liquid/ninety_six_channel/p200/default/1_0.json +11 -11
  112. package/lib/pipette/definitions/2/liquid/ninety_six_channel/p200/default/3_0.json +12 -12
  113. package/lib/pipette/definitions/2/liquid/single_channel/p50/default/3_6.json +5 -5
  114. package/lib/pipette/definitions/2/liquid/single_channel/p50/lowVolumeDefault/3_6.json +5 -5
  115. package/lib/pipette/fixtures/name/index.d.ts +1 -1
  116. package/lib/protocol/fixtures/index.d.ts +2 -2
  117. package/lib/protocol/index.d.ts +7 -7
  118. package/lib/protocol/types/schemaV4.d.ts +1 -1
  119. package/lib/protocol/types/schemaV5.d.ts +1 -1
  120. package/lib/protocol/types/schemaV5Addendum.d.ts +1 -1
  121. package/lib/protocol/types/schemaV6/command/gantry.d.ts +4 -4
  122. package/lib/protocol/types/schemaV6/command/index.d.ts +5 -5
  123. package/lib/protocol/types/schemaV6/command/module.d.ts +1 -1
  124. package/lib/protocol/types/schemaV6/command/pipetting.d.ts +1 -1
  125. package/lib/protocol/types/schemaV6/command/setup.d.ts +1 -1
  126. package/lib/protocol/types/schemaV6/command/timing.d.ts +1 -1
  127. package/lib/protocol/types/schemaV6/index.d.ts +2 -2
  128. package/lib/protocol/types/schemaV7/command/annotation.d.ts +1 -1
  129. package/lib/protocol/types/schemaV7/command/calibration.d.ts +5 -5
  130. package/lib/protocol/types/schemaV7/command/gantry.d.ts +4 -4
  131. package/lib/protocol/types/schemaV7/command/incidental.d.ts +1 -1
  132. package/lib/protocol/types/schemaV7/command/index.d.ts +7 -7
  133. package/lib/protocol/types/schemaV7/command/module.d.ts +1 -1
  134. package/lib/protocol/types/schemaV7/command/pipetting.d.ts +1 -1
  135. package/lib/protocol/types/schemaV7/command/setup.d.ts +1 -1
  136. package/lib/protocol/types/schemaV7/command/timing.d.ts +1 -1
  137. package/lib/protocol/types/schemaV7/index.d.ts +2 -2
  138. package/lib/protocol/types/schemaV8/index.d.ts +1 -1
  139. package/liquid-class/definitions/1/ethanol_80.json +1455 -1059
  140. package/liquid-class/definitions/1/glycerol_50.json +1454 -1058
  141. package/liquid-class/definitions/1/water.json +1459 -1063
  142. package/liquid-class/fixtures/1/fixture_glycerol50.json +66 -48
  143. package/liquid-class/schemas/1.json +34 -48
  144. package/module/definitions/3/absorbanceReaderV1.json +1 -0
  145. package/module/definitions/3/flexStackerModuleV1.json +6 -0
  146. package/module/definitions/3/magneticBlockV1.json +1 -0
  147. package/module/definitions/3/magneticModuleV1.json +1 -0
  148. package/module/definitions/3/magneticModuleV2.json +1 -0
  149. package/module/definitions/3/temperatureModuleV1.json +1 -0
  150. package/module/definitions/3/temperatureModuleV2.json +1 -0
  151. package/module/definitions/3/thermocyclerModuleV1.json +1 -0
  152. package/module/definitions/3/thermocyclerModuleV2.json +1 -0
  153. package/module/schemas/3.json +4 -0
  154. package/package.json +1 -1
  155. package/pipette/definitions/2/geometry/eight_channel/p50/3_5.json +4 -0
  156. package/pipette/definitions/2/geometry/ninety_six_channel/p200/3_0.json +4 -0
  157. package/pipette/definitions/2/geometry/single_channel/p50/3_6.json +4 -0
  158. package/pipette/definitions/2/liquid/ninety_six_channel/p200/default/1_0.json +11 -11
  159. package/pipette/definitions/2/liquid/ninety_six_channel/p200/default/3_0.json +12 -12
  160. package/pipette/definitions/2/liquid/single_channel/p50/default/3_6.json +5 -5
  161. package/pipette/definitions/2/liquid/single_channel/p50/lowVolumeDefault/3_6.json +5 -5
  162. package/pipette/fixtures/index.ts +12 -12
  163. package/pipette/fixtures/name/index.ts +1 -0
  164. package/protocol/fixtures/index.ts +2 -3
  165. package/protocol/index.ts +9 -8
  166. package/protocol/types/schemaV4.ts +4 -4
  167. package/protocol/types/schemaV5.ts +1 -1
  168. package/protocol/types/schemaV5Addendum.ts +1 -1
  169. package/protocol/types/schemaV6/command/gantry.ts +4 -4
  170. package/protocol/types/schemaV6/command/index.ts +6 -6
  171. package/protocol/types/schemaV6/command/module.ts +1 -1
  172. package/protocol/types/schemaV6/command/pipetting.ts +2 -1
  173. package/protocol/types/schemaV6/command/setup.ts +2 -2
  174. package/protocol/types/schemaV6/command/timing.ts +1 -1
  175. package/protocol/types/schemaV6/index.ts +3 -3
  176. package/protocol/types/schemaV7/command/annotation.ts +1 -1
  177. package/protocol/types/schemaV7/command/calibration.ts +7 -6
  178. package/protocol/types/schemaV7/command/gantry.ts +5 -5
  179. package/protocol/types/schemaV7/command/incidental.ts +1 -1
  180. package/protocol/types/schemaV7/command/index.ts +14 -14
  181. package/protocol/types/schemaV7/command/module.ts +1 -1
  182. package/protocol/types/schemaV7/command/pipetting.ts +2 -1
  183. package/protocol/types/schemaV7/command/setup.ts +2 -2
  184. package/protocol/types/schemaV7/command/timing.ts +1 -1
  185. package/protocol/types/schemaV7/index.ts +3 -3
  186. package/protocol/types/schemaV8/index.ts +3 -3
@@ -1,6 +1,6 @@
1
1
  import type {
2
- CommonCommandRunTimeInfo,
3
2
  CommonCommandCreateInfo,
3
+ CommonCommandRunTimeInfo,
4
4
  OnDeckLabwareLocation,
5
5
  } from '.'
6
6
  import type { MotorAxes } from '../../js/types'
@@ -12,6 +12,9 @@ export type UnsafeRunTimeCommand =
12
12
  | UnsafeEngageAxesRunTimeCommand
13
13
  | UnsafeUngripLabwareRunTimeCommand
14
14
  | UnsafePlaceLabwareRunTimeCommand
15
+ | UnsafeFlexStackerCloseLatchRunTimeCommand
16
+ | UnsafeFlexStackerOpenLatchRunTimeCommand
17
+ | UnsafeFlexStackerPrepareShuttleRunTimeCommand
15
18
 
16
19
  export type UnsafeCreateCommand =
17
20
  | UnsafeBlowoutInPlaceCreateCommand
@@ -20,6 +23,10 @@ export type UnsafeCreateCommand =
20
23
  | UnsafeEngageAxesCreateCommand
21
24
  | UnsafeUngripLabwareCreateCommand
22
25
  | UnsafePlaceLabwareCreateCommand
26
+ | UnsafeFlexStackerManualRetrieveCreateCommand
27
+ | UnsafeFlexStackerCloseLatchCreateCommand
28
+ | UnsafeFlexStackerOpenLatchCreateCommand
29
+ | UnsafeFlexStackerPrepareShuttleCreateCommand
23
30
 
24
31
  export interface UnsafeBlowoutInPlaceParams {
25
32
  pipetteId: string
@@ -105,3 +112,58 @@ export interface UnsafePlaceLabwareRunTimeCommand
105
112
  UnsafePlaceLabwareCreateCommand {
106
113
  result?: any
107
114
  }
115
+ export interface UnsafeFlexStackerManualRetrieveParams {
116
+ moduleId: string
117
+ }
118
+ export interface UnsafeFlexStackerManualRetrieveCreateCommand
119
+ extends CommonCommandCreateInfo {
120
+ commandType: 'unsafe/flexStacker/manualRetrieve'
121
+ params: UnsafeFlexStackerManualRetrieveParams
122
+ }
123
+ export interface UnsafeFlexStackerManualRetrieveLatchRunTimeCommand
124
+ extends CommonCommandRunTimeInfo,
125
+ UnsafeFlexStackerManualRetrieveCreateCommand {
126
+ result?: any
127
+ }
128
+ export interface UnsafeFlexStackerCloseLatchParams {
129
+ moduleId: string
130
+ }
131
+ export interface UnsafeFlexStackerCloseLatchCreateCommand
132
+ extends CommonCommandCreateInfo {
133
+ commandType: 'unsafe/flexStacker/closeLatch'
134
+ params: UnsafeFlexStackerCloseLatchParams
135
+ }
136
+ export interface UnsafeFlexStackerCloseLatchRunTimeCommand
137
+ extends CommonCommandRunTimeInfo,
138
+ UnsafeFlexStackerCloseLatchCreateCommand {
139
+ result?: any
140
+ }
141
+
142
+ export interface UnsafeFlexStackerOpenLatchParams {
143
+ moduleId: string
144
+ }
145
+ export interface UnsafeFlexStackerOpenLatchCreateCommand
146
+ extends CommonCommandCreateInfo {
147
+ commandType: 'unsafe/flexStacker/openLatch'
148
+ params: UnsafeFlexStackerOpenLatchParams
149
+ }
150
+ export interface UnsafeFlexStackerOpenLatchRunTimeCommand
151
+ extends CommonCommandRunTimeInfo,
152
+ UnsafeFlexStackerOpenLatchCreateCommand {
153
+ result?: any
154
+ }
155
+
156
+ export interface UnsafeFlexStackerPrepareShuttleParams {
157
+ moduleId: string
158
+ ignoreLatch?: boolean
159
+ }
160
+ export interface UnsafeFlexStackerPrepareShuttleCreateCommand
161
+ extends CommonCommandCreateInfo {
162
+ commandType: 'unsafe/flexStacker/prepareShuttle'
163
+ params: UnsafeFlexStackerPrepareShuttleParams
164
+ }
165
+ export interface UnsafeFlexStackerPrepareShuttleRunTimeCommand
166
+ extends CommonCommandRunTimeInfo,
167
+ UnsafeFlexStackerPrepareShuttleCreateCommand {
168
+ result?: any
169
+ }
package/deck/index.ts CHANGED
@@ -1,18 +1,15 @@
1
1
  // v3 deck defs
2
- import ot2StandardDeckV3 from './definitions/3/ot2_standard.json'
3
2
  import ot2ShortFixedTrashDeckV3 from './definitions/3/ot2_short_trash.json'
3
+ import ot2StandardDeckV3 from './definitions/3/ot2_standard.json'
4
4
  import ot3StandardDeckV3 from './definitions/3/ot3_standard.json'
5
-
5
+ import ot2ShortFixedTrashDeckV4 from './definitions/4/ot2_short_trash.json'
6
6
  // v4 deck defs
7
7
  import ot2StandardDeckV4 from './definitions/4/ot2_standard.json'
8
- import ot2ShortFixedTrashDeckV4 from './definitions/4/ot2_short_trash.json'
9
8
  import ot3StandardDeckV4 from './definitions/4/ot3_standard.json'
10
-
9
+ import ot2ShortFixedTrashDeckV5 from './definitions/5/ot2_short_trash.json'
11
10
  // v5 deck defs
12
11
  import ot2StandardDeckV5 from './definitions/5/ot2_standard.json'
13
- import ot2ShortFixedTrashDeckV5 from './definitions/5/ot2_short_trash.json'
14
12
  import ot3StandardDeckV5 from './definitions/5/ot3_standard.json'
15
-
16
13
  import deckExample from './fixtures/3/deckExample.json'
17
14
 
18
15
  import type { DeckDefinition } from '../js/types'
@@ -210,6 +210,18 @@
210
210
  "detail": "HEPA UV Failed",
211
211
  "category": "roboticsInteractionError"
212
212
  },
213
+ "3020": {
214
+ "detail": "Flex Stacker Shuttle Missing",
215
+ "category": "roboticsInteractionError"
216
+ },
217
+ "3021": {
218
+ "detail": "Flex Stacker Shuttle Labware Detection Failed",
219
+ "category": "roboticsInteractionError"
220
+ },
221
+ "3022": {
222
+ "detail": "Flex Stacker Hopper Labware Detection Failed",
223
+ "category": "roboticsInteractionError"
224
+ },
213
225
  "4000": {
214
226
  "detail": "Unknown or Uncategorized Error",
215
227
  "category": "generalError"
package/errors/index.ts CHANGED
@@ -1,4 +1,5 @@
1
- import errorSchemaV1 from './schemas/1.json'
2
1
  import errorData from './definitions/1/errors.json'
2
+ import errorSchemaV1 from './schemas/1.json'
3
+
3
4
  export type * from './types'
4
5
  export { errorSchemaV1, errorData }
@@ -0,0 +1,80 @@
1
+ {
2
+ "ordering": [["A1"]],
3
+ "brand": {
4
+ "brand": "Agilent",
5
+ "brandId": ["201252-100"],
6
+ "links": ["https://www.agilent.com/store/en_US/Prod-201252-100/201252-100"]
7
+ },
8
+ "metadata": {
9
+ "displayName": "Agilent 1 Well Reservoir 290 mL",
10
+ "displayCategory": "reservoir",
11
+ "displayVolumeUnits": "mL",
12
+ "tags": []
13
+ },
14
+ "dimensions": {
15
+ "xDimension": 127.76,
16
+ "yDimension": 85.57,
17
+ "zDimension": 44.04
18
+ },
19
+ "wells": {
20
+ "A1": {
21
+ "depth": 39.23,
22
+ "shape": "rectangular",
23
+ "xDimension": 108,
24
+ "yDimension": 72,
25
+ "totalLiquidVolume": 290000,
26
+ "x": 63.88,
27
+ "y": 42.785,
28
+ "z": 4.81,
29
+ "geometryDefinitionId": "cuboidalWell"
30
+ }
31
+ },
32
+ "groups": [
33
+ {
34
+ "wells": ["A1"],
35
+ "metadata": {
36
+ "wellBottomShape": "v"
37
+ }
38
+ }
39
+ ],
40
+ "parameters": {
41
+ "format": "trough",
42
+ "isTiprack": false,
43
+ "isMagneticModuleCompatible": false,
44
+ "loadName": "agilent_1_reservoir_290ml",
45
+ "quirks": ["centerMultichannelOnWells", "touchTipDisabled"]
46
+ },
47
+ "namespace": "opentrons",
48
+ "version": 3,
49
+ "schemaVersion": 2,
50
+ "cornerOffsetFromSlot": {
51
+ "x": 0,
52
+ "y": 0,
53
+ "z": 0
54
+ },
55
+ "innerLabwareGeometry": {
56
+ "cuboidalWell": {
57
+ "sections": [
58
+ {
59
+ "shape": "cuboidal",
60
+ "topXDimension": 107.5,
61
+ "topYDimension": 71.25,
62
+ "bottomXDimension": 106.785,
63
+ "bottomYDimension": 71.0,
64
+ "topHeight": 39.23,
65
+ "bottomHeight": 2.0
66
+ },
67
+ {
68
+ "shape": "cuboidal",
69
+ "topXDimension": 106.785,
70
+ "topYDimension": 8,
71
+ "bottomXDimension": 100.75,
72
+ "bottomYDimension": 1.66,
73
+ "topHeight": 2,
74
+ "bottomHeight": 0,
75
+ "yCount": 8
76
+ }
77
+ ]
78
+ }
79
+ }
80
+ }