Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-mcp2515/badge/?version=latest
:target: https://docs.circuitpython.org/projects/mcp2515/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_MCP2515/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_MCP2515/actions
:alt: Build Status
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
A CircuitPython library for working with the MCP2515 CAN bus controller
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_.
Installing from PyPI
=====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-mcp2515/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-mcp2515
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-mcp2515
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-mcp2515
Usage Example
=============
.. code-block:: python3
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 <https://docs.circuitpython.org/projects/mcp2515/en/latest/>`_.
For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_MCP2515/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": "",
"name": "adafruit-circuitpython-mcp2515",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "adafruit,blinka,circuitpython,micropython,mcp2515,CAN,CANBUS,OBD",
"author": "",
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/d8/da/bf9f4562a7b0a2fe5040608ee409fafc0574be78f0fd8ce703cde6809354/adafruit-circuitpython-mcp2515-1.1.2.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-mcp2515/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/mcp2515/en/latest/\n :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_MCP2515/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_MCP2515/actions\n :alt: Build Status\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\nA CircuitPython library for working with the MCP2515 CAN bus controller\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_.\n\nInstalling from PyPI\n=====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-mcp2515/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-mcp2515\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-mcp2515\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .venv/bin/activate\n pip3 install adafruit-circuitpython-mcp2515\n\nUsage Example\n=============\n\n.. code-block:: python3\n\n import board\n import busio\n import digitalio\n import adafruit_mcp2515\n\n CS_PIN = 5\n cs = digitalio.DigitalInOut(board.D5)\n cs.direction = digitalio.Direction.OUTPUT\n spi = busio.SPI(board.SCK, board.MOSI, board.MISO)\n mcp = adafruit_mcp2515.MCP2515(spi, cs)\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/mcp2515/en/latest/>`_.\n\nFor information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_MCP2515/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A CircuitPython library for working with the MCP2515 CAN bus controller",
"version": "1.1.2",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_MCP2515"
},
"split_keywords": [
"adafruit",
"blinka",
"circuitpython",
"micropython",
"mcp2515",
"can",
"canbus",
"obd"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "418d084cf4d4de74e985cd609f5c9dd1e6870cf8e5034bb569d13173475f0dd1",
"md5": "6ebcd3c25f0f71ed1e31b02bbdbc1f11",
"sha256": "013f54db317e66808641c076a28ad264553fc0a7b2d480074a5c5b056419e8eb"
},
"downloads": -1,
"filename": "adafruit_circuitpython_mcp2515-1.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6ebcd3c25f0f71ed1e31b02bbdbc1f11",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 15363,
"upload_time": "2023-05-26T16:06:39",
"upload_time_iso_8601": "2023-05-26T16:06:39.324155Z",
"url": "https://files.pythonhosted.org/packages/41/8d/084cf4d4de74e985cd609f5c9dd1e6870cf8e5034bb569d13173475f0dd1/adafruit_circuitpython_mcp2515-1.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d8dabf9f4562a7b0a2fe5040608ee409fafc0574be78f0fd8ce703cde6809354",
"md5": "bddcdccab6829538393cd0c75f67137c",
"sha256": "ee5865286cb0caa57650f1afc49aa80b3ccd82e54c42ab953142ceddfe9d72da"
},
"downloads": -1,
"filename": "adafruit-circuitpython-mcp2515-1.1.2.tar.gz",
"has_sig": false,
"md5_digest": "bddcdccab6829538393cd0c75f67137c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 38945,
"upload_time": "2023-05-26T16:06:41",
"upload_time_iso_8601": "2023-05-26T16:06:41.554173Z",
"url": "https://files.pythonhosted.org/packages/d8/da/bf9f4562a7b0a2fe5040608ee409fafc0574be78f0fd8ce703cde6809354/adafruit-circuitpython-mcp2515-1.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-26 16:06:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_MCP2515",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-mcp2515"
}
JSON
