Skip to content

Commit

Permalink
chore: release notes framework (#12349)
Browse files Browse the repository at this point in the history
Add some basic content to internal release notes
  • Loading branch information
sfoster1 authored Mar 27, 2023
1 parent de9552c commit 9ed4666
Show file tree
Hide file tree
Showing 2 changed files with 69 additions and 7 deletions.
52 changes: 49 additions & 3 deletions api/release-notes-internal.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,55 @@ For more details about this release, please see the full [technical change log][

---

## OT Internal Robot Software Changes in 0.0.2
# Internal Release 0.1.0

### Bugfixes
This is 0.1.0, the first internal release for the Opentrons Flex robot software, involving both robot control and the on-device display.

### Known Issues
This is still pretty early in the process, so some things are known not to work, and are listed below. Specific compatibility notes about peripheral hardware are also listed.

## Hardware Revision Compatibility

- This release will work best on a DVT robot frame with a programmed rear-panel board. If that doesn't apply, edit `/data/feature_flags.json` and turn `rearPanelIntegration` to `false` or the robot server won't start.
- This release is compatible with EVT pipettes and gripper only if they have received the tool ID rework.
- This release is compatible with DVT pipettes and gripper.
- This release is _not_ compatible with DVT module caddies.

## Big Things That Don't Work Yet So Don't Report Bugs About Them

### ODD
- Attach, detach, and calibration flows for pipettes or gripper
- Deleting protocols stored on the robot via the ODD
- Changing the text size on the ODD through the settings

### Robot Control
- USB connectivity
- Pipette/gripper firmware update on attach: if you need to attach a new instrument, attach it and then power-cycle the robot or restart the robot server
- Pipette pressure sensing both for liquid-level sensing purposes and for clog-detection purposes
- Labware pick up failure with gripper
- Cancelling a protocol might hang - fix is to restart

## Big Things That Do Work Please Do Report Bugs About Them
### Robot Control
- Liquid handling protocols with 1 and 8 channel pipettes
- Labware movement between slots/modules, both manual and with gripper, from python protocols
- Labware drop/gripper crash errors, but they're very insensitive
- Pipette and gripper automated offset calibration
- Network connectivity and discoverability
- Firmware update for all devices attached when the robot turns on

### ODD
- Protocol execution
- Network connection management, including viewing IP addresses and connecting to wifi networks
- Automatic updates of robot software when new internal releases are created
- Chrome remote devtools - if you enable them and then use Chrome to go to robotip:9223 you'll get devtools
- After a while, the ODD should go into idle; if you touch it, it will come back online

## Smaller Known Issues
### Robot Control
- Pipette and gripper automated offset calibration still uses linear search and might have issues; double check that it worked right

## Smaller fun features
- Pipette firmware senses tips now and puts it on the canbus
- The Z-stage will now update its position from encoders after picking up tip instead of homing
- Some nice images and animations are in place while the robot is starting
- You can change the brightness of the ODD through the settings
24 changes: 20 additions & 4 deletions app-shell/build/release-notes-internal.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,26 @@ For more details about this release, please see the full [technical changelog][]

---

## Opentrons App Internal Changes in 0.0.2
# Internal Release 0.1.0

### Bug Fixes
This is 0.1.0, the first internal release for the app supporting the Opentrons Flex.

### Improved Features
This is still pretty early in the process, so some things are known not to work, and are listed below. Some things that may surprise you do work, and are also listed below. There may also be some littler things of note, and those are at the bottom.

## Big Things That Don't Work Yet So Don't Report Bugs About Them
- Attach, detach, and calibration flows for anything from the protocol setup page
- Attach, detach, and calibration flows for the gripper
- USB connectivity
- Pipette/gripper firmware update on attach: if you need to attach a new instrument, attach it and then power-cycle the robot
- If you leave the app on the device page it will very frequently ask what instrument is connected, which causes problems; don't leave the app on the device page of the robot for a really long time

## Big Things That Do Work Please Do Report Bugs About Them
- Connecting to a Flex
- Running protocols on those Flexs including simulate, play/pause, labware position check
- Except for gripper; no LPC for gripper
- Attach, detach, and calibration flows for 1, 8, and 96-channel pipettes when started from the device page
- Automatic updates of app and robot when new internal-releases are created

## Smaller Interesting New Features
- If you click on the wifi or network symbol next to a robot's name in the devices page you'll jump right to the network settings

### Known Issues

0 comments on commit 9ed4666

Please sign in to comment.