Skip to content

Commit 9268e05

Browse files
committed
update some more STAR->STARBackend in docs
1 parent 71ab71e commit 9268e05

File tree

3 files changed

+16
-16
lines changed

3 files changed

+16
-16
lines changed

docs/user_guide/00_liquid-handling/hamilton-star/iswap-module.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,42 +6,42 @@ The `R0` module allows fine grained control of the iSWAP gripper.
66

77
- Parking
88

9-
You can park the iSWAP using {meth}`~pylabrobot.liquid_handling.backends.hamilton.STAR_backend.STAR.park_iswap`.
9+
You can park the iSWAP using {meth}`~pylabrobot.liquid_handling.backends.hamilton.STAR_backend.STARBackend.park_iswap`.
1010

1111
```python
1212
await star.park_iswap()
1313
```
1414

1515
- Opening gripper:
1616

17-
You can open the iSWAP gripper using {meth}`~pylabrobot.liquid_handling.backends.hamilton.STAR_backend.STAR.iswap_open_gripper`. Warning: this will release any object that is gripped. Used for error recovery.
17+
You can open the iSWAP gripper using {meth}`~pylabrobot.liquid_handling.backends.hamilton.STAR_backend.STARBackend.iswap_open_gripper`. Warning: this will release any object that is gripped. Used for error recovery.
1818

1919
```python
2020
await star.iswap_open_gripper()
2121
```
2222

2323
## Rotations
2424

25-
You can rotate the iSWAP to 12 predifined positions using {meth}`~pylabrobot.liquid_handling.backends.hamilton.STAR_backend.STAR.iswap_rotate`.
25+
You can rotate the iSWAP to 12 predifined positions using {meth}`~pylabrobot.liquid_handling.backends.hamilton.STAR_backend.STARBackend.iswap_rotate`.
2626

2727
the positions and their corresponding integer specifications are shown visually here.
2828

2929
![alt text](iswap_positions.png)
3030

3131
For example to extend the iSWAP fully to the left, the position parameter to `iswap_rotate` would be `12`
3232

33-
You can control the wrist (T-drive) and rotation drive (W-drive) individually using {meth}`~pylabrobot.liquid_handling.backends.hamilton.STAR_backend.STAR.rotate_iswap_wrist` and {meth}`~pylabrobot.liquid_handling.backends.hamilton.STAR_backend.STAR.rotate_iswap_rotation_drive` respectively. Make sure you have enough space (you can use {meth}`~pylabrobot.liquid_handling.backends.hamilton.STAR_backend.STAR.move_iswap_y_relative`)
33+
You can control the wrist (T-drive) and rotation drive (W-drive) individually using {meth}`~pylabrobot.liquid_handling.backends.hamilton.STAR_backend.STARBackend.rotate_iswap_wrist` and {meth}`~pylabrobot.liquid_handling.backends.hamilton.STAR_backend.STARBackend.rotate_iswap_rotation_drive` respectively. Make sure you have enough space (you can use {meth}`~pylabrobot.liquid_handling.backends.hamilton.STAR_backend.STARBackend.move_iswap_y_relative`)
3434

3535
```python
36-
rotation_drive = random.choice([STAR.RotationDriveOrientation.LEFT, STAR.RotationDriveOrientation.RIGHT, STAR.RotationDriveOrientation.FRONT])
37-
wrist_drive = random.choice([STAR.WristOrientation.LEFT, STAR.WristOrientation.RIGHT, STAR.WristOrientation.STRAIGHT, STAR.WristOrientation.REVERSE])
36+
rotation_drive = random.choice([STARBackend.RotationDriveOrientation.LEFT, STARBackend.RotationDriveOrientation.RIGHT, STARBackend.RotationDriveOrientation.FRONT])
37+
wrist_drive = random.choice([STARBackend.WristOrientation.LEFT, STARBackend.WristOrientation.RIGHT, STARBackend.WristOrientation.STRAIGHT, STARBackend.WristOrientation.REVERSE])
3838
await star.rotate_iswap_rotation_drive(rotation_drive)
3939
await star.rotate_iswap_wrist(wrist_drive)
4040
```
4141

4242
## Slow movement
4343

44-
You can make the iswap move more slowly during sensitive operations using {meth}`~pylabrobot.liquid_handling.backends.hamilton.STAR_backend.STAR.slow_iswap`. This is useful when you want to avoid splashing or other disturbances.
44+
You can make the iswap move more slowly during sensitive operations using {meth}`~pylabrobot.liquid_handling.backends.hamilton.STAR_backend.STARBackend.slow_iswap`. This is useful when you want to avoid splashing or other disturbances.
4545

4646
```python
4747
async with star.slow_iswap():

docs/user_guide/00_liquid-handling/hamilton-star/star_lld.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,16 @@ Liquid level detection (LLD) is a feature that allows the Hamilton STAR(let) to
55
To use LLD, you need to specify the LLD mode when calling the `aspirate` or `dispense` methods. Here is how you can use pressure or capacative LLD with the `aspirate` :
66

77
```python
8-
await lh.aspirate([tube], vols=[300], lld_mode=[STAR.LLDMode.GAMMA])
8+
await lh.aspirate([tube], vols=[300], lld_mode=[STARBackend.LLDMode.GAMMA])
99
```
1010

1111
The `lld_mode` parameter can be one of the following:
1212

13-
- `STAR.LLDMode.OFF`: default, no LLD
14-
- `STAR.LLDMode.GAMMA`: capacative LLD
15-
- `STAR.LLDMode.PRESSURE`: pressure LLD
16-
- `STAR.LLDMode.DUAL`: both capacative and pressure LLD
17-
- `STAR.LLDMode.Z_TOUCH_OFF`: find the bottom of the container
13+
- `STARBackend.LLDMode.OFF`: default, no LLD
14+
- `STARBackend.LLDMode.GAMMA`: capacative LLD
15+
- `STARBackend.LLDMode.PRESSURE`: pressure LLD
16+
- `STARBackend.LLDMode.DUAL`: both capacative and pressure LLD
17+
- `STARBackend.LLDMode.Z_TOUCH_OFF`: find the bottom of the container
1818

1919
The `lld_mode` parameter is a list, so you can specify a different LLD mode for each channel.
2020

@@ -35,7 +35,7 @@ from pylabrobot.liquid_handling.errors import ChannelizedError
3535
from pylabrobot.resources.errors import TooLittleLiquidError
3636
channel = 0
3737
try:
38-
await lh.aspirate([tube], vols=[300], lld_mode=[STAR.LLDMode.GAMMA], use_channels=[channel])
38+
await lh.aspirate([tube], vols=[300], lld_mode=[STARBackend.LLDMode.GAMMA], use_channels=[channel])
3939
except ChannelizedError as e:
4040
if isinstance(e.errors[channel], TooLittleLiquidError):
4141
print("Too little liquid in tube")

docs/user_guide/00_liquid-handling/hamilton-star/z-probing.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@
113113
"cell_type": "markdown",
114114
"metadata": {},
115115
"source": [
116-
"Use `STAR.probe_z_height_using_channel` to probe the z-height of a single point at the current location. This function will slowly lower the channel until the liquid level sensor detects a change in capacitance. The z-height of the point of the tip is then returned."
116+
"Use `STARBackend.probe_z_height_using_channel` to probe the z-height of a single point at the current location. This function will slowly lower the channel until the liquid level sensor detects a change in capacitance. The z-height of the point of the tip is then returned."
117117
]
118118
},
119119
{
@@ -287,7 +287,7 @@
287287
"See above for more information on moving channels.\n",
288288
"\n",
289289
"```{warning}\n",
290-
"Make sure the tip is at a safe height above the labware before moving the channel. Use `STAR.move_channel_z` to move the channel to a safe height.\n",
290+
"Make sure the tip is at a safe height above the labware before moving the channel. Use `STARBackend.move_channel_z` to move the channel to a safe height.\n",
291291
"```"
292292
]
293293
},

0 commit comments

Comments
 (0)