uart_setup: add example on current uart use.

Signed-off-by: Thomas Ingleby <thomas.c.ingleby@intel.com>

diff --git a/api/mraa/uart.h b/api/mraa/uart.h
index d2c6832..efb5e04 100644 (file)
--- a/api/mraa/uart.h
+++ b/api/mraa/uart.h
@@ -31,6 +31,8 @@
  * UART is the Universal asynchronous receiver/transmitter interface to
  * libmraa. It allows the exposure of UART pins on supported boards.
  * With functionality to expand at a later date.
+ *
+ * @snippet uart_setup.c Interesting
  */
 
 #ifdef __cplusplus

diff --git a/examples/CMakeLists.txt b/examples/CMakeLists.txt
index ee914a2..04d465c 100644 (file)
--- a/examples/CMakeLists.txt
+++ b/examples/CMakeLists.txt
@@ -8,6 +8,7 @@ add_executable (gpio_read6 gpio_read6.c)
 add_executable (spi_mcp4261 spi_mcp4261.c)
 add_executable (mmap-io2 mmap-io2.c)
 add_executable (blink_onboard blink_onboard.c)
+add_executable (uart_setup uart_setup.c)
 
 include_directories(${PROJECT_SOURCE_DIR}/api)
 
@@ -21,6 +22,7 @@ target_link_libraries (gpio_read6 mraa)
 target_link_libraries (spi_mcp4261 mraa)
 target_link_libraries (mmap-io2 mraa)
 target_link_libraries (blink_onboard mraa)
+target_link_libraries (uart_setup mraa)
 
 add_subdirectory (c++)
 

diff --git a/examples/uart_setup.c b/examples/uart_setup.c
new file mode 100644 (file)
index 0000000..a5409e7
--- /dev/null
+++ b/examples/uart_setup.c
@@ -0,0 +1,42 @@
+/*
+ * Author: Thomas Ingleby <thomas.c.ingleby@intel.com>
+ * Copyright (c) 2014 Intel Corporation.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+ * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+ * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+ * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+#include "stdio.h"
+//! [Interesting]
+#include "mraa.h"
+
+int
+main(int argc, char **argv)
+{
+    mraa_uart_context uart;
+    uart = mraa_uart_init(0);
+
+    if (uart == NULL) {
+        fprintf(stdout, "UART failed to setup\n");
+    }
+
+    mraa_deinit();
+    return 0;
+}
+//! [Interesting]