Skip to content

Commit d1ccb99

Browse files
update pi stage doc (#1215)
1 parent a1f5baf commit d1ccb99

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

  • docs/source/02_user_guide/01_supported_hardware

‎docs/source/02_user_guide/01_supported_hardware/stage.rst‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -301,6 +301,20 @@ These stages are controlled by `PI <https://www.pi-usa.us/en/>`_'s own
301301
`here <https://www.pi-usa.us/en/products/controllers-drivers-motion-control-software/motion-control-software>`_.
302302
Stage names (e.g. ``L-509.20DG10``) can also be found in PIMikroMove or on a label on the side of your stage.
303303

304+
.. note::
305+
PI stages require the ``stages`` entry in the ``hardware`` section of
306+
``configuration.yaml``. This entry specifies the stage motor name
307+
assigned to each controller axis. Stage motor names (for example,
308+
``L-509.20DG10``) can be found in PI software.
309+
The stage motor names must be listed in the same order as the axes
310+
reported by PI software: the first stage motor name corresponds to axis
311+
1, the second to axis 2, the third to axis 3, and so on.
312+
For example, if PI software reports axis 1 = ``L-509.20DG10``, axis 2 =
313+
``L-509.40DG10``, and axis 3 = ``M-060.DG``, then the ``stages`` entry
314+
should begin as:
315+
``L-509.20DG10 L-509.40DG10 M-060.DG``
316+
317+
304318
-----------------
305319

306320
C-884

0 commit comments

Comments
 (0)