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.

Sign up for GitHub

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

Jump to bottom

feat(robot-server): create protocol session response model #6225

Closed
2 tasks done
amitlissack opened this issue Jul 28, 2020 · 0 comments · Fixed by #6371
Closed
2 tasks done

feat(robot-server): create protocol session response model #6225

amitlissack opened this issue Jul 28, 2020 · 0 comments · Fixed by #6371
Assignees
@mcous @amitlissack
Labels
robot server Affects the `robot-server` project robot-svcs Falls under the purview of the Robot Services squad (formerly CPX, Core Platform Experience).
Milestone
CPX Sprint 15

Comments

@amitlissack
Copy link
Contributor

amitlissack commented Jul 28, 2020 •
edited
Loading

Calls to /sessions need to return protocol session specific metadata.

  • Create pydantic model that defines protocol session specific metadata with these contents:
# This is a draft of what might be in the payload. Subject to change as 
# protocol session functionality is filled out
protocolId:  uploaded protocol used by session
currentState: Running, paused, simulating, etc.
executionsCommands:time ordered list of commands issued by user and protocol steps
- type:  User initiated or protocol step
  commandId: command that initiated 
  command: which command was executed
  startedAt: when it started
  endedAt: when it ended
  params: parameters passed to command
  result: result of the command
  • ProtocolSession._get_response_details returns model populated with protocol session specific metadata
@amitlissack amitlissack added robot-svcs Falls under the purview of the Robot Services squad (formerly CPX, Core Platform Experience). robot server Affects the `robot-server` project labels Jul 28, 2020
@mcous mcous added this to the CPX Sprint 15 milestone Aug 5, 2020
@amitlissack amitlissack mentioned this issue Aug 17, 2020
Merged
amitlissack pushed a commit that referenced this issue Aug 19, 2020
feat(robot-server): Robot server protocol session model (#6371)
973ee18 
* ProtocolSessionEvent model created
* rename ProtocolCommandExecutor.commands to events.
* unit tests for protocol command executer
* use timestamp instead of startedAt and completedAt. add '.start' to before and '.end' to after event.
* generate unique ids for protocol sourced events
* use utc_now
* who knew that the 'text' field in the payload of a command could be a format string using the other keys in payload

closes #6225
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mcous mcous

@amitlissack amitlissack

Labels
robot server Affects the `robot-server` project robot-svcs Falls under the purview of the Robot Services squad (formerly CPX, Core Platform Experience).
Projects
None yet
Milestone
CPX Sprint 15
Development

Successfully merging a pull request may close this issue.

feat(robot-server): Robot server protocol session model Opentrons/opentrons
2 participants
@mcous @amitlissack