@@ -53,7 +53,7 @@ class Link:
53
53
:type I: ndarray
54
54
:param Jm: dynamic - motor inertia
55
55
:type Jm: float
56
- :param B: dynamic - motor viscous friction: B=B⁺=B⁻, [B⁺, B⁻]
56
+ :param B: dynamic - motor viscous friction
57
57
:type B: float, or ndarray(2,)
58
58
:param Tc: dynamic - motor Coulomb friction [Tc⁺, Tc⁻]
59
59
:type Tc: ndarray(2,)
@@ -230,11 +230,16 @@ def format(fmt, val):
230
230
231
231
def islimit (self , q ):
232
232
"""
233
- Checks if the joint is exceeding a joint limit
233
+ Checks if joint exceeds limit
234
234
235
+ :param q: joint coordinate
236
+ :type q: float
235
237
:return: True if joint is exceeded
236
238
:rtype: bool
237
239
240
+ ``link.islimit(q)`` is True if ``q`` exceeds the joint limits defined
241
+ by ``link``.
242
+
238
243
:seealso: :func:`qlim`
239
244
"""
240
245
@@ -245,17 +250,20 @@ def islimit(self, q):
245
250
246
251
def nofriction (self , coulomb = True , viscous = False ):
247
252
"""
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
254
254
255
255
:param coulomb: if True, will set the Coulomb friction to 0
256
256
:type coulomb: bool
257
257
:param viscous: if True, will set the viscous friction to 0
258
258
: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
+
259
267
"""
260
268
261
269
# Copy the Link
0 commit comments