Skip to content

Commit

Permalink
feat(app): add parameters to protocol run setup screen (#14685)
Browse files Browse the repository at this point in the history
* feat(app): add parameters to protocol run setup screen
  • Loading branch information
koji authored Mar 19, 2024
1 parent d370ba8 commit 34e4165
Show file tree
Hide file tree
Showing 9 changed files with 574 additions and 32 deletions.
6 changes: 5 additions & 1 deletion app/src/App/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,11 @@ export type AppSettingsTab =
| 'advanced'
| 'feature-flags'

export type ProtocolRunDetailsTab = 'setup' | 'module-controls' | 'run-preview'
export type ProtocolRunDetailsTab =
| 'setup'
| 'module-controls'
| 'run-preview'
| 'runtime-parameters'

/**
* desktop app route params type definition
Expand Down
2 changes: 1 addition & 1 deletion app/src/assets/localization/en/protocol_details.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,12 @@
"location": "location",
"modules": "modules",
"name": "Name",
"num_choices": "{{num}} choices",
"no_available_robots_found": "No available robots found",
"no_parameters": "No parameters specified in this protocol",
"no_summary": "no summary specified for this protocol.",
"not_connected": "not connected",
"not_in_protocol": "no {{section}} is specified for this protocol",
"num_choices": "{{num}} choices",
"off": "Off",
"on_off": "On, off",
"on": "On",
Expand Down
13 changes: 10 additions & 3 deletions app/src/assets/localization/en/protocol_setup.json
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
"calibration_required": "Calibration required",
"calibration_status": "calibration status",
"calibration": "Calibration",
"cancel_and_restart_to_edit": "Cancel the run and restart setup to edit",
"closing": "Closing...",
"complete_setup_before_proceeding": "complete setup before continuing run",
"configure": "Configure",
Expand All @@ -50,6 +51,7 @@
"connection_status": "Connection Status",
"currently_configured": "Currently configured",
"currently_unavailable": "Currently unavailable",
"custom_values": "Custom values",
"deck_cal_description_bullet_1": "Perform Deck Calibration during new robot setup.",
"deck_cal_description_bullet_2": "Redo Deck Calibration if you relocate your robot.",
"deck_cal_description": "This measures the deck X and Y values relative to the gantry. Deck Calibration is the foundation for Tip Length Calibration and Pipette Offset Calibration.",
Expand All @@ -58,6 +60,7 @@
"deck_conflict_info": "<block>Update the deck configuration by removing the <strong>{{currentFixture}}</strong> in location <strong>{{cutout}}</strong>. Either remove the fixture from the deck configuration or update the protocol.</block>",
"deck_conflict": "Deck location conflict",
"deck_map": "Deck Map",
"default_values": "Default values",
"example": "Example",
"extension_mount": "extension mount",
"extra_attention_warning_title": "Secure labware and modules before proceeding to run",
Expand Down Expand Up @@ -157,6 +160,7 @@
"multiple_of_most_modules": "You can use multiples of most module types within a single Python protocol by connecting and loading the modules in a specific order. The robot will initialize the matching module attached to the lowest numbered port first, regardless of what deck slot it occupies.",
"must_have_labware_and_pip": "Protocol must load labware and a pipette",
"n_a": "N/A",
"name": "Name",
"no_data": "no data",
"no_labware_offset_data": "no labware offset data yet",
"no_modules_or_fixtures": "No modules or fixtures are specified for this protocol.",
Expand All @@ -169,16 +173,16 @@
"no_usb_required": "No USB required",
"not_calibrated": "Not calibrated yet",
"not_configured": "not configured",
"off": "off",
"off_deck": "Off deck",
"off": "off",
"offset_data": "Offset Data",
"offsets_applied_plural": "{{count}} offsets applied",
"offsets_applied": "{{count}} offset applied",
"on": "on",
"on_adapter_in_mod": "on {{adapterName}} in {{moduleName}}",
"on_adapter": "on {{adapterName}}",
"on_deck": "On deck",
"on-deck_labware": "{{count}} on-deck labware",
"on": "on",
"opening": "Opening...",
"parameters": "Parameters",
"pipette_mismatch": "Pipette generation mismatch.",
Expand Down Expand Up @@ -215,8 +219,8 @@
"reset_parameter_values_body": "This will discard any changes you have made. All parameters will have their default values.",
"reset_parameter_values": "Reset parameter values?",
"reset_values": "Reset values",
"restore_default": "Restore default values",
"resolve": "Resolve",
"restore_default": "Restore default values",
"robot_cal_description": "Robot calibration establishes how the robot knows where it is in relation to the deck. Accurate Robot calibration is essential to run protocols successfully. Robot calibration has 3 parts: Deck calibration, Tip Length calibration and Pipette Offset calibration.",
"robot_cal_help_title": "How Robot Calibration Works",
"robot_calibration_step_description_pipettes_only": "Review required instruments and calibrations for this protocol.",
Expand Down Expand Up @@ -249,8 +253,11 @@
"tip_length_calibration": "tip length calibration",
"total_vol": "total volume",
"update_deck": "Update deck",
"updated": "Updated",
"usb_connected_no_port_info": "USB Port Connected",
"usb_port_connected": "USB Port {{port}}",
"value": "Value",
"values_are_view_only": "Values are view-only",
"view_current_offsets": "View current offsets",
"view_moam": "View setup instructions for placing modules of the same type to the robot.",
"view_setup_instructions": "View setup instructions",
Expand Down
52 changes: 28 additions & 24 deletions app/src/assets/localization/en/run_details.json
Original file line number Diff line number Diff line change
@@ -1,59 +1,62 @@
{
"analysis_failure_on_robot": "An error occurred while attempting to analyze {{protocolName}} on {{robotName}}. Fix the following error and try running this protocol again.",
"analyzing_on_robot": "Analyzing on robot",
"anticipated": "Anticipated steps",
"anticipated_step": "Anticipated steps",
"anticipated": "Anticipated steps",
"apply_stored_data": "Apply stored data",
"apply_stored_labware_offset_data": "Apply stored Labware Offset data?",
"cancel_run": "Cancel run",
"cancel_run_alert_info": "Doing so will terminate this run, drop any attached tips in the trash container and home your robot.",
"cancel_run_and_restart": "Cancel the run and restart setup to edit",
"cancel_run_modal_back": "No, go back",
"cancel_run_modal_confirm": "Yes, cancel run",
"cancel_run_modal_heading": "Are you sure you want to cancel this run?",
"cancel_run_module_info": "Additionally, any hardware modules used within the protocol will remain active and maintain their current states until deactivated.",
"canceling_run": "Canceling Run",
"cancel_run": "Cancel run",
"canceling_run_dot": "canceling run...",
"clear_protocol": "Clear protocol",
"canceling_run": "Canceling Run",
"clear_protocol_to_make_available": "Clear protocol from robot to make it available.",
"clear_protocol": "Clear protocol",
"close_door_to_resume": "Close robot door to resume run",
"close_door": "Close robot door",
"closing_protocol": "Closing Protocol",
"comment": "Comment",
"comment_step": "Comment",
"comment": "Comment",
"complete_protocol_to_download": "Complete the protocol to download the run log",
"contact_information": "Download the robot logs from the Opentrons App and send it to [email protected] for assistance.",
"current_step": "Current Step",
"current_step_pause": "Current Step - Paused by User",
"current_step_pause_timer": "Timer",
"current_step_pause": "Current Step - Paused by User",
"current_step": "Current Step",
"current_temperature": "Current: {{temperature}} °C",
"custom_values": "Custom values",
"data_out_of_date": "This data is likely out of date",
"door_is_open": "Robot door is open",
"door_open_pause": "Current Step - Paused - Door Open",
"download_run_log": "Download run log",
"downloading_run_log": "Downloading run log",
"drop_tip": "Dropping tip in {{well_name}} of {{labware}} in {{labware_location}}",
"duration": "Duration",
"end": "End",
"end_of_protocol": "End of protocol",
"end_step_time": "End",
"end": "End",
"error_info": "Error {{errorCode}}: {{errorType}}",
"error_type": "Error: {{errorType}}",
"failed_step": "Failed step",
"final_step": "Final Step",
"ignore_stored_data": "Ignore stored data",
"labware": "labware",
"labware_offset_data": "labware offset data",
"labware": "labware",
"left": "Left",
"load_labware_info_protocol_setup": "Load {{labware}} in {{module_name}} in Slot {{slot_name}}",
"load_labware_info_protocol_setup_adapter": "Load {{labware}} in {{adapter_name}} in Slot {{slot_name}}",
"listed_values": "Listed values are view-only",
"load_labware_info_protocol_setup_adapter_module": "Load {{labware}} in {{adapter_name}} in {{module_name}} in Slot {{slot_name}}",
"load_labware_info_protocol_setup_adapter_off_deck": "Load {{labware}} in {{adapter_name}} off deck",
"load_labware_info_protocol_setup_adapter": "Load {{labware}} in {{adapter_name}} in Slot {{slot_name}}",
"load_labware_info_protocol_setup_no_module": "Load {{labware}} in Slot {{slot_name}}",
"load_labware_info_protocol_setup_off_deck": "Load {{labware}} off deck",
"load_labware_info_protocol_setup_plural": "Load {{labware}} in {{module_name}}",
"load_labware_info_protocol_setup": "Load {{labware}} in {{module_name}} in Slot {{slot_name}}",
"load_liquids_info_protocol_setup": "Load {{liquid}} into {{labware}}",
"load_module_protocol_setup": "Load {{module}} in Slot {{slot_name}}",
"load_module_protocol_setup_plural": "Load {{module}}",
"load_module_protocol_setup": "Load {{module}} in Slot {{slot_name}}",
"load_pipette_protocol_setup": "Load {{pipette_name}} in {{mount_name}} Mount",
"loading_protocol": "Loading Protocol",
"location": "location",
Expand All @@ -65,9 +68,10 @@
"not_available_for_a_run_in_progress": "not available for a run in progress",
"not_started_yet": "Not started yet",
"off_deck": "Off deck",
"pause": "Pause",
"parameters": "Parameters",
"pause_protocol": "Pause protocol",
"pause_run": "Pause run",
"pause": "Pause",
"paused_for": "Paused For",
"pickup_tip": "Picking up tip from {{well_name}} of {{labware}} in {{labware_location}}",
"plus_more": "+{{count}} more",
Expand All @@ -89,34 +93,33 @@
"right": "Right",
"robot_has_previous_offsets": "This robot has stored Labware Offset data from previous protocol runs. Do you want to apply that data to this protocol run? You can still adjust any offsets with Labware Position Check.",
"robot_was_recalibrated": "This robot was recalibrated after this Labware Offset data was stored.",
"run": "Run",
"run_again": "Run again",
"run_canceled": "Run canceled.",
"run_canceled_splash": "Run canceled",
"run_complete": "Run completed",
"run_canceled": "Run canceled.",
"run_complete_splash": "Run completed",
"run_complete": "Run completed",
"run_completed": "Run completed.",
"run_cta_disabled": "Complete required steps on Protocol tab before starting the run",
"run_failed": "Run failed.",
"run_failed_modal_body": "Error occurred when protocol was {{command}}",
"run_failed_modal_description": "Please contact [email protected] with relevant information for assistance with troubleshooting.",
"run_failed_modal_description_desktop": "Download the run log and send it to [email protected] for assistance.",
"run_failed_modal_description": "Please contact [email protected] with relevant information for assistance with troubleshooting.",
"run_failed_modal_header": "{{errorName}}: {{errorCode}} at protocol step {{count}}",
"run_failed_modal_title": "Run failed",
"run_failed_splash": "Run failed",
"run_failed": "Run failed.",
"run_has_diverged_from_predicted": "Run has diverged from predicted state. Cannot anticipate new steps.",
"run_preview": "Run Preview",
"run_protocol": "Run Protocol",
"run_status": "Status: {{status}}",
"run_time": "Run Time",
"setup": "Setup",
"run": "Run",
"setup_incomplete": "Complete required steps in Setup tab",
"setup": "Setup",
"slot": "Slot {{slotName}}",
"start": "Start",
"start_run": "Start run",
"start_step_time": "Start",
"start_time": "Start Time",
"status": "Status",
"start": "Start",
"status_blocked-by-open-door": "Paused - door open",
"status_failed": "Failed",
"status_finishing": "Finishing",
Expand All @@ -127,6 +130,7 @@
"status_stop-requested": "Stop requested",
"status_stopped": "Canceled",
"status_succeeded": "Completed",
"status": "Status",
"step_failed": "Step failed",
"step_number": "Step {{step_number}}:",
"steps_total": "{{count}} steps total",
Expand All @@ -135,11 +139,11 @@
"temperature_not_available": "{{temperature_type}}: n/a",
"thermocycler_error_tooltip": "Module encountered an anomaly, please contact support",
"total_elapsed_time": "Total elapsed time",
"total_step_count": "{{count}} step total",
"total_step_count_plural": "{{count}} steps total",
"total_step_count": "{{count}} step total",
"unable_to_determine_steps": "Unable to determine steps",
"view_analysis_error_details": "View <errorLink>error details</errorLink>",
"view_current_step": "View current step",
"view_error": "View error",
"view_error_details": "View error details"
"view_error_details": "View error details",
"view_error": "View error"
}
Loading

0 comments on commit 34e4165

Please sign in to comment.