Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Protocol Engine: Allow a run to pause itself and resume upon user interaction #7918

Closed
2 tasks
mcous opened this issue Jun 10, 2021 · 0 comments · Fixed by #8161
Closed
2 tasks

Protocol Engine: Allow a run to pause itself and resume upon user interaction #7918

mcous opened this issue Jun 10, 2021 · 0 comments · Fixed by #8161
Assignees
Labels
protocol-engine Ticket related to the Protocol Engine project and associated HTTP APIs robot-svcs Falls under the purview of the Robot Services squad (formerly CPX, Core Platform Experience).
Milestone

Comments

@mcous
Copy link
Contributor

mcous commented Jun 10, 2021

Overview

As a user, I'd like to be able to write a protocol that pauses that I can then resume when I tell it to, so that I can check samples and other aspects of my run before continuing.

(This is existing functionality in the current protocol run system that we need to support in the Protocol Engine architecture.)

Acceptance Criteria

  • A protocol may pause itself (e.g. via ctx.pause(msg="I am paused now"))
  • A user may resume the run by issuing a "resume" action to the protocol run

Not in scope / TBD

  • A protocol may resume itself
  • A protocol may delay itself for a predetermined time
  • A user may override the delay and resume immediately by issuing some action to the protocol run

Implementation Notes

  • There will be some trickiness here:
    • When does a protocol initiated "pause" command completed?
      1. When the pause is triggered?
      2. When the protocol is resumed?
    • How similar (or dissimilar) is a protocol initiated pause compared to a user-initiated pause?
    • How does the protocol engine signal out that the run has been paused?
@mcous mcous added the robot-svcs Falls under the purview of the Robot Services squad (formerly CPX, Core Platform Experience). label Jun 10, 2021
@mcous mcous changed the title Protocol Engine: Allow a protocol run to pause itself and resume upon user interaction Protocol Engine: Allow a run to pause itself and resume upon user interaction Jun 10, 2021
@mcous mcous added the protocol-engine Ticket related to the Protocol Engine project and associated HTTP APIs label Jun 10, 2021
@mattwelch mattwelch added this to the CPX Sprint 37 milestone Jul 13, 2021
@mcous mcous self-assigned this Jul 26, 2021
mcous added a commit that referenced this issue Aug 2, 2021
Closes #7918

Co-authored-by: Max Marrone <max@opentrons.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
protocol-engine Ticket related to the Protocol Engine project and associated HTTP APIs robot-svcs Falls under the purview of the Robot Services squad (formerly CPX, Core Platform Experience).
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants