Skip to content

Commit 93b8ee8

Browse files
committed
adds head_speed to getting started doc
1 parent 36c26a9 commit 93b8ee8

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

docs/source/getting_started.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -384,6 +384,25 @@ Normally, home commands are run immediately when called, and therefore should no
384384
robot.home('ab', enqueue=True) # adds "home ab" command to protocol queue
385385
robot.home('xyz', enqueue=True) # adds "home xyz" command to protocol queue
386386

387+
Head Speed
388+
----------
389+
390+
The speed of the robot's X and Y movements can be sped up or slowed down.
391+
392+
**robot.head_speed** (*rate*)
393+
394+
* **rate -** the speed at which the X and Y axis will move (millimeters per minute)
395+
396+
This method will immediately set the speed of the robot, and all following movements will use that speed.
397+
398+
.. note::
399+
Speeds too fast (around 6000 and higher) will cause the robot to skip step, be careful when using this method
400+
401+
.. testcode:: main
402+
403+
robot.head_speed(4500)
404+
p200.pick_up_tip()
405+
387406
Move To
388407
-------
389408

0 commit comments

Comments
 (0)