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

PE/JSONv6: Implement moveToCoordinates command #10757

Closed
SyntaxColoring opened this issue Jun 14, 2022 · 0 comments · Fixed by #10840
Closed

PE/JSONv6: Implement moveToCoordinates command #10757

SyntaxColoring opened this issue Jun 14, 2022 · 0 comments · Fixed by #10840
Assignees
Labels
api Affects the `api` project json-v6 Issues related to JSON Protocol Schema v6 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

@SyntaxColoring
Copy link
Contributor

SyntaxColoring commented Jun 14, 2022

Implement the moveToCoordinates Protocol Engine command as it's already been specified in the JSON Protocol schema v6.

At the time of writing, that's this:

{
"description": "Move To Coordinates",
"type": "object",
"required": ["commandType", "params"],
"properties": {
"key": { "type": "string" },
"commandType": { "enum": ["moveToCoordinates"] },
"params": {
"type": "object",
"required": ["pipetteId", "coordinates"],
"properties": {
"pipetteId": { "type": "string" },
"coordinates": {
"$ref": "#/definitions/offset",
"description": "X, Y and Z coordinates in mm from deck's origin location (left-front-bottom corner of work space)"
},
"minimumZHeight": {
"description": "Optional minimal Z margin in mm. If this is larger than the API's default safe Z margin, it will make the arc higher. If it's smaller, it will have no effect. Specifying this for movements that would not arc (moving within the same well in the same labware) will cause an arc movement instead.",
"type": "number",
"minimum": 0
},
"forceDirect": {
"description": "Default is false. If true, moving from one labware/well to another will not arc to the default safe z, but instead will move directly to the specified location. This will also force the 'minimumZHeight' param to be ignored. A 'direct' movement is in X/Y/Z simultaneously",
"type": "boolean"
}
}
}
}
},

@SyntaxColoring SyntaxColoring added api Affects the `api` project robot-svcs Falls under the purview of the Robot Services squad (formerly CPX, Core Platform Experience). json-v6 Issues related to JSON Protocol Schema v6 labels Jun 14, 2022
@SyntaxColoring SyntaxColoring self-assigned this Jun 14, 2022
@SyntaxColoring SyntaxColoring added the protocol-engine Ticket related to the Protocol Engine project and associated HTTP APIs label Jun 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api Affects the `api` project json-v6 Issues related to JSON Protocol Schema v6 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.

1 participant