pylabrobot.hamilton.prep.Prep#
- pylabrobot.hamilton.prep.Prep(deck: PrepDeck | None = None, simulation: bool = False, host: str | None = None, port: int = 2000, declared_configuration_json: str | None = None, firmware_tree_json: str | None = None, driver: PrepDriver | None = None, name: str = 'Prep', size_x: float = 497.0, size_y: float = 575.0, size_z: float = 575.0, simulate_motion_time: bool = False, motion_time_scale: float = 0.25) PrepDevice#
A Prep, on a Prep deck.
- Parameters:
deck (PrepDeck | None) – the deck. If omitted, builds a deck and components prefixed with
name. A supplied deck keeps its existing resource names.simulation (bool) – whether to build a simulated device, which answers without one being connected.
host (str | None) – the address the Prep answers on. Required unless simulating or given a driver.
port (int) – the port it answers on.
declared_configuration_json (str | None) – path to a declared configuration, passed to the driver this builds. Read only when this builds one: a driver given outright brings its own. A simulated device defaults to the recording of a device with an 8-channel head and a heater shaker.
firmware_tree_json (str | None) – path to a recorded firmware tree, for a simulated device to have. Defaults to that device’s (MLPrep Runtime V3.0.20).
driver (PrepDriver | None) – the driver to drive it through, instead of building one.
name (str) – what to call it.
size_x (float) – how wide it is, in mm.
size_y (float) – how deep it is, in mm.
size_z (float) – how tall it is, in mm.
simulate_motion_time (bool) – for a simulated device, whether each move takes time at all, so a viewer shows every step. Ignored for a real device.
motion_time_scale (float) – the share of the real device’s time a simulated move then takes, a quarter by default. 1.0 keeps the real time. Ignored for a real device.
- Returns:
The device, on a Prep deck.
- Return type: