Skip to content

Latest commit

 

History

History
44 lines (30 loc) · 1.14 KB

bcm.rst

File metadata and controls

44 lines (30 loc) · 1.14 KB
Raw

Broadcast Manager

.. module:: can.broadcastmanager

The broadcast manager allows the user to setup periodic message jobs. For example sending a particular message at a given period. The broadcast manager supported natively by several interfaces and a software thread based scheduler is used as a fallback.

This example shows the socketcan backend using the broadcast manager:

.. literalinclude:: ../examples/cyclic.py
    :language: python
    :linenos:

Message Sending Tasks

The class based api for the broadcast manager uses a series of mixin classes. All mixins inherit from :class:`~can.broadcastmanager.CyclicSendTaskABC` which inherits from :class:`~can.broadcastmanager.CyclicTask`.

.. autoclass:: can.broadcastmanager.CyclicTask
    :members:


.. autoclass:: can.broadcastmanager.CyclicSendTaskABC
    :members:


.. autoclass:: LimitedDurationCyclicSendTaskABC
    :members:


.. autoclass:: MultiRateCyclicSendTaskABC
    :members:


.. autoclass:: can.ModifiableCyclicTaskABC
    :members:


.. autoclass:: can.RestartableCyclicTaskABC
    :members: