b1229efbd1
all: Fix spelling mistakes based on codespell check.
...
Signed-off-by: Damien George <damien@micropython.org>
2023-04-27 18:03:06 +10:00
c1ae7d7534
docs/library/pyb.CAN: Update the recv example to take a 5-tuple.
...
A supplement to commit 5cdf964571
2022-11-15 22:50:17 +11:00
9175482f29
docs/library: Remove unnecessary "pyb." prefix on class names.
...
Otherwise these classes are refered to with a double prefix, like
pyb.pyb.ADC.
Signed-off-by: Damien George <damien@micropython.org>
2022-06-21 14:33:23 +10:00
5cdf964571
docs/library/pyb.CAN: Update CAN docs to match revised API.
2022-04-02 22:46:07 +11:00
47b778332a
all: Replace busses with buses.
...
"buses" is the widely accepted plural form of "bus".
2021-05-20 23:22:03 +10:00
20f8ce1982
stm32/pyb_can: Add ability to calculate CAN bit timing from baudrate.
...
Calculate the bit timing from baudrate if provided, allowing sample point
override. This makes it a lot easier to make CAN work between different
MCUs with different clocks, prescalers etc.
Tested on F4, F7 and H7 Y/V variants.
2020-12-17 23:01:15 +11:00
e76c7466b6
docs: Change `\*` to `*` in argument lists.
...
Latest versions of Sphinx (at least 3.1.0) do not need the `*` escaped and
will render the `\` in the output if it is there, so remove it.
Fixes issue #6209 .
2020-08-21 12:24:13 +10:00
90c524c114
docs: Remove spaces on lines that are empty.
2019-12-04 15:02:54 +11:00
0abbafd424
stm32/can: Add "list" param to CAN.recv() to receive data inplace.
...
This API matches (as close as possible) how other pyb classes allow inplace
operations, such as pyb.SPI.recv(buf).
2018-03-19 15:12:24 +11:00
b7d576d69a
docs/library/pyb.CAN: Clean up documentation of data constants.
2018-03-16 18:29:43 +11:00
a25e6c6b65
stm32/can: Add CAN.info() method to retrieve error and tx/rx buf info.
2018-03-16 18:28:35 +11:00
d7e67fb1b4
stm32/can: Add CAN.state() method to get the state of the controller.
...
This is useful for monitoring errors on the bus and knowing when a restart
is needed.
2018-03-16 17:10:41 +11:00
1272c3c65d
stm32/can: Add CAN.restart() method so controller can leave bus-off.
2018-03-15 17:29:30 +11:00
823ca03008
stm32/can: Add "auto_restart" option to constructor and init() method.
2018-03-15 17:17:33 +11:00
d91a1989f5
docs/library/pyb.CAN: Update markup to use latest doc conventions.
2018-03-15 16:30:05 +11:00
b1457db002
docs/library: Add missing cross-ref links for classes in pyb module.
2017-10-11 11:30:16 +11:00
a384a53130
docs/pyb.*: Use proper class case in method headers.
...
Class designator will be used as is in indexes, so must match actual class
name.
2016-06-08 16:21:28 +03:00
8171995ee9
docs/pyb.CAN: Mark CAN.initfilterbanks() as classmethod explicitly.
2016-06-08 15:49:30 +03:00
0a4cc24b2e
docs/pyb.*: Add "currentmodule:: pyb" directive.
...
Makes sure that classes described in these separate files are properly
designated as belonging to "pyb" module in indexes.
2016-06-08 00:57:41 +03:00
e3cd154317
stmhal: Add support for sending and receiving CAN RTR messages.
2015-04-18 14:53:00 +01:00
7d5e34287c
stmhal: Allow sending CAN messages with timeout=0.
...
Thanks to Henrik Sölver for this patch.
2015-04-16 23:52:43 +01:00
f80f1a7077
stmhal: Add support for CAN rx callbacks.
2015-02-15 03:10:53 +00:00
d8c2b2a1c4
Update documentation for the CAN class
2014-11-30 01:04:56 +00:00
d1b42d7b51
stmhal: Improve CAN init so that it can take sjw, bs1, bs2 args.
...
Also update docs to explain how CAN baudrate is determined.
2014-11-15 21:28:14 +00:00
a58713a899
docs: Cleanup and update some docs.
2014-10-31 22:21:37 +00:00
88d3054ac0
docs: Import documentation from source-code inline comments.
...
The inline docs (prefixed with /// in .c files) have been converted to
RST format and put in the docs subdirectory.
2014-10-31 01:37:19 +00:00
Damien George
Sky
iabdalkader
Mike Causer
Zenix27
Damien George
Paul Sokolovsky
Henrik