Skip to content

Commit aa23aa7

Browse files
jwwojakecormany
andauthored
docs: camera-enablement (#20175)
# Overview Updates the Flex manual with basic information about the built-in camera. Sandbox: - Opentrons App: https://sandbox.docs.opentrons.com/docs-camera-enablement/flex/opentrons-app/ (see also a bullet in the "Recent Protocol Runs" section that follows. Explains downloading images.) - Touchscreen > robot settings: https://sandbox.docs.opentrons.com/docs-camera-enablement/flex/touchscreen/settings/ - System Description > Frame and enclosure: https://sandbox.docs.opentrons.com/docs-camera-enablement/flex/system-description/robot/ RTC-884 ## Test Plan and Hands on Testing Making sure images and links work. ## Changelog **Opentrons App chapter**: Modifies `opentrons-app.md` to include a new section about the camera. Additional changes (more camera features) will come with 8.9, so this first version is basic functionality. **Touchscreen > Robot Settings**: Modifies `settings.md`. Updates the ODD image that shows all the settings. This is `touchscreen-settings.png`. No new text or text changes. **System Description**: Modifies `robot.md`. In the "Frame and Enclosure" section, adds link to Opentrons App chapter to text in the sentence, "A 2.1-megapixel camera can photograph the deck and working area..." ## Review requests The "Camera features and controls" section in the App chapter is the most significant change here. It introduces new information about the camera. This first camera release is limited, other features (e.g. shown in the Figma designs) aren't here and will be released later. Remember, this focuses on the very basic features and functions. ## Risk assessment Low but important. Want to give users enough to use the camera easily. --------- Co-authored-by: Ed Cormany <[email protected]>
1 parent 2bc10ef commit aa23aa7

File tree

5 files changed

+47
-1
lines changed

5 files changed

+47
-1
lines changed
1.44 MB
Loading
3.08 MB
Loading
111 KB
Loading

docs/flex/docs/opentrons-app.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,38 @@ Click the three-dot menu (⋮) on the module card to choose from available comma
9797
| **Temperature** | <ul><li>Set module temperature / Deactivate module</li></ul> |
9898
| **Thermocycler** | <ul><li>Set lid temperature / Deactivate lid</li><li>Open lid / Close lid</li><li>Set block temperature / Deactivate block</li></ul> |
9999

100+
## Camera features and controls
101+
102+
Every Flex comes equipped with a built-in 2-megapixel camera that can capture full HD still images and provides video of the deck and working area. Starting in robot software version 8.8, you can control the camera in the Opentrons App and from the touchscreen. When enabled, the camera provides:
103+
104+
- Live, in-app monitoring during protocol runs.
105+
- Automatic image capture at protocol-defined intervals.
106+
- Automatic image capture in response to a crash or runtime error.
107+
- The ability to download all still images in a single, compressed file (`.zip` format) after a protocol run.
108+
109+
### Controls
110+
111+
The camera is turned off by default. To turn on the camera and access its features:
112+
113+
<div class="instruction-list" markdown>
114+
115+
1. From the Opentrons App, click **Devices** and locate your robot.
116+
2. For your selected robot, click the three-dot menu (⋮) and then click **Robot settings**.
117+
3. Click the **Camera** tab to open the camera settings.
118+
4. Click the Camera slider to enable or disable the camera.
119+
120+
</div>
121+
122+
You can also see the camera's status, and turn it on and off, from the Peripherals section of the details page for your Flex. Click the three-dot menu (⋮) to enable or disable the camera. This example shows a Flex with its camera enabled.
123+
124+
<figure class="screenshot" markdown>
125+
![Details page showing enabled camera](./images/robot-details.png)
126+
</figure>
127+
128+
### Downloading images
129+
130+
All protocol images are available for download in the Recent Protocol Runs section of the robot details page.
131+
100132
## Recent protocol runs
101133

102134
The robot details page lists up to 20 recent protocol runs. This provides additional information compared to the touchscreen, which only shows the most recent run for each unique protocol.
@@ -114,4 +146,6 @@ Each entry in the recent protocol runs list includes the protocol name, its time
114146
!!! note
115147
If you need to maintain a comprehensive record of all runs performed on your Flex, you must use the **Download run log** feature to save this information to your computer.
116148

149+
- **Download image files:** Save to your computer a `.zip` file containing all the still images taken during a protocol run, if the camera was enabled.
150+
117151
Flex *will not* retain information about more than 20 runs on the robot. Proceeding to the Run Setup screen generates an entry in the list and counts towards the maximum of 20 runs, even if you never begin the protocol.

docs/flex/docs/system-description/robot.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The *frame* of the Opentrons Flex robot provides rigidity and structural support
1313

1414
The metal frame has openings for *side windows* and a *front door* made of transparent polycarbonate that let you see what's going on inside Flex. The front door hinges open for access to the interior of the system. With the front door open, you can attach instruments, modules, and deck fixtures; prepare the deck before a protocol; or manipulate the state of the deck during a protocol.
1515

16-
White LED strips on the inside top edges of the frame provide software-controllable ambient lighting. A 2-megapixel camera can photograph the deck and working area for recording and tracking protocol execution.
16+
White LED strips on the inside top edges of the frame provide software-controllable ambient lighting. A 2-megapixel camera can [photograph the deck](../opentrons-app.md#camera-features-and-controls) and working area for recording and tracking protocol execution.
1717

1818
## Deck and working area
1919

@@ -66,6 +66,18 @@ Fixtures are unpowered. They do not contain electronic or mechanical components
6666

6767
You can access the deck configuration settings from the touchscreen via the three-dot (⋮) menu and from the Opentrons App. See the [Deck Configuration section](../touchscreen/deck-config.md) of the Touchscreen chapter for more information.
6868

69+
## Camera
70+
71+
The camera is mounted on the interior frame of the robot, in the upper corner of the enclosure near the front door.
72+
73+
![Image showing robot front and interior camera](../images/camera-location.png)
74+
75+
This fixed location gives you a wide-angle field of view of attached instruments, deck-mounted modules, and labware.
76+
77+
![Default camera view](../images/camera-default.png)
78+
79+
For information about using the camera, see [Camera features and controls](../opentrons-app.md#camera-features-and-controls).
80+
6981
## Waste chute
7082

7183
The Opentrons Flex Waste Chute transfers liquids, tips, tip racks, and well plates from the Flex enclosure to a trash receptacle placed below its external opening. The waste chute attaches to a deck plate adapter that fits in slot D3. It also comes with a special window half panel that lets the chute extend out of the front of the robot.

0 commit comments

Comments
 (0)