docs: added UART examples into Python docs.
authorAlex Tereschenko <alext.mkrs@gmail.com>
Sun, 13 Dec 2015 14:57:27 +0000 (15:57 +0100)
committerBrendan Le Foll <brendan.le.foll@intel.com>
Mon, 14 Dec 2015 15:34:16 +0000 (15:34 +0000)
Signed-off-by: Alex Tereschenko <alext.mkrs@gmail.com>
Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>
src/python/docs/example.rst

index b974a28..4daf98c 100644 (file)
@@ -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