From 1947426bafce7f2cb894c1bc608c734c3df629f9 Mon Sep 17 00:00:00 2001 From: Alex Tereschenko Date: Sun, 13 Dec 2015 15:57:27 +0100 Subject: [PATCH] docs: added UART examples into Python docs. Signed-off-by: Alex Tereschenko Signed-off-by: Brendan Le Foll --- src/python/docs/example.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/src/python/docs/example.rst b/src/python/docs/example.rst index b974a28..4daf98c 100644 --- a/src/python/docs/example.rst +++ b/src/python/docs/example.rst @@ -71,3 +71,23 @@ fairly simple in use. :prepend: import mraa :start-after: import mraa +Uart +==== + +Uart is the Universal asynchronous receiver/transmitter interface in mraa. +It allows the exposure of UART pins on supported boards, with basic +configuration operations supported. + +Here's a simple pair of programs comprising a sender and receiver pair. + +Sender: + +.. literalinclude:: ../../../examples/python/uart_sender.py + :prepend: import mraa + :start-after: import mraa + +Receiver: + +.. literalinclude:: ../../../examples/python/uart_receiver.py + :prepend: import mraa + :start-after: import mraa -- 2.7.4