Clarify UART (and generally for all other peripherals) pin assignment policy.

Daniel Campora
2015-09-03 11:53:53 +02:00
parent 9d43a37a77
commit d8fabbeb05

@@ -153,7 +153,7 @@ Do we really need 3 ways to set the value?
`uart = UART(id, baudrate=9600, bits=8, parity=None, stop=1, *, pins, ...)`
- `pins` is a 4 or 2 item list indicating the TX, RX, RTS and CTS pins (in that order). Any of the pins can be `None` if one wants the UART to operate with limited functionality. If the `RTS` pin is given the the `RX` pin must be given as well. The same applies to `CTS`. When no pins are given (or all are `None`), then the default set of `TX` and `RX` pins is taken, and hardware flow control will be disabled.
- `pins` is a 4 or 2 item list indicating the TX, RX, RTS and CTS pins (in that order). Any of the pins can be `None` if one wants the UART to operate with limited functionality. If the `RTS` pin is given the the `RX` pin must be given as well. The same applies to `CTS`. When no pins are given, then the default set of `TX` and `RX` pins is taken, and hardware flow control will be disabled. If `pins=None`, no pin assignment will be made.
Methods: