feat(protocol-designer, components): add retract for aspirate and dispense to PD

components/src/atoms/ListButton/ListButton.stories.tsx

@@ -16,7 +16,7 @@ const meta: Meta<typeof ListButtonComponent> = {
     type: {
       control: {
         type: 'select',
-        options: ['noActive', 'success', 'warning'],
+        options: ['noActive', 'success', 'warning', 'onColor'],
       },
     },
   },

components/src/atoms/ListButton/__tests__/ListButton.test.tsx

@@ -39,6 +39,12 @@ describe('ListButton', () => {
     const listButton = screen.getByTestId('ListButton_notConnected')
     expect(listButton).toHaveStyle(`backgroundColor: ${COLORS.yellow30}`)
   })
+  it('should render correct style - onColor', () => {
+    props.type = 'onColor'
+    render(props)
+    const listButton = screen.getByTestId('ListButton_onColor')
+    expect(listButton).toHaveStyle(`backgroundColor: ${COLORS.white}`)
+  })
   it('should call on click when pressed', () => {
     render(props)
     fireEvent.click(screen.getByText('mock ListButton content'))

components/src/atoms/ListButton/index.tsx

@@ -75,7 +75,7 @@ export function ListButton(props: ListButtonProps): JSX.Element {
 
     &:focus-visible {
       outline: 2px solid ${COLORS.blue50};
-      outline-offset: 0.25rem;
+      outline-offset: 0.125rem;
     }
   `
 

protocol-designer/fixtures/protocol/8/doItAllV3MigratedToV8.json

@@ -149,6 +149,11 @@
           "aspirate_mix_times": "2",
           "aspirate_mix_volume": "30",
           "aspirate_mmFromBottom": 1,
+          "aspirate_retract_delay_seconds": null,
+          "aspirate_retract_mmFromBottom": null,
+          "aspirate_retract_speed": null,
+          "aspirate_retract_x_position": 0,
+          "aspirate_retract_y_position": 0,
           "aspirate_submerge_delay_seconds": null,
           "aspirate_submerge_speed": null,
           "aspirate_touchTip_checkbox": true,
@@ -176,6 +181,11 @@
           "dispense_mix_times": null,
           "dispense_mix_volume": null,
           "dispense_mmFromBottom": 0.5,
+          "dispense_retract_delay_seconds": null,
+          "dispense_retract_mmFromBottom": null,
+          "dispense_retract_speed": null,
+          "dispense_retract_x_position": 0,
+          "dispense_retract_y_position": 0,
           "dispense_submerge_delay_seconds": null,
           "dispense_submerge_speed": null,
           "dispense_touchTip_checkbox": true,

protocol-designer/fixtures/protocol/8/doItAllV4MigratedToV8.json

@@ -181,6 +181,11 @@
           "aspirate_mix_times": null,
           "aspirate_mix_volume": null,
           "aspirate_mmFromBottom": 1,
+          "aspirate_retract_delay_seconds": null,
+          "aspirate_retract_mmFromBottom": null,
+          "aspirate_retract_speed": null,
+          "aspirate_retract_x_position": 0,
+          "aspirate_retract_y_position": 0,
           "aspirate_submerge_delay_seconds": null,
           "aspirate_submerge_speed": null,
           "aspirate_touchTip_checkbox": false,
@@ -208,6 +213,11 @@
           "dispense_mix_times": null,
           "dispense_mix_volume": null,
           "dispense_mmFromBottom": 0.5,
+          "dispense_retract_delay_seconds": null,
+          "dispense_retract_mmFromBottom": null,
+          "dispense_retract_speed": null,
+          "dispense_retract_x_position": 0,
+          "dispense_retract_y_position": 0,
           "dispense_submerge_delay_seconds": null,
           "dispense_submerge_speed": null,
           "dispense_touchTip_checkbox": false,

protocol-designer/fixtures/protocol/8/doItAllV7MigratedToV8.json

@@ -199,6 +199,11 @@
           "aspirate_mix_times": null,
           "aspirate_mix_volume": null,
           "aspirate_mmFromBottom": null,
+          "aspirate_retract_delay_seconds": null,
+          "aspirate_retract_mmFromBottom": null,
+          "aspirate_retract_speed": null,
+          "aspirate_retract_x_position": 0,
+          "aspirate_retract_y_position": 0,
           "aspirate_submerge_delay_seconds": null,
           "aspirate_submerge_speed": null,
           "aspirate_touchTip_checkbox": false,
@@ -226,6 +231,11 @@
           "dispense_mix_times": null,
           "dispense_mix_volume": null,
           "dispense_mmFromBottom": null,
+          "dispense_retract_delay_seconds": null,
+          "dispense_retract_mmFromBottom": null,
+          "dispense_retract_speed": null,
+          "dispense_retract_x_position": 0,
+          "dispense_retract_y_position": 0,
           "dispense_submerge_delay_seconds": null,
           "dispense_submerge_speed": null,
           "dispense_touchTip_checkbox": false,

protocol-designer/fixtures/protocol/8/doItAllV8.json

@@ -162,6 +162,11 @@
           "aspirate_mix_times": null,
           "aspirate_mix_volume": null,
           "aspirate_mmFromBottom": null,
+          "aspirate_retract_delay_seconds": null,
+          "aspirate_retract_mmFromBottom": null,
+          "aspirate_retract_speed": null,
+          "aspirate_retract_x_position": 0,
+          "aspirate_retract_y_position": 0,
           "aspirate_submerge_delay_seconds": null,
           "aspirate_submerge_speed": null,
           "aspirate_touchTip_checkbox": false,
@@ -189,6 +194,11 @@
           "dispense_mix_times": null,
           "dispense_mix_volume": null,
           "dispense_mmFromBottom": null,
+          "dispense_retract_delay_seconds": null,
+          "dispense_retract_mmFromBottom": null,
+          "dispense_retract_speed": null,
+          "dispense_retract_x_position": 0,
+          "dispense_retract_y_position": 0,
           "dispense_submerge_delay_seconds": null,
           "dispense_submerge_speed": null,
           "dispense_touchTip_checkbox": false,

protocol-designer/fixtures/protocol/8/example_1_1_0MigratedToV8.json

@@ -119,6 +119,11 @@
           "aspirate_mix_times": 3,
           "aspirate_mix_volume": "2",
           "aspirate_mmFromBottom": 1,
+          "aspirate_retract_delay_seconds": null,
+          "aspirate_retract_mmFromBottom": null,
+          "aspirate_retract_speed": null,
+          "aspirate_retract_x_position": 0,
+          "aspirate_retract_y_position": 0,
           "aspirate_submerge_delay_seconds": null,
           "aspirate_submerge_speed": null,
           "aspirate_touchTip_checkbox": true,
@@ -146,6 +151,11 @@
           "dispense_mix_times": 2,
           "dispense_mix_volume": "3",
           "dispense_mmFromBottom": 2.5,
+          "dispense_retract_delay_seconds": null,
+          "dispense_retract_mmFromBottom": null,
+          "dispense_retract_speed": null,
+          "dispense_retract_x_position": 0,
+          "dispense_retract_y_position": 0,
           "dispense_submerge_delay_seconds": null,
           "dispense_submerge_speed": null,
           "dispense_touchTip_checkbox": true,

protocol-designer/fixtures/protocol/8/newAdvancedSettingsAndMultiTemp.json

@@ -63,6 +63,11 @@
           "aspirate_mix_times": null,
           "aspirate_mix_volume": null,
           "aspirate_mmFromBottom": 29,
+          "aspirate_retract_delay_seconds": null,
+          "aspirate_retract_mmFromBottom": null,
+          "aspirate_retract_speed": null,
+          "aspirate_retract_x_position": 0,
+          "aspirate_retract_y_position": 0,
           "aspirate_submerge_delay_seconds": null,
           "aspirate_submerge_speed": null,
           "aspirate_touchTip_checkbox": false,
@@ -90,6 +95,11 @@
           "dispense_mix_times": null,
           "dispense_mix_volume": null,
           "dispense_mmFromBottom": null,
+          "dispense_retract_delay_seconds": null,
+          "dispense_retract_mmFromBottom": null,
+          "dispense_retract_speed": null,
+          "dispense_retract_x_position": 0,
+          "dispense_retract_y_position": 0,
           "dispense_submerge_delay_seconds": null,
           "dispense_submerge_speed": null,
           "dispense_touchTip_checkbox": false,

protocol-designer/fixtures/protocol/8/ninetySixChannelFullAndColumn.json

@@ -62,6 +62,11 @@
           "aspirate_mix_times": null,
           "aspirate_mix_volume": null,
           "aspirate_mmFromBottom": null,
+          "aspirate_retract_delay_seconds": null,
+          "aspirate_retract_mmFromBottom": null,
+          "aspirate_retract_speed": null,
+          "aspirate_retract_x_position": 0,
+          "aspirate_retract_y_position": 0,
           "aspirate_submerge_delay_seconds": null,
           "aspirate_submerge_speed": null,
           "aspirate_touchTip_checkbox": false,
@@ -89,6 +94,11 @@
           "dispense_mix_times": null,
           "dispense_mix_volume": null,
           "dispense_mmFromBottom": null,
+          "dispense_retract_delay_seconds": null,
+          "dispense_retract_mmFromBottom": null,
+          "dispense_retract_speed": null,
+          "dispense_retract_x_position": 0,
+          "dispense_retract_y_position": 0,
           "dispense_submerge_delay_seconds": null,
           "dispense_submerge_speed": null,
           "dispense_touchTip_checkbox": false,
@@ -126,6 +136,11 @@
           "aspirate_mix_times": null,
           "aspirate_mix_volume": null,
           "aspirate_mmFromBottom": null,
+          "aspirate_retract_delay_seconds": null,
+          "aspirate_retract_mmFromBottom": null,
+          "aspirate_retract_speed": null,
+          "aspirate_retract_x_position": 0,
+          "aspirate_retract_y_position": 0,
           "aspirate_submerge_delay_seconds": null,
           "aspirate_submerge_speed": null,
           "aspirate_touchTip_checkbox": false,
@@ -153,6 +168,11 @@
           "dispense_mix_times": null,
           "dispense_mix_volume": null,
           "dispense_mmFromBottom": null,
+          "dispense_retract_delay_seconds": null,
+          "dispense_retract_mmFromBottom": null,
+          "dispense_retract_speed": null,
+          "dispense_retract_x_position": 0,
+          "dispense_retract_y_position": 0,
           "dispense_submerge_delay_seconds": null,
           "dispense_submerge_speed": null,
           "dispense_touchTip_checkbox": false,

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

@@ -103,7 +103,9 @@
       "dispense_touchTip_mmFromTop": "Change from where in the well the robot performs the touch tip.",
       "mix_touchTip_mmFromTop": "Change from where in the well the robot performs the touch tip.",
       "aspirate_delay_mmFromBottom": "Change from where in the well the robot delays after aspirating.",
-      "dispense_delay_mmFromBottom": "Change from where in the well the robot delays after dispensing."
+      "dispense_delay_mmFromBottom": "Change from where in the well the robot delays after dispensing.",
+      "aspirate_retract_mmFromBottom": "Change where in the well the robot retracts the tip to.",
+      "dispense_retract_mmFromBottom": "Change where in the well the robot retracts the tip from."
     },
     "field_titles": {
       "z_position": "Z position",

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

@@ -86,6 +86,8 @@
   "protocol_timeline": "Protocol timeline",
   "rename": "Rename",
   "rename_error": "Oops! Your step name is too long.",
+  "retract": "Retract",
+  "retract_speed": "Retract speed",
   "save_errors": "{{stepType}} has been saved with {{numErrors}} error(s)",
   "save_no_errors": "{{stepType}} has been saved",
   "save_warnings": "{{stepType}} has been saved with {{numWarnings}} warning(s)",
@@ -148,5 +150,6 @@
   "well_order_title": "{{prefix}} well order",
   "well_position": "Well position: X {{x}} Y {{y}} Z {{z}} (mm)",
   "well_position_z_only": "Well position: Z {{z}} (mm)",
+  "well_position_xyz": "Well position (x,y,z): {{x}}mm, {{y}}mm, {{z}}mm",
   "unknown_module": "Unknown module"
 }

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

@@ -37,6 +37,8 @@
       "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_retract": "Withdraw the tip from the liquid after aspirating",
+      "aspirate_retract_mmFromBottom": "Adjust tip position for retract after aspirate",
       "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",
@@ -51,6 +53,8 @@
       "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_retract": "Withdraw the tip from the liquid after dispensing",
+      "dispense_retract_mmFromBottom": "Adjust tip position for retract after 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",

protocol-designer/src/form-types.ts

@@ -32,6 +32,11 @@ export type StepFieldName = string
 // | 'aspirate_mix_times'
 // | 'aspirate_mix_volume'
 // | 'aspirate_mmFromBottom'
+// | 'aspirate_retract_delay_seconds'
+// | 'aspirate_retract_mmFromBottom'
+// | 'aspirate_retract_speed'
+// | 'aspirate_retract_x_position'
+// | 'aspirate_retract_y_position'
 // | 'aspirate_submerge_delay_seconds'
 // | 'aspirate_submerge_speed'
 // | 'aspirate_touchTip_checkbox'
@@ -53,6 +58,11 @@ export type StepFieldName = string
 // | 'dispense_mix_times'
 // | 'dispense_mix_volume'
 // | 'dispense_mmFromBottom'
+// | 'dispense_retract_delay_seconds'
+// | 'dispense_retract_mmFromBottom'
+// | 'dispense_retract_speed'
+// | 'dispense_retract_x_position'
+// | 'dispense_retract_y_position'
 // | 'dispense_submerge_delay_seconds'
 // | 'dispense_submerge_speed'
 // | 'dispense_touchTip_checkbox'
@@ -256,6 +266,11 @@ export interface HydratedMoveLiquidFormData extends AnnotationFields {
   aspirate_mix_times?: number | null
   aspirate_mix_volume?: number | null
   aspirate_mmFromBottom?: number | null
+  aspirate_retract_delay_seconds?: number | null
+  aspirate_retract_mmFromBottom?: number | null
+  aspirate_retract_speed?: number | null
+  aspirate_retract_x_position?: number | null
+  aspirate_retract_y_position?: number | null
   aspirate_submerge_delay_seconds?: number | null
   aspirate_submerge_speed?: number | null
   aspirate_touchTip_mmFromTop?: number | null
@@ -273,6 +288,11 @@ export interface HydratedMoveLiquidFormData extends AnnotationFields {
   dispense_mix_times?: number | null
   dispense_mix_volume?: number | null
   dispense_mmFromBottom?: number | null
+  dispense_retract_delay_seconds?: number | null
+  dispense_retract_mmFromBottom?: number | null
+  dispense_retract_speed?: number | null
+  dispense_retract_x_position?: number | null
+  dispense_retract_y_position?: number | null
   dispense_submerge_delay_seconds?: number | null
   dispense_submerge_speed?: number | null
   dispense_touchTip_mmFromTop?: number | null
@@ -413,16 +433,22 @@ export type TipZOffsetFields =
   | 'aspirate_delay_mmFromBottom'
   | 'dispense_delay_mmFromBottom'
   | 'mix_touchTip_mmFromTop'
+  | 'aspirate_retract_mmFromBottom'
+  | 'dispense_retract_mmFromBottom'
 
 export type TipYOffsetFields =
   | 'aspirate_y_position'
   | 'dispense_y_position'
   | 'mix_y_position'
+  | 'aspirate_retract_y_position'
+  | 'dispense_retract_y_position'
 
 export type TipXOffsetFields =
   | 'aspirate_x_position'
   | 'dispense_x_position'
   | 'mix_x_position'
+  | 'aspirate_retract_x_position'
+  | 'dispense_retract_x_position'
 
 export type DelayCheckboxFields =
   | 'aspirate_delay_checkbox'

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

@@ -96,6 +96,10 @@
                     matchingDispenseLabwareWellDepth,
                   1
                 ),
+          aspirate_retract_delay_seconds: null,
+          dispense_retract_delay_seconds: null,
+          aspirate_retract_speed: null,
+          dispense_retract_speed: null,
           aspirate_submerge_delay_seconds: null,
           dispense_submerge_delay_seconds: null,
           aspirate_submerge_speed: null,

protocol-designer/src/organisms/TipPositionModal/index.tsx

@@ -17,6 +17,7 @@ import {
   InputField,
   TYPOGRAPHY,
 } from '@opentrons/components'
+import { prefixMap } from '../../resources/utils'
 import { getIsTouchTipField } from '../../form-types'
 import { LINK_BUTTON_STYLE } from '../../atoms'
 import { getMainPagePortalEl } from '../Portal'
@@ -238,7 +239,7 @@ export function TipPositionModal(
       type="info"
       width="37.125rem"
       closeOnOutsideClick
-      title={t('shared:tip_position', { prefix })}
+      title={t('shared:tip_position', { prefix: prefixMap[prefix] })}
       onClose={handleCancel}
       footer={
         <Flex

protocol-designer/src/organisms/TipPositionModal/utils.tsx

@@ -17,6 +17,8 @@ export function getDefaultMmFromEdge(args: { name: StepFieldName }): number {
     case 'dispense_delay_mmFromBottom':
     case 'aspirate_delay_mmFromBottom':
     case 'aspirate_mmFromBottom':
+    case 'aspirate_retract_mmFromBottom':
+    case 'dispense_retract_mmFromBottom':
       return DEFAULT_MM_OFFSET_FROM_BOTTOM
 
     default: