.. _modules-section-label:

Module API
==========

py_trees_ros_tutorials
----------------------

.. automodule:: py_trees_ros_tutorials
   :synopsis: tutorials for py_trees in ros

py_trees_ros_tutorials.behaviours
---------------------------------

.. automodule:: py_trees_ros_tutorials.behaviours
    :members:
    :show-inheritance:
    :synopsis: behaviours for the tutorials

py_trees_ros_tutorials.mock
---------------------------

.. automodule:: py_trees_ros_tutorials.mock
    :synopsis: utilities and components for mocking a robot

py_trees_ros_tutorials.mock.actions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: py_trees_ros_tutorials.mock.actions
    :members:
    :show-inheritance:
    :synopsis: reusable action clients for testing mock components

py_trees_ros_tutorials.mock.battery
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: py_trees_ros_tutorials.mock.battery
    :members:
    :show-inheritance:
    :synopsis: mock the state of a battery component

py_trees_ros_tutorials.mock.dock
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: py_trees_ros_tutorials.mock.dock
    :members:
    :show-inheritance:
    :synopsis: mock a docking controller

py_trees_ros_tutorials.mock.launch
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: py_trees_ros_tutorials.mock.launch
    :members:
    :show-inheritance:
    :synopsis: a python launcher for all mock robot processes

py_trees_ros_tutorials.mock.led_strip
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: py_trees_ros_tutorials.mock.led_strip
    :members:
    :show-inheritance:
    :synopsis: mock a led strip notification server

py_trees_ros_tutorials.mock.move_base
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: py_trees_ros_tutorials.mock.move_base
    :members:
    :show-inheritance:
    :synopsis: mock the ROS navistack move base

py_trees_ros_tutorials.mock.rotate
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: py_trees_ros_tutorials.mock.rotate
    :members:
    :show-inheritance:
    :synopsis: mock a very simple rotation action server

py_trees_ros_tutorials.mock.safety_sensors
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: py_trees_ros_tutorials.mock.safety_sensors
    :members:
    :show-inheritance:
    :synopsis: mock a safety sensor pipeline, requires context switching

py_trees_ros_tutorials.version
------------------------------

.. automodule:: py_trees_ros_tutorials.version
    :members:
    :show-inheritance:
    :synopsis: package version number for users of the package