Skip to content

Latest commit

 

History

History
43 lines (33 loc) · 998 Bytes

api.rst

File metadata and controls

43 lines (33 loc) · 998 Bytes

API for can4python

This page shows the public part of the API. For a more detailed documentation on all objects, see the can4python sub page: :class:`.CanBus`

If you are using KCD file based configuration, you should really only need to interact with the :class:`.CanBus` object.

.. autoclass:: can4python.CanBus
   :members:
   :no-private-members:
   :noindex:


.. autoclass:: can4python.Configuration
   :members:
   :no-private-members:
   :noindex:


.. autoclass:: can4python.FilehandlerKcd
   :members:
   :no-private-members:
   :noindex:


.. autoclass:: can4python.CanFrameDefinition
    :members:
    :no-private-members:
    :noindex:


.. autoclass:: can4python.CanSignalDefinition
    :members:
    :no-private-members:
    :noindex:


.. autoexception:: can4python.CanException
    :members:
    :no-private-members:
    :noindex:


.. autoexception:: can4python.CanTimeoutException
    :members:
    :no-private-members:
    :noindex: