feat(app, api-client): usbPort type to match what robot server returns (

#13092) closes RAUT-544
Opentrons · Jul 14, 2023 · 46690d8 · 46690d8
1 parent 0630f70
commit 46690d8
Show file tree

Hide file tree

Showing 18 changed files with 195 additions and 95 deletions.
diff --git a/api-client/src/modules/__fixtures__/index.ts b/api-client/src/modules/__fixtures__/index.ts
@@ -19,6 +19,8 @@ export const mockModulesResponse = [
     usbPort: {
       port: 0,
       path: '',
+      hub: false,
+      portGroup: 'unknown',
     },
   },
   {
@@ -36,10 +38,13 @@ export const mockModulesResponse = [
       currentSpeed: 0,
       temperatureStatus: 'idle',
       currentTemperature: 23.0,
+      targetSpeed: null,
     },
     usbPort: {
       port: 0,
       path: '',
+      hub: false,
+      portGroup: 'unknown',
     },
   },
   {
@@ -58,6 +63,8 @@ export const mockModulesResponse = [
     usbPort: {
       port: 0,
       path: '',
+      hub: false,
+      portGroup: 'unknown',
     },
   },
   {
@@ -76,6 +83,8 @@ export const mockModulesResponse = [
     usbPort: {
       port: 0,
       path: '',
+      hub: false,
+      portGroup: 'unknown',
     },
   },
 ]
@@ -87,8 +96,10 @@ export const v2MockModulesResponse = [
     moduleModel: 'thermocyclerModuleV1',
     port: '/dev/ot_module_sim_thermocycler0',
     usbPort: {
-      hub: null,
       port: 0,
+      hub: false,
+      portGroup: 'unknown',
+      path: '',
     },
     serial: 'dummySerialTC',
     model: 'dummyModelTC',
@@ -116,7 +127,9 @@ export const v2MockModulesResponse = [
     moduleModel: 'heaterShakerModuleV1',
     port: '/dev/ot_module_sim_heatershaker1',
     usbPort: {
-      hub: null,
+      hub: false,
+      portGroup: 'unknown',
+      path: '',
       port: 0,
     },
     serial: 'dummySerialHS',
@@ -142,7 +155,9 @@ export const v2MockModulesResponse = [
     moduleModel: 'temperatureModuleV1',
     port: '/dev/ot_module_sim_tempdeck2',
     usbPort: {
-      hub: null,
+      hub: false,
+      portGroup: 'unknown',
+      path: '',
       port: 0,
     },
     serial: 'dummySerialTD',
@@ -162,8 +177,10 @@ export const v2MockModulesResponse = [
     moduleModel: 'magneticModuleV1',
     port: '/dev/ot_module_sim_magdeck3',
     usbPort: {
-      hub: null,
       port: 0,
+      hub: false,
+      portGroup: 'unknown',
+      path: '',
     },
     serial: 'dummySerialMD',
     model: 'mag_deck_v1.1',

diff --git a/api-client/src/modules/api-types.ts b/api-client/src/modules/api-types.ts
@@ -2,10 +2,12 @@ import { ModuleType } from '@opentrons/shared-data'
 
 import type { ModuleModel } from '@opentrons/shared-data'
 
+type PortGroup = 'main' | 'left' | 'right' | 'front' | 'unknown'
 interface PhysicalPort {
   path: string | null
-  port: number | null
-  hub: number | null
+  port: number
+  hub: boolean
+  portGroup: PortGroup
 }
 
 export interface ApiBaseModule {

diff --git a/app/src/assets/localization/en/device_details.json b/app/src/assets/localization/en/device_details.json
@@ -132,8 +132,8 @@
   "to_run_protocol_go_to_protocols_page": "To run a protocol on this robot, import a protocol on the <navlink>Protocols page</navlink>",
   "update_now": "Update now",
   "updating_firmware": "Updating firmware...",
-  "usb_hub": "usb-{{port}} via hub",
   "usb_port": "usb-{{port}}",
+  "usb_port_not_connected": "usb not connected",
   "version": "Version {{version}}",
   "view_pipette_setting": "Pipette Settings",
   "view_run_record": "View protocol run record",

diff --git a/app/src/assets/localization/en/protocol_setup.json b/app/src/assets/localization/en/protocol_setup.json
@@ -48,7 +48,6 @@
   "heater_shaker_extra_attention": "Use latch controls for easy placement of labware.",
   "heater_shaker_labware_list_view": "To add labware, use the toggle to control the latch",
   "how_offset_data_works": "How labware offsets work",
-  "hub_port_connected": "USB Port {{port}} via hub",
   "initial_liquids_num_plural": "{{count}} initial liquids",
   "initial_liquids_num": "{{count}} initial liquid",
   "initial_location": "Initial Location",

diff --git a/app/src/organisms/Devices/HeaterShakerWizard/HeaterShakerModuleCard.tsx b/app/src/organisms/Devices/HeaterShakerWizard/HeaterShakerModuleCard.tsx
@@ -50,9 +50,11 @@ export const HeaterShakerModuleCard = (
             fontSize={TYPOGRAPHY.fontSizeCaption}
             paddingBottom={SPACING.spacing4}
           >
-            {t(module?.usbPort.port === null ? 'usb_hub' : 'usb_port', {
-              port: module?.usbPort.hub ?? module?.usbPort.port,
-            })}
+            {module?.usbPort !== null
+              ? t('usb_port', {
+                  port: module?.usbPort?.port,
+                })
+              : t('usb_port_not_connected')}
           </StyledText>
           <Flex paddingBottom={SPACING.spacing4}>
             <Icon

diff --git a/app/src/organisms/Devices/HeaterShakerWizard/PowerOn.tsx b/app/src/organisms/Devices/HeaterShakerWizard/PowerOn.tsx
@@ -62,8 +62,7 @@ export function PowerOn(props: PowerOnProps): JSX.Element {
               <ModuleInfo
                 moduleModel={moduleDef.model}
                 isAttached={props.attachedModule !== null}
-                usbPort={props.attachedModule?.usbPort.port ?? null}
-                hubPort={props.attachedModule?.usbPort.hub ?? null}
+                physicalPort={props.attachedModule?.usbPort ?? null}
               />
             </Module>
           </React.Fragment>

diff --git a/app/src/organisms/Devices/HeaterShakerWizard/__tests__/AttachAdapter.test.tsx b/app/src/organisms/Devices/HeaterShakerWizard/__tests__/AttachAdapter.test.tsx
@@ -38,7 +38,12 @@ const mockHeaterShakeShaking: HeaterShakerModule = {
     errorDetails: null,
     status: 'idle',
   },
-  usbPort: { path: '/dev/ot_module_heatershaker0', port: 1, hub: null },
+  usbPort: {
+    path: '/dev/ot_module_heatershaker0',
+    port: 1,
+    hub: false,
+    portGroup: 'unknown',
+  },
 }
 
 describe('AttachAdapter', () => {

diff --git a/app/src/organisms/Devices/HeaterShakerWizard/__tests__/PowerOn.test.tsx b/app/src/organisms/Devices/HeaterShakerWizard/__tests__/PowerOn.test.tsx
@@ -30,14 +30,13 @@ describe('PowerOn', () => {
   })
 
   it('renders heater shaker SVG with info with module connected', () => {
-    if (props.attachedModule != null) {
-      props.attachedModule.usbPort.hub = 1
-      props.attachedModule.usbPort.port = null
+    if (props.attachedModule != null && props.attachedModule.usbPort != null) {
+      props.attachedModule.usbPort.port = 1
     }
     const { getByText } = render(props)
     getByText('Connected')
     getByText('Heater-Shaker Module GEN1')
-    getByText('USB Port 1 via hub')
+    getByText('USB Port 1')
   })
 
   it('renders heater shaker SVG with info with module not connected', () => {

diff --git a/app/src/organisms/Devices/ModuleInfo.tsx b/app/src/organisms/Devices/ModuleInfo.tsx
@@ -21,17 +21,17 @@ import {
 
 import { StyledText } from '../../atoms/text'
 import { useRunHasStarted } from './hooks'
+import type { PhysicalPort } from '../../redux/modules/api-types'
 
 export interface ModuleInfoProps {
   moduleModel: ModuleModel
   isAttached: boolean
-  usbPort: number | null
-  hubPort: number | null
+  physicalPort: PhysicalPort | null
   runId?: string
 }
 
 export const ModuleInfo = (props: ModuleInfoProps): JSX.Element => {
-  const { moduleModel, usbPort, hubPort, isAttached, runId = null } = props
+  const { moduleModel, physicalPort, isAttached, runId = null } = props
   const moduleDef = getModuleDef2(moduleModel)
   const {
     xDimension,
@@ -42,17 +42,14 @@ export const ModuleInfo = (props: ModuleInfoProps): JSX.Element => {
   const { t } = useTranslation('protocol_setup')
 
   const runHasStarted = useRunHasStarted(runId)
-
   let connectionStatus = t('no_usb_port_yet')
   if (moduleModel === MAGNETIC_BLOCK_V1) {
     connectionStatus = t('no_usb_required')
   }
-  if (usbPort === null && hubPort === null && isAttached) {
+  if (physicalPort === null && isAttached) {
     connectionStatus = t('usb_connected_no_port_info')
-  } else if (hubPort === null && usbPort !== null && isAttached) {
-    connectionStatus = t('usb_port_connected', { port: usbPort })
-  } else if (hubPort !== null && isAttached) {
-    connectionStatus = t('hub_port_connected', { port: hubPort })
+  } else if (physicalPort != null && isAttached) {
+    connectionStatus = t('usb_port_connected', { port: physicalPort.port })
   }
 
   return (

diff --git a/app/src/organisms/Devices/ProtocolRun/SetupModules/SetupModulesMap.tsx b/app/src/organisms/Devices/ProtocolRun/SetupModules/SetupModulesMap.tsx
@@ -74,8 +74,7 @@ export const SetupModulesMap = ({
                         <ModuleInfo
                           moduleModel={model}
                           isAttached={attachedModuleMatch != null}
-                          usbPort={attachedModuleMatch?.usbPort.port ?? null}
-                          hubPort={attachedModuleMatch?.usbPort.hub ?? null}
+                          physicalPort={attachedModuleMatch?.usbPort ?? null}
                           runId={runId}
                         />
                       </Module>

diff --git a/app/src/organisms/Devices/ProtocolRun/SetupModules/__tests__/SetupModulesMap.test.tsx b/app/src/organisms/Devices/ProtocolRun/SetupModules/__tests__/SetupModulesMap.test.tsx
@@ -193,8 +193,7 @@ describe('SetupModulesMap', () => {
         partialComponentPropsMatcher({
           moduleModel: mockMagneticModule.model,
           isAttached: false,
-          usbPort: null,
-          hubPort: null,
+          physicalPort: null,
           runId: MOCK_RUN_ID,
         })
       )
@@ -247,8 +246,7 @@ describe('SetupModulesMap', () => {
         componentPropsMatcher({
           moduleModel: mockMagneticModule.model,
           isAttached: true,
-          usbPort: mockMagneticModuleFixture.usbPort.port,
-          hubPort: mockMagneticModuleFixture.usbPort.hub,
+          physicalPort: mockMagneticModuleFixture.usbPort,
           runId: MOCK_RUN_ID,
         })
       )
@@ -259,8 +257,7 @@ describe('SetupModulesMap', () => {
         componentPropsMatcher({
           moduleModel: mockTCModule.model,
           isAttached: true,
-          usbPort: mockThermocyclerFixture.usbPort.port,
-          hubPort: mockThermocyclerFixture.usbPort.hub,
+          physicalPort: mockThermocyclerFixture.usbPort,
           runId: MOCK_RUN_ID,
         })
       )
@@ -273,7 +270,6 @@ describe('SetupModulesMap', () => {
   it('renders Moam with the correct module in the correct slot', () => {
     const dupModId = `${mockMagneticModule.moduleId}duplicate`
     const dupModPort = 10
-    const dupModHub = 2
     when(mockUseModuleRenderInfoForProtocolById)
       .calledWith(MOCK_ROBOT_NAME, MOCK_RUN_ID)
       .mockReturnValue({
@@ -308,7 +304,9 @@ describe('SetupModulesMap', () => {
             model: mockMagneticModule.model,
             usbPort: {
               port: dupModPort,
-              hub: dupModHub,
+              hub: false,
+              portGroup: 'unknown',
+              path: '',
             },
           } as any,
           slotName: '3',
@@ -320,8 +318,7 @@ describe('SetupModulesMap', () => {
         componentPropsMatcher({
           moduleModel: mockMagneticModule.model,
           isAttached: true,
-          usbPort: mockMagneticModuleFixture.usbPort.port,
-          hubPort: mockMagneticModuleFixture.usbPort.hub,
+          physicalPort: mockMagneticModuleFixture.usbPort,
           runId: MOCK_RUN_ID,
         })
       )
@@ -332,8 +329,12 @@ describe('SetupModulesMap', () => {
         componentPropsMatcher({
           moduleModel: mockMagneticModule.model,
           isAttached: true,
-          usbPort: dupModPort,
-          hubPort: dupModHub,
+          physicalPort: {
+            port: dupModPort,
+            hub: false,
+            portGroup: 'unknown',
+            path: '',
+          },
           runId: MOCK_RUN_ID,
         })
       )

diff --git a/app/src/organisms/Devices/__tests__/ModuleInfo.test.tsx b/app/src/organisms/Devices/__tests__/ModuleInfo.test.tsx
@@ -33,8 +33,7 @@ describe('ModuleInfo', () => {
     props = {
       moduleModel: mockTCModule.model,
       isAttached: false,
-      usbPort: null,
-      hubPort: null,
+      physicalPort: null,
     }
     when(mockUseRunHasStarted).calledWith(MOCK_RUN_ID).mockReturnValue(false)
   })
@@ -48,22 +47,19 @@ describe('ModuleInfo', () => {
     getByText('Not connected')
   })
 
-  it('should show module connected and hub number', () => {
-    props = { ...props, usbPort: 1, hubPort: 1, isAttached: true }
-    const { getByText } = render(props)
-    getByText('Connected')
-    getByText('USB Port 1 via hub')
-  })
-
   it('should show module connected and no USB number', () => {
-    props = { ...props, usbPort: null, hubPort: null, isAttached: true }
+    props = { ...props, isAttached: true }
     const { getByText } = render(props)
     getByText('Connected')
     getByText('USB Port Connected')
   })
 
   it('should show module connected and USB number', () => {
-    props = { ...props, usbPort: 1, hubPort: null, isAttached: true }
+    props = {
+      ...props,
+      physicalPort: { port: 1, hub: false, portGroup: 'unknown', path: '' },
+      isAttached: true,
+    }
     const { getByText } = render(props)
     getByText('Connected')
     getByText('USB Port 1')
@@ -72,8 +68,7 @@ describe('ModuleInfo', () => {
   it('should not show module connected when run has started', () => {
     props = {
       ...props,
-      usbPort: 1,
-      hubPort: null,
+      physicalPort: { port: 1, hub: false, portGroup: 'unknown', path: '' },
       isAttached: true,
       runId: MOCK_RUN_ID,
     }

diff --git a/app/src/organisms/ModuleCard/__tests__/ErrorInfo.test.tsx b/app/src/organisms/ModuleCard/__tests__/ErrorInfo.test.tsx
@@ -35,7 +35,12 @@ const mockErrorThermocycler = {
     totalStepCount: null,
     status: 'error',
   },
-  usbPort: { path: '/dev/ot_module_thermocycler0', port: 1, hub: null },
+  usbPort: {
+    path: '/dev/ot_module_thermocycler0',
+    port: 1,
+    hub: false,
+    portGroup: 'unknown',
+  },
 } as ThermocyclerModule
 
 const mockErrorHeaterShaker = {
@@ -57,7 +62,12 @@ const mockErrorHeaterShaker = {
     errorDetails: 'errorDetails',
     status: 'error',
   },
-  usbPort: { path: '/dev/ot_module_heatershaker0', hub: null, port: 1 },
+  usbPort: {
+    path: '/dev/ot_module_heatershaker0',
+    hub: false,
+    port: 1,
+    portGroup: 'unknown',
+  },
 } as HeaterShakerModule
 
 const render = (props: React.ComponentProps<typeof ErrorInfo>) => {