Skip to content

Commit

Permalink
doc: Link to safety check section
Browse files Browse the repository at this point in the history
Add links to the safety check section to related configuration values.
  • Loading branch information
luator committed Sep 18, 2024
1 parent 7af473c commit f2cbf23
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions doc/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ Options
Maximum current [in Ampere] that can be sent to the motor. Commands that result in
higher torques will be clipped to the maximum.

See :ref:`safety_checks`.

.. confval:: has_endstop: bool = false

Specify whether the joints have physical end stops or not.
Expand Down Expand Up @@ -84,6 +86,7 @@ Options

Set to zero to completely disable damping.

See :ref:`safety_checks`.

.. confval:: position_control_gains

Expand Down Expand Up @@ -115,6 +118,8 @@ Options
Exceeding this limit with some joints results in the action for that joint being
adjusted to move the joint back inside the limits.

See :ref:`safety_checks`.

.. confval:: soft_position_limits_upper: list[N_joints] = [inf, ...]

Soft upper limits for joint position. See :confval:`soft_position_limits_lower`.
Expand Down

0 comments on commit f2cbf23

Please sign in to comment.