Need help with python-can?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

hardbyte
592 Stars 321 Forks GNU Lesser General Public License v3.0 2.1K Commits 129 Opened issues

Description

The can package provides controller area network support for Python developers

Services available

!
?

Need anything else?

Contributors list

# 92,506
Android
Kotlin
materia...
can-bus
446 commits
# 134,257
homomor...
can-bus
Postgre...
TeX
303 commits
# 168,854
Shell
can-bus
can
python3
157 commits
# 261,163
Python
can-bus
travis
circlec...
48 commits
# 147,581
HTML
slack
Kotlin
mvi
42 commits
# 352,368
Python
Shell
can-bus
35 commits
# 20,723
C++
Java
wiimote
ps3
29 commits
# 373,275
Python
Shell
can-bus
28 commits
# 84,441
Python
Shell
can-bus
can
27 commits
# 7,527
Python
paypal
stripe
Django
15 commits
# 439,728
Python
Shell
can-bus
14 commits
# 21,042
Python
python3
jupyter
tkinter
13 commits
# 268,766
can-bus
sed
Linux
C++
12 commits
# 194,880
Shell
can-bus
c-plus-...
pyinsta...
8 commits
# 121,909
Shell
can-bus
strateg...
C
8 commits
# 499,321
C
Shell
can-bus
HTML
6 commits
# 485,239
Shell
modbus-...
visa
HTML
6 commits
# 469,970
Python
Shell
can
dbf
5 commits
# 369,631
CSS
GraphQL
webasse...
can-bus
5 commits
# 495,078
Shell
can-bus
C++
C
5 commits

python-can

|release| |downloads| |downloads_monthly| |formatter|

|docs| |buildtravis| |buildappveyor| |coverage|

.. |release| image:: https://img.shields.io/pypi/v/python-can.svg :target: https://pypi.python.org/pypi/python-can/ :alt: Latest Version on PyPi

.. |downloads| image:: https://pepy.tech/badge/python-can :target: https://pepy.tech/project/python-can :alt: Downloads on PePy

.. |downloads_monthly| image:: https://pepy.tech/badge/python-can/month :target: https://pepy.tech/project/python-can/month :alt: Monthly downloads on PePy

.. |formatter| image:: https://img.shields.io/badge/code%20style-black-000000.svg :target: https://github.com/python/black :alt: This project uses the black formatter.

.. |docs| image:: https://readthedocs.org/projects/python-can/badge/?version=stable :target: https://python-can.readthedocs.io/en/stable/ :alt: Documentation

.. |build_travis| image:: https://img.shields.io/travis/hardbyte/python-can/develop.svg?label=Travis%20CI :target: https://travis-ci.org/hardbyte/python-can/branches :alt: Travis CI Server for develop branch

.. |build_appveyor| image:: https://img.shields.io/appveyor/ci/hardbyte/python-can/develop.svg?label=AppVeyor :target: https://ci.appveyor.com/project/hardbyte/python-can/history :alt: AppVeyor CI Server for develop branch

.. |coverage| image:: https://codecov.io/gh/hardbyte/python-can/branch/develop/graph/badge.svg :target: https://codecov.io/gh/hardbyte/python-can/branch/develop :alt: Test coverage reports on Codecov.io

.. image:: https://img.shields.io/endpoint.svg?url=https://gh.mergify.io/badges/hardbyte/python-can&style=flat :target: https://mergify.io :alt: Mergify Status

The C\ ontroller A\ rea N\ etwork is a bus standard designed to allow microcontrollers and devices to communicate with each other. It has priority based bus arbitration and reliable deterministic communication. It is used in cars, trucks, boats, wheelchairs and more.

The

can
package provides controller area network support for Python developers; providing common abstractions to different hardware devices, and a suite of utilities for sending and receiving messages on a can bus.

The library currently supports Python 3.6+ as well as PyPy 3 and runs on Mac, Linux and Windows.

============================== =========== Library Version Python


2.x 2.6+, 3.4+ 3.x 2.7+, 3.5+ 4.x (currently on develop) 3.6+ ============================== ===========

Features

  • common abstractions for CAN communication
  • support for many different backends (see the
    docs 
    __)
  • receiving, sending, and periodically sending messages
  • normal and extended arbitration IDs
  • limited
    CAN FD 
    __ support
  • many different loggers and readers supporting playback: ASC (CANalyzer format), BLF (Binary Logging Format by Vector), CSV, SQLite and Canutils log
  • efficient in-kernel or in-hardware filtering of messages on supported interfaces
  • bus configuration reading from file or environment variables
  • CLI tools for working with CAN buses (see the
    docs 
    __)
  • more

Example usage

.. code:: python

# import the library
import can

create a bus instance

many other interfaces are supported as well (see below)

bus = can.Bus(interface='socketcan', channel='vcan0', receive_own_messages=True)

send a message

message = can.Message(arbitration_id=123, is_extended_id=True, data=[0x11, 0x22, 0x33]) bus.send(message, timeout=0.2)

iterate over received messages

for msg in bus: print("{:X}: {}".format(msg.arbitration_id, msg.data))

or use an asynchronous notifier

notifier = can.Notifier(bus, [can.Logger("recorded.log"), can.Printer()])

You can find more information in the documentation, online at

python-can.readthedocs.org 
__.

Discussion

If you run into bugs, you can file them in our

issue tracker 
__ on GitHub.

There is also a

python-can 
__ mailing list for development discussion.

Stackoverflow 
__ has several questions and answers tagged with
python+can
.

Wherever we interact, we strive to follow the

Python Community Code of Conduct 
__.

Contributing

See

doc/development.rst 
__ for getting started.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.