=============
API Reference
=============

Complete API documentation for the AV2.

.. contents:: Contents
   :local:
   :depth: 1

Overview
========

This section provides detailed API documentation for all public classes and functions in the AV2.

Core Modules
============

runner
------

.. automodule:: runner
   :members:
   :undoc-members:
   :show-inheritance:

xsens_class
-----------

.. automodule:: xsens_class
   :members:
   :undoc-members:
   :show-inheritance:

osmnx_class
-----------

.. automodule:: osmnx_class
   :members:
   :undoc-members:
   :show-inheritance:

pure_pursuit_controller
-----------------------

.. automodule:: pure_pursuit_controller
   :members:
   :undoc-members:
   :show-inheritance:

vehicle_actuator
----------------

.. automodule:: vehicle_actuator
   :members:
   :undoc-members:
   :show-inheritance:

Perception Modules
==================

perception.occupancy_grid
-------------------------

.. automodule:: perception.occupancy_grid
   :members:
   :undoc-members:
   :show-inheritance:

perception.state
----------------

.. automodule:: perception.state
   :members:
   :undoc-members:
   :show-inheritance:

perception.core_types
---------------------

.. automodule:: perception.core_types
   :members:
   :undoc-members:
   :show-inheritance:

Planning Modules
================

planning.dwa_planner
--------------------

.. automodule:: planning.dwa_planner
   :members:
   :undoc-members:
   :show-inheritance:

Sensor Modules
==============

sensors.lidar_interface
-----------------------

.. automodule:: sensors.lidar_interface
   :members:
   :undoc-members:
   :show-inheritance:

sensors.camera_interface
------------------------

.. automodule:: sensors.camera_interface
   :members:
   :undoc-members:
   :show-inheritance:

.. note::

   API documentation is auto-generated from source code docstrings using Sphinx autodoc.
   Ensure all public methods have proper docstrings for complete documentation.