diff --git a/docs/heater-shaker/docs/adapters.md b/docs/heater-shaker/docs/adapters.md new file mode 100644 index 00000000000..6d0d33f7a67 --- /dev/null +++ b/docs/heater-shaker/docs/adapters.md @@ -0,0 +1,49 @@ +--- +title: "Heater-Shaker Module: Thermal Adapters" +--- + +# Thermal Adapters + +Aluminum thermal adapters help transfer heat from the Heater-Shaker to attached labware. The module comes with your choice of a universal flat adapter, a PCR well plate adapter, a 96-well flat bottom adapter, or a deep well adapter. You can also purchase additional adapters directly from the [modules section](https://opentrons.com/products/categories/modules) of the Opentrons website. + +![Universal adapter, PCR adapter, flat bottom adapater, deep well adapter images](images/thermal-adapters.png) + +## Supported Labware + +The listed thermal adapters are only compatible with the following labware. + +| Labware | API Load Name | +| ---- | ---- | +| [NEST 96 Well Plate 100 µL PCR Full Skirt][nest100] | `nest_96_wellplate_100ul_pcr_full_skirt` | +| [NEST 96 Well Plate 200 µL Flat][nest200] | `nest_96_wellplate_200ul_flat` | +| [NEST 96 Deep Well Plate 2 mL][nestDeepWell] | `nest_96_wellplate_2ml_deep` | +| [Opentrons Tough 96 Well Plate 200 µL PCR Full Skirt][opentronsTough] | `opentrons_96_wellplate_200ul_pcr_full_skirt` | +| [Corning 384 Well Plate 112 µL Flat][corning384] | `corning_384_wellplate_112ul_flat` | + + +[nest100]: https://labware.opentrons.com/nest_96_wellplate_100ul_pcr_full_skirt?category=wellPlate#/?loadName=nest_96_wellplate_100ul_pcr_full_skirt +[nest200]: https://labware.opentrons.com/nest_96_wellplate_100ul_pcr_full_skirt?category=wellPlate#/?loadName=nest_96_wellplate_200ul_flat +[nestDeepWell]: https://labware.opentrons.com/nest_96_wellplate_100ul_pcr_full_skirt?category=wellPlate#/?loadName=nest_96_wellplate_2ml_deep +[opentronsTough]: https://labware.opentrons.com/nest_96_wellplate_100ul_pcr_full_skirt?category=wellPlate#/?loadName=opentrons_96_wellplate_200ul_pcr_full_skirt +[corning384]: https://labware.opentrons.com/nest_96_wellplate_100ul_pcr_full_skirt?category=wellPlate#/?loadName=corning_384_wellplate_112ul_flat + +The Universal Flat Bottom Plate Adapter works with most flat- bottom ANSI/SLAS automation compliant labware. For more information, see the [JSON Labware Schema section](../flex/labware/definitions.md#json-labware-schema) in the Labware chapter of the Flex Instruction Manual. + +## Attaching a Thermal Adapter + +
+ +1. Use the included T10 Torx screwdriver and Thermal Adapter Screw to attach your chosen adapter to the module. + + !!!warning + Using a different screwdriver can strip the screws. Using different screws can damage the module. + +![Attaching an adapter to the module](images/adapter-attachment.png){style="width: 60%; margin-left: 0;"} + +2. Check the alignment of the thermal adapter. If properly attached, it will sit flush to the surface of the module. + + ![Aligned and misaligned adapter image](images/adapter-alignment.png) + +3. Verify that the adapter is firmly attached. The adapter is secure when it doesn’t move while gently pulling on it and rocking it from side to side. + +
diff --git a/docs/heater-shaker/docs/compliance.md b/docs/heater-shaker/docs/compliance.md new file mode 100644 index 00000000000..2dd3130fc87 --- /dev/null +++ b/docs/heater-shaker/docs/compliance.md @@ -0,0 +1,144 @@ +--- +title: "Heater-Shaker Module: Safety Information and Regulatory Compliance" +--- + +# Safety Information and Regulatory Compliance + +Opentrons recommends that you follow the safe use specifications listed in this section and throughout this manual. + +## Environmental Conditions + +The Heater-Shaker should only be used indoors on a sturdy, dry, flat horizontal surface. It must be installed in a low-vibration environment with stable ambient conditions. Keep the Heater-Shaker away from direct sunlight or HVAC systems that may cause significant temperature or humidity changes. + +Opentrons has validated the Heater-Shaker’s performance in the conditions recommended for system operation. Operating the unit in these conditions helps provide optimal results. The following table lists and defines the environmental operating conditions for recommended use, acceptable for system operation, and for storage of your Heater-Shaker. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Environmental ConditionsRecommendedAcceptableStorage and Transportation
Ambient Temperatures20 to 24 °C20 to 25 °C–10 to +60 °C
Relative Humidity40 to 60%, non-condensing80% maximum10 to 85%, non-condensing (below 30 °C)
AltitudeUp to 2000 m above sea levelUp to 2000 m above sea levelUp to 2000 m above sea level
Pollution Degree222
+ +The following table lists and defines use and storage standards for the Heater-Shaker. + +| Operating Conditions | Description | +|----|----| +| Recommended | Opentrons has validated the Heater-Shaker’s performance in the conditions recommended for system operation. Operating the Heater-Shaker in these conditions means you can expect the module to meet performance specifications for the module. | +| Acceptable | These conditions are acceptable for system operation. The Heater-Shaker is safe to use in these conditions, but the module may not meet performance specifications. | +| Storage | Storage and transportation conditions only apply when the device is completely disconnected from power and other equipment. | + +## Instrument Safety Warnings + +Warning symbols posted on the Heater-Shaker or listed here refer directly to the safe use of the instrument. Refer to the previous table for symbol definitions. + + + + + + + + + + + + + + + + + + +
SymbolDescription
Hot surface warning symbolCAUTION: Hot surface.
+ The Heater-Shaker generates enough heat to cause serious burns. Wear safety goggles or other eye protection at all times during operation. Always ensure the module returns to idle temperature before removing samples or the module. Always allow maximum clearance to avoid accidental burns. +
Pinch point warning symbolCAUTION: Pinch point.
+ The labware latch on the Heater-Shaker presents a pinch point hazard. Keep hands and fingers away from the module while the latch opens and closes. +
+ +## Temperature Safety + +!!!warning + Never touch the module when its status light is red. + +During normal operation, the top plate, labware adapters, and labware on top of the Heater-Shaker can reach temperatures of up to 95 °C. Touching these surfaces while they are hot poses the risk of burns. + +To reduce the risk of burns, always check the color of the status light before touching the module. If the status light is red, the module may be hot to the touch. Do not touch the module if it is hot. Use the Opentrons App to deactivate the heater and allow the module to cool until the LED status light is solid white. If you must handle a module that is powered off, and you are unsure whether it is hot to the touch: + +- If you can do so _without touching any other part of the module_, press the power button to activate the module and check the color of the status light. + +- If you cannot safely press the power button, allow the module to cool for at least 10 minutes before touching it. + +### Powering Down + +When powering down the Heater-Shaker, ensure that it is idle (not shaking) and not hot to the touch. If the module’s status light is solid white, it is safe to handle. If the status light is red, the module is hot. Allow the Heater-Shaker to cool until the status light is white before powering it down. Turning off the power while the status light is red prevents other users from determining whether the module is hot to the touch. See the [LED Status Light section](specifications.md#led-status) for more information about these visual status indicators. + +Press the power button above the USB connector to turn off the module. You can unplug the power adapter once the module is powered down. + +## Standards Compliance + +The Heater-Shaker has been tested and found to be in compliance with all applicable requirements of the following safety and electromagnetic standards. + +### Safety + +- IEC/EN 61010-1 Safety­ Requirements­ for­ Electrical­ Equipment for­ Measurement,­ Control­, and Laboratory Use +- IEC 61010-2-010­ Requirement ­for­ Heating +- IEC 61010-2-051: 2018­ Particular Requirements For Laboratory Equipment for Mixing and Stirring + +### Electromagnetic Compatibility + +- FCC part 15 subpart B class A +- IEC/EN 61326-1 EMC Testing of Laboratory Equipment + +### Hazardous Substances + +RoHS compliant + +### FCC Warnings and Notes + +**Warning:** Changes or modifications to this unit not expressly approved by Opentrons Labworks Inc. could void the user’s authority to operate the equipment. + +**Note:** This equipment has been tested and found to comply with the limits for a Class A digital device, pursuant to part 15 of the FCC rules. These limits are designed to provide reasonable protection against harmful interference when the equipment is operated in a commercial environment. This equipment generates, uses, and can radiate radio frequency energy and, if not installed and used in accordance with the instruction manual, may cause harmful interference to radio communications. Operation of this equipment in a residential area is likely to cause harmful interference in which case the user will be required to correct the interference at their own expense. + +**Note regarding FCC compliance:** Although this instrument has been tested and found to comply with Part 15, Subpart B of the FCC Rules for a Class A digital device, please note that this compliance is voluntary, for the instrument qualifies as an “exempted device” under 47 CFR 15.103(c), in regard to the cited FCC regulations in effect at the time of manufacture. + +### CISPR 11 Class A + +**Caution:** This equipment is not intended for use in residential environments and may not provide adequate protection to radio reception in such environments. + +## WEEE Policy + + +Opentrons is dedicated to adhering to the EU Directive on Waste Electrical and Electronic Equipment (WEEE – 2012/19/EU). Our goal is to ensure that our products are properly disposed of or recycled once they reach the end of their useful life. + +Opentrons products that fall under the WEEE directive are labeled with the symbol, signifying that they should not be thrown away with regular household waste but must be collected and handled separately. + +If you or your business have Opentrons products that are at end of life or need to be discarded for a separate purpose, contact Opentrons for proper disposal and recycling. diff --git a/docs/heater-shaker/docs/flex-installation.md b/docs/heater-shaker/docs/flex-installation.md new file mode 100644 index 00000000000..512a65a1889 --- /dev/null +++ b/docs/heater-shaker/docs/flex-installation.md @@ -0,0 +1,75 @@ +--- +title: "Heater-Shaker Module: Flex Installation Instructions" +--- + +# Flex Attachment Instructions + +Installing the Heater-Shaker on your robot includes attaching it to the deck and calibrating it for the first time. The instructions here and on the touchscreen will help you get started. The tools you need are included with the module or in the User Kit that came with your Flex. + +## Attaching the Heater-Shaker + +
+ +1. Choose the supported slot you want to use for the module. Use the 2.5 mm screwdriver to remove the deck slot plate. + +2. Insert the Heater-Shaker into its caddy by aligning the power button on the module with the on/off switch on the caddy. + + !!!tip + If you’re having trouble inserting the module into its caddy, the module’s power button is probably facing away from the caddy’s on/off switch. Turn the module so the power button faces the on/off switch and try again. + +3. Holding the module in the caddy, use the T10 Torx screwdriver to turn the anchor screws clockwise to tighten the anchors. The module is secure when it doesn’t move while gently pulling on it and rocking it from side to side. + + !!!warning + The shaking motion of the Heater-Shaker requires anchoring to help ensure it does not dislodge itself while in operation. + +4. Connect the USB cable to the module. + +5. Connect power cable to the module. The Heater-Shaker has an asymmetrical 4-pin power connector. When connecting the power cable to the module: + + - Match the connector's flat side to the flat side of the module's power port. + - Aligned cables attach easily; misaligned cables do not. + - _Do not_ plug the power cable into a wall outlet until instructed to do so. + +
+ ![DIN power connector](images/din-power-connector.png) +
+ +6. Insert the caddy into the deck slot and route the power and USB cables through the removable side covers of the Flex. + +7. Connect the USB cable to a USB port on the Flex. + +8. Connect the power cable to a wall outlet. Gently press the on/off switch to turn the module on. + +
+ +If the temperature and status LCDs are illuminated, the module is powered on. + +When successfully connected, the module appears in the Pipettes and Modules section on your robot’s device detail page in the Opentrons App. From there, you can control the module’s labware latch or run a test shake. See the [Software Control section](software-control.md) below. + +Next, you’ll calibrate the module. + +## Calibrating the Heater-Shaker + +When you first install a module on Flex, you need to run automated positional calibration. This process is similar to calibrating instruments like pipettes or the gripper. Module calibration ensures that the Flex moves to the exact correct location for optimal protocol performance. You do not have to recalibrate the module if you remove and reattach it to the same Flex. + +To calibrate the Heater-Shaker, turn on the power supply. This starts the calibration workflow process on the touchscreen. Instructions on the touchscreen will guide you through the calibration procedure, which is outlined below. + +!!!warning + The gantry and pipette will move during calibration. Keep your hands clear of the working area before tapping an action button on the touchscreen. + +
+ +1. Tap **Start setup** on the touchscreen. The robot checks the +module’s firmware and updates it automatically, if required. + +2. Attach the Heater-Shaker’s calibration adapter to the module and tap **Confirm placement**. + +3. Attach the calibration probe to the pipette. + +4. Tap **Begin calibration**. + +5. After the calibration process is complete, remove the calibration adapter from the module and remove the calibration probe from the pipette. + +6. Tap **Exit**. Your module is now calibrated. + +
diff --git a/docs/heater-shaker/docs/images/3-dot-menu.png b/docs/heater-shaker/docs/images/3-dot-menu.png new file mode 100644 index 00000000000..dfad3eb86e7 Binary files /dev/null and b/docs/heater-shaker/docs/images/3-dot-menu.png differ diff --git a/docs/heater-shaker/docs/images/WEEE.svg b/docs/heater-shaker/docs/images/WEEE.svg new file mode 100644 index 00000000000..fc12dfe9ba4 --- /dev/null +++ b/docs/heater-shaker/docs/images/WEEE.svg @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/docs/heater-shaker/docs/images/adapter-alignment.png b/docs/heater-shaker/docs/images/adapter-alignment.png new file mode 100644 index 00000000000..4f163ba4250 Binary files /dev/null and b/docs/heater-shaker/docs/images/adapter-alignment.png differ diff --git a/docs/heater-shaker/docs/images/adapter-attachment.png b/docs/heater-shaker/docs/images/adapter-attachment.png new file mode 100644 index 00000000000..8bc655ce635 Binary files /dev/null and b/docs/heater-shaker/docs/images/adapter-attachment.png differ diff --git a/docs/heater-shaker/docs/images/devices.png b/docs/heater-shaker/docs/images/devices.png new file mode 100644 index 00000000000..c5fb38f7f32 Binary files /dev/null and b/docs/heater-shaker/docs/images/devices.png differ diff --git a/docs/heater-shaker/docs/images/din-power-connector.png b/docs/heater-shaker/docs/images/din-power-connector.png new file mode 100644 index 00000000000..8690ac4ee79 Binary files /dev/null and b/docs/heater-shaker/docs/images/din-power-connector.png differ diff --git a/docs/heater-shaker/docs/images/heater-shaker-hero.png b/docs/heater-shaker/docs/images/heater-shaker-hero.png new file mode 100644 index 00000000000..1bbd52bb4a6 Binary files /dev/null and b/docs/heater-shaker/docs/images/heater-shaker-hero.png differ diff --git a/docs/heater-shaker/docs/images/hot-surface-warning.svg b/docs/heater-shaker/docs/images/hot-surface-warning.svg new file mode 100644 index 00000000000..7f4fa2b554f --- /dev/null +++ b/docs/heater-shaker/docs/images/hot-surface-warning.svg @@ -0,0 +1,21 @@ + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/heater-shaker/docs/images/hs-anchors.png b/docs/heater-shaker/docs/images/hs-anchors.png new file mode 100644 index 00000000000..3413e29c228 Binary files /dev/null and b/docs/heater-shaker/docs/images/hs-anchors.png differ diff --git a/docs/heater-shaker/docs/images/hs-caddy.png b/docs/heater-shaker/docs/images/hs-caddy.png new file mode 100644 index 00000000000..9acc441bc46 Binary files /dev/null and b/docs/heater-shaker/docs/images/hs-caddy.png differ diff --git a/docs/heater-shaker/docs/images/hs-deck-map.png b/docs/heater-shaker/docs/images/hs-deck-map.png new file mode 100644 index 00000000000..d7b85d91b8b Binary files /dev/null and b/docs/heater-shaker/docs/images/hs-deck-map.png differ diff --git a/docs/heater-shaker/docs/images/hs-parts.png b/docs/heater-shaker/docs/images/hs-parts.png new file mode 100644 index 00000000000..7e0f2656269 Binary files /dev/null and b/docs/heater-shaker/docs/images/hs-parts.png differ diff --git a/docs/heater-shaker/docs/images/hs-with-labels.png b/docs/heater-shaker/docs/images/hs-with-labels.png new file mode 100644 index 00000000000..e8dd6cef4ef Binary files /dev/null and b/docs/heater-shaker/docs/images/hs-with-labels.png differ diff --git a/docs/heater-shaker/docs/images/hs-with-labels.svg b/docs/heater-shaker/docs/images/hs-with-labels.svg new file mode 100644 index 00000000000..7c153716ce5 --- /dev/null +++ b/docs/heater-shaker/docs/images/hs-with-labels.svg @@ -0,0 +1,4 @@ + + + +
Labware latch
Labware latch
Heating & shaking plate
Heating & shaki...
2x anchors
2x anchors
Serial number
Serial number
Power port
Power port
USB port
USB port
Power button
Power button \ No newline at end of file diff --git a/docs/heater-shaker/docs/images/module-icon-dark.svg b/docs/heater-shaker/docs/images/module-icon-dark.svg new file mode 100644 index 00000000000..aaa8e49cf3d --- /dev/null +++ b/docs/heater-shaker/docs/images/module-icon-dark.svg @@ -0,0 +1,16 @@ + + + + + + + + + + + + + + + + diff --git a/docs/heater-shaker/docs/images/module-status.png b/docs/heater-shaker/docs/images/module-status.png new file mode 100644 index 00000000000..f76a76370ce Binary files /dev/null and b/docs/heater-shaker/docs/images/module-status.png differ diff --git a/docs/heater-shaker/docs/images/pinch-point-warning.svg b/docs/heater-shaker/docs/images/pinch-point-warning.svg new file mode 100644 index 00000000000..31cdaee1cdf --- /dev/null +++ b/docs/heater-shaker/docs/images/pinch-point-warning.svg @@ -0,0 +1,22 @@ + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/heater-shaker/docs/images/thermal-adapters.png b/docs/heater-shaker/docs/images/thermal-adapters.png new file mode 100644 index 00000000000..160e80567b9 Binary files /dev/null and b/docs/heater-shaker/docs/images/thermal-adapters.png differ diff --git a/docs/heater-shaker/docs/index.md b/docs/heater-shaker/docs/index.md new file mode 100644 index 00000000000..470e061cbf9 --- /dev/null +++ b/docs/heater-shaker/docs/index.md @@ -0,0 +1,19 @@ +--- +title: "Heater-Shaker Module GEN1 Instruction Manual" +hide: toc +--- + +
+ +# Heater-Shaker Module GEN1 Instruction Manual + +![Heater-Shaker hero image](images/heater-shaker-hero.png) + +**Opentrons Labworks Inc.**
+May 2024 + +
+ +## Product Description + +The Opentrons Heater-Shaker Module GEN1 provides on-deck heating and orbital shaking. The Heater-Shaker can heat samples to 95 °C and shake them at speeds ranging from 200 to 3000 rpm. It is compatible with the Opentrons Flex and OT-2 liquid handling robots and selected flat, deep-well, and 96-well plates. The Heater-Shaker can also be used alongside other Opentrons modules and with the Opentrons Flex Gripper. diff --git a/docs/heater-shaker/docs/maintenance.md b/docs/heater-shaker/docs/maintenance.md new file mode 100644 index 00000000000..c9a49d8800a --- /dev/null +++ b/docs/heater-shaker/docs/maintenance.md @@ -0,0 +1,69 @@ +--- +title: "Heater-Shaker Module: Maintenance and Cleaning" +--- + +# Maintenance and Cleaning + +## Maintenance + +Users should not attempt to service or repair the Heater-Shaker themselves. If you have concerns about the module’s performance or require maintenance, please contact Opentrons Support. + +## Cleaning + +The following table lists the chemicals you can use to clean your Heater-Shaker. Diluted alcohol and distilled water are our recommended cleaning products, but you can refer to this list for other cleaning options. + +!!!warning + - Do not use acetone to clean the Heater-Shaker. + - Do not disassemble the Heater-Shaker for cleaning or attempt to clean its internal electronic components or mechanical parts. + - Do not put the Heater-Shaker in an autoclave. + + + + + + + + + + + + + + + + + + + + + + +
SolutionRecommendations
Alcohol +
    +
  • Includes ethyl/ethanol, isopropyl, and methanol.
    • +
  • Dilute to 70% for cleaning.
    • +
  • Do not use 100% alcohol.
    • +
+
Bleach +
    +
  • Dilute to 10% (1:10 bleach/water ratio) for cleaning.
    • +
  • Do not use 100% bleach.
    • +
+
Distilled WaterYou can use distilled water to clean or rinse your Heater-Shaker.
+ +Turn off the Heater-Shaker before cleaning it. You can clean the top surfaces of the module while it’s installed in a deck slot. However, for better access, you may want to: + +- Disconnect any USB or power cables before you begin. +- Remove the caddy (Flex only) and module from the deck slot. +- Remove the module from the caddy (Flex only). + +Once you’ve prepared the module for cleaning: + +
+ +1. Dampen a soft, clean cloth or paper towel with a cleaning solution. +2. Gently wipe off the module’s surfaces. +3. Rinse off any remaining residue using a cloth dampened with distilled water. +4. Let the module air dry. + +
diff --git a/docs/heater-shaker/docs/ot2-installation.md b/docs/heater-shaker/docs/ot2-installation.md new file mode 100644 index 00000000000..babe3368bde --- /dev/null +++ b/docs/heater-shaker/docs/ot2-installation.md @@ -0,0 +1,34 @@ +--- +title: "Heater-Shaker Module: OT-2 Installation Instructions" +--- + +# OT-2 Installation Instructions + +To install the Heater-Shaker on your OT-2: + +
+ +1. Choose the supported deck slot you want to use for the module and press it gently into place. + +2. Holding the module, use the T10 Torx screwdriver that came with it to turn the anchor screws clockwise to tighten the anchors. The module is secure when it doesn’t move while gently pulling on it and rocking it from side to side. + + !!!warning + The shaking motion of the Heater-Shaker requires anchoring to help ensure it does not dislodge itself while in operation. + +3. Connect the USB cable to the module and to a USB port on your OT-2. + +4. Connect power cable to the module. The Heater-Shaker has an asymmetrical 4-pin power connector. When connecting the power cable to the module: + + - Match the connector's flat side to the flat side of the module's power port. + - Aligned cables attach easily; misaligned cables do not. + - _Do not_ plug the power cable into a wall outlet until instructed to do so. + +
+ ![DIN power connector](images/din-power-connector.png) +
+ +5. Connect the power cable to a wall outlet. Gently press the on/off switch to turn the module on. + +If the temperature and status LCDs are illuminated, the module is powered on. + +When successfully connected, the module appears in the Instruments and Modules section on your robot’s device detail page in the Opentrons App. From there, you can control the module’s labware latch or run a test shake (see the [Software Control section](software-control.md) below). The Heater-Shaker does not require calibration on an OT-2. At this point, the module is ready to use. \ No newline at end of file diff --git a/docs/heater-shaker/docs/preinstall.md b/docs/heater-shaker/docs/preinstall.md new file mode 100644 index 00000000000..ce4f5cd1826 --- /dev/null +++ b/docs/heater-shaker/docs/preinstall.md @@ -0,0 +1,75 @@ +--- +title: "Heater-Shaker Module: Before You Begin" +--- + +# Before You Begin + +Review this section for important information about deck placement, alignment, and anchor adjustments for the Heater-Shaker. + +## Flex Caddies + +When used with a Flex robot, the Heater-Shaker fits into a caddy that occupies space below the deck. The caddy places your labware closer to the deck surface and allows for below-deck cable routing. See the [Caddies section](../flex/modules/caddy.md) of the Flex Instruction Manual for more information. + +![Module caddy with labels](images/hs-caddy.png) + +Caddies are available for purchase from the [Modules section](https://opentrons.com/products/categories/modules) of the Opentrons website. + +The OT-2 does not use caddies. The module clips directly to the deck. However, you still need to secure the Heater-Shaker with its anchors when used with an OT-2. + +## Anchor Adjustments + +Anchors are screw-adjustable panels on the Heater-Shaker module. They provide the clamping force that secures the module to its caddy or to the deck when mounted on a Flex or OT-2. Use the T10 Torx screwdriver that comes with the module to adjust the anchors. + +- To loosen/retract the anchors, turn the screws counterclockwise. +- To tighten/extend the anchors, turn the screws clockwise. + +![Adjusting module anchors](images/hs-anchors.png) + +Before installation: + +- Check the anchors to make sure they’re flush with the base of the Heater-Shaker. +- If the anchors interfere with installing the module, adjust them until there’s enough clearance to seat the module and tighten them to hold it in place. + +## Deck Placement and Cable Alignment + +The supported deck slot positions for the Heater-Shaker depend on the robot you’re using. + +| Robot Model | Deck Placement | +|----|----| +| Flex | In any slot in column 1 or 3. The module can go in slot A3, but you need to remove the trash bin first. | +| OT-2 | In deck slots 1, 3, 4, 6, 7, or 10. | + +![Deck map showing module installation locations](images/hs-deck-map.png) + +To properly align the Heater-Shaker relative to the robot, make sure the module’s power and USB ports face outward, away from the center of the deck. This helps make cable routing and access easier. + + + + + + + + + + + + + + + + + + +
Robot ModelDeck Placement
Flex +
    +
  • Facing left in column 1.
    • +
  • Facing right in column 3.
    • +
+
OT-2 +
    +
  • Facing left in slot 1, 4, 7, or 10.
    • +
  • Facing right in slot 3 or 6.
    • +
+
+ +Do not install the Heater-Shaker with the ports facing in, towards the middle of the deck. This alignment makes cable routing and access difficult. diff --git a/docs/heater-shaker/docs/software-control.md b/docs/heater-shaker/docs/software-control.md new file mode 100644 index 00000000000..65a75630aef --- /dev/null +++ b/docs/heater-shaker/docs/software-control.md @@ -0,0 +1,32 @@ +--- +title: "Heater-Shaker Module: Software Control" +--- + +# Software Control + +You control the Heater-Shaker through protocols you create in [Opentrons Protocol Designer](https://designer.opentrons.com/) or the [Python API](https://docs.opentrons.com/v2/modules/heater_shaker.html#heater-shaker-module). Running these protocols requires version 6.1.0 or newer of the [Opentrons App](https://opentrons.com/ot-app) and robot server. + +The Opentrons App displays the current status of the Heater-Shaker and can also control the module outside of protocols. To control a Heater-Shaker, go to the **Devices** tab and select a robot that has a Heater-Shaker connected to it. Robots with a connected and powered on Heater-Shaker will display a thermometer icon thermometer icon under the modules section of the device card. + +
+![Heater-Shaker image and labels in the devices tab](images/devices.png) +
+ +On the device detail page, a module card shows the current status +of the Heater-Shaker, including: + +- Whether it is heating, cooling, or holding at the target temperature. A warning banner appears if the module is hot to the touch (>49 °C). +- The target (if set) and current temperature. +- Whether the module is speeding up, slowing down, or holding at the target shake speed. +- The target (if set) and current shake speed. +- Whether the labware latch is open or closed. + +
+![Detail page image showing module status as hot](images/module-status.png) +
+ +On the module card, you can click the three-dot menu (⋮) to see other controls for the Heater-Shaker. These options let you control the heater, shaker, and labware latch independently. You can also view information about the module, including its serial number, firmware version, or launch the in-app attachment guide. + +
+![Detail page showing 3 dot menu options](images/3-dot-menu.png) +
diff --git a/docs/heater-shaker/docs/specifications.md b/docs/heater-shaker/docs/specifications.md new file mode 100644 index 00000000000..4e11d2ed320 --- /dev/null +++ b/docs/heater-shaker/docs/specifications.md @@ -0,0 +1,164 @@ +--- +title: "Heater-Shaker Module: Product Specifications" +--- + +# Product Specifications + +![Heater-Shaker with external features labeled](images/hs-with-labels.svg) + +## Model Number + +GEN1 + +## Included Parts + +![Module parts with labels](images/hs-parts.png) + +## Software Requirements + +The Heater-Shaker requires version 6.1.0 or newer of the Opentrons App and robot server. You can download the Opentrons App for Mac, Windows, or Linux at . + +## Physical Specifications + +All specifications are for the module as shipped: with latches in the closed position and without labware or adapters. + +- **Dimensions:** 152 mm L x 90 mm W x 82 mm H +- **Weight:** 1.34 kg +- **Composition:** CNC aluminum and polycarbonate plastic + +## Power Specifications + +An external AC/DC power unit provides power to the Heater-Shaker. It connects to mains AC power with an IEC power cable and sends DC power to the module through a mini-DIN 4-pin power connector. The power specifications for this device are shown below: + +- **Input:** 100–240 VAC, 50/60 Hz, 4.0 A +- **Output:** 36 VDC, 6.1 A, 219.6 W + +!!!warning + _Do not_ replace the power supply cable unless at the direction of Opentrons Support. + +The following table lists power consumption values measured at the wall outlet. Typical power consumption is when the module maintains temperatures and shake speeds within the normal range. Maximum power consumption is when the module simultaneously heats at full power and shakes at maximum speed. + + + + + + + + + + + + + + + + + + + + + + +
Operating ConditionPower Consumption
Idle3 W
Normal +
    +
  • Shaking: 4–11 W
    • +
  • Heating: 10–30 W
    • +
  • Heating and Shaking: 10–40 W
    • +
+
Maximum125–130 W
+ +## Shaking Profile + + + + + + + + + + + + + + + + + + + + +
Orbital Diameter2.0 mm
Orbital DirectionClockwise
Speed Range200–3000 rpm
Speed Accuracy±25 rpm
+ +!!!note + Some labware may recommend a lower rpm. + +## Temperature Profile + + + + + + + + + + + + + + + + + + + + +
Temperature Range37-95 °C
Temperature Accuracy±0.5 °C at 55 °C
Temperature Uniformity±0.5 °C at 55 °C
Ramp Rate10 °C/min
+ +## LED Status Light { #led-status } + +The Heater-Shaker has an LED status light that can display three colors: amber, red, and white. Understanding these status indications is important for safely handling the module. The possible module conditions indicated by the light are listed below. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
LED ColorModule Status
RedA red light indicates a hot temperature state. +
    +
  • Solid red: Hot to the touch (>49 °C).
    • +
  • Pulsing red: Heating
    • +
+
WhiteA solid white light indicates the module is: +
    +
  • Powered on and idle (not actively heating or cooling).
    • +
  • Deactivated and not hot to the touch (<49 °C).
    • +
+
+ AmberSolid amber indicates an error.
+ Amber/RedPulsing amber and red (alternating) indicates an error and the module is hot to the touch (>49 °C)
LED offPowered off
diff --git a/docs/heater-shaker/docs/warranty.md b/docs/heater-shaker/docs/warranty.md new file mode 100644 index 00000000000..53976d496e1 --- /dev/null +++ b/docs/heater-shaker/docs/warranty.md @@ -0,0 +1,35 @@ +--- +title: "Heater-Shaker Module: Additional Product Information" +--- + +# Additional Product Information + +## Warranty + +All hardware purchased from Opentrons is covered under a 1-year standard warranty. Opentrons warrants to the end-user of the products that they will be free of manufacturing defects due to part quality issues or poor workmanship and also warrants that the products will materially conform to Opentrons’ published specifications. + +## Support + +Opentrons Support can help you with questions about our products and services. If you discover a defect, or believe your product is not functioning to published specifications, contact us at . + +Please have the Heater-Shaker’s serial number available when contacting support. You can find the serial number on the bottom of the module or in the Opentrons App. To find the module serial number in the app, go to the Instruments and Modules section of your robot’s device details page, click the three-dot menu (⋮) and then click **About**. + +## App Download + +Control your liquid handling robot and modules using the Opentrons App. Download the app for Mac, Windows, or Linux at https://opentrons.com/ot-app. + +## Manufacturer Description + +[Opentrons Labworks Inc](https://opentrons.com/)
+45-18 Court Square West
+Long Island City, NY 11101 + +--- + +**Post-sales service & contacting Opentrons** + +If you have any questions about the use of the system, abnormal phenomena, or special needs, please contact: support@opentrons.com. Also visit [www.opentrons.com](http://www.opentrons.com). + +Trademarks: Opentrons®, Opentrons drop logo (Opentrons Labworks, Inc.). Registered names, trademarks, etc. used in this document, even when not specifically marked as such, are not to be considered unprotected by law. + +December 2024 © OPENTRONS 2024. ALL RIGHTS RESERVED diff --git a/docs/heater-shaker/mkdocs.yml b/docs/heater-shaker/mkdocs.yml new file mode 100644 index 00000000000..4c1441c7c79 --- /dev/null +++ b/docs/heater-shaker/mkdocs.yml @@ -0,0 +1,53 @@ +site_name: heater-shaker + +nav: + - Home: index.md + - Safety Information and Regulatory Compliance: compliance.md + - Product Specifications: specifications.md + - Thermal Adapters: adapters.md + - Installing the Heater-Shaker: + - Before You Begin: preinstall.md + - Flex Attachment Steps: flex-installation.md + - OT-2 Attachment Steps: ot2-installation.md + - Software Control: software-control.md + - Maintenance and Cleaning: maintenance.md + - Additional Product Information: warranty.md + +theme: + name: material + palette: + primary: custom + accent: custom + logo: images/opentrons-droplet-white.svg + favicon: images/opentrons-droplet-color.svg + icon: + admonition: + tip: material/lightbulb-on-outline + +plugins: + - search + - autorefs + - parent-css + +markdown_extensions: + - admonition + - attr_list + - md_in_html + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg + - pymdownx.inlinehilite + - pymdownx.highlight: + anchor_linenums: true + line_spans: true + pygments_lang_class: true + - pymdownx.superfences + - sane_lists + - toc: + permalink: true + +extra_css: + - manual.css + - ../opentrons-theme.css + +copyright: '© Opentrons 2025. All rights reserved.
Trademarks: Opentrons®, Opentrons drop logo (Opentrons Labworks, Inc.).
Registered names, trademarks, etc. used in this document, even when not specifically marked as such, are not to be considered unprotected by law.' \ No newline at end of file diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index ae811192582..abade175e90 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -10,6 +10,7 @@ nav: - Flex Stacker: '!include stacker-manual/mkdocs.yml' - HEPA/UV Module: '!include hepa-uv/mkdocs.yml' - Thermocycler Module: '!include thermocycler-manual/mkdocs.yml' + - Heater-Shaker Module: '!include heater-shaker/mkdocs.yml' - Protocol Designer: '!include protocol-designer/mkdocs.yml' - Python API: https://docs.opentrons.com/v2/ diff --git a/docs/shared/icons/opentrons/heater-shaker.svg b/docs/shared/icons/opentrons/heater-shaker.svg new file mode 100644 index 00000000000..e147cda6a00 --- /dev/null +++ b/docs/shared/icons/opentrons/heater-shaker.svg @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + diff --git a/docs/shared/instruction-manuals.css b/docs/shared/instruction-manuals.css index 41527c42979..dbe7b711dc3 100644 --- a/docs/shared/instruction-manuals.css +++ b/docs/shared/instruction-manuals.css @@ -114,6 +114,12 @@ figure.side-by-side img { background-color: #F09D20; } +/* Longitudinal split dot for two-color LEDs */ +.status-dot.yellow-red-split { + background-image: linear-gradient(to right, #F09D20 50%, red 50%); + background-color: transparent; +} + /* Aligns status dots and text if needed */ .status-dot-container { display: flex; diff --git a/docs/shared/modules/index.md b/docs/shared/modules/index.md index 32a7c701bbc..36476131e43 100644 --- a/docs/shared/modules/index.md +++ b/docs/shared/modules/index.md @@ -30,6 +30,14 @@ Opentrons hardware modules add features and capabilities to your robot. [:octicons-arrow-right-24: Instruction Manual](../hepa-uv/index.md) +- :opentrons-heater-shaker:{ .xl .middle } __Heater-Shaker__ + + --- + + Provides on-deck heating and orbital shaking. + + [:octicons-arrow-right-24: Instruction Manual](../heater-shaker/index.md) + - :opentrons-thermocycler:{ .xl .middle } __Thermocycler Module__ ---