@opentrons/shared-data 0.1.1 → 0.1.2-alpha.1

package/js/constants.ts

@@ -0,0 +1,405 @@
+import type { CutoutFixtureId, CutoutId, AddressableAreaName } from '../deck'
+import type { ModuleType } from './types'
+
+// constants for dealing with robot coordinate system (eg in labwareTools)
+export const SLOT_LENGTH_MM = 127.76 // along X axis in robot coordinate system
+
+export const SLOT_WIDTH_MM = 85.48 // along Y axis in robot coordinate system
+
+// constants for SVG renders of the deck
+export const SLOT_RENDER_WIDTH = SLOT_LENGTH_MM // along X axis in SVG coords
+
+export const SLOT_RENDER_HEIGHT = SLOT_WIDTH_MM // along Y axis in SVG coords
+
+// taken from opentrons_1_trash_1100ml_fixed v1's dimensions
+export const FIXED_TRASH_RENDER_HEIGHT = 165.86 // along Y axis in SVG coords
+
+// used for module visualization, remove this when we start using actual module dimensions
+export const STD_SLOT_X_DIM = 128
+export const STD_SLOT_Y_DIM = 86
+export const STD_SLOT_DIVIDER_WIDTH = 4
+
+export const OPENTRONS_LABWARE_NAMESPACE = 'opentrons'
+export const FIXED_TRASH_ID = 'fixedTrash'
+
+// TODO: IL 2020-02-19 These 3 constants are DEPRECATED because they're ambiguous model vs type.
+export const THERMOCYCLER: 'thermocycler' = 'thermocycler'
+export const TEMPDECK: 'tempdeck' = 'tempdeck'
+export const MAGDECK: 'magdeck' = 'magdeck'
+
+// these are the Module Def Schema v2 equivalents of the above. They should match the names of JSON definitions
+// in shared-data/module/definitions/2.
+export const MAGNETIC_MODULE_V1: 'magneticModuleV1' = 'magneticModuleV1'
+export const MAGNETIC_MODULE_V2: 'magneticModuleV2' = 'magneticModuleV2'
+export const TEMPERATURE_MODULE_V1: 'temperatureModuleV1' =
+  'temperatureModuleV1'
+export const TEMPERATURE_MODULE_V2: 'temperatureModuleV2' =
+  'temperatureModuleV2'
+export const THERMOCYCLER_MODULE_V1: 'thermocyclerModuleV1' =
+  'thermocyclerModuleV1'
+export const THERMOCYCLER_MODULE_V2: 'thermocyclerModuleV2' =
+  'thermocyclerModuleV2'
+export const HEATERSHAKER_MODULE_V1: 'heaterShakerModuleV1' =
+  'heaterShakerModuleV1'
+
+export const MAGNETIC_BLOCK_V1: 'magneticBlockV1' = 'magneticBlockV1'
+
+export const GRIPPER_V1: 'gripperV1' = 'gripperV1'
+export const GRIPPER_V1_1: 'gripperV1.1' = 'gripperV1.1'
+export const GRIPPER_V1_2: 'gripperV1.2' = 'gripperV1.2'
+export const GRIPPER_MODELS = [GRIPPER_V1, GRIPPER_V1_1, GRIPPER_V1_2]
+
+// robot display name
+export const FLEX_DISPLAY_NAME: 'Opentrons Flex' = 'Opentrons Flex'
+
+// pipette display categories
+export const FLEX: 'FLEX' = 'FLEX'
+export const GEN2: 'GEN2' = 'GEN2'
+export const GEN1: 'GEN1' = 'GEN1'
+
+// pipette mounts
+export const LEFT: 'left' = 'left'
+export const RIGHT: 'right' = 'right'
+export const EXTENSION: 'extension' = 'extension'
+
+// fake slot that PD uses to represent the slot the thermocycler sits in
+export const SPAN7_8_10_11_SLOT: 'span7_8_10_11' = 'span7_8_10_11'
+
+// NOTE: these are NOT module MODELs, they are `moduleType`s. Should match ENUM in module definition file.
+export const TEMPERATURE_MODULE_TYPE: 'temperatureModuleType' =
+  'temperatureModuleType'
+export const MAGNETIC_MODULE_TYPE: 'magneticModuleType' = 'magneticModuleType'
+export const THERMOCYCLER_MODULE_TYPE: 'thermocyclerModuleType' =
+  'thermocyclerModuleType'
+export const HEATERSHAKER_MODULE_TYPE: 'heaterShakerModuleType' =
+  'heaterShakerModuleType'
+export const MAGNETIC_BLOCK_TYPE: 'magneticBlockType' = 'magneticBlockType'
+
+export const MAGNETIC_MODULE_MODELS = [MAGNETIC_MODULE_V1, MAGNETIC_MODULE_V2]
+
+export const NON_CONNECTING_MODULE_TYPES: ModuleType[] = [MAGNETIC_BLOCK_TYPE]
+
+export const TEMPERATURE_MODULE_MODELS = [
+  TEMPERATURE_MODULE_V1,
+  TEMPERATURE_MODULE_V2,
+]
+
+export const THERMOCYCLER_MODULE_MODELS = [
+  THERMOCYCLER_MODULE_V1,
+  THERMOCYCLER_MODULE_V2,
+]
+
+export const HEATERSHAKER_MODULE_MODELS = [HEATERSHAKER_MODULE_V1]
+
+export const MAGNETIC_BLOCK_MODELS = [MAGNETIC_BLOCK_V1]
+
+export const MODULE_MODELS = [
+  ...MAGNETIC_MODULE_MODELS,
+  ...TEMPERATURE_MODULE_MODELS,
+  ...THERMOCYCLER_MODULE_MODELS,
+  ...HEATERSHAKER_MODULE_MODELS,
+  ...MAGNETIC_BLOCK_MODELS,
+]
+
+export const MODULE_MODELS_OT2_ONLY = [
+  ...MAGNETIC_MODULE_MODELS,
+  TEMPERATURE_MODULE_V1,
+  THERMOCYCLER_MODULE_V1,
+]
+
+export const MODULE_TYPES = [
+  TEMPERATURE_MODULE_TYPE,
+  MAGNETIC_MODULE_TYPE,
+  THERMOCYCLER_MODULE_TYPE,
+  HEATERSHAKER_MODULE_TYPE,
+  MAGNETIC_BLOCK_TYPE,
+]
+
+export const GEN_ONE_MULTI_PIPETTES = ['p10_multi', 'p50_multi', 'p300_multi']
+
+export const IDENTITY_VECTOR = { x: 0, y: 0, z: 0 }
+
+export const ROBOT_MODELS = ['OT-2 Standard', 'OT-3 Standard']
+export const OT2_ROBOT_TYPE = 'OT-2 Standard' as const
+export const FLEX_ROBOT_TYPE = 'OT-3 Standard' as const
+
+//  TODO(jr, 7/13/23): rename this constant to FLEX_PIPETTES
+export const OT3_PIPETTES = [
+  'p300_single_flex',
+  'p1000_single_flex',
+  'p20_single_flex',
+  'p50_single_flex',
+  'p50_multi_flex',
+  'p1000_multi_flex',
+  'p1000_96',
+]
+export const OT2_PIPETTES = [
+  'p300_single',
+  'p300_multi',
+  'p300_single_gen2',
+  'p300_multi_gen2',
+  'p1000_single',
+  'p1000_single_gen2',
+  'p20_single_gen2',
+  'p20_multi_gen2',
+  'p50_single',
+  'p50_multi',
+  'p10_single',
+  'p10_multi',
+]
+
+//  magnetic module info
+export const MM: 'mm' = 'mm'
+export const MAGNETIC_MODULES_MAX_ENGAGE_HEIGHT = 20
+export const MAGNETIC_MODULE_V2_DISNEGAGED_HEIGHT = -2.5 //  TODO(jr, 6/14/22): change this to -4 when ticket #9585 merges
+export const MAGNETIC_MODULE_V1_DISNEGAGED_HEIGHT = -2.5
+
+export const MAGNETIC_MODULE_TYPE_LABWARE_BOTTOM_HEIGHT = 0
+
+export const CELSIUS: '°C' = '°C'
+export const TEMP_MIN = 4
+export const TEMP_MAX = 96
+export const TEMP_BLOCK_MAX = 99
+export const TEMP_LID_MIN = 37
+export const TEMP_LID_MAX = 110
+export const HS_TEMP_MIN = 37
+export const HS_TEMP_MAX = 95
+export const MICRO_LITERS = 'µL'
+
+// Heater shaker module info
+export const RPM: 'RPM' = 'RPM'
+export const HS_RPM_MIN = 200
+export const HS_RPM_MAX = 3000
+export const TOO_HOT_TEMP = 48.9
+export const MAX_LABWARE_HEIGHT_EAST_WEST_HEATER_SHAKER_MM = 53
+
+export const OT2_STANDARD_MODEL: 'OT-2 Standard' = 'OT-2 Standard'
+export const OT2_STANDARD_DECKID: 'ot2_standard' = 'ot2_standard'
+export const FLEX_STANDARD_MODEL: 'OT-3 Standard' = 'OT-3 Standard'
+export const FLEX_STANDARD_DECKID: 'ot3_standard' = 'ot3_standard'
+
+export const SINGLE_CHANNEL: 'Single-Channel' = 'Single-Channel'
+export const EIGHT_CHANNEL: '8-Channel' = '8-Channel'
+export const NINETY_SIX_CHANNEL: '96-Channel' = '96-Channel'
+export const SINGLE_MOUNT_PIPETTES: 'Single-Channel_and_8-Channel' =
+  'Single-Channel_and_8-Channel'
+
+// Thermocycler module info
+export const TC_MODULE_LOCATION_OT2: '7,8,10,11' = '7,8,10,11'
+export const TC_MODULE_LOCATION_OT3: 'A1+B1' = 'A1+B1'
+
+export const WEIGHT_OF_96_CHANNEL: '~10kg' = '~10kg'
+
+export const MOVABLE_TRASH_CUTOUTS: CutoutId[] = [
+  'cutoutA1',
+  'cutoutB1',
+  'cutoutC1',
+  'cutoutD1',
+  'cutoutA3',
+  'cutoutB3',
+  'cutoutC3',
+  'cutoutD3',
+]
+
+export const SINGLE_LEFT_CUTOUTS: CutoutId[] = [
+  'cutoutA1',
+  'cutoutB1',
+  'cutoutC1',
+  'cutoutD1',
+]
+
+export const SINGLE_CENTER_CUTOUTS: CutoutId[] = [
+  'cutoutA2',
+  'cutoutB2',
+  'cutoutC2',
+  'cutoutD2',
+]
+
+export const SINGLE_RIGHT_CUTOUTS: CutoutId[] = [
+  'cutoutA3',
+  'cutoutB3',
+  'cutoutC3',
+  'cutoutD3',
+]
+
+export const STAGING_AREA_CUTOUTS: CutoutId[] = [
+  'cutoutA3',
+  'cutoutB3',
+  'cutoutC3',
+  'cutoutD3',
+]
+
+export const WASTE_CHUTE_CUTOUT: 'cutoutD3' = 'cutoutD3'
+
+export const A1_ADDRESSABLE_AREA: 'A1' = 'A1'
+export const A2_ADDRESSABLE_AREA: 'A2' = 'A2'
+export const A3_ADDRESSABLE_AREA: 'A3' = 'A3'
+export const A4_ADDRESSABLE_AREA: 'A4' = 'A4'
+export const B1_ADDRESSABLE_AREA: 'B1' = 'B1'
+export const B2_ADDRESSABLE_AREA: 'B2' = 'B2'
+export const B3_ADDRESSABLE_AREA: 'B3' = 'B3'
+export const B4_ADDRESSABLE_AREA: 'B4' = 'B4'
+export const C1_ADDRESSABLE_AREA: 'C1' = 'C1'
+export const C2_ADDRESSABLE_AREA: 'C2' = 'C2'
+export const C3_ADDRESSABLE_AREA: 'C3' = 'C3'
+export const C4_ADDRESSABLE_AREA: 'C4' = 'C4'
+export const D1_ADDRESSABLE_AREA: 'D1' = 'D1'
+export const D2_ADDRESSABLE_AREA: 'D2' = 'D2'
+export const D3_ADDRESSABLE_AREA: 'D3' = 'D3'
+export const D4_ADDRESSABLE_AREA: 'D4' = 'D4'
+
+export const MOVABLE_TRASH_A1_ADDRESSABLE_AREA: 'movableTrashA1' =
+  'movableTrashA1'
+export const MOVABLE_TRASH_A3_ADDRESSABLE_AREA: 'movableTrashA3' =
+  'movableTrashA3'
+export const MOVABLE_TRASH_B1_ADDRESSABLE_AREA: 'movableTrashB1' =
+  'movableTrashB1'
+export const MOVABLE_TRASH_B3_ADDRESSABLE_AREA: 'movableTrashB3' =
+  'movableTrashB3'
+export const MOVABLE_TRASH_C1_ADDRESSABLE_AREA: 'movableTrashC1' =
+  'movableTrashC1'
+export const MOVABLE_TRASH_C3_ADDRESSABLE_AREA: 'movableTrashC3' =
+  'movableTrashC3'
+export const MOVABLE_TRASH_D1_ADDRESSABLE_AREA: 'movableTrashD1' =
+  'movableTrashD1'
+export const MOVABLE_TRASH_D3_ADDRESSABLE_AREA: 'movableTrashD3' =
+  'movableTrashD3'
+
+export const ONE_CHANNEL_WASTE_CHUTE_ADDRESSABLE_AREA: '1ChannelWasteChute' =
+  '1ChannelWasteChute'
+export const EIGHT_CHANNEL_WASTE_CHUTE_ADDRESSABLE_AREA: '8ChannelWasteChute' =
+  '8ChannelWasteChute'
+export const NINETY_SIX_CHANNEL_WASTE_CHUTE_ADDRESSABLE_AREA: '96ChannelWasteChute' =
+  '96ChannelWasteChute'
+export const GRIPPER_WASTE_CHUTE_ADDRESSABLE_AREA: 'gripperWasteChute' =
+  'gripperWasteChute'
+
+export const ADDRESSABLE_AREA_1: '1' = '1'
+export const ADDRESSABLE_AREA_2: '2' = '2'
+export const ADDRESSABLE_AREA_3: '3' = '3'
+export const ADDRESSABLE_AREA_4: '4' = '4'
+export const ADDRESSABLE_AREA_5: '5' = '5'
+export const ADDRESSABLE_AREA_6: '6' = '6'
+export const ADDRESSABLE_AREA_7: '7' = '7'
+export const ADDRESSABLE_AREA_8: '8' = '8'
+export const ADDRESSABLE_AREA_9: '9' = '9'
+export const ADDRESSABLE_AREA_10: '10' = '10'
+export const ADDRESSABLE_AREA_11: '11' = '11'
+
+export const OT2_SINGLE_SLOT_ADDRESSABLE_AREAS: AddressableAreaName[] = [
+  ADDRESSABLE_AREA_1,
+  ADDRESSABLE_AREA_2,
+  ADDRESSABLE_AREA_3,
+  ADDRESSABLE_AREA_4,
+  ADDRESSABLE_AREA_5,
+  ADDRESSABLE_AREA_6,
+  ADDRESSABLE_AREA_7,
+  ADDRESSABLE_AREA_8,
+  ADDRESSABLE_AREA_9,
+  ADDRESSABLE_AREA_10,
+  ADDRESSABLE_AREA_11,
+]
+
+export const FLEX_SINGLE_SLOT_ADDRESSABLE_AREAS: AddressableAreaName[] = [
+  A1_ADDRESSABLE_AREA,
+  A2_ADDRESSABLE_AREA,
+  A3_ADDRESSABLE_AREA,
+  B1_ADDRESSABLE_AREA,
+  B2_ADDRESSABLE_AREA,
+  B3_ADDRESSABLE_AREA,
+  C1_ADDRESSABLE_AREA,
+  C2_ADDRESSABLE_AREA,
+  C3_ADDRESSABLE_AREA,
+  D1_ADDRESSABLE_AREA,
+  D2_ADDRESSABLE_AREA,
+  D3_ADDRESSABLE_AREA,
+]
+
+export const FLEX_STAGING_AREA_SLOT_ADDRESSABLE_AREAS: AddressableAreaName[] = [
+  A4_ADDRESSABLE_AREA,
+  B4_ADDRESSABLE_AREA,
+  C4_ADDRESSABLE_AREA,
+  D4_ADDRESSABLE_AREA,
+]
+
+export const MOVABLE_TRASH_ADDRESSABLE_AREAS: AddressableAreaName[] = [
+  MOVABLE_TRASH_A1_ADDRESSABLE_AREA,
+  MOVABLE_TRASH_A3_ADDRESSABLE_AREA,
+  MOVABLE_TRASH_B1_ADDRESSABLE_AREA,
+  MOVABLE_TRASH_B3_ADDRESSABLE_AREA,
+  MOVABLE_TRASH_C1_ADDRESSABLE_AREA,
+  MOVABLE_TRASH_C3_ADDRESSABLE_AREA,
+  MOVABLE_TRASH_D1_ADDRESSABLE_AREA,
+  MOVABLE_TRASH_D3_ADDRESSABLE_AREA,
+]
+
+export const WASTE_CHUTE_ADDRESSABLE_AREAS: AddressableAreaName[] = [
+  ONE_CHANNEL_WASTE_CHUTE_ADDRESSABLE_AREA,
+  EIGHT_CHANNEL_WASTE_CHUTE_ADDRESSABLE_AREA,
+  NINETY_SIX_CHANNEL_WASTE_CHUTE_ADDRESSABLE_AREA,
+  GRIPPER_WASTE_CHUTE_ADDRESSABLE_AREA,
+]
+
+export const SINGLE_LEFT_SLOT_FIXTURE: 'singleLeftSlot' = 'singleLeftSlot'
+export const SINGLE_CENTER_SLOT_FIXTURE: 'singleCenterSlot' = 'singleCenterSlot'
+export const SINGLE_RIGHT_SLOT_FIXTURE: 'singleRightSlot' = 'singleRightSlot'
+
+export const STAGING_AREA_RIGHT_SLOT_FIXTURE: 'stagingAreaRightSlot' =
+  'stagingAreaRightSlot'
+
+export const TRASH_BIN_ADAPTER_FIXTURE: 'trashBinAdapter' = 'trashBinAdapter'
+
+export const WASTE_CHUTE_RIGHT_ADAPTER_COVERED_FIXTURE: 'wasteChuteRightAdapterCovered' =
+  'wasteChuteRightAdapterCovered'
+export const WASTE_CHUTE_RIGHT_ADAPTER_NO_COVER_FIXTURE: 'wasteChuteRightAdapterNoCover' =
+  'wasteChuteRightAdapterNoCover'
+export const STAGING_AREA_SLOT_WITH_WASTE_CHUTE_RIGHT_ADAPTER_COVERED_FIXTURE: 'stagingAreaSlotWithWasteChuteRightAdapterCovered' =
+  'stagingAreaSlotWithWasteChuteRightAdapterCovered'
+export const STAGING_AREA_SLOT_WITH_WASTE_CHUTE_RIGHT_ADAPTER_NO_COVER_FIXTURE: 'stagingAreaSlotWithWasteChuteRightAdapterNoCover' =
+  'stagingAreaSlotWithWasteChuteRightAdapterNoCover'
+
+export const SINGLE_SLOT_FIXTURES: CutoutFixtureId[] = [
+  SINGLE_LEFT_SLOT_FIXTURE,
+  SINGLE_CENTER_SLOT_FIXTURE,
+  SINGLE_RIGHT_SLOT_FIXTURE,
+]
+
+export const WASTE_CHUTE_FIXTURES: CutoutFixtureId[] = [
+  WASTE_CHUTE_RIGHT_ADAPTER_COVERED_FIXTURE,
+  WASTE_CHUTE_RIGHT_ADAPTER_NO_COVER_FIXTURE,
+  STAGING_AREA_SLOT_WITH_WASTE_CHUTE_RIGHT_ADAPTER_COVERED_FIXTURE,
+  STAGING_AREA_SLOT_WITH_WASTE_CHUTE_RIGHT_ADAPTER_NO_COVER_FIXTURE,
+]
+
+export const WASTE_CHUTE_ONLY_FIXTURES: CutoutFixtureId[] = [
+  WASTE_CHUTE_RIGHT_ADAPTER_COVERED_FIXTURE,
+  WASTE_CHUTE_RIGHT_ADAPTER_NO_COVER_FIXTURE,
+]
+
+export const WASTE_CHUTE_STAGING_AREA_FIXTURES: CutoutFixtureId[] = [
+  STAGING_AREA_SLOT_WITH_WASTE_CHUTE_RIGHT_ADAPTER_COVERED_FIXTURE,
+  STAGING_AREA_SLOT_WITH_WASTE_CHUTE_RIGHT_ADAPTER_NO_COVER_FIXTURE,
+]
+
+export const LOW_VOLUME_PIPETTES = ['p50_single_flex', 'p50_multi_flex']
+
+// default hex values for liquid colors
+const electricPurple = '#b925ff'
+const goldenYellow = '#ffd600'
+const aquamarine = '#9dffd8'
+const orangePeel = '#ff9900'
+const skyBlue = '#50d5ff'
+const popPink = '#ff80f5'
+const springGreen = '#7eff42'
+const tartRed = '#ff4f4f'
+export const DEFAULT_LIQUID_COLORS = [
+  electricPurple,
+  goldenYellow,
+  aquamarine,
+  orangePeel,
+  skyBlue,
+  popPink,
+  springGreen,
+  tartRed,
+]
+export const DEPRECATED_WHALE_GREY = '#9395a0'

package/js/cypressUtils.ts

@@ -0,0 +1,35 @@
+import isEqual from 'lodash/isEqual'
+import isObject from 'lodash/isObject'
+import transform from 'lodash/transform'
+
+const difference = (object: any, base: any): any => {
+  const changes = (object: any, base: any): any => {
+    return transform(object, function (result, value, key) {
+      if (!isEqual(value, base[key])) {
+        result[key] =
+          isObject(value) && isObject(base[key])
+            ? changes(value, base[key])
+            : value
+      }
+    })
+  }
+
+  return changes(object, base)
+}
+
+// deepEqual won't always return a diff, Cypress doesn't fully support object diffs :(
+// also Cypress doesn't seem to support logging to the console? So throwing the diff as an error instead
+export const expectDeepEqual = (assert: any, a: any, b: any): void => {
+  try {
+    assert.deepEqual(a, b)
+  } catch (e) {
+    // visualize undefineds
+    const replacer = (key: string, value: unknown): unknown =>
+      typeof value === 'undefined' ? '__undefined__' : value
+
+    throw Error(
+      'Expected deep equal. Diff is: ' +
+        JSON.stringify(difference(a, b), replacer, 4)
+    )
+  }
+}

package/js/errors.ts

@@ -0,0 +1,33 @@
+import errorDefinitions from '../errors/definitions/1/errors.json'
+
+export type ErrorCodes = keyof typeof errorDefinitions.codes
+export type ErrorCategories = keyof typeof errorDefinitions.categories
+
+export interface ErrorCategory {
+  detail: string
+  codePrefix: string
+}
+
+export interface ErrorBody {
+  detail: string
+  category: ErrorCategory
+  code: ErrorCodes
+}
+
+interface JSONErrorBody {
+  detail: string
+  category: ErrorCategories
+}
+
+export function getError(code: ErrorCodes): ErrorBody | null {
+  return errorDefinitions.codes[code]
+    ? {
+        code: code,
+        detail: errorDefinitions.codes[code].detail,
+        category:
+          errorDefinitions.categories[
+            (errorDefinitions.codes[code] as JSONErrorBody).category
+          ],
+      }
+    : null
+}

package/js/fixtures.ts

@@ -0,0 +1,156 @@
+import {
+  FLEX_ROBOT_TYPE,
+  STAGING_AREA_RIGHT_SLOT_FIXTURE,
+  TRASH_BIN_ADAPTER_FIXTURE,
+  WASTE_CHUTE_RIGHT_ADAPTER_COVERED_FIXTURE,
+  WASTE_CHUTE_RIGHT_ADAPTER_NO_COVER_FIXTURE,
+  STAGING_AREA_SLOT_WITH_WASTE_CHUTE_RIGHT_ADAPTER_COVERED_FIXTURE,
+  STAGING_AREA_SLOT_WITH_WASTE_CHUTE_RIGHT_ADAPTER_NO_COVER_FIXTURE,
+} from './constants'
+import type { CutoutFixtureId, CutoutId, OT2CutoutId } from '../deck'
+import type { AddressableArea, CoordinateTuple, DeckDefinition } from './types'
+
+export function getCutoutDisplayName(cutout: CutoutId): string {
+  return cutout.replace('cutout', '')
+}
+
+// mapping of OT-2 deck slots to cutouts
+export const OT2_CUTOUT_BY_SLOT_ID: { [slotId: string]: OT2CutoutId } = {
+  1: 'cutout1',
+  2: 'cutout2',
+  3: 'cutout3',
+  4: 'cutout4',
+  5: 'cutout5',
+  6: 'cutout6',
+  7: 'cutout7',
+  8: 'cutout8',
+  9: 'cutout9',
+  10: 'cutout10',
+  11: 'cutout11',
+  fixedTrash: 'cutout12',
+}
+
+// mapping of Flex deck slots to cutouts
+export const FLEX_CUTOUT_BY_SLOT_ID: { [slotId: string]: CutoutId } = {
+  A1: 'cutoutA1',
+  A2: 'cutoutA2',
+  A3: 'cutoutA3',
+  A4: 'cutoutA3',
+  B1: 'cutoutB1',
+  B2: 'cutoutB2',
+  B3: 'cutoutB3',
+  B4: 'cutoutB3',
+  C1: 'cutoutC1',
+  C2: 'cutoutC2',
+  C3: 'cutoutC3',
+  C4: 'cutoutC3',
+  D1: 'cutoutD1',
+  D2: 'cutoutD2',
+  D3: 'cutoutD3',
+  D4: 'cutoutD3',
+}
+
+// returns the position associated with a slot id
+export function getPositionFromSlotId(
+  slotId: string,
+  deckDef: DeckDefinition
+): CoordinateTuple | null {
+  const cutoutWithSlot =
+    deckDef.robot.model === FLEX_ROBOT_TYPE
+      ? FLEX_CUTOUT_BY_SLOT_ID[slotId]
+      : OT2_CUTOUT_BY_SLOT_ID[slotId]
+
+  const cutoutPosition =
+    deckDef.locations.cutouts.find(cutout => cutout.id === cutoutWithSlot)
+      ?.position ?? null
+
+  // adjust for offset from cutout
+  const offsetFromCutoutFixture = getAddressableAreaFromSlotId(slotId, deckDef)
+    ?.offsetFromCutoutFixture ?? [0, 0, 0]
+
+  const slotPosition: CoordinateTuple | null =
+    cutoutPosition != null
+      ? [
+          cutoutPosition[0] + offsetFromCutoutFixture[0],
+          cutoutPosition[1] + offsetFromCutoutFixture[1],
+          cutoutPosition[2] + offsetFromCutoutFixture[2],
+        ]
+      : null
+
+  return slotPosition
+}
+
+export function getAddressableAreaFromSlotId(
+  slotId: string,
+  deckDef: DeckDefinition
+): AddressableArea | null {
+  return (
+    deckDef.locations.addressableAreas.find(
+      addressableArea => addressableArea.id === slotId
+    ) ?? null
+  )
+}
+
+export function getFixtureDisplayName(
+  cutoutFixtureId: CutoutFixtureId | null
+): string {
+  if (cutoutFixtureId === STAGING_AREA_RIGHT_SLOT_FIXTURE) {
+    return 'Staging area slot'
+  } else if (cutoutFixtureId === TRASH_BIN_ADAPTER_FIXTURE) {
+    return 'Trash bin'
+  } else if (cutoutFixtureId === WASTE_CHUTE_RIGHT_ADAPTER_NO_COVER_FIXTURE) {
+    return 'Waste chute only'
+  } else if (cutoutFixtureId === WASTE_CHUTE_RIGHT_ADAPTER_COVERED_FIXTURE) {
+    return 'Waste chute only with cover'
+  } else if (
+    cutoutFixtureId ===
+    STAGING_AREA_SLOT_WITH_WASTE_CHUTE_RIGHT_ADAPTER_NO_COVER_FIXTURE
+  ) {
+    return 'Waste chute with staging area slot'
+  } else if (
+    cutoutFixtureId ===
+    STAGING_AREA_SLOT_WITH_WASTE_CHUTE_RIGHT_ADAPTER_COVERED_FIXTURE
+  ) {
+    return 'Waste chute with staging area slot and cover'
+  } else {
+    return 'Slot'
+  }
+}
+
+const STANDARD_OT2_SLOTS = [
+  '1',
+  '2',
+  '3',
+  '4',
+  '5',
+  '6',
+  '7',
+  '8',
+  '9',
+  '10',
+  '11',
+]
+
+const STANDARD_FLEX_SLOTS = [
+  'A1',
+  'A2',
+  'A3',
+  'B1',
+  'B2',
+  'B3',
+  'C1',
+  'C2',
+  'C3',
+  'D1',
+  'D2',
+  'D3',
+]
+
+export const isAddressableAreaStandardSlot = (
+  addressableAreaId: string,
+  deckDef: DeckDefinition
+): boolean =>
+  (deckDef.robot.model === FLEX_ROBOT_TYPE
+    ? STANDARD_FLEX_SLOTS
+    : STANDARD_OT2_SLOTS
+  ).includes(addressableAreaId)