uart: Add c++ uart example

Signed-off-by: Brendan Le Foll <brendan.le.foll@intel.com>

diff --git a/api/mraa/uart.hpp b/api/mraa/uart.hpp
index f986335..ba6e8cb 100644 (file)
--- a/api/mraa/uart.hpp
+++ b/api/mraa/uart.hpp
@@ -37,6 +37,8 @@ namespace mraa
  * @brief API to UART (enabling only)
  *
  * This file defines the UART interface for libmraa
+ *
+ * @snippet Uart-example.cpp Interesting
  */
 class Uart
 {

diff --git a/examples/c++/CMakeLists.txt b/examples/c++/CMakeLists.txt
index 75fce2c..109663e 100644 (file)
--- a/examples/c++/CMakeLists.txt
+++ b/examples/c++/CMakeLists.txt
@@ -3,6 +3,7 @@ add_executable (blink-io-cpp Blink-IO.cpp)
 add_executable (Pwm3-cycle Pwm3-cycle.cpp)
 add_executable (I2c-compass I2c-compass.cpp)
 add_executable (Spi-pot Spi-pot.cpp)
+add_executable (Uart Uart-example.cpp)
 
 include_directories(${PROJECT_SOURCE_DIR}/api)
 
@@ -11,3 +12,4 @@ target_link_libraries (blink-io-cpp mraa stdc++)
 target_link_libraries (Pwm3-cycle mraa stdc++)
 target_link_libraries (I2c-compass mraa stdc++ m)
 target_link_libraries (Spi-pot mraa stdc++)
+target_link_libraries (Uart mraa stdc++)

diff --git a/examples/c++/Uart-example.cpp b/examples/c++/Uart-example.cpp
new file mode 100644 (file)
index 0000000..240417a
--- /dev/null
+++ b/examples/c++/Uart-example.cpp
@@ -0,0 +1,70 @@
+/*
+ * Author: Brendan Le Foll <brendan.le.foll@intel.com>
+ * Copyright (c) 2015 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 <unistd.h>
+#include <iostream>
+#include <exception>
+
+#include "mraa.hpp"
+
+int
+main()
+{
+    //! [Interesting]
+    // If you have a valid platform configuration use numbers to represent uart
+    // device. If not use raw mode where std::string is taken as a constructor
+    // parameter
+    mraa::Uart* dev;
+    try {
+        dev = new mraa::Uart(0);
+    } catch (std::exception& e) {
+        std::cout << e.what() << ", likely invalid platform config" << std::endl;
+    }
+
+    try {
+        dev = new mraa::Uart("/dev/ttyACM0");
+    } catch (std::exception& e) {
+        std::cout << "Error while setting up raw UART, do you have a uart?" << std::endl;
+        std::terminate();
+    }
+
+    if (dev->setBaudRate(115200) != MRAA_SUCCESS) {
+        std::cout << "Error setting parity on UART" << std::endl;
+    }
+
+    if (dev->setMode(8, MRAA_UART_PARITY_NONE, 1) != MRAA_SUCCESS) {
+        std::cout << "Error setting parity on UART" << std::endl;
+    }
+
+    if (dev->setFlowcontrol(false, false) != MRAA_SUCCESS) {
+        std::cout << "Error setting flow control UART" << std::endl;
+    }
+
+    dev->writeStr("Hello monkeys");
+    //! [Interesting]
+
+    delete dev;
+
+    return MRAA_SUCCESS;
+}