# Generated by sila2.code_generator; sila2.__version__: 0.12.2
# -----
# This class does not do anything useful at runtime. Its only purpose is to provide type annotations.
# Since sphinx does not support .pyi files (yet?), this is a .py file.
# -----
from __future__ import annotations
from typing import TYPE_CHECKING
if TYPE_CHECKING:
from typing import Iterable, List, Optional
from labwaretransfermanipulatorcontroller_types import (
GetLabware_Responses,
PrepareForInput_Responses,
PrepareForOutput_Responses,
PutLabware_Responses,
)
from sila2.client import ClientMetadataInstance, ClientObservableCommandInstance, ClientUnobservableProperty
from .labwaretransfermanipulatorcontroller_types import HandoverPosition, PositionIndex
[docs]
class LabwareTransferManipulatorControllerClient:
"""
This feature (together with the "Labware Transfer Site Controller" feature) provides commands to trigger the
sub-tasks of handing over a labware item, e.g. a microtiter plate or a tube, from one device to another in a
standardized and generic way.
For each labware transfer a defined sequence of commands has to be called on both involved devices to ensure the
proper synchronization of all necessary transfer actions without unwanted physical interferences and to optimize
the transfer performance regarding the execution time. Using the generic commands, labware transfers between any
arbitrary labware handling devices can be controlled (a robot device has not necessarily to be involved).
Generally, a labware transfer is executed between a source and a destination device, where one of them is the
active device (executing the handover actions) and the other one is the passive device.
The "Labware Transfer Manipulator Controller" feature is used to control the labware transfer on the side of the
active device to hand over labware to or take over labware from a passive device, which provides the
"Labware Transfer Site Controller" feature.
If a device is capable to act either as the active or as the passive device of a labware transfer it must provide
both features.
The complete sequence of issued transfer commands on both devices is as follows:
1. Prior to the actual labware transfer a "Prepare For Output" command is sent to the source device to execute all
necessary actions to be ready to release a labware item (e.g. open a tray) and simultaneously a "Prepare For
Input" command is sent to the destination device to execute all necessary actions to be ready to receive a
labware item (e.g. position the robotic arm near the tray of the source device).
2. When both devices have successfully finished their "Prepare For ..." command execution, the next commands are
issued.
3a If the source device is the active device it will receive a "Put Labware" command to execute all necessary
actions to put the labware item into the destination device. After the transfer has been finished successfully,
the destination device receives a "Labware Delivered" command, that triggers all actions to be done after the
labware item has been transferred (e.g. close the opened tray).
3b If the destination device is the active device it will receive a "Get Labware" command to execute all necessary
actions to get the labware from the source device (e.g. gripping the labware item). After that command has been
finished successfully, the source device receives a "Labware Removed" command, that triggers all actions to be
done after the labware item has been transferred (e.g. close the opened tray).
The command sequences for an active source or destination device have always to be as follows:
- for an active source device: PrepareForOutput - PutLabware.
- for an active destination device: PrepareForInput - GetLabware.
If the commands issued by the client differ from the respective command sequences an "Invalid Command Sequence"
error will be raised.
To address the location, where a labware item can be handed over to or from other devices, every device must
provide one or more uniquely named positions (handover positions) via the "Available Handover Positions" property.
A robot (active device) should have at least one handover position for each device that it interacts with, whereas
most passive devices will only have one handover position. In the case of a position array (e.g. a rack), the
position within the array is specified via the sub-position of the handover position, passed as an index number.
To address the positions within a device where the transferred labware item has to be stored at or is to be taken
from (e.g. the storage positions inside an incubator), the internal position is specified. Each device must provide
the number of available internal positions via the "Number Of Internal Positions" property. In the case of no
multiple internal positions, this property as well as the "Internal Position" parameter value must be 1.
With the "Prepare For Input" command there is also information about the labware transferred, like labware type or
a unique labware identifier (e.g. a barcode).
The "Intermediate Actions" parameter of the "Put Labware" and "Get Labware" commands can be used to specify commands
that have to be executed while a labware item is transferred to avoid unnecessary movements, e.g. if a robot has to
get a plate from a just opened tray and a lid has to be put on the plate before it will be gripped, the lid handling
actions have to be included in the "Get Labware" actions. The intermediate actions have to be executed in the same
order they have been specified by the "Intermediate Actions" parameter.
The property "Available Intermediate Actions" returns a list of commands that can be included in a "Put Labware" or
"Get Labware" command.
"""
AvailableHandoverPositions: ClientUnobservableProperty[List[HandoverPosition]]
"""
All handover positions of the device including the number of sub-positions.
"""
NumberOfInternalPositions: ClientUnobservableProperty[int]
"""
The number of addressable internal positions of the device.
"""
AvailableIntermediateActions: ClientUnobservableProperty[List[str]]
"""
Returns all commands that can be executed within a "Put Labware" or "Get Labware" command execution.
"""
[docs]
def PrepareForOutput(
self,
HandoverPosition: HandoverPosition,
InternalPosition: PositionIndex,
*,
metadata: Optional[Iterable[ClientMetadataInstance]] = None,
) -> ClientObservableCommandInstance[PrepareForOutput_Responses]:
"""
Put the device into a state in which it is ready to release the labware at the specified handover position.
"""
...
[docs]
def PutLabware(
self,
HandoverPosition: HandoverPosition,
IntermediateActions: List[str],
*,
metadata: Optional[Iterable[ClientMetadataInstance]] = None,
) -> ClientObservableCommandInstance[PutLabware_Responses]:
"""
Place the currently processed labware item at the specified handover position (sent to the active source device after a "Prepare For Output" command).
"""
...
[docs]
def GetLabware(
self,
HandoverPosition: HandoverPosition,
IntermediateActions: List[str],
*,
metadata: Optional[Iterable[ClientMetadataInstance]] = None,
) -> ClientObservableCommandInstance[GetLabware_Responses]:
"""
Retrieve a labware item from the specified handover position (sent to the active destination device after a "Prepare For Input" command).
"""
...
