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 = 'Hamilton Prep', size_x: float = 497.0, size_y: float = 575.0, size_z: float = 575.0) → 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 PRPAA1087’s recording.

  • firmware_tree_json (str | None) – path to a recorded firmware tree, for a simulated device to have. Defaults to MLPrep Runtime V1.2.2’s.

  • 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.

Returns:

The device, on a Prep deck.

Return type:

PrepDevice