Skip to content

Commit a8a4778

Browse files
jwwojakecormany
andauthored
docs: update error recovery options table (#18911)
# Overview Chapter 7, Software and Operations. Updates the table that lists error recovery options. - Changes markdown table to HTML. - No liquid detected row: adds 2 new recovery options - Pipette overpressure row: removes nested unordered lists, not needed. ## Test Plan and Hands on Testing Check the revised code to make sure it displays info in a formatted table. Sandbox URL: see the table in the [error recovery section](http://sandbox.docs.s3-website.us-east-2.amazonaws.com/error-recovery-flex-manual/flex-manual/software-operation/#error-recovery). ## Changelog See summary above. ## Review requests Nothing specific. ## Risk assessment Low, docs only. --------- Co-authored-by: Ed Cormany <[email protected]>
1 parent e04b24a commit a8a4778

File tree

1 file changed

+51
-11
lines changed

1 file changed

+51
-11
lines changed

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

Lines changed: 51 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -247,11 +247,6 @@ move the pipette quickly, but beware of crashing the pipette into
247247
labware.</figcaption>
248248
</figure>
249249

250-
<figure class="screenshot" markdown>
251-
TK image of 8.4 LPC
252-
<figcaption>Summary of new labware offsets ready to be applied to a protocol.</figcaption>
253-
</figure>
254-
255250
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.
256251

257252
!!! note
@@ -286,11 +281,56 @@ Tap **Launch recovery mode** to see options for the particular type of error tha
286281

287282
Flex provides a protocol recovery path for the following error conditions.
288283

289-
| Error type | Description {style="width: 30%;"} | Recovery options |
290-
| :--------- | :---------- | :--------------- |
291-
| No liquid detected | Occurs when a pipette encounters an empty well and expects a liquid to be present. | <ul><li>Manually refill well and skip to the next step.</li><li>Ignore the error and skip to the next step.</li><li>Cancel protocol run.</li></ul> |
292-
| Pipette overpressure | Occurs when pressure inside the pipette exceeds the normal range while aspirating or dispensing liquid. Caused by clogged, bent, or sealed tips. | <ul><li>For aspiration:</li><ul><li>Retry with new tips.</li><li>Cancel protocol run.</li></ul><li>For dispense:</li><ul><li>Skip to the next step with the same tips.</li><li>Skip to the next step with new tips.</li><li>Cancel protocol run.</li></ul></ul> |
293-
| General errors | A catch-all category for other errors. | <ul><li>Retry step.</li><li>Skip to next step.</li><li>Cancel protocol run.</li></ul> |
284+
<table>
285+
<thead>
286+
<tr>
287+
<th>Error type</th>
288+
<th style="width: 30%;">Description</th>
289+
<th>Recovery options</th>
290+
</tr>
291+
</thead>
292+
<tbody>
293+
<tr>
294+
<td>No liquid detected</td>
295+
<td>Occurs when a pipette encounters an empty well and expects a liquid to be present.</td>
296+
<td>
297+
<ul>
298+
<li>Manually fill the empty well and retry with the same tips.</li>
299+
<li>Manually fill the empty well and retry with new tips.</li>
300+
<li>Manually fill the empty well and skip to the next step.</li>
301+
<li>Ignore the error and skip to the next step.</li>
302+
<li>Cancel protocol run.</li>
303+
</ul>
304+
</td>
305+
</tr>
306+
<tr>
307+
<td>Pipette overpressure</td>
308+
<td>Occurs when pressure inside the pipette exceeds the normal range while aspirating or dispensing liquid. Caused by clogged, bent, or sealed tips.</td>
309+
<td>For aspiration:<br>
310+
<ul>
311+
<li>Retry with new tips.</li>
312+
<li>Cancel protocol run.</li>
313+
</ul>
314+
For dispense:
315+
<ul>
316+
<li>Skip to the next step with the same tips.</li>
317+
<li>Skip to the next step with new tips.</li>
318+
<li>Cancel protocol run.</li>
319+
</ul>
320+
</td>
321+
</tr>
322+
<tr>
323+
<td>General errors</td>
324+
<td>A catch-all category for other errors.</td>
325+
<td>
326+
<ul>
327+
<li>Retry step.</li>
328+
<li>Skip to next step.</li>
329+
<li>Cancel protocol run.</li>
330+
</ul>
331+
</td>
332+
</tr> </tbody>
333+
</table>
294334

295335
!!! note
296336
The tip presence sensor is disabled for [partial tip pickup](system-description.md#partial-tip-pickup) of 1, 2, or 3 tips. In these configurations, Flex cannot detect tip pickup errors and will not present error recovery options if the pipette fails to pick up the tips. The run will continue unless and until another error occurs.
@@ -708,7 +748,7 @@ Flex *will not* retain information about more than 20 runs on the robot. Proceed
708748

709749
You can work with your Flex through a Secure Shell (SSH) terminal connection. Terminal access lets you [run protocols directly from the command line](https://docs.opentrons.com/v2/new_advanced_running.html#command-line) or perform advanced tasks, such as customizing the Python environment on the robot. Protocols that reference external files on disk (apart from custom labware definition files) must be run from the command line.
710750

711-
!!!Note
751+
!!!note
712752
- SSH keys are required before you can connect to Flex and issue commands from a terminal.
713753
- If you're unable to use a Wi-Fi network for SSH, see [Hardwired SSH Connections][hardwired-ssh-connections] below.
714754

0 commit comments

Comments
 (0)