From 383936698d9b90dab0b218cba72a04436e1939e0 Mon Sep 17 00:00:00 2001
From: Ryan Howard <ryan.howard@opentrons.com>
Date: Wed, 20 Nov 2024 13:36:20 -0500
Subject: [PATCH] chore(shared-data): rename emulsify to em (#16911)

<!--
Thanks for taking the time to open a Pull Request (PR)! Please make sure
you've read the "Opening Pull Requests" section of our Contributing
Guide:


https://github.com/Opentrons/opentrons/blob/edge/CONTRIBUTING.md#opening-pull-requests

GitHub provides robust markdown to format your PR. Links, diagrams,
pictures, and videos along with text formatting make it possible to
create a rich and informative PR. For more information on GitHub
markdown, see:


https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax

To ensure your code is reviewed quickly and thoroughly, please fill out
the sections below to the best of your ability!
-->

# Overview
In order to simplify and make future planning for how to display this
OEM rename emulsify to EM everywhere for the new 8 channel
<!--
Describe your PR at a high level. State acceptance criteria and how this
PR fits into other work. Link issues, PRs, and other relevant resources.
-->

## Test Plan and Hands on Testing

<!--
Describe your testing of the PR. Emphasize testing not reflected in the
code. Attach protocols, logs, screenshots and any other assets that
support your testing.
-->

## Changelog

<!--
List changes introduced by this PR considering future developers and the
end user. Give careful thought and clear documentation to breaking
changes.
-->

## Review requests

<!--
- What do you need from reviewers to feel confident this PR is ready to
merge?
- Ask questions.
-->

## Risk assessment

<!--
- Indicate the level of attention this PR needs.
- Provide context to guide reviewers.
- Discuss trade-offs, coupling, and side effects.
- Look for the possibility, even if you think it's small, that your
change may affect some other part of the system.
- For instance, changing return tip behavior may also change the
behavior of labware calibration.
- How do your unit tests and on hands on testing mitigate this PR's
risks and the risk of future regressions?
- Especially in high risk PRs, explain how you know your testing is
enough.
-->
---
 .../opentrons/hardware_control/backends/ot3controller.py    | 2 +-
 hardware/opentrons_hardware/firmware_bindings/constants.py  | 2 +-
 hardware/opentrons_hardware/instruments/pipettes/serials.py | 2 +-
 .../tests/opentrons_hardware/instruments/test_serials.py    | 4 ++--
 shared-data/command/schemas/11.json                         | 2 +-
 shared-data/js/constants.ts                                 | 1 +
 .../p1000/3_0.json                                          | 2 +-
 .../p1000/3_0.json                                          | 2 +-
 .../p1000/placeholder.gltf                                  | 0
 .../p1000/default/3_0.json                                  | 0
 .../python/opentrons_shared_data/pipette/dev_types.py       | 4 ++--
 .../python/opentrons_shared_data/pipette/load_data.py       | 4 ++--
 .../pipette/scripts/update_configuration_files.py           | 2 +-
 shared-data/python/opentrons_shared_data/pipette/types.py   | 4 ++--
 .../python/tests/pipette/test_max_flow_rates_per_volume.py  | 2 +-
 shared-data/python/tests/pipette/test_validate_schema.py    | 6 +++---
 16 files changed, 20 insertions(+), 19 deletions(-)
 rename shared-data/pipette/definitions/2/general/{eight_channel_emulsify => eight_channel_em}/p1000/3_0.json (99%)
 rename shared-data/pipette/definitions/2/geometry/{eight_channel_emulsify => eight_channel_em}/p1000/3_0.json (93%)
 rename shared-data/pipette/definitions/2/geometry/{eight_channel_emulsify => eight_channel_em}/p1000/placeholder.gltf (100%)
 rename shared-data/pipette/definitions/2/liquid/{eight_channel_emulsify => eight_channel_em}/p1000/default/3_0.json (100%)

diff --git a/api/src/opentrons/hardware_control/backends/ot3controller.py b/api/src/opentrons/hardware_control/backends/ot3controller.py
index 627d6f5c424..1251fcc4adb 100644
--- a/api/src/opentrons/hardware_control/backends/ot3controller.py
+++ b/api/src/opentrons/hardware_control/backends/ot3controller.py
@@ -1008,7 +1008,7 @@ def _lookup_serial_key(pipette_name: FirmwarePipetteName) -> str:
         lookup_name = {
             FirmwarePipetteName.p1000_single: "P1KS",
             FirmwarePipetteName.p1000_multi: "P1KM",
-            FirmwarePipetteName.p1000_multi_emulsify: "P1KP",
+            FirmwarePipetteName.p1000_multi_em: "P1KP",
             FirmwarePipetteName.p50_single: "P50S",
             FirmwarePipetteName.p50_multi: "P50M",
             FirmwarePipetteName.p1000_96: "P1KH",
diff --git a/hardware/opentrons_hardware/firmware_bindings/constants.py b/hardware/opentrons_hardware/firmware_bindings/constants.py
index 435e13ab2a1..ecdc8ae8c64 100644
--- a/hardware/opentrons_hardware/firmware_bindings/constants.py
+++ b/hardware/opentrons_hardware/firmware_bindings/constants.py
@@ -359,7 +359,7 @@ class PipetteName(int, Enum):
     p1000_96 = 0x04
     p50_96 = 0x05
     p200_96 = 0x06
-    p1000_multi_emulsify = 0x07
+    p1000_multi_em = 0x07
     unknown = 0xFFFF
 
 
diff --git a/hardware/opentrons_hardware/instruments/pipettes/serials.py b/hardware/opentrons_hardware/instruments/pipettes/serials.py
index a29366649cf..c18772fe656 100644
--- a/hardware/opentrons_hardware/instruments/pipettes/serials.py
+++ b/hardware/opentrons_hardware/instruments/pipettes/serials.py
@@ -27,7 +27,7 @@
 NAME_LOOKUP: Dict[str, PipetteName] = {
     "P1KS": PipetteName.p1000_single,
     "P1KM": PipetteName.p1000_multi,
-    "P1KP": PipetteName.p1000_multi_emulsify,
+    "P1KP": PipetteName.p1000_multi_em,
     "P50S": PipetteName.p50_single,
     "P50M": PipetteName.p50_multi,
     "P1KH": PipetteName.p1000_96,
diff --git a/hardware/tests/opentrons_hardware/instruments/test_serials.py b/hardware/tests/opentrons_hardware/instruments/test_serials.py
index 4784ad9a08c..2820b5ffbe5 100644
--- a/hardware/tests/opentrons_hardware/instruments/test_serials.py
+++ b/hardware/tests/opentrons_hardware/instruments/test_serials.py
@@ -42,9 +42,9 @@
         ),
         (
             "P1KPV30",
-            PipetteName.p1000_multi_emulsify,
+            PipetteName.p1000_multi_em,
             30,
-            b"\x00"*16,
+            b"\x00" * 16,
         ),
     ],
 )
diff --git a/shared-data/command/schemas/11.json b/shared-data/command/schemas/11.json
index 37e59f9ef54..cc2202f850d 100644
--- a/shared-data/command/schemas/11.json
+++ b/shared-data/command/schemas/11.json
@@ -2690,7 +2690,7 @@
         "p1000_single_gen2",
         "p1000_single_flex",
         "p1000_multi_flex",
-        "p1000_multi_emulsify",
+        "p1000_multi_em",
         "p1000_96",
         "p200_96"
       ],
diff --git a/shared-data/js/constants.ts b/shared-data/js/constants.ts
index 8772a5ab3b9..888d9f0c2f7 100644
--- a/shared-data/js/constants.ts
+++ b/shared-data/js/constants.ts
@@ -145,6 +145,7 @@ export const OT3_PIPETTES = [
   'p50_single_flex',
   'p50_multi_flex',
   'p1000_multi_flex',
+  'p1000_multi_em_flex',
   'p1000_96',
   'p200_96',
 ]
diff --git a/shared-data/pipette/definitions/2/general/eight_channel_emulsify/p1000/3_0.json b/shared-data/pipette/definitions/2/general/eight_channel_em/p1000/3_0.json
similarity index 99%
rename from shared-data/pipette/definitions/2/general/eight_channel_emulsify/p1000/3_0.json
rename to shared-data/pipette/definitions/2/general/eight_channel_em/p1000/3_0.json
index 0d68704a00a..c49ae20d87a 100644
--- a/shared-data/pipette/definitions/2/general/eight_channel_emulsify/p1000/3_0.json
+++ b/shared-data/pipette/definitions/2/general/eight_channel_em/p1000/3_0.json
@@ -1,6 +1,6 @@
 {
   "$otSharedSchema": "#/pipette/schemas/2/pipettePropertiesSchema.json",
-  "displayName": "FLEX 8-Channel Emulsifying 1000 μL",
+  "displayName": "FLEX 8-Channel EM 1000 μL",
   "model": "p1000",
   "displayCategory": "FLEX",
   "validNozzleMaps": {
diff --git a/shared-data/pipette/definitions/2/geometry/eight_channel_emulsify/p1000/3_0.json b/shared-data/pipette/definitions/2/geometry/eight_channel_em/p1000/3_0.json
similarity index 93%
rename from shared-data/pipette/definitions/2/geometry/eight_channel_emulsify/p1000/3_0.json
rename to shared-data/pipette/definitions/2/geometry/eight_channel_em/p1000/3_0.json
index d464cd5b9fe..b92e7415fe3 100644
--- a/shared-data/pipette/definitions/2/geometry/eight_channel_emulsify/p1000/3_0.json
+++ b/shared-data/pipette/definitions/2/geometry/eight_channel_em/p1000/3_0.json
@@ -1,6 +1,6 @@
 {
   "$otSharedSchema": "#/pipette/schemas/2/pipetteGeometrySchema.json",
-  "pathTo3D": "pipette/definitions/2/geometry/eight_channel_emulsify/p1000/placeholder.gltf",
+  "pathTo3D": "pipette/definitions/2/geometry/eight_channel_em/p1000/placeholder.gltf",
   "nozzleOffset": [-8.0, -16.0, -259.15],
   "pipetteBoundingBoxOffsets": {
     "backLeftCorner": [-38.5, 0.0, -259.15],
diff --git a/shared-data/pipette/definitions/2/geometry/eight_channel_emulsify/p1000/placeholder.gltf b/shared-data/pipette/definitions/2/geometry/eight_channel_em/p1000/placeholder.gltf
similarity index 100%
rename from shared-data/pipette/definitions/2/geometry/eight_channel_emulsify/p1000/placeholder.gltf
rename to shared-data/pipette/definitions/2/geometry/eight_channel_em/p1000/placeholder.gltf
diff --git a/shared-data/pipette/definitions/2/liquid/eight_channel_emulsify/p1000/default/3_0.json b/shared-data/pipette/definitions/2/liquid/eight_channel_em/p1000/default/3_0.json
similarity index 100%
rename from shared-data/pipette/definitions/2/liquid/eight_channel_emulsify/p1000/default/3_0.json
rename to shared-data/pipette/definitions/2/liquid/eight_channel_em/p1000/default/3_0.json
diff --git a/shared-data/python/opentrons_shared_data/pipette/dev_types.py b/shared-data/python/opentrons_shared_data/pipette/dev_types.py
index 0b5b5672ca4..8ae367378f2 100644
--- a/shared-data/python/opentrons_shared_data/pipette/dev_types.py
+++ b/shared-data/python/opentrons_shared_data/pipette/dev_types.py
@@ -31,7 +31,7 @@
     "p1000_single_gen2",
     "p1000_single_flex",
     "p1000_multi_flex",
-    "p1000_multi_emulsify",
+    "p1000_multi_em",
     "p1000_96",
     "p200_96",
 ]
@@ -58,7 +58,7 @@ class PipetteNameType(str, Enum):
     P1000_SINGLE_GEN2 = "p1000_single_gen2"
     P1000_SINGLE_FLEX = "p1000_single_flex"
     P1000_MULTI_FLEX = "p1000_multi_flex"
-    P1000_MULTI_EMULSIFY = "p1000_multi_emulsify"
+    P1000_MULTI_EM = "p1000_multi_em"
     P1000_96 = "p1000_96"
     P200_96 = "p200_96"
 
diff --git a/shared-data/python/opentrons_shared_data/pipette/load_data.py b/shared-data/python/opentrons_shared_data/pipette/load_data.py
index fb121725c37..40027d54394 100644
--- a/shared-data/python/opentrons_shared_data/pipette/load_data.py
+++ b/shared-data/python/opentrons_shared_data/pipette/load_data.py
@@ -114,13 +114,13 @@ def load_serial_lookup_table() -> Dict[str, str]:
         "eight_channel": "M",
         "single_channel": "S",
         "ninety_six_channel": "H",
-        "eight_channel_emulsify": "P",
+        "eight_channel_em": "P",
     }
     _channel_model_str = {
         "single_channel": "single",
         "ninety_six_channel": "96",
         "eight_channel": "multi",
-        "eight_channel_emulsify": "multi_emulsify",
+        "eight_channel_em": "multi_em",
     }
     _model_shorthand = {"p1000": "p1k", "p300": "p3h"}
     for channel_dir in _dirs_in(config_path):
diff --git a/shared-data/python/opentrons_shared_data/pipette/scripts/update_configuration_files.py b/shared-data/python/opentrons_shared_data/pipette/scripts/update_configuration_files.py
index c1e03d5ab9d..d72a09e666b 100644
--- a/shared-data/python/opentrons_shared_data/pipette/scripts/update_configuration_files.py
+++ b/shared-data/python/opentrons_shared_data/pipette/scripts/update_configuration_files.py
@@ -355,7 +355,7 @@ def _update_all_models(configuration_to_update: List[str]) -> None:
         "single_channel": "single",
         "ninety_six_channel": "96",
         "eight_channel": "multi",
-        "eight_channel_emulsify": "multi_emulsify",
+        "eight_channel_em": "multi_em",
     }
 
     for channel_dir in os.listdir(paths_to_validate):
diff --git a/shared-data/python/opentrons_shared_data/pipette/types.py b/shared-data/python/opentrons_shared_data/pipette/types.py
index 33164904d97..d5315ec12d5 100644
--- a/shared-data/python/opentrons_shared_data/pipette/types.py
+++ b/shared-data/python/opentrons_shared_data/pipette/types.py
@@ -216,7 +216,7 @@ def dict_for_encode(self) -> bool:
     "p1000_single_gen2",
     "p1000_single_flex",
     "p1000_multi_flex",
-    "p1000_multi_emulsify",
+    "p1000_multi_em",
     "p1000_96",
     "p200_96",
 ]
@@ -243,7 +243,7 @@ class PipetteNameType(str, enum.Enum):
     P1000_SINGLE_GEN2 = "p1000_single_gen2"
     P1000_SINGLE_FLEX = "p1000_single_flex"
     P1000_MULTI_FLEX = "p1000_multi_flex"
-    P1000_MULTI_EMULSIFY = "p1000_multi_emulsify"
+    P1000_MULTI_EM = "p1000_multi_em"
     P1000_96 = "p1000_96"
     P200_96 = "p200_96"
 
diff --git a/shared-data/python/tests/pipette/test_max_flow_rates_per_volume.py b/shared-data/python/tests/pipette/test_max_flow_rates_per_volume.py
index c5e9cc49604..aae0c1a4e1b 100644
--- a/shared-data/python/tests/pipette/test_max_flow_rates_per_volume.py
+++ b/shared-data/python/tests/pipette/test_max_flow_rates_per_volume.py
@@ -49,7 +49,7 @@ def get_all_pipette_models() -> Iterator[PipetteModel]:
         "single_channel": "single",
         "ninety_six_channel": "96",
         "eight_channel": "multi",
-        "eight_channel_emulsify": "multi_emulsify",
+        "eight_channel_em": "multi_em",
     }
     assert os.listdir(paths_to_validate), "You have a path wrong"
     for channel_dir in os.listdir(paths_to_validate):
diff --git a/shared-data/python/tests/pipette/test_validate_schema.py b/shared-data/python/tests/pipette/test_validate_schema.py
index 5d3080dbd7a..57f19dfe3ad 100644
--- a/shared-data/python/tests/pipette/test_validate_schema.py
+++ b/shared-data/python/tests/pipette/test_validate_schema.py
@@ -22,7 +22,7 @@ def iterate_models() -> Iterator[PipetteModel]:
         "single_channel": "single",
         "ninety_six_channel": "96",
         "eight_channel": "multi",
-        "eight_channel_emulsify": "multi_emulsify",
+        "eight_channel_em": "multi_em",
     }
     defn_root = get_shared_data_root() / "pipette" / "definitions" / "2" / "liquid"
     assert os.listdir(defn_root), "A path is wrong"
@@ -64,7 +64,7 @@ def test_pick_up_configs_configuration_by_nozzle_map_keys() -> None:
         "single_channel": "single",
         "ninety_six_channel": "96",
         "eight_channel": "multi",
-        "eight_channel_emulsify": "multi_emulsify",
+        "eight_channel_em": "multi_em",
     }
     assert os.listdir(paths_to_validate), "You have a path wrong"
     for channel_dir in os.listdir(paths_to_validate):
@@ -107,7 +107,7 @@ def test_pick_up_configs_configuration_ordered_from_smallest_to_largest() -> Non
         "single_channel": "single",
         "ninety_six_channel": "96",
         "eight_channel": "multi",
-        "eight_channel_emulsify": "multi_emulsify",
+        "eight_channel_em": "multi_em",
     }
     assert os.listdir(paths_to_validate), "You have a path wrong"
     for channel_dir in os.listdir(paths_to_validate):