Add a new simple and command line async reader example

Change-Id: I4142d187c3ad37d1e7f5219df3d50679a9f35a8e
Reviewed-by: Sergey Belyashov <Sergey.Belyashov@gmail.com>
Reviewed-by: Denis Shienkov <denis.shienkov@gmail.com>

7 files changed, 339 insertions, 1 deletions

diff --git a/examples/serialport/creaderasync/creaderasync.pro b/examples/serialport/creaderasync/creaderasync.pro
new file mode 100644
index 0000000..27b17dc
--- /dev/null
+++ b/examples/serialport/creaderasync/creaderasync.pro
@@ -0,0 +1,20 @@
+QT = core
+
+greaterThan(QT_MAJOR_VERSION, 4) {
+    QT       += serialport
+} else {
+    include($$QTSERIALPORT_PROJECT_ROOT/src/serialport/qt4support/serialport.prf)
+}
+
+CONFIG += console
+CONFIG -= app_bundle
+
+TARGET = creaderasync
+TEMPLATE = app
+
+HEADERS += \
+    serialportreader.h
+
+SOURCES += \
+    main.cpp \
+    serialportreader.cpp
diff --git a/examples/serialport/creaderasync/main.cpp b/examples/serialport/creaderasync/main.cpp
new file mode 100644
index 0000000..96fecdd
--- /dev/null
+++ b/examples/serialport/creaderasync/main.cpp
@@ -0,0 +1,104 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Laszlo Papp <lpapp@kde.org>
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the QtSerialPort module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights.  These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3.0 as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU General Public License version 3.0 requirements will be
+** met: http://www.gnu.org/copyleft/gpl.html.
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "serialportreader.h"
+
+#include <QtSerialPort/QSerialPort>
+
+#include <QTextStream>
+#include <QCoreApplication>
+#include <QFile>
+#include <QStringList>
+
+QT_USE_NAMESPACE
+
+int main(int argc, char *argv[])
+{
+    QCoreApplication coreApplication(argc, argv);
+    int argumentCount = QCoreApplication::arguments().size();
+    QStringList argumentList = QCoreApplication::arguments();
+
+    QTextStream standardOutput(stdout);
+
+    if (argumentCount == 1) {
+        standardOutput << QObject::tr("Usage: %1 <serialportname> [baudrate]").arg(argumentList.first()) << endl;
+        return 1;
+    }
+
+    QSerialPort serialPort;
+    QString serialPortName = argumentList.at(1);
+    serialPort.setPortName(serialPortName);
+
+    if (!serialPort.open(QIODevice::ReadOnly)) {
+        standardOutput << QObject::tr("Failed to open port %1, error: %2").arg(serialPortName).arg(serialPort.errorString()) << endl;
+        return 1;
+    }
+
+    int serialPortBaudRate = (argumentCount > 2) ? argumentList.at(2).toInt() : QSerialPort::Baud9600;
+    if (!serialPort.setBaudRate(serialPortBaudRate)) {
+        standardOutput << QObject::tr("Failed to set 9600 baud for port %1, error: %2").arg(serialPortName).arg(serialPort.errorString()) << endl;
+        return 1;
+    }
+
+    if (!serialPort.setDataBits(QSerialPort::Data8)) {
+        standardOutput << QObject::tr("Failed to set 8 data bits for port %1, error: %2").arg(serialPortName).arg(serialPort.errorString()) << endl;
+        return 1;
+    }
+
+    if (!serialPort.setParity(QSerialPort::NoParity)) {
+        standardOutput << QObject::tr("Failed to set no parity for port %1, error: %2").arg(serialPortName).arg(serialPort.errorString()) << endl;
+        return 1;
+    }
+
+    if (!serialPort.setStopBits(QSerialPort::OneStop)) {
+        standardOutput << QObject::tr("Failed to set 1 stop bit for port %1, error: %2").arg(serialPortName).arg(serialPort.errorString()) << endl;
+        return 1;
+    }
+
+    if (!serialPort.setFlowControl(QSerialPort::NoFlowControl)) {
+        standardOutput << QObject::tr("Failed to set no flow control for port %1, error: %2").arg(serialPortName).arg(serialPort.errorString()) << endl;
+        return 1;
+    }
+
+    SerialPortReader serialPortReader(&serialPort);
+
+    return coreApplication.exec();
+}
diff --git a/examples/serialport/creaderasync/serialportreader.cpp b/examples/serialport/creaderasync/serialportreader.cpp
new file mode 100644
index 0000000..310455c
--- /dev/null
+++ b/examples/serialport/creaderasync/serialportreader.cpp
@@ -0,0 +1,90 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Laszlo Papp <lpapp@kde.org>
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the QtSerialPort module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights.  These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3.0 as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU General Public License version 3.0 requirements will be
+** met: http://www.gnu.org/copyleft/gpl.html.
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "serialportreader.h"
+
+#include <QCoreApplication>
+
+QT_USE_NAMESPACE
+
+SerialPortReader::SerialPortReader(QSerialPort *serialPort, QObject *parent)
+    : QObject(parent)
+    , m_serialPort(serialPort)
+    , m_standardOutput(stdout)
+{
+    connect(m_serialPort, SIGNAL(readyRead()), SLOT(handleReadyRead()));
+    connect(m_serialPort, SIGNAL(error(QSerialPort::SerialPortError)), SLOT(handleError(QSerialPort::SerialPortError)));
+    connect(&m_timer, SIGNAL(timeout()), SLOT(handleTimeout()));
+
+    m_timer.start(5000);
+}
+
+SerialPortReader::~SerialPortReader()
+{
+}
+
+void SerialPortReader::handleReadyRead()
+{
+    m_readData = m_serialPort->readAll();
+
+    if (!m_timer.isActive())
+        m_timer.start(5000);
+}
+
+void SerialPortReader::handleTimeout()
+{
+    if (m_readData.isEmpty()) {
+        m_standardOutput << QObject::tr("Either no data was currently available on the standard input for reading, or an error occurred for port %1, error: %2").arg(m_serialPort->portName()).arg(m_serialPort->errorString()) << endl;
+        QCoreApplication::exit(1);
+    } else {
+        m_standardOutput << QObject::tr("Data successfully received from port %1").arg(m_serialPort->portName()) << endl;
+        m_standardOutput << m_readData << endl;
+        QCoreApplication::quit();
+    }
+}
+
+void SerialPortReader::handleError(QSerialPort::SerialPortError serialPortError)
+{
+    if (serialPortError == QSerialPort::ReadError) {
+        m_standardOutput << QObject::tr("An I/O error occurred while reading the data from port %1, error: %2").arg(m_serialPort->portName()).arg(m_serialPort->errorString()) << endl;
+        QCoreApplication::exit(1);
+    }
+}
diff --git a/examples/serialport/creaderasync/serialportreader.h b/examples/serialport/creaderasync/serialportreader.h
new file mode 100644
index 0000000..187c486
--- /dev/null
+++ b/examples/serialport/creaderasync/serialportreader.h
@@ -0,0 +1,78 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Laszlo Papp <lpapp@kde.org>
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the QtSerialPort module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 2.1 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU Lesser General Public License version 2.1 requirements
+** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Digia gives you certain additional
+** rights.  These rights are described in the Digia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 3.0 as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL included in the
+** packaging of this file.  Please review the following information to
+** ensure the GNU General Public License version 3.0 requirements will be
+** met: http://www.gnu.org/copyleft/gpl.html.
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef SERIALPORTREADER_H
+#define SERIALPORTREADER_H
+
+#include <QtSerialPort/QSerialPort>
+
+#include <QTextStream>
+#include <QTimer>
+#include <QByteArray>
+#include <QObject>
+
+QT_USE_NAMESPACE
+
+QT_BEGIN_NAMESPACE
+
+QT_END_NAMESPACE
+
+class SerialPortReader : public QObject
+{
+    Q_OBJECT
+
+public:
+    SerialPortReader(QSerialPort *serialPort, QObject *parent = 0);
+    ~SerialPortReader();
+
+private slots:
+    void handleReadyRead();
+    void handleTimeout();
+    void handleError(QSerialPort::SerialPortError error);
+
+private:
+    QSerialPort *m_serialPort;
+    QByteArray  m_readData;
+    QTextStream m_standardOutput;
+    QTimer      m_timer;
+};
+
+#endif
diff --git a/examples/serialport/doc/creaderasync.qdoc b/examples/serialport/doc/creaderasync.qdoc
new file mode 100644
index 0000000..2349856
--- /dev/null
+++ b/examples/serialport/doc/creaderasync.qdoc
@@ -0,0 +1,45 @@
+/****************************************************************************
+**
+** Copyright (C) 2013 Laszlo Papp <lpapp@kde.org>
+** Contact: http://www.qt-project.org/legal
+**
+** This file is part of the documentation of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:FDL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and Digia.  For licensing terms and
+** conditions see http://qt.digia.com/licensing.  For further information
+** use the contact form at http://qt.digia.com/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file.  Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: http://www.gnu.org/copyleft/fdl.html.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+/*!
+    \example creader
+    \title Command Line Reader Async Example
+    \ingroup qtserialport-examples
+
+    The Command Line Reader Async example shows how to use the QSerialPort class for
+    receiving data asynchronously over the selected serial port with the desired
+    settings.
+
+    \image creaderasync-example.png Screenshot of the Command Line Reader Async example
+
+    This command line reader async example receives data asynchronously over the
+    selected serial port in a console, provided by the QSerialPort class.
+
+    For receiving data synchronously over the selected serial port, use the
+    \l{QSerialPort::read()}{read()} or \l{QSerialPort::readAll()}{readAll()}
+    methods, and \l{QIODevice::readyRead()}{readyRead()} signal.
+*/
diff --git a/examples/serialport/examples.qdoc b/examples/serialport/examples.qdoc
index af73fc6..6e5f3c4 100644
--- a/examples/serialport/examples.qdoc
+++ b/examples/serialport/examples.qdoc
@@ -40,6 +40,7 @@
     \li \l cenumerator
     \li \l cwriterasync
     \li \l cwritersync
+    \li \l creaderasync
     \li \l creadersync
     \li \l enumerator
     \li \l terminal
diff --git a/examples/serialport/serialport.pro b/examples/serialport/serialport.pro
index 57f6ec5..ba8d167 100644
--- a/examples/serialport/serialport.pro
+++ b/examples/serialport/serialport.pro
@@ -1,6 +1,6 @@
 TEMPLATE = subdirs
 CONFIG += ordered
-SUBDIRS = cenumerator creadersync cwriterasync cwritersync
+SUBDIRS = cenumerator creaderasync creadersync cwriterasync cwritersync
 greaterThan(QT_MAJOR_VERSION, 4) {
     !isEmpty(QT.widgets.name):SUBDIRS += enumerator terminal blockingmaster blockingslave
 } else {