summaryrefslogtreecommitdiff
path: root/docs/library
diff options
context:
space:
mode:
authorDamien George <damien.p.george@gmail.com>2018-03-15 17:17:33 +1100
committerDamien George <damien.p.george@gmail.com>2018-03-15 17:17:33 +1100
commit823ca03008908d98671393c00b018349d18b46a2 (patch)
treead50600964375dc6efaf5912720feb1be7d530f2 /docs/library
parent1608c4f5bef361894009828f51f0f576cbefd943 (diff)
stm32/can: Add "auto_restart" option to constructor and init() method.
Diffstat (limited to 'docs/library')
-rw-r--r--docs/library/pyb.CAN.rst4
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/library/pyb.CAN.rst b/docs/library/pyb.CAN.rst
index 7a3a5e939..6e5b958cf 100644
--- a/docs/library/pyb.CAN.rst
+++ b/docs/library/pyb.CAN.rst
@@ -49,7 +49,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, auto_restart=False)
Initialise the CAN bus with the given parameters:
@@ -64,6 +64,8 @@ Methods
it can be between 1 and 1024 inclusive
- *bs2* defines the location of the transmit point in units of the time quanta;
it can be between 1 and 16 inclusive
+ - *auto_restart* sets whether the controller will automatically try and restart
+ communications after entering the bus-off state
The time quanta tq is the basic unit of time for the CAN bus. tq is the CAN
prescaler value divided by PCLK1 (the frequency of internal peripheral bus 1);