class UART – duplex serial communication bus¶
UART implements the standard UART/USART duplex serial communications protocol. At the physical level it consists of 2 lines: RX and TX. The unit of communication is a character (not to be confused with a string character) which can be 8 or 9 bits wide.
UART objects can be created and initialised using:
from pyb import UART uart = UART(1, 9600) # init with given baudrate uart.init(9600, bits=8, parity=None, stop=1) # init with given parameters
Bits can be 5, 6, 7, 8. Parity can be
UART.ODD. Stop can be 1 or 2.
A UART object acts like a stream object and reading and writing is done using the standard stream methods:
uart.read(10) # read 10 characters, returns a bytes object uart.readall() # read all available characters uart.readline() # read a line uart.readinto(buf) # read and store into the given buffer uart.write('abc') # write the 3 characters
To check if there is anything to be read, use:
uart.any() # returns the number of characters available for reading
Construct a UART object on the given bus.
buscan be 0 or 1. If the bus is not given, the default one will be selected (0) or the selection will be made based on the given pins.
init(baudrate=9600, bits=8, parity=None, stop=1, *, pins=(TX, RX, RTS, CTS))
Initialise the UART bus with the given parameters:
baudrateis the clock rate.
bitsis the number of bits per character, 7, 8 or 9.
parityis the parity,
stopis the number of stop bits, 1 or 2.
pinsis 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.
Turn off the UART bus.
Return the number of characters available for reading.
Read characters. If
nbytesis specified then read at most that many bytes.
Return value: a bytes object containing the bytes read in. Returns
Read as much data as possible.
Return value: a bytes object.
Receive a single character on the bus.
Return value: The character read, as an integer. Returns -1 on timeout.
Read bytes into the
nbytesis specified then read at most that many bytes. Otherwise, read at most
Return value: number of bytes read and stored into
Read a line, ending in a newline character.
Return value: the line read.
Write the buffer of bytes to the bus.
Return value: number of bytes written.
Send a break condition on the bus. This drives the bus low for a duration of 13 bits. Return value:
callback(value, priority=1, handler=None)¶
Create a callback to be triggered when data is received on the UART.
valuesets the size in bytes of the Rx buffer. Every character received is put into this buffer as long as there’s space free.
prioritylevel of the interrupt. Can take values in the range 1-7. Higher values represent higher priorities.
handleran optional function to be called when new characters arrive.
The handler will be called whenever any of the following two conditions are met:
- 4 new characters have been received.
- At least 1 new character is waiting in the Rx buffer and the Rx line has been silent for the duration of 1 complete frame.
This means that when the handler function is called there might be 1, 2, 3 or 4 characters waiting.
Return a callback object.