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 using data files with a protocol #8072

Closed
sanni-t opened this issue Jul 8, 2021 · 1 comment
Closed

protocol-engine: allow using data files with a protocol #8072

sanni-t opened this issue Jul 8, 2021 · 1 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).

Comments

@sanni-t
Copy link
Member

sanni-t commented Jul 8, 2021

Overview

As a user, I want to use an HTTP endpoint to send a Python protocol file and accompanying data files to the robot

  • I should be able to upload a non-python data file (csv, txt, json) along with my protocol and read (and write to?) this file from my python protocol.
  • Should be able to upload multiple data files and these should be recognized as such and should be associated with the protocol file

Implementation details

  • The /protocols endpoint is a multi-part/form-data that accepts multiple files. You use that id to upload multiple files. They are all saved in the same directory on /tmp and associated with the same protocol ID.
  • Once you are done uploading files, you can use a simulate endpoint to check the uploaded protocol
  • The robot-server/ engine recognizes if the file is a data file or a python file. If it’s a data file, the PE leaves it alone and assumes the python protocol file does correct I/O in order to access its data
  • Rely on nginx max file size limit

NOTE:

  • uploading support files later while a protocol is running is out of scope for this ticket
  • could end up supporting zip file uploads after @readywater 's UX spike
@sanni-t sanni-t added the protocol-engine Ticket related to the Protocol Engine project and associated HTTP APIs label Jul 8, 2021
@mattwelch mattwelch added the robot-svcs Falls under the purview of the Robot Services squad (formerly CPX, Core Platform Experience). label Jul 8, 2021
@sanni-t
Copy link
Member Author

sanni-t commented Feb 21, 2024

Done.

@sanni-t sanni-t closed this as completed Feb 21, 2024
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

No branches or pull requests

2 participants