feature(app): get command text for flex stacker commands

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

@@ -22,6 +22,14 @@
   "estop_pressed_description": "First, safely clear the deck of any labware or spills. Then, twist the E-stop button clockwise. Finally, have the robot move the gantry to its home position.",
   "find_your_robot": "Find your robot in the Devices section of the app to install software updates.",
   "firmware_update_download_logs": "Contact support for assistance.",
+  "flex_stacker_empty": "Manually empty all labware from robot Stacker",
+  "flex_stacker_empty_from_location": "Manually empty all labware from robot {{stackerColumn}}",
+  "flex_stacker_fill": "Fill robot Stacker",
+  "flex_stacker_fill_with_quantity_and_labware": "Fill robot {{stackerColumn}} with {{quantity}} {{labwareAndLidDisplayNames}}",
+  "flex_stacker_retrieve": "Retrieve from robot Stacker",
+  "flex_stacker_set_stored_labware": "Set stored labware in robot Stacker",
+  "flex_stacker_set_stored_labware_with_quantity_and_location": "Configure robot {{stackerColumn}} with {{quantity}} {{labwareAndLidDisplayNames}}",
+  "flex_stacker_store": "Store into robot Stacker",
   "general_error_message": "If you keep getting this message, try restarting your app and robot. If this does not resolve the issue, contact support.",
   "gripper": "Gripper",
   "gripper_still_attached": "Gripper still attached",
@@ -55,6 +63,7 @@
   "previous_releases": "View previous releases",
   "receive_alert": "Receive an alert when a software update is available.",
   "restore_description": "Reverting to previous software versions is not recommended, but you can access previous releases below. For best results, uninstall the existing app and remove its configuration files before installing the previous version.",
+  "retrieve_labware_from_stacker_to": "Retrieve {{primaryDefinitionDisplayName}} from robot Stacker to {{slotName}}",
   "robot_server_version_ot3_description": "The robot software includes the robot server and the touchscreen display interface.",
   "robot_software_update_required": "A robot software update is required to run protocols with this version of the app.",
   "run_failed_modal_description_desktop": "Contact support for assistance.",
@@ -70,6 +79,7 @@
   "show_labware_offset_snippets_description": "Only for users who need to apply labware offset data outside of the app. When enabled, code snippets for Jupyter Notebook and SSH are available during protocol setup after configuring all required offsets.",
   "something_seems_wrong": "There may be a problem with your pipette. Exit setup and contact support for assistance.",
   "storage_limit_reached_description": "Your robot has reached the limit of quick transfers that it can store. You must delete an existing quick transfer before creating a new one.",
+  "store_labware_from_slot_to_stacker": "Store {{primaryDefinitionDisplayName}} from {{slotName}} to robot Stacker",
   "system_language_preferences_update_description": "Your system’s language was recently updated. Would you like to use the updated language as the default for the app?",
   "these_are_advanced_settings": "<block>These are advanced settings. Please do not attempt to adjust without assistance from support. Changing these settings may affect the lifespan of your pipette.</block><block>These settings do not override any pipette settings defined in protocols.</block>",
   "u2e_driver_description": "The OT-2 uses this adapter for its USB connection to the desktop app.",

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

@@ -22,6 +22,14 @@
   "estop_pressed_description": "First, safely clear the deck of any labware or spills. Then, twist the E-stop button clockwise. Finally, have Flex move the gantry to its home position.",
   "find_your_robot": "Find your robot in the Opentrons App to install software updates.",
   "firmware_update_download_logs": "Download the robot logs from the Opentrons App and send them to support@opentrons.com for assistance.",
+  "flex_stacker_empty": "Manually empty all labware from Flex Stacker",
+  "flex_stacker_empty_from_location": "Manually empty all labware from Flex {{stackerColumn}}",
+  "flex_stacker_fill": "Fill Flex Stacker",
+  "flex_stacker_fill_with_quantity_and_labware": "Fill Flex {{stackerColumn}} with {{quantity}} {{labwareAndLidDisplayNames}}",
+  "flex_stacker_retrieve": "Retrieve from Flex Stacker",
+  "flex_stacker_set_stored_labware": "Set stored labware in Flex Stacker",
+  "flex_stacker_set_stored_labware_with_quantity_and_location": "Configure Flex {{stackerColumn}} with {{quantity}} {{labwareAndLidDisplayNames}}",
+  "flex_stacker_store": "Store into Flex Stacker",
   "general_error_message": "If you keep getting this message, try restarting your app and robot. If this does not resolve the issue, contact Opentrons Support.",
   "gripper": "Flex Gripper",
   "gripper_still_attached": "Flex Gripper still attached",
@@ -55,6 +63,7 @@
   "previous_releases": "View previous Opentrons releases",
   "receive_alert": "Receive an alert when an Opentrons software update is available.",
   "restore_description": "Opentrons does not recommend reverting to previous software versions, but you can access previous releases below. For best results, uninstall the existing app and remove its configuration files before installing the previous version.",
+  "retrieve_labware_from_stacker_to": "Retrieve {{primaryDefinitionDisplayName}} from Flex Stacker to {{slotName}}",
   "robot_server_version_ot3_description": "The Opentrons Flex software includes the robot server and the touchscreen display interface.",
   "robot_software_update_required": "A robot software update is required to run protocols with this version of the Opentrons App.",
   "run_failed_modal_description_desktop": "Download the run log and send it to support@opentrons.com for assistance.",
@@ -70,6 +79,7 @@
   "show_labware_offset_snippets_description": "Only for users who need to apply labware offset data outside of the Opentrons App. When enabled, code snippets for Jupyter Notebook and SSH are available during protocol setup after configuring all required offsets.",
   "something_seems_wrong": "There may be a problem with your pipette. Exit setup and contact Opentrons Support for assistance.",
   "storage_limit_reached_description": "Your Opentrons Flex has reached the limit of quick transfers that it can store. You must delete an existing quick transfer before creating a new one.",
+  "store_labware_from_slot_to_stacker": "Store {{primaryDefinitionDisplayName}} from {{slotName}} to Flex Stacker",
   "system_language_preferences_update_description": "Your system’s language was recently updated. Would you like to use the updated language as the default for the Opentrons App?",
   "these_are_advanced_settings": "<block>These are advanced settings. Please do not attempt to adjust without assistance from Opentrons Support. Changing these settings may affect the lifespan of your pipette.</block><block>These settings do not override any pipette settings defined in protocols.</block>",
   "u2e_driver_description": "The OT-2 uses this adapter for its USB connection to the Opentrons App.",

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

@@ -88,6 +88,7 @@
   "single_nozzle_layout": "single nozzle layout",
   "slot": "Slot {{slot_name}}",
   "stacker_display_name": "Stacker {{stacker_slot}}",
+  "stacker_column_display_name": "Stacker in Column {{stacker_slot}}",
   "target_temperature": "target temperature",
   "tc_awaiting_for_duration": "Waiting for Thermocycler profile to complete",
   "tc_run_profile_steps": "Temperature: {{celsius}}°C, hold time: {{duration}}",
@@ -108,5 +109,6 @@
   "waiting_for_tc_lid_to_reach": "Waiting for Thermocycler lid to reach target temperature",
   "waiting_to_reach_temp_module": "Waiting for Temperature Module to reach {{temp}}",
   "waste_chute": "Waste Chute",
-  "with_reference_of": "with reference of {{wavelength}} nm"
+  "with_reference_of": "with reference of {{wavelength}} nm",
+  "with_lid_name": " with {{lidDisplayName}}"
 }

components/src/organisms/CommandText/useCommandTextString/index.ts

@@ -53,7 +53,7 @@
   params: UseCommandTextStringParams
 ): GetCommandTextResult {
   const { command } = params
-  const { t } = useTranslation('protocol_command_text')
+  const { t } = useTranslation(['protocol_command_text', 'branded'])
 
   const fullParams = { ...params, t }
 
@@ -147,6 +147,18 @@
           command,
         }),
       }
+    case 'flexStacker/retrieve':
+    case 'flexStacker/store':
+    case 'flexStacker/setStoredLabware':
+    case 'flexStacker/empty':
+    case 'flexStacker/fill':
+      return {
+        kind: 'generic',
+        commandText: utils.getFlexStackerCommandText({
+          ...fullParams,
+          command,
+        }),
+      }
     case 'thermocycler/runProfile':
       return utils.getTCRunProfileCommandText({ ...fullParams, command })
 

components/src/organisms/CommandText/useCommandTextString/utils/commandText/__tests__/getFlexStackerCommandText.test.tsx

@@ -0,0 +1,178 @@
+import { screen } from '@testing-library/react'
+import { vi, describe, it, beforeEach } from 'vitest'
+import { useTranslation } from 'react-i18next'
+
+import { renderWithProviders } from '../../../../../../testing/utils'
+import { i18n } from '../../../../../../i18n'
+import {
+  getFlexStackerCommandText,
+  KEYS_BY_COMMAND_TYPE,
+} from '../getFlexStackerCommandText'
+import { getLabwareDefURI } from '@opentrons/shared-data'
+import { getLabwareDisplayLocation } from '../../getLabwareDisplayLocation'
+
+vi.mock('@opentrons/shared-data')
+vi.mock('../../getLabwareDisplayLocation')
+
+const baseCommandData = {
+  allRunDefs: [
+    { metadata: { displayName: 'tip rack' } },
+    { metadata: { displayName: 'plate' } },
+  ],
+  robotType: 'OT-2',
+  commandTextData: {
+    commands: [],
+    labware: [],
+    modules: [],
+    pipettes: [{ id: 'pipette-1', pipetteName: 'p300_single' }],
+  },
+} as any
+
+function TestWrapper({ command }: { command: any }): JSX.Element {
+  const { t } = useTranslation(['protocol_command_text', 'branded'])
+  const text = getFlexStackerCommandText({
+    command,
+    ...baseCommandData,
+    t,
+  })
+
+  return <div>{text}</div>
+}
+
+const render = (command: any) => {
+  return renderWithProviders(<TestWrapper command={command} />, {
+    i18nInstance: i18n,
+  })
+}
+
+describe('getPipettingCommandText', () => {
+  beforeEach(() => {
+    vi.mocked(getLabwareDefURI).mockReturnValue('tiprack-uri')
+    vi.mocked(getLabwareDisplayLocation).mockReturnValue('Slot 1')
+  })
+
+  it('should render retrieve command text correctly', () => {
+    const command = {
+      id: 'cmd-1',
+      commandType: 'flexStacker/retrieve',
+      params: {
+        moduleId: 'module-id',
+      },
+      result: {
+        primaryLabwareURI: 'tiprack-uri',
+      },
+    }
+
+    render(command)
+    screen.getByText('retrieve_labware_from_stacker_to')
+  })
+
+  it('should render store command text correctly', () => {
+    const command = {
+      id: 'cmd-1',
+      commandType: 'flexStacker/store',
+      params: {
+        moduleId: 'module-id',
+      },
+      result: {
+        primaryLabwareURI: 'tiprack-uri',
+        primaryOriginLocationSequence: [
+          { kind: 'onAddressableArea', addressableAreaName: 'A1' },
+        ],
+      },
+    }
+
+    render(command)
+    screen.getByText('store_labware_from_slot_to_stacker')
+  })
+
+  it('should render setStoredLabware command text correctly', () => {
+    const command = {
+      id: 'cmd-1',
+      commandType: 'flexStacker/setStoredLabware',
+      params: {
+        moduleId: 'module-id',
+      },
+      result: {
+        primaryLabwareURI: 'tiprack-uri',
+        primaryLabwareDefinition: {
+          metadata: {
+            displayName: 'dummy def',
+          },
+        },
+        primaryOriginLocationSequence: [
+          { kind: 'onAddressableArea', addressableAreaName: 'A1' },
+        ],
+      },
+    }
+
+    render(command)
+    screen.getByText(
+      'flex_stacker_set_stored_labware_with_quantity_and_location'
+    )
+  })
+
+  it('should render fill command text correctly', () => {
+    const command = {
+      id: 'cmd-1',
+      commandType: 'flexStacker/fill',
+      params: {
+        moduleId: 'module-id',
+      },
+      result: {
+        primaryLabwareURI: 'tiprack-uri',
+        primaryLabwareDefinition: {
+          metadata: {
+            displayName: 'dummy def',
+          },
+        },
+        primaryOriginLocationSequence: [
+          { kind: 'onAddressableArea', addressableAreaName: 'A1' },
+        ],
+      },
+    }
+
+    render(command)
+    screen.getByText('flex_stacker_fill_with_quantity_and_labware')
+  })
+
+  it('should render empty command text correctly', () => {
+    const command = {
+      id: 'cmd-1',
+      commandType: 'flexStacker/empty',
+      params: {
+        moduleId: 'module-id',
+      },
+      result: {
+        primaryLabwareURI: 'tiprack-uri',
+        primaryLabwareDefinition: {
+          metadata: {
+            displayName: 'dummy def',
+          },
+        },
+        primaryOriginLocationSequence: [
+          { kind: 'onAddressableArea', addressableAreaName: 'A1' },
+        ],
+      },
+    }
+    render(command)
+    screen.getByText('flex_stacker_empty_from_location')
+  })
+})
+
+describe.each(Object.entries(KEYS_BY_COMMAND_TYPE))(
+  'Default fallback for %s',
+  (commandType, expectedKey) => {
+    it(`should render default text for ${commandType} when result is missing`, () => {
+      const command = {
+        id: 'cmd-1',
+        commandType: commandType,
+        params: {
+          moduleId: 'module-id',
+        },
+      }
+      render(command)
+      screen.getByText(expectedKey)
+    })
+  }
+)