feat(app, shared-data, step-generation): frontend low volume support (#…

…13526) Front-end support for flex low volume closes RAUT-714 --------- Co-authored-by: Andy Sigler <[email protected]>
Opentrons · Sep 13, 2023 · 37f06a9 · 37f06a9
1 parent ccfed52
commit 37f06a9
Show file tree

Hide file tree

Showing 14 changed files with 372 additions and 131 deletions.
diff --git a/app/src/assets/localization/en/protocol_command_text.json b/app/src/assets/localization/en/protocol_command_text.json
@@ -1,6 +1,7 @@
 {
   "aspirate": "Aspirating {{volume}} µL from well {{well_name}} of {{labware}} in {{labware_location}} at {{flow_rate}} µL/sec",
   "blowout": "Blowing out at well {{well_name}} of {{labware}} in {{labware_location}} at {{flow_rate}} µL/sec",
+  "configure_for_volume": "Configure {{pipette}} to aspirate {{volume}} µL",
   "closing_tc_lid": "Closing Thermocycler lid",
   "comment": "Comment",
   "confirm_and_resume": "Confirm and resume",
@@ -12,6 +13,7 @@
   "degrees_c": "{{temp}}°C",
   "disengaging_magnetic_module": "Disengaging Magnetic Module",
   "dispense": "Dispensing {{volume}} µL into well {{well_name}} of {{labware}} in {{labware_location}} at {{flow_rate}} µL/sec",
+  "dispense_push_out": "Dispensing {{volume}} µL into well {{well_name}} of {{labware}} in {{labware_location}} at {{flow_rate}} µL/sec and pushing out {{push_out_volume}} µL",
   "drop_tip": "Dropping tip in {{well_name}} of {{labware}}",
   "engaging_magnetic_module": "Engaging Magnetic Module",
   "fixed_trash": "Fixed Trash",

diff --git a/app/src/organisms/CommandText/PipettingCommandText.tsx b/app/src/organisms/CommandText/PipettingCommandText.tsx
@@ -48,14 +48,23 @@ export const PipettingCommandText = ({
       })
     }
     case 'dispense': {
-      const { volume, flowRate } = command.params
-      return t('dispense', {
-        well_name: wellName,
-        labware: getLabwareName(robotSideAnalysis, labwareId),
-        labware_location: displayLocation,
-        volume: volume,
-        flow_rate: flowRate,
-      })
+      const { volume, flowRate, pushOut } = command.params
+      return pushOut
+        ? t('dispense_push_out', {
+            well_name: wellName,
+            labware: getLabwareName(robotSideAnalysis, labwareId),
+            labware_location: displayLocation,
+            volume: volume,
+            flow_rate: flowRate,
+            push_out_volume: pushOut,
+          })
+        : t('dispense', {
+            well_name: wellName,
+            labware: getLabwareName(robotSideAnalysis, labwareId),
+            labware_location: displayLocation,
+            volume: volume,
+            flow_rate: flowRate,
+          })
     }
     case 'blowout': {
       const { flowRate } = command.params

diff --git a/app/src/organisms/CommandText/__tests__/CommandText.test.tsx b/app/src/organisms/CommandText/__tests__/CommandText.test.tsx
@@ -5,7 +5,11 @@ import { CommandText } from '../'
 import { mockRobotSideAnalysis } from '../__fixtures__'
 
 import type { MoveToWellRunTimeCommand } from '@opentrons/shared-data/protocol/types/schemaV7/command/gantry'
-import type { BlowoutRunTimeCommand } from '@opentrons/shared-data/protocol/types/schemaV7/command/pipetting'
+import type {
+  BlowoutRunTimeCommand,
+  DispenseRunTimeCommand,
+  ConfigureForVolumeRunTimeCommand,
+} from '@opentrons/shared-data/protocol/types/schemaV7/command/pipetting'
 import type {
   LoadLabwareRunTimeCommand,
   LoadLiquidRunTimeCommand,
@@ -31,7 +35,7 @@ describe('CommandText', () => {
       )
     }
   })
-  it('renders correct text for dispense', () => {
+  it('renders correct text for dispense without pushOut', () => {
     const command = mockRobotSideAnalysis.commands.find(
       c => c.commandType === 'dispense'
     )
@@ -49,6 +53,31 @@ describe('CommandText', () => {
       )
     }
   })
+  it('renders correct text for dispense with pushOut', () => {
+    const command = mockRobotSideAnalysis.commands.find(
+      c => c.commandType === 'dispense'
+    )
+    const pushOutDispenseCommand = {
+      ...command,
+      params: {
+        ...command?.params,
+        pushOut: 10,
+      },
+    } as DispenseRunTimeCommand
+    expect(pushOutDispenseCommand).not.toBeUndefined()
+    if (pushOutDispenseCommand != null) {
+      const { getByText } = renderWithProviders(
+        <CommandText
+          robotSideAnalysis={mockRobotSideAnalysis}
+          command={pushOutDispenseCommand}
+        />,
+        { i18nInstance: i18n }
+      )[0]
+      getByText(
+        'Dispensing 100 µL into well A1 of NEST 96 Well Plate 100 µL PCR Full Skirt (1) in Magnetic Module GEN2 in Slot 1 at 300 µL/sec and pushing out 10 µL'
+      )
+    }
+  })
   it('renders correct text for blowout', () => {
     const dispenseCommand = mockRobotSideAnalysis.commands.find(
       c => c.commandType === 'dispense'
@@ -91,6 +120,24 @@ describe('CommandText', () => {
       getByText('Moving to well A1 of NEST 1 Well Reservoir 195 mL in Slot 5')
     }
   })
+  it('renders correct text for configureForVolume', () => {
+    const command = {
+      commandType: 'configureForVolume',
+      params: {
+        volume: 1,
+        pipetteId: 'f6d1c83c-9d1b-4d0d-9de3-e6d649739cfb',
+      },
+    } as ConfigureForVolumeRunTimeCommand
+
+    const { getByText } = renderWithProviders(
+      <CommandText
+        robotSideAnalysis={mockRobotSideAnalysis}
+        command={command}
+      />,
+      { i18nInstance: i18n }
+    )[0]
+    getByText('Configure P300 Single-Channel GEN1 to aspirate 1 µL')
+  })
   it('renders correct text for dropTip', () => {
     const command = mockRobotSideAnalysis.commands.find(
       c => c.commandType === 'dropTip'

diff --git a/app/src/organisms/CommandText/index.tsx b/app/src/organisms/CommandText/index.tsx
@@ -2,13 +2,13 @@ import * as React from 'react'
 import { useTranslation } from 'react-i18next'
 
 import { Flex, DIRECTION_COLUMN, SPACING } from '@opentrons/components'
+import { getPipetteNameSpecs, RunTimeCommand } from '@opentrons/shared-data'
 import { StyledText } from '../../atoms/text'
 import { LoadCommandText } from './LoadCommandText'
 import { PipettingCommandText } from './PipettingCommandText'
 import { TemperatureCommandText } from './TemperatureCommandText'
 import { MoveLabwareCommandText } from './MoveLabwareCommandText'
 
-import type { RunTimeCommand } from '@opentrons/shared-data'
 import type { CompletedProtocolAnalysis } from '@opentrons/shared-data/js'
 import type { StyleProps } from '@opentrons/components'
 
@@ -139,6 +139,24 @@ export function CommandText(props: Props): JSX.Element | null {
         </StyledText>
       )
     }
+    case 'configureForVolume': {
+      const { volume, pipetteId } = command.params
+      const pipetteName = robotSideAnalysis.pipettes.find(
+        pip => pip.id === pipetteId
+      )?.pipetteName
+
+      return (
+        <StyledText as="p" {...styleProps}>
+          {t('configure_for_volume', {
+            volume,
+            pipette:
+              pipetteName != null
+                ? getPipetteNameSpecs(pipetteName)?.displayName
+                : '',
+          })}
+        </StyledText>
+      )
+    }
     case 'touchTip':
     case 'home':
     case 'savePosition':