djsundog
/
circuitpython
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #8298 from jepler/canio-doc-mcp2515 

canio: add a doc note about boards like CAN feather that use mcp2515
This commit is contained in:
Jeff Epler 2023-08-22 09:48:09 -05:00 committed by GitHub
parent c07fff574e 994bd2371f
commit bae7e5292e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
conf.py
View File

@ -443,6 +443,7 @@ texinfo_documents = [
# Example configuration for intersphinx: refer to the Python standard library. # Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {"python": ('https://docs.python.org/3/', None), intersphinx_mapping = {"python": ('https://docs.python.org/3/', None),
"register": ('https://circuitpython.readthedocs.io/projects/register/en/latest/', 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)} "typing": ('https://circuitpython.readthedocs.io/projects/adafruit-circuitpython-typing/en/latest/', None)}
# Adapted from sphinxcontrib-redirects # Adapted from sphinxcontrib-redirects

5
shared-bindings/canio/__init__.c
View File

@ -27,7 +27,10 @@
//| """CAN bus access //| """CAN bus access
//| //|
//| The `canio` module contains low level classes to support the CAN bus //| 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 //| 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 //| are no longer needed if the program continues after use. To do so, either