.. _modules-section-label:

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

py_trees_ros
------------

.. automodule:: py_trees_ros
   :synopsis: is your robot misbehaving?

py_trees_ros.action_clients
---------------------------

.. automodule:: py_trees_ros.action_clients
    :members:
    :show-inheritance:
    :synopsis: behaviours that work with action clients

py_trees_ros.battery
--------------------

.. automodule:: py_trees_ros.battery
    :members:
    :show-inheritance:
    :synopsis: helpers for getting the most out of your battery

py_trees_ros.blackboard
-----------------------

.. automodule:: py_trees_ros.blackboard
    :members:
    :show-inheritance:
    :synopsis: the ros blackboard and the blackboard watcher

py_trees_ros.conversions
------------------------

.. automodule:: py_trees_ros.conversions
    :members:
    :show-inheritance:
    :synopsis: py_trees - ros messages conversion library

py_trees_ros.exceptions
-----------------------

.. automodule:: py_trees_ros.exceptions
    :members:
    :show-inheritance:
    :synopsis: custom exceptions for py_trees_ros

py_trees_ros.publishers
-----------------------

.. automodule:: py_trees_ros.publishers
    :members:
    :show-inheritance:
    :synopsis: publish data to the ROS network

py_trees_ros.service_clients
----------------------------

.. automodule:: py_trees_ros.service_clients
    :members:
    :show-inheritance:
    :synopsis: behaviours that work with service clients

py_trees_ros.subscribers
------------------------

.. automodule:: py_trees_ros.subscribers
    :members:
    :show-inheritance:
    :synopsis: put a lid on the asynchronicity

py_trees_ros.transforms
-----------------------

.. automodule:: py_trees_ros.transforms
    :members:
    :show-inheritance:
    :synopsis: lookup and send transforms to and from the blackboard


py_trees_ros.trees
------------------

.. automodule:: py_trees_ros.trees
    :members:
    :show-inheritance:
    :synopsis: extensions with ros handles for debugging, visualisation messages and more

py_trees_ros.utilities
----------------------

.. automodule:: py_trees_ros.utilities
    :members:
    :show-inheritance:
    :synopsis: assorted utility functions

py_trees_ros.visitors
---------------------

.. automodule:: py_trees_ros.visitors
    :members:
    :show-inheritance:
    :synopsis: entities that visit behaviours as a tree is traversed

py_trees_ros.programs
---------------------

.. automodule:: py_trees_ros.programs
   :synopsis: command line utilities for py_trees_ros

py_trees_ros.programs.blackboard_watcher
----------------------------------------

.. automodule:: py_trees_ros.programs.blackboard_watcher
    :members:
    :special-members:
    :show-inheritance:
    :synopsis: command line blackboard watcher

py_trees_ros.programs.tree_watcher
----------------------------------

.. automodule:: py_trees_ros.programs.tree_watcher
    :members:
    :special-members:
    :show-inheritance:
    :synopsis: command line tree watcher