Skip to content

Commit 3674594

Browse files
committed
Update documentation
1 parent dd2a1e8 commit 3674594

File tree

3 files changed

+15
-4
lines changed

3 files changed

+15
-4
lines changed

doc/architecture/script_command_interface.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ At the time of writing the ``ScriptCommandInterface`` provides the following fun
2020
contact example
2121
<https://github.com/UniversalRobots/Universal_Robots_Client_Library/blob/master/examples/tool_contact_example.cpp>`_
2222
for more information.
23+
- ``setFrictionCompensation()``: Set friction compensation for torque command.
2324

2425
Communication protocol
2526
----------------------
@@ -48,6 +49,7 @@ The robot reads from the "script_command_socket" expecting a 32 bit integer repr
4849
- 4: endForceMode
4950
- 5: startToolContact
5051
- 6: endToolContact
52+
- 7: setFrictionCompensation
5153
1-27 data fields specific to the command
5254
===== =====
5355

@@ -121,6 +123,15 @@ The robot reads from the "script_command_socket" expecting a 32 bit integer repr
121123
1 No specific meaning / values ignored
122124
===== =====
123125

126+
.. table:: With endToolContact command
127+
:widths: auto
128+
129+
===== =====
130+
index meaning
131+
===== =====
132+
1 friction_compensation_enabled enable/disable friction compensation for torque command.
133+
===== =====
134+
124135
.. note::
125136
In URScript the ``socket_read_binary_integer()`` function is used to read the data from the
126137
script command socket. The first index in that function's return value is the number of integers read,

include/ur_client_library/control/script_command_interface.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -151,8 +151,8 @@ class ScriptCommandInterface : public ReverseInterface
151151
* \brief Set friction compensation for the torque_command. If true the torque command will compensate for friction,
152152
* if false it will not.
153153
*
154-
* \param friction_compensation_enabled Will set a friction_compensation variable in urscript, which will be used when calling
155-
* torque_command
154+
* \param friction_compensation_enabled Will set a friction_compensation_enabled variable in urscript, which will be
155+
* used when calling torque_command
156156
*
157157
* \returns True, if the write was performed successfully, false otherwise.
158158
*/

include/ur_client_library/ur/ur_driver.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -718,8 +718,8 @@ class UrDriver
718718
* \brief Set friction compensation for the torque_command. If true the torque command will compensate for friction,
719719
* if false it will not.
720720
*
721-
* \param friction_compensation_enabled Will set a friction_compensation variable in urscript, which will be used when calling
722-
* torque_command
721+
* \param friction_compensation_enabled Will set a friction_compensation_enabled variable in urscript, which will be
722+
* used when calling torque_command
723723
*
724724
* \returns True, if the write was performed successfully, false otherwise.
725725
*/

0 commit comments

Comments
 (0)