feat(shared-data, app): add configureNozzleLayout command type in run log

app/src/assets/localization/en/protocol_command_text.json

@@ -6,6 +6,7 @@
   "closing_tc_lid": "Closing Thermocycler lid",
   "comment": "Comment",
   "configure_for_volume": "Configure {{pipette}} to aspirate {{volume}} µL",
+  "configure_nozzle_layout": "Configure {{pipette}} to use {{amount}} nozzles",
   "confirm_and_resume": "Confirm and resume",
   "deactivate_hs_shake": "Deactivating shaker",
   "deactivate_temperature_module": "Deactivating Temperature Module",
@@ -37,7 +38,7 @@
   "opening_tc_lid": "Opening Thermocycler lid",
   "pause_on": "Pause on {{robot_name}}",
   "pause": "Pause",
-  "pickup_tip": "Picking up tip from {{well_name}} of {{labware}} in {{labware_location}}",
+  "pickup_tip": "Picking up tip(s) from {{well_range}} of {{labware}} in {{labware_location}}",
   "prepare_to_aspirate": "Preparing {{pipette}} to aspirate",
   "return_tip": "Returning tip to {{well_name}} of {{labware}} in {{labware_location}}",
   "save_position": "Saving position",

app/src/organisms/CommandText/PipettingCommandText.tsx

@@ -16,6 +16,7 @@
   getLabwareName,
   getLabwareDisplayLocation,
   getFinalLabwareLocation,
+  getWellRange,
 } from './utils'
 
 type PipettingRunTimeCommmand =
@@ -122,8 +123,18 @@
           })
     }
     case 'pickUpTip': {
+      const pipetteId = command.params.pipetteId
+      const pipetteName = robotSideAnalysis.pipettes.find(
+        pip => pip.id === pipetteId
+      )?.pipetteName
+
       return t('pickup_tip', {
-        well_name: wellName,
+        well_range: getWellRange(
+          pipetteId,
+          pipetteName,
+          allPreviousCommands,
+          wellName
+        ),
         labware: getLabwareName(robotSideAnalysis, labwareId),
         labware_location: displayLocation,
       })

app/src/organisms/CommandText/__tests__/CommandText.test.tsx

@@ -219,7 +219,7 @@ describe('CommandText', () => {
         { i18nInstance: i18n }
       )[0]
       getByText(
-        'Picking up tip from A1 of Opentrons 96 Tip Rack 300 µL in Slot 9'
+        'Picking up tip(s) from A1 of Opentrons 96 Tip Rack 300 µL in Slot 9'
       )
     }
   })

app/src/organisms/CommandText/index.tsx

@@ -165,6 +165,25 @@
         </StyledText>
       )
     }
+    case 'configureNozzleLayout': {
+      const { configuration_params, pipetteId } = command.params
+      const pipetteName = robotSideAnalysis.pipettes.find(
+        pip => pip.id === pipetteId
+      )?.pipetteName
+
+      // TODO (sb, 11/9/23): Add support for other configurations when needed
+      return (
+        <StyledText as="p" {...styleProps}>
+          {t('configure_nozzle_layout', {
+            amount: configuration_params.style === 'COLUMN' ? '8' : 'all',
+            pipette:
+              pipetteName != null
+                ? getPipetteNameSpecs(pipetteName)?.displayName
+                : '',
+          })}
+        </StyledText>
+      )
+    }
     case 'prepareToAspirate': {
       const { pipetteId } = command.params
       const pipetteName = robotSideAnalysis.pipettes.find(

app/src/organisms/CommandText/utils/getWellRange.ts

@@ -0,0 +1,44 @@
+import {
+  getPipetteNameSpecs,
+  PipetteName,
+  RunTimeCommand,
+} from '@opentrons/shared-data'
+
+/**
+ * @param pipetteName name of pipette being used
+ * @param commands list of commands to search within
+ * @param wellName the target well for pickup tip
+ * @returns WellRange string of wells pipette will pickup tips from
+ */
+export function getWellRange(
+  pipetteId: string,
+  pipetteName: PipetteName,
+  commands: RunTimeCommand[],
+  wellName: string
+): string {
+  const pipetteChannels = getPipetteNameSpecs(pipetteName)?.channels ?? 1
+  let usedChannels = pipetteChannels
+  if (pipetteChannels === 96) {
+    for (const c of commands.reverse()) {
+      if (
+        c.commandType === 'configureNozzleLayout' &&
+        c.params?.pipetteId === pipetteId
+      ) {
+        // TODO(sb, 11/9/23): add support for quadrant and row configurations when needed
+        if (c.params.configuration_params.style === 'SINGLE') {
+          usedChannels = 1
+        } else if (c.params.configuration_params.style === 'COLUMN') {
+          usedChannels = 8
+        }
+        break
+      }
+    }
+  }
+  if (usedChannels === 96) {
+    return 'A1 - H12'
+  } else if (usedChannels === 8) {
+    const column = wellName.substr(1)
+    return `A${column} - H${column}`
+  }
+  return wellName
+}

app/src/organisms/CommandText/utils/index.ts

@@ -5,3 +5,4 @@ export * from './getModuleDisplayLocation'
 export * from './getLiquidDisplayName'
 export * from './getLabwareDisplayLocation'
 export * from './getFinalLabwareLocation'
+export * from './getWellRange'

shared-data/command/types/setup.ts

@@ -71,13 +71,26 @@ export interface LoadFixtureRunTimeCommand
   result?: LoadLabwareResult
 }
 
+export interface ConfigureNozzleLayoutCreateCommand
+  extends CommonCommandCreateInfo {
+  commandType: 'configureNozzleLayout'
+  params: ConfigureNozzleLayoutParams
+}
+
+export interface ConfigureNozzleLayoutRunTimeCommand
+  extends CommonCommandRunTimeInfo,
+    ConfigureNozzleLayoutCreateCommand {
+  result?: {}
+}
+
 export type SetupRunTimeCommand =
   | LoadPipetteRunTimeCommand
   | LoadLabwareRunTimeCommand
   | LoadFixtureRunTimeCommand
   | LoadModuleRunTimeCommand
   | LoadLiquidRunTimeCommand
   | MoveLabwareRunTimeCommand
+  | ConfigureNozzleLayoutRunTimeCommand
 
 export type SetupCreateCommand =
   | LoadPipetteCreateCommand
@@ -86,6 +99,7 @@ export type SetupCreateCommand =
   | LoadModuleCreateCommand
   | LoadLiquidCreateCommand
   | MoveLabwareCreateCommand
+  | ConfigureNozzleLayoutCreateCommand
 
 export type LabwareLocation =
   | 'offDeck'
@@ -161,3 +175,26 @@ interface LoadFixtureParams {
   loadName: FixtureLoadName
   fixtureId?: string
 }
+
+const COLUMN = 'COLUMN'
+const SINGLE = 'SINGLE'
+const ROW = 'ROW'
+const QUADRANT = 'QUADRANT'
+const EMPTY = 'EMPTY'
+
+export type NozzleConfigurationStyle =
+  | typeof COLUMN
+  | typeof SINGLE
+  | typeof ROW
+  | typeof QUADRANT
+  | typeof EMPTY
+
+interface NozzleConfigurationParams {
+  primary_nozzle: string
+  style: NozzleConfigurationStyle
+}
+
+interface ConfigureNozzleLayoutParams {
+  pipetteId: string
+  configuration_params: NozzleConfigurationParams
+}