Skip to content

Commit aeea720

Browse files
jwwojakecormany
andauthored
docs: Labware position check revisions (#18900)
# Overview This is a change to Chapter 7, Software & Operations, Labware Position Check section. It includes new capabilities released w/ v8.4. New features or concepts include: - Protocol independent nature of offsets, not tied to protocols - Default offset concepts - Applied offset concepts - Hardcoded offsets Includes new images and sections to support these changes. Reference RTC-630. ## Test Plan and Hands on Testing Checking for proper use of Markdown, HTML, and the usual writing stuff. In follow-on updates, we ought to get these H3s moved up. There are a lot of H4s in this chapter and version. Sandbox URL: [labware offsets and position checking](http://sandbox.docs.s3-website.us-east-2.amazonaws.com/labware-position-check-revisions/flex-manual/software-operation/#labware-offsets-and-position-checking) ## Changelog The single section "Labware Position Check" becomes "Labware offsets and position checking." - Main subsections "Labware offsets" and "Labware Position Check" - New images, reusing old jog control images. ## Review requests Also, @anthonywilleee might want to give this a look. ## Risk assessment Low, docs only. Could still be out of date as this was for 8.4. Can catch up in subsequent update. --------- Co-authored-by: Ed Cormany <[email protected]>
1 parent 322e142 commit aeea720

File tree

3 files changed

+37
-15
lines changed

3 files changed

+37
-15
lines changed

docs/flex-manual/docs/images/labware-offsets.svg

Lines changed: 4 additions & 0 deletions
Loading
183 KB
Loading

docs/flex-manual/docs/software-operation.md

Lines changed: 33 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -220,37 +220,55 @@ When working with CSV files, keep in mind that:
220220

221221
Parameter and CSV file selections are still editable until you tap **Confirm values**. Modifications become read-only after that. To make further adjustments, you'll have to cancel the protocol run and start over.
222222

223-
### Labware Position Check
223+
### Labware offsets and position checking
224224

225-
Opentrons recommends performing Labware Position Check before your protocol run. This process fine- tunes the positioning of instruments, relative to specific types of labware in specific slots on the deck. The results of Labware Position Check are saved as labware offsets, which are measured to the nearest 0.1 mm. You can apply saved labware offsets to future runs of the same protocol (or other protocols that use the same labware in the same positions) to save time.
225+
#### Labware offsets
226+
Labware offsets are fine-tuned positional coordinates that help your robot align its pipette relative to a specific piece of labware. The release of robot software version 8.4 introduced significant improvements to the labware offset and position checking system.
226227

227-
Labware Position Check guides you through these steps:
228+
| Feature | Description |
229+
|----|----|
230+
| Protocol independence | Offsets are positional adjustments associated with a piece of labware, rather than with a specific protocol, and saved on the robot. This allows for greater flexibility and reusability of offset data in any protocol. |
231+
| Default offsets | Default offsets are manually created via Labware Position Check and then automatically applied to each instance of that labware, regardless of deck slot or protocol. This "measure once, set everywhere" feature means you don't have to check offsets for duplicate labware, which helps reduce protocol setup time and effort. |
232+
| Applied offsets | Applied offsets override defaults for a specific piece of labware in a specific deck slot. You can use an applied offset with different protocols, but the labware and deck slot must be the same as the original applied offset. |
233+
| Hardcoded offsets | A hardcoded offset is an offset type typically created by advanced users via the Opentrons Python API. Because these offsets are defined in code (`set_offset`), you cannot change them from the touchscreen or Opentrons App. You’ll need to modify the Python protocol file to change a hardcoded offset. See [Setting Labware Offsets](https://docs.opentrons.com/v2/new_advanced_running.html?highlight=offset#setting-labware-offsets). |
228234

229-
1. Attach the calibration probe to the pipette.
235+
#### Offsets at-a-glance
230236

231-
2. Clear the deck of labware, but leave modules in place.
237+
This illustration shows how the different types of offsets appear as you're configuring a protocol on the Flex touchscreen.
232238

233-
3. Place a specific type of labware in a specific deck slot.
239+
![](images/labware-offsets.svg)
234240

235-
4. Align the probe to the labware using the on-screen jog controls. Then confirm the position.
241+
#### Labware Position Check
236242

237-
5. Repeat steps 3 and 4 for each labware--slot combination used in your protocol.
243+
Labware Position Check lets you align a pipette relative to a piece of labware (e.g. a well plate), which helps ensure accurate and reproducible pipetting results.
238244

239-
6. Review and save your new labware offset data.
245+
You must ensure that each piece of labware used in your protocol has a default or applied offset associated with it. As shown in the touchscreen example below, you cannot run a protocol (the blue run button is inactive) if it uses labware that is missing offset data.
240246

241-
7. Remove the calibration probe from the pipette.
247+
<figure class="screenshot" markdown>
248+
![Touchscreen showing missing labware offset](images/missing-offsets.png)
249+
</figure>
250+
251+
Tap **Labware Offsets** to see which labware is missing an offset and to start Labware Position Check. Refer to the touchscreen or the Opentrons App when running Labware Position Check. It will provide instructions and animations to guide you through this process.
252+
253+
#### Jog controls
254+
255+
During Labware Position Check, you’ll use the jog controls to align the pipette with the selected labware.
242256

243257
<figure class="screenshot" markdown>
244258
![Jog controls, with three options for jump size on the left, toggle between axes in the middle, and arrow buttons on the right.](images/touchscreen-lpc-jog-controls.png "Labware Position Check jog controls")
245-
<figcaption>Jog controls used in Labware Position Check. Use larger jump sizes to
246-
move the pipette quickly, but beware of crashing the pipette into
247-
labware.</figcaption>
259+
<figcaption>Jog controls used in Labware Position Check.</figcaption>
248260
</figure>
249261

250-
When you run Labware Position Check for the first time, the pipette will start at its default position for all labware (X 0.0 Y 0.0 Z 0.0). On subsequent runs, the pipette will start at the previously saved offset locations. This lets you quickly confirm offset data before every protocol run.
262+
To use the jog controls:
263+
264+
1. Select a jog control option to set the pipette's axis of movement.
265+
2. Select a jump size to set how far the pipette moves (in mm). You can move the pipette in increments of 0.1, 1, or 10 mm. Use larger jump sizes to move the pipette quickly, but beware of crashing the pipette into labware.
266+
3. Tap an arrow to move the pipette for your selected direction and distance.
267+
4. Tap **Close** when, in your best judgement, the pipette is optimally aligned with the selected labware.
268+
5. Continue to follow prompts and instructions on the touchscreen to complete the Labware Position Check process.
251269

252270
!!! note
253-
The pipette will always start at the default position if you turn off Apply Labware Offsets in the robot settings.
271+
Labware Position Check corrects for minor, millimeter-scale pipette and labware alignment variations. If you find yourself using it to compensate for large, multi-centimeter offsets, this may suggest an alignment problem related to labware manufacturing defects or incorrect labware definitions. Contact Opentrons Support if you encounter persistent, significant instrument or labware misalignments.
254272

255273
### Run progress
256274

0 commit comments

Comments
 (0)