feat(protocol-designer): add submerge for aspirate and dispense

protocol-designer/src/assets/localization/en/application.json

@@ -58,6 +58,7 @@
     "microliter": "µL",
     "microliterPerSec": "µL/s",
     "millimeter": "mm",
+    "millimeterPerSec": "mm/s",
     "nanometer": "nm",
     "minutes": "m",
     "rpm": "rpm",

protocol-designer/src/assets/localization/en/protocol_steps.json

@@ -107,6 +107,8 @@
   "speed": "Speed",
   "starting_deck": "Starting deck",
   "step_substeps": "{{stepType}} details",
+  "submerge": "Submerge",
+  "submerge_speed": "Submerge speed",
   "temperature": "Temperature",
   "temperature_module": {
     "active": "<semiBoldText>{{module}}</semiBoldText><text>set to</text><tag/>",

protocol-designer/src/assets/localization/en/tooltip.json

@@ -37,6 +37,7 @@
       "aspirate_mmFromBottom": "Adjust tip position for aspirate",
       "aspirate_touchTip_checkbox": "Touch tip to each side of the well after aspirating",
       "aspirate_touchTip_mmFromTop": "Distance from the top of the well",
+      "aspirate_submerge": "Lower the tip into the liquid before aspirating",
       "aspirate_wells": "First select a source labware",
       "blowout_checkbox": "Blow extra air through the tip",
       "blowout_flowRate": "Blowout speed",
@@ -50,6 +51,7 @@
       "dispense_labware": "Pipette unable to access labware in staging area",
       "dispense_mix_checkbox": "Aspirate and dispense repeatedly after main dispense",
       "dispense_mmFromBottom": "Adjust tip position for dispense",
+      "dispense_submerge": "Lower the tip into the liquid before dispensing",
       "dispense_touchTip_checkbox": "Touch tip to each side of the well after dispensing",
       "dispense_touchTip_mmFromTop": "Distance from the top of the well",
       "dispense_wells": "First select a destination labware",

protocol-designer/src/form-types.ts

@@ -32,6 +32,7 @@ export type StepFieldName = string
 // | 'aspirate_mix_times'
 // | 'aspirate_mix_volume'
 // | 'aspirate_mmFromBottom'
+// | 'aspirate_submerge_speed'
 // | 'aspirate_touchTip_checkbox'
 // | 'aspirate_touchTip_mmFromTop'
 // | 'aspirate_wellOrder_first'
@@ -51,6 +52,7 @@ export type StepFieldName = string
 // | 'dispense_mix_times'
 // | 'dispense_mix_volume'
 // | 'dispense_mmFromBottom'
+// | 'dispense_submerge_speed'
 // | 'dispense_touchTip_checkbox'
 // | 'dispense_touchTip_mmFromTop'
 // | 'dispense_wellOrder_first'
@@ -252,6 +254,8 @@ export interface HydratedMoveLiquidFormData extends AnnotationFields {
   aspirate_mix_times?: number | null
   aspirate_mix_volume?: number | null
   aspirate_mmFromBottom?: number | null
+  aspirate_submerge_delay_seconds?: number | null
+  aspirate_submerge_speed?: number | null
   aspirate_touchTip_mmFromTop?: number | null
   aspirate_wells_grouped?: boolean | null
   aspirate_x_position?: number | null
@@ -266,6 +270,8 @@ export interface HydratedMoveLiquidFormData extends AnnotationFields {
   dispense_mix_times?: number | null
   dispense_mix_volume?: number | null
   dispense_mmFromBottom?: number | null
+  dispense_submerge_delay_seconds?: number | null
+  dispense_submerge_speed?: number | null
   dispense_touchTip_mmFromTop?: number | null
   dispense_x_position?: number | null
   dispense_y_position?: number | null

protocol-designer/src/load-file/migration/8_5_0.ts

@@ -72,6 +72,10 @@ export const migrateFile = (
         dispense_touchTip_mmFromBottom,
         aspirate_labware,
         dispense_labware,
+        aspirate_submerge_delay_seconds,
+        dispense_submerge_delay_seconds,
+        aspirate_submerge_speed,
+        dispense_submerge_speed,
         ...rest
       } = form
       const matchingAspirateLabwareWellDepth = getMigratedPositionFromTop(
@@ -110,6 +114,10 @@ export const migrateFile = (
                     matchingDispenseLabwareWellDepth,
                   1
                 ),
+          aspirate_submerge_delay_seconds: null,
+          dispense_submerge_delay_seconds: null,
+          aspirate_submerge_speed: null,
+          dispense_submerge_speed: null,
         },
       }
     }

protocol-designer/src/pages/Designer/ProtocolSteps/StepForm/StepTools/MoveLiquidTools/index.tsx

@@ -1,15 +1,24 @@
 import { useSelector } from 'react-redux'
 import { useTranslation } from 'react-i18next'
 import {
+  ALIGN_CENTER,
+  COLORS,
   DIRECTION_COLUMN,
   Divider,
   Flex,
+  Icon,
+  ListItem,
   SPACING,
   StyledText,
   Tabs,
+  Tooltip,
+  useHoverTooltip,
 } from '@opentrons/components'
 import { getTrashOrLabware } from '@opentrons/step-generation'
-import { getEnableReturnTip } from '../../../../../../feature-flags/selectors'
+import {
+  getEnableLiquidClasses,
+  getEnableReturnTip,
+} from '../../../../../../feature-flags/selectors'
 import {
   getAdditionalEquipmentEntities,
   getLabwareEntities,
@@ -61,11 +70,13 @@ export function MoveLiquidTools(props: StepFormProps): JSX.Element {
     tab,
     setTab,
   } = props
+  const [targetProps, tooltipProps] = useHoverTooltip()
   const { t, i18n } = useTranslation(['protocol_steps', 'form', 'tooltip'])
   const { path } = formData
   const additionalEquipmentEntities = useSelector(
     getAdditionalEquipmentEntities
   )
+  const enableLiquidClasses = useSelector(getEnableLiquidClasses)
   const enableReturnTip = useSelector(getEnableReturnTip)
   const labwares = useSelector(getLabwareEntities)
   const pipettes = useSelector(getPipetteEntities)
@@ -316,6 +327,67 @@ export function MoveLiquidTools(props: StepFormProps): JSX.Element {
           ]
         }
       />
+      {enableLiquidClasses ? (
+        <>
+          <Divider marginY="0" />
+          <Flex
+            flexDirection={DIRECTION_COLUMN}
+            gridGap={SPACING.spacing8}
+            padding={`0 ${SPACING.spacing16}`}
+          >
+            <Flex gridGap={SPACING.spacing8} alignItems={ALIGN_CENTER}>
+              <StyledText
+                desktopStyle="bodyDefaultRegular"
+                color={COLORS.grey60}
+              >
+                {t('protocol_steps:submerge')}
+              </StyledText>
+              <Flex {...targetProps}>
+                <Icon
+                  name="information"
+                  size={SPACING.spacing12}
+                  color={COLORS.grey60}
+                  data-testid="information_icon"
+                />
+              </Flex>
+              <Tooltip tooltipProps={tooltipProps}>
+                {t(`tooltip:step_fields.defaults.${tab}_submerge`)}
+              </Tooltip>
+            </Flex>
+            <ListItem type="noActive">
+              <Flex
+                padding={SPACING.spacing12}
+                width="100%"
+                flexDirection={DIRECTION_COLUMN}
+                gridGap={SPACING.spacing8}
+              >
+                <InputStepFormField
+                  showTooltip={false}
+                  padding="0"
+                  title={t('protocol_steps:submerge_speed')}
+                  {...propsForFields[`${tab}_submerge_speed`]}
+                  units={t('application:units.millimeterPerSec')}
+                  errorToShow={getFormLevelError(
+                    `${tab}_submerge_speed`,
+                    mappedErrorsToField
+                  )}
+                />
+                <InputStepFormField
+                  showTooltip={false}
+                  padding="0"
+                  title={t('protocol_steps:delay_duration')}
+                  {...propsForFields[`${tab}_submerge_delay_seconds`]}
+                  units={t('application:units.seconds')}
+                  errorToShow={getFormLevelError(
+                    `${tab}_submerge_delay_seconds`,
+                    mappedErrorsToField
+                  )}
+                />
+              </Flex>
+            </ListItem>
+          </Flex>
+        </>
+      ) : null}
       <Divider marginY="0" />
       <Flex
         flexDirection={DIRECTION_COLUMN}

protocol-designer/src/step-forms/test/createPresavedStepForm.test.ts

@@ -160,6 +160,8 @@ describe('createPresavedStepForm', () => {
       aspirate_mix_times: null,
       aspirate_mix_volume: null,
       aspirate_mmFromBottom: null,
+      aspirate_submerge_delay_seconds: null,
+      aspirate_submerge_speed: null,
       aspirate_touchTip_checkbox: false,
       aspirate_touchTip_mmFromTop: null,
       aspirate_wellOrder_first: 't2b',
@@ -177,6 +179,8 @@ describe('createPresavedStepForm', () => {
       dispense_mix_times: null,
       dispense_mix_volume: null,
       dispense_mmFromBottom: null,
+      dispense_submerge_delay_seconds: null,
+      dispense_submerge_speed: null,
       dispense_touchTip_checkbox: false,
       dispense_touchTip_mmFromTop: null,
       dispense_wellOrder_first: 't2b',

protocol-designer/src/steplist/formLevel/getDefaultsForStepType.ts

@@ -61,6 +61,8 @@ export function getDefaultsForStepType(
         aspirate_mix_times: null,
         aspirate_mix_volume: null,
         aspirate_mmFromBottom: null,
+        aspirate_submerge_delay_seconds: null,
+        aspirate_submerge_speed: null,
         aspirate_touchTip_checkbox: false,
         aspirate_touchTip_mmFromTop: null,
         aspirate_wellOrder_first: DEFAULT_WELL_ORDER_FIRST_OPTION,
@@ -85,6 +87,8 @@ export function getDefaultsForStepType(
         dispense_mix_times: null,
         dispense_mix_volume: null,
         dispense_mmFromBottom: null,
+        dispense_submerge_delay_seconds: null,
+        dispense_submerge_speed: null,
         dispense_touchTip_checkbox: false,
         dispense_touchTip_mmFromTop: null,
         dispense_wellOrder_first: DEFAULT_WELL_ORDER_FIRST_OPTION,

protocol-designer/src/steplist/formLevel/test/getDefaultsForStepType.test.ts

@@ -34,6 +34,8 @@ describe('getDefaultsForStepType', () => {
         aspirate_mix_times: null,
         aspirate_mix_volume: null,
         aspirate_mmFromBottom: null,
+        aspirate_submerge_delay_seconds: null,
+        aspirate_submerge_speed: null,
         aspirate_touchTip_checkbox: false,
         aspirate_touchTip_mmFromTop: null,
 
@@ -46,6 +48,8 @@ describe('getDefaultsForStepType', () => {
         dispense_mix_times: null,
         dispense_mix_volume: null,
         dispense_mmFromBottom: null,
+        dispense_submerge_delay_seconds: null,
+        dispense_submerge_speed: null,
         dispense_touchTip_checkbox: false,
         dispense_touchTip_mmFromTop: null,
 

protocol-designer/src/ui/steps/test/selectors.test.ts

@@ -432,18 +432,23 @@ describe('_getSavedMultiSelectFieldValues', () => {
         },
         aspirate_x_position: {
           isIndeterminate: false,
+          value: undefined,
         },
         aspirate_y_position: {
           isIndeterminate: false,
+          value: undefined,
         },
         dispense_x_position: {
           isIndeterminate: false,
+          value: undefined,
         },
         dispense_y_position: {
           isIndeterminate: false,
+          value: undefined,
         },
         blowout_z_offset: {
           isIndeterminate: false,
+          value: undefined,
         },
         aspirate_wells: {
           isIndeterminate: true,
@@ -512,6 +517,14 @@ describe('_getSavedMultiSelectFieldValues', () => {
           value: -1,
           isIndeterminate: false,
         },
+        aspirate_submerge_delay_seconds: {
+          isIndeterminate: false,
+          value: undefined,
+        },
+        aspirate_submerge_speed: {
+          isIndeterminate: false,
+          value: undefined,
+        },
         // dispense settings
         dispense_labware: {
           value: 'dispense_labware_id',
@@ -573,6 +586,14 @@ describe('_getSavedMultiSelectFieldValues', () => {
           value: -1,
           isIndeterminate: false,
         },
+        dispense_submerge_delay_seconds: {
+          isIndeterminate: false,
+          value: undefined,
+        },
+        dispense_submerge_speed: {
+          isIndeterminate: false,
+          value: undefined,
+        },
         blowout_checkbox: {
           value: true,
           isIndeterminate: false,
@@ -689,6 +710,7 @@ describe('_getSavedMultiSelectFieldValues', () => {
         },
         tipRack: {
           isIndeterminate: false,
+          value: undefined,
         },
         blowout_flowRate: {
           isIndeterminate: true,
@@ -710,18 +732,23 @@ describe('_getSavedMultiSelectFieldValues', () => {
         },
         aspirate_x_position: {
           isIndeterminate: false,
+          value: undefined,
         },
         aspirate_y_position: {
           isIndeterminate: false,
+          value: undefined,
         },
         dispense_x_position: {
           isIndeterminate: false,
+          value: undefined,
         },
         dispense_y_position: {
           isIndeterminate: false,
+          value: undefined,
         },
         blowout_z_offset: {
           isIndeterminate: false,
+          value: undefined,
         },
         preWetTip: {
           isIndeterminate: true,
@@ -762,6 +789,14 @@ describe('_getSavedMultiSelectFieldValues', () => {
           isIndeterminate: false,
           value: -1,
         },
+        aspirate_submerge_delay_seconds: {
+          isIndeterminate: false,
+          value: undefined,
+        },
+        aspirate_submerge_speed: {
+          isIndeterminate: false,
+          value: undefined,
+        },
         // dispense settings
         dispense_labware: {
           isIndeterminate: true,
@@ -814,6 +849,14 @@ describe('_getSavedMultiSelectFieldValues', () => {
           isIndeterminate: false,
           value: -1,
         },
+        dispense_submerge_delay_seconds: {
+          isIndeterminate: false,
+          value: undefined,
+        },
+        dispense_submerge_speed: {
+          isIndeterminate: false,
+          value: undefined,
+        },
         blowout_checkbox: {
           isIndeterminate: true,
         },