Controller Area Network interface module for Python
Project description
The Controller Area Network 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 CPython as well as PyPy and runs on Mac, Linux and Windows.
Library Version |
Python |
2.x |
2.6+, 3.4+ |
3.x |
2.7+, 3.5+ |
4.0+ |
3.7+ |
4.3+ |
3.8+ |
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
CAN FD support
many different loggers and readers supporting playback: ASC (CANalyzer format), BLF (Binary Logging Format by Vector), MF4 (Measurement Data Format v4 by ASAM), TRC, CSV, SQLite, and Canutils log
efficient in-kernel or in-hardware filtering of messages on supported interfaces
bus configuration reading from a file or from environment variables
command line tools for working with CAN buses (see the docs)
more
Example usage
pip install python-can
# import the library
import can
# create a bus instance using 'with' statement,
# this will cause bus.shutdown() to be called on the block exit;
# many other interfaces are supported as well (see documentation)
with can.Bus(interface='socketcan',
channel='vcan0',
receive_own_messages=True) as bus:
# 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(f"{msg.arbitration_id:X}: {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.
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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for python_can-4.3.1-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | eebb68db388b8c997fc7c92dce311656946c968ff407706f5b5f9cc671879479 |
|
| MD5 | 44a7907d51a037ebba621dd891549005 |
|
| BLAKE2b-256 | 15e8dfc2ada455befa17c39ae5e8412d772e205a3256ba808151b2481687e81a |
