Introduction¶
A CircuitPython library for working with the MCP2515 CAN bus controller
Dependencies¶
This driver depends on:
Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.
Installing from PyPI¶
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:
pip3 install adafruit-circuitpython-mcp2515
To install system-wide (this may be required in some cases):
sudo pip3 install adafruit-circuitpython-mcp2515
To install in a virtual environment in your current project:
mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-mcp2515
Usage Example¶
import board
import busio
import digitalio
import adafruit_mcp2515
CS_PIN = 5
cs = digitalio.DigitalInOut(board.D5)
cs.direction = digitalio.Direction.OUTPUT
spi = busio.SPI(board.SCK, board.MOSI, board.MISO)
mcp = adafruit_mcp2515.MCP2515(spi, cs)
Documentation¶
API documentation for this library can be found on Read the Docs.
For information on building library documentation, please check out this guide.
Contributing¶
Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.
Table of Contents¶
Examples
API Reference
adafruit_mcp2515
MCP2515
MCP2515.baudrate
MCP2515.bus_off_state_count
MCP2515.deinit()
MCP2515.deinit_filtering_registers()
MCP2515.error_passive_state_count
MCP2515.error_warning_state_count
MCP2515.initialize()
MCP2515.listen()
MCP2515.loopback
MCP2515.read_message()
MCP2515.receive_error_count
MCP2515.restart()
MCP2515.send()
MCP2515.silent
MCP2515.state
MCP2515.transmit_error_count
MCP2515.unread_message_count
BusState
Listener
Match
Message
RemoteTransmissionRequest