.. _api_doc:

API Documentation
=================

|

PyOpenocdClient
---------------

.. automodule:: py_openocd_client

   .. autoclass:: py_openocd_client.PyOpenocdClient
      :members:

|

Command result
--------------

.. autoclass:: py_openocd_client.OcdCommandResult
   :members:

|

Exceptions
----------

.. autoexception:: OcdCommandFailedError
   :members:

.. autoexception:: OcdConnectionError

.. autoexception:: OcdCommandTimeoutError
   :members:

.. autoexception:: OcdInvalidResponseError
   :members:

.. autoexception:: OcdBaseException

|

Other data types
----------------

.. autoclass:: py_openocd_client.BpInfo
   :members:

.. autoclass:: py_openocd_client.WpInfo
   :members:

.. autoenum:: py_openocd_client.BpType
   :members:

.. autoenum:: py_openocd_client.WpType
   :members: