base

📄️ Introduction

📄️ base

base

📄️ Proxy a request to the specified device.

📄️ Delete a specific nest object in the motion database.

📄️ Delete a specific path object in the motion database.

📄️ Delete a specific waypoint object in the motion database.

📄️ Delete a specific zone object in the motion database.

📄️ Return the current waypoint for the given device, if any.

📄️ Return the labware currently held by the device, if any.

📄️ Proxy a request to the specified device.

📄️ Retrieve the schema of a specific loaded device.

📄️ Retrieve the schemas of all devices that are ready.

📄️ Healthcheck

Check if the driver is running and able to serve requests

📄️ Passthrough route for querying LIMS for labware.

📄️ Get a hotel.

📄️ Get a specific nest object in the motion database.

📄️ Get all nest objects in the motion database.

📄️ Get a specific path object in the motion database.

📄️ Get all path objects in the motion database.

📄️ Get a specific waypoint object in the motion database.

📄️ Get all waypoint objects in the motion database, with optional filters.

📄️ Get a specific zone object in the motion database.

📄️ Get all zone objects in the motion database.

📄️ Get service version

📄️ Proxy a request to the specified device.

📄️ Batch update a set of waypoints.

📄️ Move a device to an absolute coordinate. Does not need to start at a waypoint.

WARNING: This move will not follow any path and may move unexpectedly. Use caution.

📄️ Directly move a device to the target waypoint. Does not need to start at a waypoint.

WARNING: This move will not follow any path and may move unexpectedly. Use caution.

📄️ Fetch labware from a nest. Optionally, automatically store after fetching.

📄️ Load a labware into a nest. Optionally, first fetch labware from storage.

📄️ Proxy a request to the specified device.

📄️ Move a device to a target waypoint using a generated motion plan consisting of taught paths and zones.

This move needs to start at a valid waypoint. If the device is not currently at a waypoint, use direct move first.

📄️ Generate (but don't execute) a motion plan for a given device.

📄️ Move a device to a position relative to the current coordinate. Does not need to start at a waypoint.

WARNING: This move will not follow any path and may move unexpectedly. Use caution.

📄️ Create a new hotel.

📄️ Creates a new nest.

📄️ Creates a new path. Requires path name, name of an associated device, and coordinates dict.

📄️ Creates a new waypoint. Requires waypoint name, name of the associated device, and coordinates dict.

📄️ Creates a new zone. Requires zone name, name of the associated device, and coordinates dict.

📄️ Proxy a request to the specified device.

📄️ Replace a nest entirely.

📄️ Replace a path entirely.

📄️ Replace the waypoint.

📄️ Replace a zone entirely.