fix(protocol-designer): heater-shaker caption and error copy (#18933)

This PR updates the heater-shaker shake speed and temperature range
captions to match designs. It also updates the error copy to display
"Enter a value within the specified range" whether the relevant
temperature field is empty, or it is entered but out of range.

Closes RQA-4196

Author: ncdiehl11

protocol-designer/src/assets/localization/en/form.json

@@ -187,7 +187,7 @@
         "duration": "Duration",
         "latch": {
           "setLatch": "Labware latch",
-          "toggleOff": "Close",
+          "toggleOff": "Closed",
           "toggleOn": "Open"
         },
         "shaker": {

protocol-designer/src/assets/localization/en/protocol_steps.json

@@ -4,53 +4,53 @@
   "air_gap_volume": "Air gap volume",
   "all": "All",
   "and": "and",
-  "aspirate_labware": "Source labware",
   "aspirate": "Aspirate",
+  "aspirate_labware": "Source labware",
   "aspirated": "Aspirated",
-  "back_to_overview": "Back to overview",
   "back": "Back",
-  "batch_edit_steps": "Batch edit steps",
+  "back_to_overview": "Back to overview",
   "batch_edit": "Batch edit",
+  "batch_edit_steps": "Batch edit steps",
   "batch_edits_saved": "Batch edits saved",
   "blowout_location": "Blowout location",
   "blowout_position": "Blowout position from top",
   "captions_for_fields": {
     "blockTargetTemp": "Valid range between 4 and 99˚C",
+    "blockTargetTempHold": "Valid range between 4 and 99˚C",
+    "heaterShakerTimer": "Use the format mm:ss",
     "lidTargetTemp": "Valid range between 37 and 110˚C",
-    "targetSpeed": "Must be between 200 and 3000 rpm",
-    "targetTemperature": "Must be between 4 and 95˚C",
-    "targetHeaterShakerTemperature": "Must be between 37 and 95˚C",
-    "blockTargetTempHold": "Must be between 4 and 99˚C",
-    "lidTargetTempHold": "Must be between 37 and 110˚C",
-    "volume": "Must be between 0.1 and {{max}}"
+    "lidTargetTempHold": "Valid range between 37 and 110˚C",
+    "targetHeaterShakerTemperature": "Valid range between 37 and 95˚C",
+    "targetSpeed": "Valid range between 200 and 3000 rpm",
+    "targetTemperature": "Valid range between 4 and 95˚C",
+    "volume": "Valid range between 0.1 and {{max}}"
   },
   "change_tips": "Change tips",
   "column": "Column",
-  "configuration": "Configuration",
-  "consolidate": "Conslidate",
-  "of": "of",
   "comfirm_reset_settings": {
-    "no_liquid_class": "Continuing will undo any changes and restore the settings to the default values.",
-    "liquid_class_selected": "Continuing will undo any changes and restore the settings to the values associated with the {{liquidClassName}} liquid class."
+    "liquid_class_selected": "Continuing will undo any changes and restore the settings to the values associated with the {{liquidClassName}} liquid class.",
+    "no_liquid_class": "Continuing will undo any changes and restore the settings to the default values."
   },
+  "configuration": "Configuration",
+  "consolidate": "Conslidate",
   "deck_hardware": "Deck hardware",
   "default_flow_rate": "The default flow rate is {{flowRate}}",
   "default_tip_option": "Default - get next tip",
   "delay_duration": "Delay duration",
   "delay_position": "Delay position from bottom",
-  "delete_steps": "Delete steps",
   "delete": "Delete step",
-  "dispense_labware": "Destination labware",
-  "distribute": "Distribute",
+  "delete_steps": "Delete steps",
   "dispense": "Dispense",
+  "dispense_labware": "Destination labware",
   "dispensed": "Dispensed",
   "disposal_volume": "Disposal volume",
-  "duplicate_steps": "Duplicate steps",
+  "distribute": "Distribute",
   "duplicate": "Duplicate step",
-  "edit_step": "Edit step",
+  "duplicate_steps": "Duplicate steps",
   "edit_hardware": "Edit your deck hardware",
-  "edit_modules": "Edit modules",
   "edit_hardware_on_deck": "Edit your deck hardware by placing modules and fixtures onto the deck",
+  "edit_modules": "Edit modules",
+  "edit_step": "Edit step",
   "ending_deck": "Ending deck",
   "engage_height": "Engage height",
   "flow_type_title": "{{type}} flow rate",
@@ -72,19 +72,19 @@
   "heater_shaker_state": "Heater-Shaker state",
   "in": "in",
   "into": "into",
+  "labware_in": "Labware in",
   "labware_to": "{{labware}} to",
   "liquids": "{{num}} liquids",
-  "labware_in": "Labware in",
   "magnetic_module": {
     "disengage": "<semiBoldText>{{module}}</semiBoldText><text>disengaged</text>",
     "engage": "<semiBoldText>{{module}}</semiBoldText><text>engaged to</text><tag/>"
   },
   "max_disposal_volume": "Max {{vol}} {{unit}}",
+  "mix": "Mix",
+  "mix_repetitions": "Mix repetitions",
   "mix_times": "Mix repetitions",
   "mix_volume": "Mix volume",
-  "mix": "Mix",
   "mixing": "Mixing",
-  "mix_repetitions": "Mix repetitions",
   "module": "Module",
   "modules": "Modules",
   "modules_and_fixtures": "Modules and fixtures",
@@ -97,33 +97,34 @@
   "multiDispense": "Distribute",
   "new_location": "New location",
   "no_tiprack": "No tiprack available",
+  "of": "of",
   "off_deck": "Off-Deck",
   "pause": {
     "untilResume": "Pausing until manually told to resume",
     "untilTemperature": "<text>Pausing until</text><semiBoldText>{{module}}</semiBoldText><text>reaches</text><tag/>",
     "untilTime": "<text>Pausing for</text><tag/>"
   },
-  "pipette_path": "Pipette path",
   "pipette": "Pipette",
+  "pipette_path": "Pipette path",
   "place_hardware": "Place the modules and fixtures that you are using for this protocol onto the deck.",
   "place_modules": "Place the modules that you are using for this protocol onto the deck.",
   "protocol_steps": "Protocol steps",
   "protocol_timeline": "Protocol timeline",
   "reference_positions": {
-    "well-top": "well top",
+    "liquid-meniscus": "liquid meniscus",
     "well-bottom": "well bottom",
     "well-center": "well center",
-    "liquid-meniscus": "liquid meniscus"
+    "well-top": "well top"
   },
-  "rename_error": "Oops! Your step name is too long.",
   "rename": "Rename",
+  "rename_error": "Oops! Your step name is too long.",
   "reset_settings": "Reset {{tab}} settings",
-  "retract_speed": "Retract speed",
   "retract": "Retract",
+  "retract_speed": "Retract speed",
   "save_errors": "{{stepType}} has been saved with {{numErrors}} error(s)",
   "save_no_errors": "{{stepType}} has been saved",
-  "save_warnings_and_errors": "{{stepType}} has been saved with {{numErrors}} error(s) and {{numWarnings}} warning(s)",
   "save_warnings": "{{stepType}} has been saved with {{numWarnings}} warning(s)",
+  "save_warnings_and_errors": "{{stepType}} has been saved with {{numErrors}} error(s) and {{numWarnings}} warning(s)",
   "select_aspirate_labware": "Select a source labware",
   "select_aspirate_wells": "Select source wells using a {{displayName}}",
   "select_dispense_labware": "Select a destination labware",
@@ -137,19 +138,18 @@
   "select_volume": "Select a volume",
   "select_wells": "Select wells using a {{displayName}}",
   "shake": "Shake",
-  "single_nozzle": "Single",
   "single": "Single transfer",
+  "single_nozzle": "Single",
   "speed": "Speed",
   "starting_deck": "Starting deck",
   "step_substeps": "{{stepType}} details",
-  "submerge_speed": "Submerge speed",
   "submerge": "Submerge",
+  "submerge_speed": "Submerge speed",
   "temperature": "Temperature",
   "temperature_module": {
     "active": "<semiBoldText>{{module}}</semiBoldText><text>set to</text><tag/>",
     "deactivated": "<semiBoldText>{{module}}</semiBoldText><text>deactivated</text>"
   },
-  "time_in": "{{times}} times in",
   "thermocycler_module": {
     "lid_position": {
       "closed": "closed",
@@ -172,14 +172,15 @@
     }
   },
   "time": "Time",
+  "time_in": "{{times}} times in",
   "timeline": "Timeline",
-  "tiprack": "Tiprack",
   "tip_handling": {
     "title": "Tip pickup behavior",
     "tooltip": "Choose tip pickup frequency for aspirations"
   },
   "tip_management": "Tip management",
   "tip_position": "{{prefix}} tip position",
+  "tiprack": "Tiprack",
   "touch_tip_position": "Touch tip position from top",
   "transfer": "Transfer",
   "unknown_module": "Unknown module",
@@ -189,11 +190,11 @@
   "volume_per_well": "Volume per well",
   "well_name": "Well {{wellName}}",
   "well_order_title": "{{prefix}} well order",
-  "well_position_with_reference_nested": "Well position (x,y,z): {{x}}mm, {{y}}mm, {{z}}mm from {{reference}}",
+  "well_position": "Well position: X {{x}} Y {{y}} Z {{z}} (mm)",
   "well_position_with_reference": "Well position: X {{x}} Y {{y}} Z {{z}} (mm) from {{reference}}",
+  "well_position_with_reference_nested": "Well position (x,y,z): {{x}}mm, {{y}}mm, {{z}}mm from {{reference}}",
   "well_position_xyz": "Well position (x,y,z): {{x}}mm, {{y}}mm, {{z}}mm",
   "well_position_z_only": "Well position: Z {{z}} (mm)",
-  "well_position": "Well position: X {{x}} Y {{y}} Z {{z}} (mm)",
   "wells_in_labware": "{{well}} of {{labware}}",
   "wells_of": "{{wells}} of"
 }

protocol-designer/src/steplist/formLevel/errors.ts

@@ -79,6 +79,7 @@ export interface FormError {
 }
 
 const RANGE_TITLE = 'Enter a value within the specified range'
+const TIME_TITLE = 'Enter a value that uses the specified format'
 
 const INCOMPATIBLE_ASPIRATE_LABWARE: FormError = {
   title: 'Selected aspirate labware is incompatible with pipette',
@@ -203,17 +204,17 @@ const LID_TEMPERATURE_HOLD_REQUIRED: FormError = {
   page: 1,
 }
 const SHAKE_SPEED_REQUIRED: FormError = {
-  title: 'Speed required',
+  title: RANGE_TITLE,
   dependentFields: ['setShake', 'targetSpeed'],
   location: 'field',
 }
 const SHAKE_TIME_REQUIRED: FormError = {
-  title: 'Duration required',
+  title: TIME_TITLE,
   dependentFields: ['heaterShakerSetTimer', 'heaterShakerTimer'],
   location: 'field',
 }
 const SHAKER_TIME_FORMAT: FormError = {
-  title: 'Must be a valid time (mm:ss)',
+  title: TIME_TITLE,
   dependentFields: ['heaterShakerTimer'],
   location: 'field',
 }
@@ -235,7 +236,7 @@ const PAUSE_TEMP_REQUIRED: FormError = {
   location: 'field',
 }
 const HS_TEMPERATURE_REQUIRED: FormError = {
-  title: 'Temperature required',
+  title: RANGE_TITLE,
   dependentFields: [
     'targetHeaterShakerTemperature',
     'setHeaterShakerTemperature',