Skip to content

Commit

Permalink
docs: add known issues to docs (#197)
Browse files Browse the repository at this point in the history
This commit adds the known issue to the documentation and updates the
bug issue template.
  • Loading branch information
rickstaa authored Dec 13, 2023
1 parent 3441187 commit 4cac087
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 3 deletions.
3 changes: 1 addition & 2 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,7 @@ body:
description: "Please complete the following information."
value: |
- OS: [e.g. Windows, Mac, Linux, iOS, android]
- Browser [e.g. chrome, safari, brave, firefox]
- Version [e.g. 22]
- Panda gazebo version: [e.g. v2.15.4]
- type: textarea
attributes:
label: Additional context
Expand Down
41 changes: 41 additions & 0 deletions panda_gazebo/docs/source/get_started/issues.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
============
Known Issues
============

This document outlines the known issues with the :panda-gazebo:`panda_gazebo <>` package you
may encounter while using. We recommend checking :panda-gazebo:`the issues page <issues>` on the
:panda-gazebo:`GitHub repository <>` for updates.

Gravity Compensation Bug
-------------------------

- **Issue**: Gravity compensation is not working properly when the robot is effort-controlled.
- **Reference**: `#39 <https://github.com/rickstaa/panda-gazebo/issues/39>`_

Due to an upstream bug in the :panda-gazebo:`franka_gazebo <>` package, the gravity compensation feature may not function as expected.
This issue can be mitigated by switching the physics engine from `ODE`_ to `DART`_ using the ``physics`` argument in the ``simulation.launch`` file:

.. code-block:: bash
roslaunch panda_gazebo simulation.launch physics:=Dart
Simulation Crashes with DART Physics
--------------------------------------

- **Issue**: The simulation sometimes crashes when the `DART`_ physics engine is used and the gripper is controlled.
- **Reference**: `#196 <https://github.com/rickstaa/panda-gazebo/issues/196>`_

Users may experience occasional simulation crashes when using the `DART`_ physics engine and controlling the gripper. We
recommend switching to the `ODE`_ physics engine when using the gripper.

Gripper Problems when Vertical
------------------------------

- **Issue**: The gripper is not working properly when being vertical to the ground.
- **Reference**: `#33 <https://github.com/rickstaa/panda-gazebo/issues/33>`_

Due to incorrectly tuned PID gains in the :panda-gazebo:`franka_gazebo <>` package, the gripper may not function properly when it is oriented
vertically to the ground.

.. _ODE: http://www.ode.org/
.. _DART: https://dartsim.github.io/
2 changes: 1 addition & 1 deletion panda_gazebo/docs/source/get_started/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ modes that can be selected using the ``control_mode`` argument:

- ``trajectory``: The robot is controlled using joint position trajectories.
- ``position``: The robot is controlled using joint position commands.
- ``effort``: The robot is controlled using joint effort commands.
- ``effort``: The robot is controlled using joint effort commands.

.. Note::

Expand Down
1 change: 1 addition & 0 deletions panda_gazebo/docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@ Contents

get_started/install.rst
get_started/usage.rst
get_started/issues.rst

.. toctree::
:maxdepth: 2
Expand Down

0 comments on commit 4cac087

Please sign in to comment.