fix(app): fix the function to retrieve Liquid Class values (#19465)

* fix(app): fix the function to retrieve Liquid Class values

Author: koji

app/src/local-resources/instruments/hooks/usePipetteSpecsv2.ts

@@ -1,4 +1,4 @@
-import { getPipetteSpecsV2 } from '@opentrons/shared-data'
+import { getPipetteModelSpecs, getPipetteSpecsV2 } from '@opentrons/shared-data'
 
 import { useIsOEMMode } from '/app/resources/robot-settings'
 
@@ -12,7 +12,18 @@ export function usePipetteSpecsV2(
   name?: PipetteName | PipetteModel
 ): PipetteV2Specs | null {
   const isOEMMode = useIsOEMMode()
-  const pipetteSpecs = getPipetteSpecsV2(name)
+
+  // If it's a PipetteModel (contains 'v'), convert to PipetteName first
+  let pipetteName: PipetteName | undefined
+  if (name && name.includes('v')) {
+    // This is a PipetteModel, get the PipetteName from it
+    const modelSpecs = getPipetteModelSpecs(name as PipetteModel)
+    pipetteName = modelSpecs?.name as PipetteName
+  } else {
+    pipetteName = name as PipetteName
+  }
+
+  const pipetteSpecs = getPipetteSpecsV2(pipetteName)
 
   if (pipetteSpecs == null) {
     return null

app/src/organisms/ODD/QuickTransferFlow/QuickTransferAdvancedSettings/BlowOut.tsx

@@ -15,6 +15,7 @@ import {
   StyledText,
 } from '@opentrons/components'
 import {
+  FLEX_ROBOT_TYPE,
   FLEX_SINGLE_SLOT_BY_CUTOUT_ID,
   getAllLiquidClassDefs,
   getFlexNameConversion,
@@ -284,6 +285,7 @@ export function BlowOut(props: BlowOutProps): JSX.Element {
     flowRateType: 'blowout',
     correctionVolume: correctionVolume ?? 0,
     shaftULperMM: state.pipette.shaftULperMM,
+    robotType: FLEX_ROBOT_TYPE,
   })
 
   const speedError =

app/src/organisms/ODD/QuickTransferFlow/utils/generateQuickTransferArgs.ts

@@ -57,7 +57,7 @@ function getOrderedWells(
   return intersection(allWellsOrdered, unorderedWells)
 }
 
-function getInvariantContextAndRobotState(
+export function getInvariantContextAndRobotState(
   quickTransferState: QuickTransferSummaryState
 ): { invariantContext: InvariantContext; robotState: RobotState } {
   const tipRackDefURI = getLabwareDefURI(quickTransferState.tipRack)

app/src/organisms/ODD/QuickTransferFlow/utils/getFlowRaiteFields.ts

@@ -0,0 +1,23 @@
+import min from 'lodash/min'
+
+import { linearInterpolate } from '@opentrons/shared-data'
+
+import type { LiquidHandlingPropertyByVolume } from '@opentrons/shared-data'
+
+export const getFlowRateFields = (
+  volume: number,
+  flowRateByVolume: LiquidHandlingPropertyByVolume,
+  liquidHandlingAction: 'aspirate' | 'dispense' | 'all',
+  hardwareMaximum: number | null = null
+): Record<string, number | null> => {
+  const interpolatedFlowRate = linearInterpolate(
+    volume,
+    flowRateByVolume as Array<[number, number]>
+  )
+  return {
+    [`${liquidHandlingAction}_flowRate`]:
+      hardwareMaximum != null
+        ? min([interpolatedFlowRate, hardwareMaximum]) ?? null
+        : interpolatedFlowRate,
+  }
+}

app/src/organisms/ODD/QuickTransferFlow/utils/getMatchingTipLiquidSpecsFromSpec.ts

@@ -0,0 +1,58 @@
+import { getAllLabwareDefs, LOW_VOLUME_PIPETTES } from '@opentrons/shared-data'
+
+import { getPipetteNameFromSpecs } from './getPipetteNameFromSpecs'
+
+import type { PipetteV2Specs, SupportedTip } from '@opentrons/shared-data'
+
+const LOW_PIPETTE_VOLUME = 5
+
+export function getMatchingTipLiquidSpecsFromSpec(
+  pipetteSpecs: PipetteV2Specs,
+  volume: number,
+  tiprackUri: string
+): SupportedTip {
+  const matchingLabwareDef = getAllLabwareDefs()[tiprackUri]
+  const pipetteName = getPipetteNameFromSpecs(pipetteSpecs)
+
+  console.assert(
+    matchingLabwareDef,
+    `expected to find a matching labware def with tiprack ${tiprackUri} but could not`
+  )
+
+  const tipLength = matchingLabwareDef?.parameters.tipLength ?? 0
+
+  if (tipLength === 0) {
+    console.error(
+      `expected to find a tiplength with tiprack ${
+        matchingLabwareDef?.metadata.displayName ?? 'unknown displayName'
+      } but could not`
+    )
+  }
+
+  const isLowVolumePipette = LOW_VOLUME_PIPETTES.includes(pipetteName)
+
+  const isUsingLowVolume = volume < LOW_PIPETTE_VOLUME
+  const liquidType =
+    isLowVolumePipette && isUsingLowVolume ? 'lowVolumeDefault' : 'default'
+
+  const liquidSupportedTips = Object.values(
+    pipetteSpecs.liquids[liquidType].supportedTips
+  )
+
+  //  find the supported tip liquid specs that either exactly match
+  //  tipLength or are closest, this accounts for custom tipracks
+  const matchingTipLiquidSpecs = liquidSupportedTips.sort((tipA, tipB) => {
+    const differenceA = Math.abs(tipA.defaultTipLength - tipLength)
+    const differenceB = Math.abs(tipB.defaultTipLength - tipLength)
+    return differenceA - differenceB
+  })[0]
+
+  console.assert(
+    matchingTipLiquidSpecs,
+    `expected to find the tip liquid specs but could not with pipette tiprack displayname ${
+      matchingLabwareDef?.metadata.displayName ?? 'unknown displayname'
+    }`
+  )
+
+  return matchingTipLiquidSpecs
+}

app/src/organisms/ODD/QuickTransferFlow/utils/getMaxUiFlowRate.ts

@@ -1,36 +1,63 @@
 import round from 'lodash/round'
 
-import type { PipetteChannels, SupportedTip } from '@opentrons/shared-data'
+import { FLEX_ROBOT_TYPE, OT2_ROBOT_TYPE } from '@opentrons/shared-data'
+
+import type {
+  PipetteChannels,
+  RobotType,
+  SupportedTip,
+} from '@opentrons/shared-data'
 
 type FlowRateType = 'aspirate' | 'dispense' | 'blowout'
 
-const FLEX_X_Y_MAX_SPEED = 300
-const FLEX_LOW_THROUGHPUT_Z_MAX_SPEED = 100
-const FLEX_HIGH_THROUGHPUT_Z_MAX_SPEED = 35
-const FLEX_LOW_THROUGHPUT_PLUNGER_MAX_SPEED = 70
-const FLEX_HIGH_THROUGHPUT_PLUNGER_MAX_SPEED = 15
+// Note(kk:2025-09-05): keep OT-2 values since we will move the same functions from (app&pd) to shared-data after the release
+export const FLEX_X_Y_MAX_SPEED = 300
+export const FLEX_LOW_THROUGHPUT_Z_MAX_SPEED = 100
+export const FLEX_HIGH_THROUGHPUT_Z_MAX_SPEED = 35
+export const FLEX_LOW_THROUGHPUT_PLUNGER_MAX_SPEED = 70
+export const FLEX_HIGH_THROUGHPUT_PLUNGER_MAX_SPEED = 15
+export const OT2_X_MAX_SPEED = 600
+export const OT2_Y_MAX_SPEED = 400
+export const OT2_Z_MAX_SPEED = 125
+export const OT2_PLUNGER_MAX_SPEED = 40
 
 const CHANNELS_MAPPED_TO_MAX_SPEED: Record<
-  number,
-  { plunger: number; x: number; y: number; z: number }
+  RobotType,
+  Record<number, { plunger: number; x: number; y: number; z: number }>
 > = {
-  1: {
-    plunger: FLEX_LOW_THROUGHPUT_PLUNGER_MAX_SPEED,
-    x: FLEX_X_Y_MAX_SPEED,
-    y: FLEX_X_Y_MAX_SPEED,
-    z: FLEX_LOW_THROUGHPUT_Z_MAX_SPEED,
-  },
-  8: {
-    plunger: FLEX_LOW_THROUGHPUT_PLUNGER_MAX_SPEED,
-    x: FLEX_X_Y_MAX_SPEED,
-    y: FLEX_X_Y_MAX_SPEED,
-    z: FLEX_LOW_THROUGHPUT_Z_MAX_SPEED,
+  [FLEX_ROBOT_TYPE]: {
+    1: {
+      plunger: FLEX_LOW_THROUGHPUT_PLUNGER_MAX_SPEED,
+      x: FLEX_X_Y_MAX_SPEED,
+      y: FLEX_X_Y_MAX_SPEED,
+      z: FLEX_LOW_THROUGHPUT_Z_MAX_SPEED,
+    },
+    8: {
+      plunger: FLEX_LOW_THROUGHPUT_PLUNGER_MAX_SPEED,
+      x: FLEX_X_Y_MAX_SPEED,
+      y: FLEX_X_Y_MAX_SPEED,
+      z: FLEX_LOW_THROUGHPUT_Z_MAX_SPEED,
+    },
+    96: {
+      plunger: FLEX_HIGH_THROUGHPUT_PLUNGER_MAX_SPEED,
+      x: FLEX_X_Y_MAX_SPEED,
+      y: FLEX_X_Y_MAX_SPEED,
+      z: FLEX_HIGH_THROUGHPUT_Z_MAX_SPEED,
+    },
   },
-  96: {
-    plunger: FLEX_HIGH_THROUGHPUT_PLUNGER_MAX_SPEED,
-    x: FLEX_X_Y_MAX_SPEED,
-    y: FLEX_X_Y_MAX_SPEED,
-    z: FLEX_HIGH_THROUGHPUT_Z_MAX_SPEED,
+  [OT2_ROBOT_TYPE]: {
+    1: {
+      plunger: OT2_PLUNGER_MAX_SPEED,
+      x: OT2_X_MAX_SPEED,
+      y: OT2_Y_MAX_SPEED,
+      z: OT2_Z_MAX_SPEED,
+    },
+    8: {
+      plunger: OT2_PLUNGER_MAX_SPEED,
+      x: OT2_X_MAX_SPEED,
+      y: OT2_Y_MAX_SPEED,
+      z: OT2_Z_MAX_SPEED,
+    },
   },
 }
 
@@ -42,6 +69,7 @@ const _getPipetteAccuracyUlPerMm = (args: {
   const { targetVolume, tipLiquidSpecs, flowRateType } = args
 
   const flowRateFunction = tipLiquidSpecs[flowRateType].default['1']
+
   let pipetteAccuracyUlPerMm = null
   for (let i = 0; i < flowRateFunction.length; i++) {
     const [x, y, z] = flowRateFunction[i]
@@ -51,7 +79,8 @@ const _getPipetteAccuracyUlPerMm = (args: {
     }
   }
   const lastEntry = flowRateFunction[flowRateFunction.length - 1]
-  return lastEntry[1] * targetVolume + lastEntry[2]
+  const result = lastEntry[1] * targetVolume + lastEntry[2]
+  return result
 }
 
 export const getMaxUiFlowRate = (args: {
@@ -61,6 +90,7 @@ export const getMaxUiFlowRate = (args: {
   flowRateType: FlowRateType
   correctionVolume: number
   shaftULperMM: number
+  robotType: RobotType
 }): number => {
   const {
     targetVolume,
@@ -69,19 +99,27 @@ export const getMaxUiFlowRate = (args: {
     flowRateType,
     correctionVolume,
     shaftULperMM,
+    robotType,
   } = args
 
-  const maxPlungerSpeed = CHANNELS_MAPPED_TO_MAX_SPEED[channels].plunger
+  const maxPlungerSpeed =
+    CHANNELS_MAPPED_TO_MAX_SPEED[robotType][channels].plunger
+
   if (flowRateType === 'blowout') {
-    return round(shaftULperMM * maxPlungerSpeed)
+    const result = round(shaftULperMM * maxPlungerSpeed)
+    return result
   }
+
   const pipetteAccuracyUlPerMm = _getPipetteAccuracyUlPerMm({
     targetVolume,
     tipLiquidSpecs,
     flowRateType,
   })
+
   const correctionMultiplier = 1.0 + correctionVolume / targetVolume
   const travelMm = targetVolume / pipetteAccuracyUlPerMm
   const travelMmCorrected = travelMm * correctionMultiplier
-  return round(targetVolume / (travelMmCorrected / maxPlungerSpeed))
+  const result = round(targetVolume / (travelMmCorrected / maxPlungerSpeed))
+
+  return result
 }

app/src/organisms/ODD/QuickTransferFlow/utils/getPipetteNameFromSpecs.ts

@@ -0,0 +1,21 @@
+import type { PipetteV2Specs } from '@opentrons/shared-data'
+
+export const getPipetteNameFromSpecs = (
+  pipetteSpecs: PipetteV2Specs
+): string => {
+  const { model, channels, displayCategory } = pipetteSpecs
+
+  const channelSuffix =
+    channels === 1
+      ? 'single'
+      : channels === 8
+      ? 'multi'
+      : channels === 96
+      ? '96'
+      : 'single'
+
+  // Note(kk:2025-09-05): This is used for Flex only
+  const robotSuffix = displayCategory === 'FLEX' && 'flex'
+
+  return `${model}_${channelSuffix}_${robotSuffix}`
+}