Skip to content

Commit 8dd48a2

Browse files
committed
polish
1 parent d8f2c2c commit 8dd48a2

File tree

1 file changed

+16
-8
lines changed

1 file changed

+16
-8
lines changed

roboticstoolbox/robot/Link.py

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ class Link:
5353
:type I: ndarray
5454
:param Jm: dynamic - motor inertia
5555
:type Jm: float
56-
:param B: dynamic - motor viscous friction: B=B⁺=B⁻, [B⁺, B⁻]
56+
:param B: dynamic - motor viscous friction
5757
:type B: float, or ndarray(2,)
5858
:param Tc: dynamic - motor Coulomb friction [Tc⁺, Tc⁻]
5959
:type Tc: ndarray(2,)
@@ -230,11 +230,16 @@ def format(fmt, val):
230230

231231
def islimit(self, q):
232232
"""
233-
Checks if the joint is exceeding a joint limit
233+
Checks if joint exceeds limit
234234
235+
:param q: joint coordinate
236+
:type q: float
235237
:return: True if joint is exceeded
236238
:rtype: bool
237239
240+
``link.islimit(q)`` is True if ``q`` exceeds the joint limits defined
241+
by ``link``.
242+
238243
:seealso: :func:`qlim`
239244
"""
240245

@@ -245,17 +250,20 @@ def islimit(self, q):
245250

246251
def nofriction(self, coulomb=True, viscous=False):
247252
"""
248-
``l2 = nofriction(coulomb, viscous)`` copies the link and returns a
249-
link with the same parameters except, the Coulomb and/or viscous
250-
friction parameter to zero.
251-
252-
``l2 = nofriction()`` as above except the the Coulomb parameter is set
253-
to zero.
253+
Clone link without friction
254254
255255
:param coulomb: if True, will set the Coulomb friction to 0
256256
:type coulomb: bool
257257
:param viscous: if True, will set the viscous friction to 0
258258
:type viscous: bool
259+
260+
``link.nofriction()`` is a copy of the link instance with the same
261+
parameters except, the Coulomb and/or viscous friction parameters are
262+
set to zero.
263+
264+
.. note:: For simulation it can be useful to remove Couloumb friction
265+
which can cause problems for numerical integration.
266+
259267
"""
260268

261269
# Copy the Link

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy