Skip to content

Commit b2c931c

Browse files
committed
docs: Clarify that the motion functions use script functions for execution
Make it explicit that there is no magic going on here, but the motion functions simply forward information to respective URScript functions using the same parametrization and implications as the script functions.
1 parent 0f6b513 commit b2c931c

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

doc/architecture/instruction_executor.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,15 @@ The Instruction Executor uses the :ref:`trajectory_point_interface` and the
1212
:ref:`reverse_interface`
1313
for sending motion instructions to the robot. Hence, it requires a :ref:`ur_driver` object.
1414

15+
.. note::
16+
The ``InstructionExecutor`` simply forwards the trajectory points to the robot. Execution
17+
is done using respective URScript functions such as `movej
18+
<https://www.universal-robots.com/manuals/EN/HTML/SW5_20/Content/prod-scriptmanual/G5/movej_qa14v105t0r.htm>`_
19+
or `movel
20+
<https://www.universal-robots.com/manuals/EN/HTML/SW5_20/Content/prod-scriptmanual/G5/movel_posea12v025t.htm>`_.
21+
Therefore, all parameters and restrictions of these functions apply. For example, velocity and
22+
acceleration parameters will be ignored if there is a time != 0 given.
23+
1524
As a minimal working example, please see ``examples/instruction_executor.cpp`` example:
1625

1726
.. literalinclude:: ../../examples/instruction_executor.cpp

doc/architecture/trajectory_point_interface.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,15 @@ control PC to the robot for execution. Execution isn't started, before a start c
1717
the ``ReverseInterface``. Once trajectory execution is done (either successful, failed or canceled
1818
externally), the robot will send a response back to the control PC via the trajectory socket.
1919

20+
.. note::
21+
The ``TrajectoryPointInterface`` simply forwards the trajectory points to the robot. Execution
22+
is done using respective URScript functions such as `movej
23+
<https://www.universal-robots.com/manuals/EN/HTML/SW5_20/Content/prod-scriptmanual/G5/movej_qa14v105t0r.htm>`_
24+
or `movel
25+
<https://www.universal-robots.com/manuals/EN/HTML/SW5_20/Content/prod-scriptmanual/G5/movel_posea12v025t.htm>`_.
26+
Therefore, all parameters and restrictions of these functions apply. For example, velocity and
27+
acceleration parameters will be ignored if there is a time != 0 given.
28+
2029

2130
Communication protocol
2231
----------------------

0 commit comments

Comments
 (0)