Skip to content

docs: Flex manual, update E-stop and module behavior table #18857

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

Merged
merged 11 commits into from
Jul 9, 2025

Conversation

jwwojak
Copy link
Contributor

@jwwojak jwwojak commented Jul 8, 2025

Overview

Revisions to chapter 3, System Description, Emergency Stop Pendant section. Changes update the table that lists how different modules respond to E-stop activation:

  • New entries: HEPA/UV and plate reader
  • Complex table, change to HTML from markdown.
  • Remove single bullet list items for temp module, thermocycler, status light.

JIRA RTC-580

Test Plan and Hands on Testing

Checked with SMEs and testing the robot and e-stop itself.

Changelog

Text changes to a table, contents and code.

Review requests

The usual process.

Risk assessment

Low.

Changes to the table that describes how modules react when the e-stop is engaged.

Adds new rows for the HEPA/UV module and plate reader.

Removes single bullet item lists (might be an artifact from conversion to mkdocs).

Replaces markdown w/ html for the table.
@jwwojak jwwojak requested a review from ecormany July 8, 2025 19:37
@jwwojak jwwojak self-assigned this Jul 8, 2025
Manual says flex status light turns red. It does not. The light turns yellow, solid (not flashing or pulsing). Stays yellow until you reset the e-stop. Last minute change from checking.
@jwwojak
Copy link
Contributor Author

jwwojak commented Jul 8, 2025

Needed a last minute push re: status light info. Will change to regular PR.

@jwwojak jwwojak marked this pull request as ready for review July 8, 2025 19:49
Copy link

codecov bot commented Jul 8, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 24.34%. Comparing base (026eba7) to head (35c5ed4).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             edge   #18857   +/-   ##
=======================================
  Coverage   24.34%   24.34%           
=======================================
  Files        3312     3312           
  Lines      289304   289304           
  Branches    30805    30805           
=======================================
  Hits        70432    70432           
  Misses     218851   218851           
  Partials       21       21           
Flag Coverage Δ
protocol-designer 19.11% <ø> (ø)
step-generation 5.33% <ø> (ø)

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Contributor

@ecormany ecormany left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Change to HTML table is a warranted improvement here. A couple prose comments and questions.

jwwojak and others added 7 commits July 9, 2025 10:52
Thanks for the suggestions. Applying now.

Co-authored-by: Ed Cormany <edward.cormany@opentrons.com>
Thermocycler light turns red, not yellow.
Changes to the table that describes how modules react when the e-stop is engaged.

Adds new rows for the HEPA/UV module and plate reader.

Removes single bullet item lists (might be an artifact from conversion to mkdocs).

Replaces markdown w/ html for the table.
Manual says flex status light turns red. It does not. The light turns yellow, solid (not flashing or pulsing). Stays yellow until you reset the e-stop. Last minute change from checking.
Thanks for the suggestions. Applying now.

Co-authored-by: Ed Cormany <edward.cormany@opentrons.com>
Thermocycler light turns red, not yellow.
@jwwojak jwwojak force-pushed the estop-docs-revisions branch from b0579e9 to 35c5ed4 Compare July 9, 2025 17:04
@jwwojak jwwojak merged commit 3f1b888 into edge Jul 9, 2025
6 checks passed
@jwwojak jwwojak deleted the estop-docs-revisions branch July 9, 2025 18:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants