pyrcf.executables.visualise_robot
=================================

.. py:module:: pyrcf.executables.visualise_robot

.. autoapi-nested-parse::

   Visualise any robot urdf (or robot description package from robot_description.py) in pybullet.

   Useful for finding out joint values and joint limits.

   Usage:
       pyrcf-visualise-robot <description_name> [as_floating_base? (1 or 0)]
       Args:
           <description_name>: Provide robot description name as first argument
               The robot description name should be a valid path to urdf file or
               name of a description package from
               the `robot_descriptions.py` repo that has a valid urdf file:
               https://github.com/robot-descriptions/robot_descriptions.py?tab=readme-ov-file#descriptions.
               e.g. `pepper_description`.
           (Optional): second argument can be 1 or 0 to load the robot as
               a fixed base robot (1) or not (0).



Attributes
----------

.. autoapisummary::

   pyrcf.executables.visualise_robot.usage_string


Functions
---------

.. autoapisummary::

   pyrcf.executables.visualise_robot.main


Module Contents
---------------

.. py:data:: usage_string
   :value: Multiline-String

   .. raw:: html

      <details><summary>Show Value</summary>

   .. code-block:: python

      """
      Visualise any robot urdf (or robot description package from robot_description.py) in pybullet.
      Useful for finding out joint values and joint limits.
      
      
      Usage: 
      
      pyrcf-visualise-robot <description_name> [as_floating_base? (1 or 0)]
      
      Args:
      	 <description_name>: Provide robot description name as first argument
      		The robot description name should be a valid path to urdf file or 
      		name of a description package from
      		 the `robot_descriptions.py` repo that has a valid urdf file: 
      		https://github.com/robot-descriptions/robot_descriptions.py?tab=readme-ov-file#descriptions.
      		 e.g. `pepper_description`.
      	 (Optional): second argument can be 1 or 0 to load the robot as
      		a fixed base robot (1) or not (0).
      """

   .. raw:: html

      </details>



.. py:function:: main()