@@ -36,7 +36,11 @@ class JointActionCfg(ActionTermCfg):
36
36
"""Whether to preserve the order of the joint names in the action output. Defaults to False."""
37
37
38
38
clip : dict [str , tuple ] | None = None
39
- """Clip range for the action (dict of regex expressions). Defaults to None."""
39
+ """Clip range for the action (dict of regex expressions). Defaults to None.
40
+
41
+ Dictionary keys should be regex expressions of joint names and values should be tuples of
42
+ (lower, upper) bounds.
43
+ """
40
44
41
45
42
46
@configclass
@@ -131,7 +135,11 @@ class JointPositionToLimitsActionCfg(ActionTermCfg):
131
135
"""
132
136
133
137
clip : dict [str , tuple ] | None = None
134
- """Clip range for the action (dict of regex expressions). Defaults to None."""
138
+ """Clip range for the action (dict of regex expressions). Defaults to None.
139
+
140
+ Dictionary keys should be regex expressions of joint names and values should be tuples of
141
+ (lower, upper) bounds.
142
+ """
135
143
136
144
137
145
@configclass
@@ -228,6 +236,7 @@ class NonHolonomicActionCfg(ActionTermCfg):
228
236
"""Clip range for the action (dict of regex expressions).
229
237
230
238
The expected keys are "v", and "yaw". Defaults to None for no clipping.
239
+ Values should be tuples of (lower, upper) bounds.
231
240
"""
232
241
233
242
@@ -346,13 +355,22 @@ class OffsetCfg:
346
355
"""The configuration for the operational space controller."""
347
356
348
357
position_scale : float = 1.0
349
- """Scale factor for the position targets. Defaults to 1.0."""
358
+ """Scale factor for the position targets. Defaults to 1.0.
359
+
360
+ Note: The scaling is applied before the clipping of the position targets.
361
+ """
350
362
351
363
orientation_scale : float = 1.0
352
- """Scale factor for the orientation (quad for ``pose_abs`` or axis-angle for ``pose_rel``). Defaults to 1.0."""
364
+ """Scale factor for the orientation (quad for ``pose_abs`` or axis-angle for ``pose_rel``). Defaults to 1.0.
365
+
366
+ Note: The scaling is applied before the clipping of the orientation targets.
367
+ """
353
368
354
369
wrench_scale : float = 1.0
355
- """Scale factor for the wrench targets. Defaults to 1.0."""
370
+ """Scale factor for the wrench targets. Defaults to 1.0.
371
+
372
+ Note: The scaling is applied before the clipping of the wrench targets.
373
+ """
356
374
357
375
stiffness_scale : float = 1.0
358
376
"""Scale factor for the stiffness commands. Defaults to 1.0."""
@@ -377,6 +395,8 @@ class OffsetCfg:
377
395
this limits the reachable range of the end-effector in the world frame. When using the controller in ``"rel"`` mode
378
396
this limits the maximum velocity of the end-effector in the task frame. This must match the number of active axes
379
397
in :attr:`controller_cfg.motion_control_axes_task`.
398
+
399
+ Note: The clipping is applied after the scale factor is applied.
380
400
381
401
Example:
382
402
..code-block:: python
@@ -392,7 +412,9 @@ class OffsetCfg:
392
412
The expected format is a list of tuples, each containing two values. When using the controller in ``"abs"`` mode
393
413
this limits the reachable range of the end-effector in the world frame. When using the controller in ``"rel"`` mode
394
414
this limits the maximum velocity of the end-effector in the task frame. This must match the number of active axes
395
- in :attr:`controller_cfg.motion_control_axes_task`.
415
+ in :attr:`controller_cfg.motion_control_axes_task`. Angles are given in the following order: (roll, pitch, yaw).
416
+
417
+ Note: The clipping is applied after the scale factor is applied.
396
418
397
419
Example:
398
420
..code-block:: python
@@ -408,6 +430,8 @@ class OffsetCfg:
408
430
The expected format is a list of tuples, each containing two values. This effectively limits
409
431
the maximum force and torque that can be commanded in the task frame.
410
432
433
+ Note: The clipping is applied after the scale factor is applied.
434
+
411
435
Example:
412
436
..code-block:: python
413
437
clip_wrench = [
0 commit comments