@opentrons/components 0.1.6-alpha.8 → 0.1.7-alpha.0

package/src/organisms/CommandText/useCommandTextString/utils/commandText/getDirectTranslationCommandText.ts

@@ -0,0 +1,44 @@
+import type { RunTimeCommand } from '@opentrons/shared-data/command'
+import type { HandlesCommands } from '../types'
+
+const SIMPLE_TRANSLATION_KEY_BY_COMMAND_TYPE: {
+  [commandType in RunTimeCommand['commandType']]?: string
+} = {
+  home: 'home_gantry',
+  savePosition: 'save_position',
+  touchTip: 'touch_tip',
+  'magneticModule/engage': 'engaging_magnetic_module',
+  'magneticModule/disengage': 'disengaging_magnetic_module',
+  'temperatureModule/deactivate': 'deactivate_temperature_module',
+  'thermocycler/waitForBlockTemperature': 'waiting_for_tc_block_to_reach',
+  'thermocycler/waitForLidTemperature': 'waiting_for_tc_lid_to_reach',
+  'thermocycler/openLid': 'opening_tc_lid',
+  'thermocycler/closeLid': 'closing_tc_lid',
+  'thermocycler/deactivateBlock': 'deactivating_tc_block',
+  'thermocycler/deactivateLid': 'deactivating_tc_lid',
+  'thermocycler/awaitProfileComplete': 'tc_awaiting_for_duration',
+  'heaterShaker/deactivateHeater': 'deactivating_hs_heater',
+  'heaterShaker/openLabwareLatch': 'unlatching_hs_latch',
+  'heaterShaker/closeLabwareLatch': 'latching_hs_latch',
+  'heaterShaker/deactivateShaker': 'deactivate_hs_shake',
+  'heaterShaker/waitForTemperature': 'waiting_for_hs_to_reach',
+}
+
+type HandledCommands = Extract<
+  RunTimeCommand,
+  { commandType: keyof typeof SIMPLE_TRANSLATION_KEY_BY_COMMAND_TYPE }
+>
+
+export type GetDirectTranslationCommandText = HandlesCommands<HandledCommands>
+
+export function getDirectTranslationCommandText({
+  command,
+  t,
+}: GetDirectTranslationCommandText): string {
+  const simpleTKey =
+    command != null
+      ? SIMPLE_TRANSLATION_KEY_BY_COMMAND_TYPE[command.commandType]
+      : null
+
+  return simpleTKey != null ? t(simpleTKey) : ''
+}

package/src/organisms/CommandText/useCommandTextString/utils/commandText/getFlexStackerCommandText.ts

@@ -0,0 +1,32 @@
+import type {
+  FlexStackerSetStoredLabwareRunTimeCommand,
+  FlexStackerStoreRunTimeCommand,
+  FlexStackerRetrieveRunTimeCommand,
+  FlexStackerFillRunTimeCommand,
+  FlexStackerEmptyRunTimeCommand,
+  RunTimeCommand,
+} from '@opentrons/shared-data'
+import type { HandlesCommands } from '../types'
+
+export type FlexStackerCommand =
+  | FlexStackerSetStoredLabwareRunTimeCommand
+  | FlexStackerStoreRunTimeCommand
+  | FlexStackerRetrieveRunTimeCommand
+  | FlexStackerFillRunTimeCommand
+  | FlexStackerEmptyRunTimeCommand
+
+type HandledCommands = Extract<
+  RunTimeCommand,
+  { commandType: FlexStackerCommand }
+>
+
+type GetFlexStackerCommandText = HandlesCommands<HandledCommands>
+
+// hold until Casey's work is implemented?
+export const getFlexStackerCommandText = ({
+  command,
+  t,
+}: // stackerCommand,
+GetFlexStackerCommandText): string => {
+  return ''
+}

package/src/organisms/CommandText/useCommandTextString/utils/commandText/getHSShakeSpeedCommandText.ts

@@ -0,0 +1,11 @@
+import type { HeaterShakerSetAndWaitForShakeSpeedRunTimeCommand } from '@opentrons/shared-data/command'
+import type { HandlesCommands } from '../types'
+
+export function getHSShakeSpeedCommandText({
+  command,
+  t,
+}: HandlesCommands<HeaterShakerSetAndWaitForShakeSpeedRunTimeCommand>): string {
+  const { rpm } = command.params
+
+  return t('set_and_await_hs_shake', { rpm })
+}

package/src/organisms/CommandText/useCommandTextString/utils/commandText/getLiquidProbeCommandText.ts

@@ -0,0 +1,60 @@
+import { getFinalLabwareLocation } from '../getFinalLabwareLocation'
+import { getLabwareDisplayLocation } from '../getLabwareDisplayLocation'
+import { getLabwareName } from '../getLabwareName'
+import type {
+  LiquidProbeRunTimeCommand,
+  RunTimeCommand,
+  TryLiquidProbeRunTimeCommand,
+} from '@opentrons/shared-data'
+import type { HandlesCommands } from '../types'
+
+type LiquidProbeRunTimeCommands =
+  | LiquidProbeRunTimeCommand
+  | TryLiquidProbeRunTimeCommand
+
+export function getLiquidProbeCommandText({
+  command,
+  allRunDefs,
+  commandTextData,
+  t,
+  robotType,
+}: HandlesCommands<LiquidProbeRunTimeCommands>): string {
+  const { wellName, labwareId } = command.params
+
+  const allPreviousCommands = commandTextData?.commands.slice(
+    0,
+    commandTextData.commands.findIndex(c => c.id === command?.id)
+  )
+
+  const labwareLocation =
+    allPreviousCommands != null
+      ? getFinalLabwareLocation(
+          labwareId as string,
+          allPreviousCommands as RunTimeCommand[]
+        )
+      : null
+
+  const displayLocation = getLabwareDisplayLocation({
+    loadedLabwares: commandTextData?.labware ?? [],
+    location: labwareLocation?.locationSequence ?? labwareLocation?.location,
+    robotType,
+    allRunDefs,
+    loadedModules: commandTextData?.modules ?? [],
+    t,
+  })
+
+  const labware =
+    commandTextData != null
+      ? getLabwareName({
+          loadedLabwares: commandTextData?.labware ?? [],
+          labwareId,
+          allRunDefs,
+        })
+      : null
+
+  return t('detect_liquid_presence', {
+    labware,
+    labware_location: displayLocation,
+    well_name: wellName,
+  })
+}

package/src/organisms/CommandText/useCommandTextString/utils/commandText/getLoadCommandText.ts

@@ -0,0 +1,172 @@
+import find from 'lodash/find'
+import {
+  getAllLiquidClassDefs,
+  getModuleDisplayName,
+  getModuleType,
+  getOccludedSlotCountForModule,
+  getPipetteSpecsV2,
+  THERMOCYCLER_MODULE_V1,
+  THERMOCYCLER_MODULE_V2,
+} from '@opentrons/shared-data'
+
+import { getPipetteNameOnMount } from '../getPipetteNameOnMount'
+import { getLiquidDisplayName } from '../getLiquidDisplayName'
+import { getLabwareName } from '../getLabwareName'
+import { getLabwareDisplayLocation } from '../getLabwareDisplayLocation'
+
+import type { GetCommandText } from '../..'
+
+export const getLoadCommandText = ({
+  command,
+  commandTextData,
+  robotType,
+  t,
+  allRunDefs,
+}: GetCommandText): string => {
+  switch (command?.commandType) {
+    case 'loadPipette': {
+      const pipetteModel =
+        commandTextData != null
+          ? getPipetteNameOnMount(
+              commandTextData.pipettes,
+              command.params.mount
+            )
+          : null
+      return t('load_pipette_protocol_setup', {
+        pipette_name:
+          pipetteModel != null
+            ? getPipetteSpecsV2(pipetteModel)?.displayName ?? ''
+            : '',
+        mount_name: command.params.mount === 'left' ? t('left') : t('right'),
+      })
+    }
+    case 'loadModule': {
+      const occludedSlotCount = getOccludedSlotCountForModule(
+        getModuleType(command.params.model),
+        robotType
+      )
+      let slotName = command.params.location.slotName
+      if (
+        THERMOCYCLER_MODULE_V2 === command.params.model ||
+        THERMOCYCLER_MODULE_V1 === command.params.model
+      ) {
+        slotName = 'A1 + B1'
+      }
+      return t('load_module_protocol_setup', {
+        count: occludedSlotCount,
+        module: getModuleDisplayName(command.params.model),
+        slot_name: slotName,
+      })
+    }
+    case 'loadLid':
+    case 'loadLabware': {
+      const location = getLabwareDisplayLocation({
+        location: command.result?.locationSequence ?? command.params.location,
+        robotType,
+        allRunDefs,
+        loadedLabwares: commandTextData?.labware ?? [],
+        loadedModules: commandTextData?.modules ?? [],
+        t,
+      })
+      const labwareName =
+        'displayName' in command.params && command.params.displayName != null
+          ? command.params.displayName
+          : command.result?.definition.metadata.displayName
+
+      // use in preposition for modules and slots, on for labware and adapters
+      let displayLocation = t('in_location', { location })
+      if (
+        command.params.location === 'offDeck' ||
+        command.params.location === 'systemLocation'
+      ) {
+        displayLocation = location
+      } else if ('labwareId' in command.params.location) {
+        displayLocation = t('on_location', { location })
+      }
+
+      return t('load_labware_to_display_location', {
+        labware: labwareName,
+        display_location: displayLocation,
+      })
+    }
+    case 'loadLidStack': {
+      // this will be the case if the system creates an empty stack to move lids onto
+      if (command.result?.definition == null) {
+        return t('load_lid_stack_empty')
+      }
+      const location =
+        command.result?.stackLocationSequence != null
+          ? getLabwareDisplayLocation({
+              location: command.result.stackLocationSequence,
+              robotType,
+              allRunDefs,
+              loadedLabwares: commandTextData?.labware ?? [],
+              loadedModules: commandTextData?.modules ?? [],
+              t,
+            })
+          : ''
+      // use in preposition for modules and slots, on for labware and adapters
+      let displayLocation = t('in_location', { location })
+      if (
+        command.params.location !== 'systemLocation' &&
+        command.params.location !== 'offDeck' &&
+        'labwareId' in command.params.location
+      ) {
+        displayLocation = t('on_location', { location })
+      }
+      const lidName = command.result.definition.metadata.displayName
+      const quantity = command.params.quantity
+      return t('load_lid_stack', {
+        quantity,
+        labware: lidName,
+        display_location: displayLocation,
+      })
+    }
+    case 'reloadLabware': {
+      const { labwareId } = command.params
+      const labware =
+        commandTextData != null
+          ? getLabwareName({
+              loadedLabwares: commandTextData?.labware ?? [],
+              labwareId,
+              allRunDefs,
+            })
+          : null
+      return t('reloading_labware', { labware })
+    }
+    case 'loadLiquid': {
+      const { liquidId, labwareId } = command.params
+      return t('load_liquids_info_protocol_setup', {
+        liquid:
+          commandTextData != null
+            ? getLiquidDisplayName(commandTextData.liquids ?? [], liquidId)
+            : null,
+        labware:
+          commandTextData != null
+            ? getLabwareName({
+                loadedLabwares: commandTextData?.labware ?? [],
+                labwareId,
+                allRunDefs,
+              })
+            : null,
+      })
+    }
+    case 'loadLiquidClass': {
+      const { liquidClassName } = command.params.liquidClassRecord
+      const liquidClassDisplayName = find(
+        getAllLiquidClassDefs(),
+        liquidClassDef => liquidClassDef.liquidClassName === liquidClassName
+      )?.displayName
+      return t('load_liquid_class', {
+        liquidClassDisplayName,
+      })
+    }
+    default: {
+      console.warn(
+        'LoadCommandText encountered a command with an unrecognized commandType: ',
+        command
+      )
+      return ''
+    }
+  }
+}

package/src/organisms/CommandText/useCommandTextString/utils/commandText/getMoveLabwareCommandText.ts

@@ -0,0 +1,108 @@
+import { GRIPPER_WASTE_CHUTE_ADDRESSABLE_AREA } from '@opentrons/shared-data'
+
+import { getFinalLabwareLocation } from '../getFinalLabwareLocation'
+import { getLabwareDisplayLocation } from '../getLabwareDisplayLocation'
+import { getLabwareName } from '../getLabwareName'
+
+import type { MoveLabwareRunTimeCommand } from '@opentrons/shared-data'
+import type { HandlesCommands } from '../types'
+
+export function getMoveLabwareCommandText({
+  command,
+  allRunDefs,
+  t,
+  commandTextData,
+  robotType,
+}: HandlesCommands<MoveLabwareRunTimeCommand>): string {
+  const { labwareId, newLocation, strategy } = command.params
+  let oldDisplayLocation = null
+  let newDisplayLocation = null
+  if (
+    command.result?.originLocationSequence != null &&
+    command.result?.immediateDestinationLocationSequence != null
+  ) {
+    oldDisplayLocation = getLabwareDisplayLocation({
+      location: command.result.originLocationSequence,
+      robotType,
+      allRunDefs,
+      loadedLabwares: commandTextData?.labware ?? [],
+      loadedModules: commandTextData?.modules ?? [],
+      t,
+    })
+    newDisplayLocation = getLabwareDisplayLocation({
+      location: command.result.immediateDestinationLocationSequence,
+      robotType,
+      allRunDefs,
+      loadedLabwares: commandTextData?.labware ?? [],
+      loadedModules: commandTextData?.modules ?? [],
+      t,
+    })
+  } else {
+    const allPreviousCommands = commandTextData?.commands.slice(
+      0,
+      commandTextData.commands.findIndex(c => c.id === command.id)
+    )
+    const oldLocation =
+      allPreviousCommands != null
+        ? getFinalLabwareLocation(labwareId, allPreviousCommands)
+        : null
+
+    oldDisplayLocation = getLabwareDisplayLocation({
+      location: oldLocation?.location,
+      robotType,
+      allRunDefs,
+      loadedLabwares: commandTextData?.labware ?? [],
+      loadedModules: commandTextData?.modules ?? [],
+      t,
+    })
+    newDisplayLocation = getLabwareDisplayLocation({
+      location: newLocation,
+      robotType,
+      allRunDefs,
+      loadedLabwares: commandTextData?.labware ?? [],
+      loadedModules: commandTextData?.modules ?? [],
+      t,
+    })
+  }
+
+  // add waste chute to i18n
+  const location = newDisplayLocation?.includes(
+    GRIPPER_WASTE_CHUTE_ADDRESSABLE_AREA
+  )
+    ? 'Waste Chute'
+    : newDisplayLocation
+
+  // system location is an off deck location we create lid stacks in and
+  // move them to and should not be exposed to the user
+  if (oldDisplayLocation === 'systemLocation') {
+    return t('move_lid_stack_to_deck', { slot_name: newDisplayLocation })
+  } else if (newDisplayLocation === 'systemLocation') {
+    return t('move_lid_stack_from_deck', { slot_name: oldDisplayLocation })
+  }
+
+  return strategy === 'usingGripper'
+    ? t('move_labware_using_gripper', {
+        labware:
+          commandTextData != null
+            ? getLabwareName({
+                allRunDefs,
+                loadedLabwares: commandTextData.labware ?? [],
+                labwareId,
+              })
+            : null,
+        old_location: oldDisplayLocation,
+        new_location: location,
+      })
+    : t('move_labware_manually', {
+        labware:
+          commandTextData != null
+            ? getLabwareName({
+                allRunDefs,
+                loadedLabwares: commandTextData.labware ?? [],
+                labwareId,
+              })
+            : null,
+        old_location: oldDisplayLocation,
+        new_location: location,
+      })
+}

package/src/organisms/CommandText/useCommandTextString/utils/commandText/getMoveRelativeCommandText.ts

@@ -0,0 +1,11 @@
+import type { MoveRelativeRunTimeCommand } from '@opentrons/shared-data/command'
+import type { HandlesCommands } from '../types'
+
+export function getMoveRelativeCommandText({
+  command,
+  t,
+}: HandlesCommands<MoveRelativeRunTimeCommand>): string {
+  const { axis, distance } = command.params
+
+  return t('move_relative', { axis, distance })
+}

package/src/organisms/CommandText/useCommandTextString/utils/commandText/getMoveToAddressableAreaCommandText.ts

@@ -0,0 +1,19 @@
+import { getAddressableAreaDisplayName } from '../getAddressableAreaDisplayName'
+
+import type { MoveToAddressableAreaRunTimeCommand } from '@opentrons/shared-data/command'
+import type { HandlesCommands } from '../types'
+
+export function getMoveToAddressableAreaCommandText({
+  command,
+  commandTextData,
+  t,
+}: HandlesCommands<MoveToAddressableAreaRunTimeCommand>): string {
+  const addressableAreaDisplayName =
+    commandTextData != null
+      ? getAddressableAreaDisplayName(commandTextData.commands, command.id, t)
+      : null
+
+  return t('move_to_addressable_area', {
+    addressable_area: addressableAreaDisplayName,
+  })
+}

package/src/organisms/CommandText/useCommandTextString/utils/commandText/getMoveToAddressableAreaForDropTipCommandText.ts

@@ -0,0 +1,19 @@
+import { getAddressableAreaDisplayName } from '../getAddressableAreaDisplayName'
+
+import type { MoveToAddressableAreaForDropTipRunTimeCommand } from '@opentrons/shared-data/command'
+import type { HandlesCommands } from '../types'
+
+export function getMoveToAddressableAreaForDropTipCommandText({
+  command,
+  commandTextData,
+  t,
+}: HandlesCommands<MoveToAddressableAreaForDropTipRunTimeCommand>): string {
+  const addressableAreaDisplayName =
+    commandTextData != null
+      ? getAddressableAreaDisplayName(commandTextData.commands, command.id, t)
+      : null
+
+  return t('move_to_addressable_area_drop_tip', {
+    addressable_area: addressableAreaDisplayName,
+  })
+}

package/src/organisms/CommandText/useCommandTextString/utils/commandText/getMoveToCoordinatesCommandText.ts

@@ -0,0 +1,11 @@
+import type { MoveToCoordinatesRunTimeCommand } from '@opentrons/shared-data/command'
+import type { HandlesCommands } from '../types'
+
+export function getMoveToCoordinatesCommandText({
+  command,
+  t,
+}: HandlesCommands<MoveToCoordinatesRunTimeCommand>): string {
+  const { coordinates } = command.params
+
+  return t('move_to_coordinates', coordinates)
+}

package/src/organisms/CommandText/useCommandTextString/utils/commandText/getMoveToSlotCommandText.ts

@@ -0,0 +1,11 @@
+import type { MoveToSlotRunTimeCommand } from '@opentrons/shared-data/command'
+import type { HandlesCommands } from '../types'
+
+export function getMoveToSlotCommandText({
+  command,
+  t,
+}: HandlesCommands<MoveToSlotRunTimeCommand>): string {
+  const { slotName } = command.params
+
+  return t('move_to_slot', { slot_name: slotName })
+}

package/src/organisms/CommandText/useCommandTextString/utils/commandText/getMoveToWellCommandText.ts

@@ -0,0 +1,46 @@
+import { getFinalLabwareLocation } from '../getFinalLabwareLocation'
+import { getLabwareDisplayLocation } from '../getLabwareDisplayLocation'
+import { getLabwareName } from '../getLabwareName'
+
+import type { MoveToWellRunTimeCommand } from '@opentrons/shared-data/command'
+import type { HandlesCommands } from '../types'
+
+export function getMoveToWellCommandText({
+  command,
+  allRunDefs,
+  t,
+  commandTextData,
+  robotType,
+}: HandlesCommands<MoveToWellRunTimeCommand>): string {
+  const { wellName, labwareId } = command.params
+  const allPreviousCommands = commandTextData?.commands.slice(
+    0,
+    commandTextData.commands.findIndex(c => c.id === command.id)
+  )
+  const labwareLocation =
+    allPreviousCommands != null
+      ? getFinalLabwareLocation(labwareId, allPreviousCommands)
+      : null
+
+  const displayLocation = getLabwareDisplayLocation({
+    loadedLabwares: commandTextData?.labware ?? [],
+    location: labwareLocation?.locationSequence ?? labwareLocation?.location,
+    robotType,
+    allRunDefs,
+    loadedModules: commandTextData?.modules ?? [],
+    t,
+  })
+
+  return t('move_to_well', {
+    well_name: wellName,
+    labware:
+      commandTextData != null
+        ? getLabwareName({
+            loadedLabwares: commandTextData.labware ?? [],
+            labwareId,
+            allRunDefs,
+          })
+        : null,
+    labware_location: displayLocation,
+  })
+}