pylabrobot.brooks.precise_flex.PreciseFlex.set_payload

async PreciseFlex.set_payload(payload_pct: int) → None

Set the payload percent of maximum for the currently selected or attached robot.

Parameters:

payload_pct (int) – Payload percentage from 0 to 100 indicating the percent of the maximum payload the robot is carrying.

Raises:

ValueError – If payload_pct is not between 0 and 100.

Return type:

None

Note

If the robot is moving, waits for the robot to stop before setting a value.