pylabrobot.formulatrix.mantis.driver.features.arm.Arm#

class pylabrobot.formulatrix.mantis.driver.features.arm.Arm(*, driver: MantisDriver, configuration: MantisArmConfiguration)#

Bases: object

The arm and Z, built on every unit; the generation selects only private plumbing.

Bringing it up needs the unit’s arm block: on a v4 each arm motor’s offset, encoder reference and encoder correction; on a v3 its homing settings, home frame and route to idle. Without it nothing is sent and initialize refuses; it never falls back to another unit’s values. A v3 has no absolute encoders: what needs them raises MantisConfigurationError, and its moves after the bring-up raise NotImplementedError until one has run on a v3. The zones and approach_paths blocks give the routes; without them the head is moved to idle only from near it, and the waste and the washes refuse. Without the stage block the deck-frame moves and request_pose refuse. Routes (bring-up, park, the approach paths, stop) move at the ROUTE_* profile; the other moves take the arms at it unless an xy speed is given.

The public moves take the nozzle in the deck frame, mm, and its speed in mm/s; a joint state holds each motor as it reads, Z in mm down from its flag.

After each move, and where a failed one stopped, the measured pose goes to _pose_observer if one is set: the two links’ angles and Z’s height, as keywords theta_1, theta_2 and z.

Attributes

default_minimum_traverse_height

The nozzle's height above the deck it rises to before it moves across, mm, where a move's minimum_traverse_height_start is None; None takes the safe height, SAFE_HEIGHT above Z's flag.

default_xy_acceleration

The nozzle's acceleration across the deck for a move, mm/s²; None takes the route profile.

default_xy_speed

The nozzle's speed across the deck for a move, mm/s; None takes the route profile.

default_z_acceleration

Z's acceleration for a move, and its deceleration at a stop, in mm/s², within Z_ACCELERATION_RANGE.

default_z_speed

Z's speed for a move, in mm/s, within Z_SPEED_RANGE.

is_initialized

Whether initialize brought the arm up since the link opened.

Methods

__init__(*, driver, configuration)

initialize()

Bring the arm and Z up from power-on: a v4 from where its absolute encoders read, a v3 from its stops and flags.

is_xy_reachable(*, x, y)

Whether the head can reach a deck-frame (x, y), mm, by the arm's inverse kinematics.

move_to_joint_state(*, joint_state[, ...])

Move the motors named to a joint state, queued (command 68); the others hold.

move_to_location(*, location[, ...])

Move the nozzle to a deck-frame location: across as move_to_xy_position, then down as move_to_z_position.

move_to_wash(*, position[, with_model_updates])

Move the head into a wash position along the unit's approach path, from wherever it stands; from the other wash position without leaving the wash.

move_to_waste(*[, with_model_updates])

Move the head into the waste along the unit's approach path, from wherever it stands.

move_to_xy_position(*, x, y[, ...])

Move the nozzle across to (x, y) in the deck frame, guarded: Z rises first to the traverse height if it is below it, then the arms move with Z held.

move_to_z_position(*, z[, speed, acceleration])

Move the nozzle to a height in the deck frame where it stands; the arms hold.

park(*[, minimum_traverse_height_start, ...])

Move the head to idle along its zone's route, from any zone; from an approach path, first out along it.

recover_from_fault()

Recover from a motor fault as recorded: stop every motor, clear Z's faults then the arms', and recover to idle as initialize does: a v4 from its absolute encoders, a v3 by its whole bring-up again.

request_absolute_joint_state()

Each arm motor's angle from its absolute encoder, in degrees, by motor; nothing moves.

request_is_parked(*[, tolerance])

Whether the head is at idle: each arm motor at its idle target by its absolute encoder, and Z at or above its home flag by its encoder (command 84).

request_joint_state()

Where the controller holds each motor: 0 and 1 in degrees, 2 (Z) in mm down from its flag.

request_pose()

Where every joint of the arm is and where the nozzle is, in the deck frame, worked out from the joint state; nothing moves.

Parameters: