Skip to content

canio: add a doc note about boards like CAN feather that use mcp2515 #8298

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 22, 2023
Merged

canio: add a doc note about boards like CAN feather that use mcp2515 #8298

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -443,6 +443,7 @@ def autoapi_prepare_jinja_env(jinja_env):
# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {"cpython": ('https://docs.python.org/3/', None),
"register": ('https://circuitpython.readthedocs.io/projects/register/en/latest/', None),
"mcp2515": ('https://circuitpython.readthedocs.io/projects/mcp2515/en/latest/', None),
"typing": ('https://circuitpython.readthedocs.io/projects/adafruit-circuitpython-typing/en/latest/', None)}

# Adapted from sphinxcontrib-redirects
Expand Down
5 changes: 4 additions & 1 deletion shared-bindings/canio/__init__.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,10 @@
//| """CAN bus access
//|
//| The `canio` module contains low level classes to support the CAN bus
//| protocol.
//| protocol on microcontrollers that have built-in CAN peripherals.
//|
//| Boards like the Adafruit RP2040 CAN Bus Feather that use an MCP2515 or
//| compatible chip use the `mcp2515:adafruit_mcp2515` module instead.
//|
//| CAN and Listener classes change hardware state and should be deinitialized when they
//| are no longer needed if the program continues after use. To do so, either
Expand Down