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

feat(shared-data): Update labware schema 3 for new positioning system #17486

Draft
wants to merge 1 commit into
base: edge
Choose a base branch
from

Conversation

SyntaxColoring
Copy link
Contributor

@SyntaxColoring SyntaxColoring commented Feb 10, 2025

Overview

Closes EXEC-79 and EXEC-81. Changes our labware schema and definitions to implement the new positioning system described in this design document.

Test Plan and Hands on Testing

To do.

Changelog

Schema

  • dimensions and cornerOffsetFromSlot have been replaced by a new extents object, which has space to list the overall extents (extents.total) separately from the footprint extents (extents.footprint), or any other specific things that we might come up with later.
  • Added locatableFeatures, which is the crux of the new positioning system.
  • To do: add locatingFeatures too.
  • To do: I think stackingOffsetWithLabware and stackingOffsetWithModule need to be extended to filter by the locating feature in addition to the labware/module load name. When the parent and child are heterogeneous, it's only possible to define a sensible stacking offset in reference to a specific locating feature pairing.

Definitions

  • To do: migrate all definitions in schema 3 to the new system

Other

  • To do: Python and TypeScript bindings
  • To do: labware definition tests
    • The topLeft locating feature should be the origin
    • Wells should be in the +x, -y quadrant
    • The footprint extent should be wholly contained within the total extent

Review requests

Risk assessment

Copy link

codecov bot commented Feb 10, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 25.60%. Comparing base (2ec42e1) to head (0bf5e33).
Report is 3 commits behind head on edge.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             edge   #17486      +/-   ##
==========================================
+ Coverage   20.09%   25.60%   +5.51%     
==========================================
  Files        3191     3178      -13     
  Lines      230123   229684     -439     
  Branches     8204     9586    +1382     
==========================================
+ Hits        46246    58814   +12568     
+ Misses     183877   170847   -13030     
- Partials        0       23      +23     
Flag Coverage Δ
app 3.21% <ø> (?)
labware-library 3.95% <ø> (?)
opentrons-ai-client 4.82% <ø> (?)
protocol-designer 17.44% <ø> (+0.02%) ⬆️
shared-data 75.12% <ø> (+1.27%) ⬆️
step-generation 4.09% <ø> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 273 files with indirect coverage changes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant