File: interfaces.rst

package info (click to toggle)
python-can 3.3.2.final~github-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 2,172 kB
  • sloc: python: 10,208; makefile: 30; sh: 12
file content (45 lines) | stat: -rw-r--r-- 1,114 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
CAN Interface Modules
---------------------

**python-can** hides the low-level, device-specific interfaces to controller
area network adapters in interface dependant modules. However as each hardware
device is different, you should carefully go through your interface's
documentation.

The available interfaces are:

.. toctree::
   :maxdepth: 1

   interfaces/socketcan
   interfaces/kvaser
   interfaces/serial
   interfaces/slcan
   interfaces/ixxat
   interfaces/pcan
   interfaces/usb2can
   interfaces/nican
   interfaces/iscan
   interfaces/neovi
   interfaces/vector
   interfaces/virtual
   interfaces/canalystii
   interfaces/systec

Additional interfaces can be added via a plugin interface. An external package
can register a new interface by using the ``can.interface`` entry point in its setup.py.

The format of the entry point is ``interface_name=module:classname`` where
``classname`` is a concrete :class:`can.BusABC` implementation.

::

 entry_points={
     'can.interface': [
         "interface_name=module:classname",
     ]
 },


The *Interface Names* are listed in :doc:`configuration`.