aboutsummaryrefslogtreecommitdiff
path: root/docs/library/pyb.CAN.rst
diff options
context:
space:
mode:
authorPaul Sokolovsky2016-06-08 16:21:28 +0300
committerPaul Sokolovsky2016-06-08 16:21:28 +0300
commita384a5313013d8ffda4db0e509cf798a080b3526 (patch)
treec1b87be77f0a3a68fc5a55880bf9de8af3b90b87 /docs/library/pyb.CAN.rst
parent585aafc27eb7fa8fe660e3eeaa29bf8d7ab99213 (diff)
docs/pyb.*: Use proper class case in method headers.
Class designator will be used as is in indexes, so must match actual class name.
Diffstat (limited to 'docs/library/pyb.CAN.rst')
-rw-r--r--docs/library/pyb.CAN.rst16
1 files changed, 8 insertions, 8 deletions
diff --git a/docs/library/pyb.CAN.rst b/docs/library/pyb.CAN.rst
index 7d7dfabd8..9e71f12b0 100644
--- a/docs/library/pyb.CAN.rst
+++ b/docs/library/pyb.CAN.rst
@@ -48,7 +48,7 @@ Class Methods
Methods
-------
-.. method:: can.init(mode, extframe=False, prescaler=100, \*, sjw=1, bs1=6, bs2=8)
+.. method:: CAN.init(mode, extframe=False, prescaler=100, \*, sjw=1, bs1=6, bs2=8)
Initialise the CAN bus with the given parameters:
@@ -80,11 +80,11 @@ Methods
See page 680 of the STM32F405 datasheet for more details.
-.. method:: can.deinit()
+.. method:: CAN.deinit()
Turn off the CAN bus.
-.. method:: can.setfilter(bank, mode, fifo, params, \*, rtr)
+.. method:: CAN.setfilter(bank, mode, fifo, params, \*, rtr)
Configure a filter bank:
@@ -126,17 +126,17 @@ Methods
|CAN.MASK32 |1 |
+-----------+----------------------+
-.. method:: can.clearfilter(bank)
+.. method:: CAN.clearfilter(bank)
Clear and disables a filter bank:
- ``bank`` is the filter bank that is to be cleared.
-.. method:: can.any(fifo)
+.. method:: CAN.any(fifo)
Return ``True`` if any message waiting on the FIFO, else ``False``.
-.. method:: can.recv(fifo, \*, timeout=5000)
+.. method:: CAN.recv(fifo, \*, timeout=5000)
Receive data on the bus:
@@ -150,7 +150,7 @@ Methods
- The FMI (Filter Match Index) value.
- An array containing the data.
-.. method:: can.send(data, id, \*, timeout=0, rtr=False)
+.. method:: CAN.send(data, id, \*, timeout=0, rtr=False)
Send a message on the bus:
@@ -170,7 +170,7 @@ Methods
Return value: ``None``.
-.. method:: can.rxcallback(fifo, fun)
+.. method:: CAN.rxcallback(fifo, fun)
Register a function to be called when a message is accepted into a empty fifo: