add in hopper location for getLabwareDisplayLocation

Author: ahiuchingau

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

@@ -93,6 +93,7 @@
   "single": "single",
   "single_nozzle_layout": "single nozzle layout",
   "slot": "Slot {{slot_name}}",
+  "stacker_hopper_display": "Stacker {{row}}",
   "target_temperature": "target temperature",
   "tc_awaiting_for_duration": "Waiting for Thermocycler profile to complete",
   "tc_run_profile_steps": "Temperature: {{celsius}}°C, hold time: {{duration}}",

components/src/organisms/CommandText/useCommandTextString/utils/__tests__/getLabwareDisplayLocation.test.tsx

@@ -268,6 +268,50 @@ describe('getLabwareDisplayLocation with translations', () => {
             }
           })
         })
+
+        detailLevels.forEach(detailLevel => {
+          it(`should handle labware on a stacker module with detailLevel "${detailLevel}"`, () => {
+            const locationSequence: LabwareLocationSequence = [
+              { kind: 'onAddressableArea', addressableAreaName: 'flexStackerModuleV1D4' },
+              { kind: 'onModule', moduleId: 'mockModuleId' },
+              {
+                kind: 'onCutoutFixture',
+                cutoutId: 'cutoutD3',
+                possibleCutoutFixtureIds: ['flexStackerModuleV1WithWasteChuteRightAdapterNoCover']
+              }]
+            vi.mocked(getModuleModel).mockReturnValue('flexStackerModuleV1')
+            vi.mocked(getModuleDisplayLocation).mockReturnValue('D3')
+            vi.mocked(getModuleDisplayName).mockReturnValue('Flex Stacker')
+            vi.mocked(getModuleType).mockReturnValue('flexStackerModuleType')
+
+            render({
+              location: locationSequence,
+              params: { ...defaultParams, detailLevel }
+            })
+
+            screen.getByText('Slot D4')
+          })
+        })
+
+        detailLevels.forEach(detailLevel => {
+          it(`should handle labware in stacker hopper with detailLevel "${detailLevel}"`, () => {
+            const locationSequence: LabwareLocationSequence = [
+              { kind: "inStackerHopper", moduleId: "UUID" }
+            ]
+
+            vi.mocked(getModuleModel).mockReturnValue('flexStackerModuleV1')
+            vi.mocked(getModuleDisplayLocation).mockReturnValue('D3')
+            vi.mocked(getModuleDisplayName).mockReturnValue('Flex Stacker')
+            vi.mocked(getModuleType).mockReturnValue('flexStackerModuleType')
+
+            render({
+              location: locationSequence,
+              params: { ...defaultParams, detailLevel }
+            })
+
+            screen.getByText('Stacker D')
+          })
+        })
       })
 
       describe('labware on another labware', () => {
@@ -448,4 +492,3 @@ describe('getLabwareDisplayLocation with translations', () => {
     })
   })
 })
-

components/src/organisms/CommandText/useCommandTextString/utils/getLabwareDisplayLocation.tsx

@@ -1,8 +1,9 @@
 import {
-  FLEX_STACKER_MODULE_V1,
+  FLEX_STACKER_MODULE_TYPE,
   getModuleDisplayName,
   getModuleType,
   getOccludedSlotCountForModule,
+  getModuleDeckLabel,
   MOVABLE_TRASH_ADDRESSABLE_AREAS,
   THERMOCYCLER_MODULE_V1,
   THERMOCYCLER_MODULE_V2,
@@ -51,23 +52,18 @@ export function getLabwareDisplayLocation(
   const { t, isOnDevice = false, location } = params
   const locationResult = Array.isArray(location)
     ? getLabwareLocationFromSequence({
-        ...params,
-        locationSequence: location,
-      })
+      ...params,
+      locationSequence: location,
+    })
     : getLabwareLocation({
-        ...params,
-        location: location ?? null,
-      })
+      ...params,
+      location: location ?? null,
+    })
   if (locationResult == null) {
     return ''
   }
 
-  const { slotName: initialSlotName, moduleModel, adapterName } = locationResult
-  const slotName =
-    moduleModel === THERMOCYCLER_MODULE_V1 ||
-    moduleModel === THERMOCYCLER_MODULE_V2
-      ? 'A1+B1'
-      : initialSlotName
+  const { slotName, moduleModel, adapterName } = locationResult
 
   if (slotName === 'offDeck' || slotName === 'systemLocation') {
     return t('off_deck')
@@ -83,37 +79,26 @@ export function getLabwareDisplayLocation(
   }
   // Module location without adapter
   else if (moduleModel != null && adapterName == null) {
+    const moduleSlot = getModuleDeckLabel(getModuleType(moduleModel), slotName)
+    if (getModuleType(moduleModel) === FLEX_STACKER_MODULE_TYPE) {
+      // in hopper location always return Stacker {{row}}
+      return t('stacker_hopper_display', {
+        row: getSlotRow(moduleSlot as string),
+      })
+    }
     if (params.detailLevel === 'slot-only') {
-      switch (moduleModel) {
-        case THERMOCYCLER_MODULE_V1:
-        case THERMOCYCLER_MODULE_V2:
-          return t('slot', { slot_name: 'A1+B1' })
-        case FLEX_STACKER_MODULE_V1:
-          return t('stacker_display_name', {
-            stacker_slot: getSlotColumn(slotName),
-          })
-        default:
-          return t('slot', { slot_name: slotName })
-      }
-    } else {
-      switch (moduleModel) {
-        case FLEX_STACKER_MODULE_V1:
-          return t('stacker_column_display_name', {
-            stacker_slot: getSlotColumn(slotName),
-          })
-        default:
-          return isOnDevice
-            ? `${getModuleDisplayName(moduleModel)}, ${slotName}`
-            : t('module_in_slot', {
-                count: getOccludedSlotCountForModule(
-                  getModuleType(moduleModel),
-                  params.robotType
-                ),
-                module: getModuleDisplayName(moduleModel),
-                slot_name: slotName,
-              })
-      }
+      return t('slot', { slot_name: moduleSlot })
     }
+    return isOnDevice
+      ? `${getModuleDisplayName(moduleModel)}, ${moduleSlot}`
+      : t('module_in_slot', {
+        count: getOccludedSlotCountForModule(
+          getModuleType(moduleModel),
+          params.robotType
+        ),
+        module: getModuleDisplayName(moduleModel),
+        slot_name: moduleSlot,
+      })
   }
   // Adapter locations
   else if (adapterName != null) {
@@ -138,7 +123,7 @@ export function getLabwareDisplayLocation(
   }
 }
 
-function getSlotColumn(slotName: string): string {
+function getSlotRow(slotName: string): string {
   return slotName.charAt(0)
 }
 

components/src/organisms/CommandText/useCommandTextString/utils/getLabwareLocation.tsx

@@ -130,6 +130,15 @@ export function getLabwareLocationFromSequence(
                 : moduleModel ?? undefined,
           }
         }
+      } else if (sequenceItem.kind === 'inStackerHopper') {
+        return {
+          ...acc,
+          slotName: getModuleDisplayLocation(
+            loadedModules,
+            sequenceItem.moduleId
+          ),
+          moduleModel: getModuleModel(loadedModules, sequenceItem.moduleId),
+        }
       }
       // TODO(tz, 4-16-25): add inHopperLocation when logic is merged
       else if (detailLevel === 'full') {