/**************************************************************************** ** ** Copyright (C) 2012 Denis Shienkov ** Copyright (C) 2013 Laszlo Papp ** Contact: http://www.qt.io/licensing/ ** ** This file is part of the QtSerialPort module of the Qt Toolkit. ** ** $QT_BEGIN_LICENSE:LGPL21$ ** 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 The Qt Company. For licensing terms ** and conditions see http://www.qt.io/terms-conditions. For further ** information use the contact form at http://www.qt.io/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 or version 3 as published by the Free ** Software Foundation and appearing in the file LICENSE.LGPLv21 and ** LICENSE.LGPLv3 included in the packaging of this file. Please review the ** following information to ensure the GNU Lesser General Public License ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. ** ** As a special exception, The Qt Company gives you certain additional ** rights. These rights are described in The Qt Company LGPL Exception ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. ** ** $QT_END_LICENSE$ ** ****************************************************************************/ #ifndef QSERIALPORT_H #define QSERIALPORT_H #include QT_BEGIN_NAMESPACE class QSerialPortInfo; class QSerialPortPrivate; class QSerialPort : public QIODevice { Q_OBJECT Q_DECLARE_PRIVATE(QSerialPort) Q_PROPERTY(qint32 baudRate READ baudRate WRITE setBaudRate NOTIFY baudRateChanged) Q_PROPERTY(DataBits dataBits READ dataBits WRITE setDataBits NOTIFY dataBitsChanged) Q_PROPERTY(Parity parity READ parity WRITE setParity NOTIFY parityChanged) Q_PROPERTY(StopBits stopBits READ stopBits WRITE setStopBits NOTIFY stopBitsChanged) Q_PROPERTY(FlowControl flowControl READ flowControl WRITE setFlowControl NOTIFY flowControlChanged) #if QT_DEPRECATED_SINCE(5, 2) Q_PROPERTY(DataErrorPolicy dataErrorPolicy READ dataErrorPolicy WRITE setDataErrorPolicy NOTIFY dataErrorPolicyChanged) #endif Q_PROPERTY(bool dataTerminalReady READ isDataTerminalReady WRITE setDataTerminalReady NOTIFY dataTerminalReadyChanged) Q_PROPERTY(bool requestToSend READ isRequestToSend WRITE setRequestToSend NOTIFY requestToSendChanged) Q_PROPERTY(SerialPortError error READ error RESET clearError NOTIFY error) #if QT_DEPRECATED_SINCE(5, 3) Q_PROPERTY(bool settingsRestoredOnClose READ settingsRestoredOnClose WRITE setSettingsRestoredOnClose NOTIFY settingsRestoredOnCloseChanged) #endif Q_ENUMS(BaudRate DataBits Parity StopBits FlowControl DataErrorPolicy SerialPortError) Q_FLAGS(Directions PinoutSignals) #if defined(Q_OS_WIN32) || defined(Q_OS_WINCE) typedef void* Handle; #else typedef int Handle; #endif public: enum Direction { Input = 1, Output = 2, AllDirections = Input | Output }; Q_DECLARE_FLAGS(Directions, Direction) enum BaudRate { Baud1200 = 1200, Baud2400 = 2400, Baud4800 = 4800, Baud9600 = 9600, Baud19200 = 19200, Baud38400 = 38400, Baud57600 = 57600, Baud115200 = 115200, UnknownBaud = -1 }; enum DataBits { Data5 = 5, Data6 = 6, Data7 = 7, Data8 = 8, UnknownDataBits = -1 }; enum Parity { NoParity = 0, EvenParity = 2, OddParity = 3, SpaceParity = 4, MarkParity = 5, UnknownParity = -1 }; enum StopBits { OneStop = 1, OneAndHalfStop = 3, TwoStop = 2, UnknownStopBits = -1 }; enum FlowControl { NoFlowControl, HardwareControl, SoftwareControl, UnknownFlowControl = -1 }; enum PinoutSignal { NoSignal = 0x00, TransmittedDataSignal = 0x01, ReceivedDataSignal = 0x02, DataTerminalReadySignal = 0x04, DataCarrierDetectSignal = 0x08, DataSetReadySignal = 0x10, RingIndicatorSignal = 0x20, RequestToSendSignal = 0x40, ClearToSendSignal = 0x80, SecondaryTransmittedDataSignal = 0x100, SecondaryReceivedDataSignal = 0x200 }; Q_DECLARE_FLAGS(PinoutSignals, PinoutSignal) #if QT_DEPRECATED_SINCE(5, 2) #if defined _MSC_VER #pragma deprecated(UnknownBaud) #pragma deprecated(UnknownDataBits) #pragma deprecated(UnknownParity) #pragma deprecated(UnknownStopBits) #pragma deprecated(UnknownFlowControl) #pragma deprecated(TransmittedDataSignal) #pragma deprecated(ReceivedDataSignal) #endif #endif #if QT_DEPRECATED_SINCE(5, 2) enum DataErrorPolicy { SkipPolicy, PassZeroPolicy, IgnorePolicy, StopReceivingPolicy, UnknownPolicy = -1 }; #endif enum SerialPortError { NoError, DeviceNotFoundError, PermissionError, OpenError, ParityError, FramingError, BreakConditionError, WriteError, ReadError, ResourceError, UnsupportedOperationError, UnknownError, TimeoutError, NotOpenError }; explicit QSerialPort(QObject *parent = Q_NULLPTR); explicit QSerialPort(const QString &name, QObject *parent = Q_NULLPTR); explicit QSerialPort(const QSerialPortInfo &info, QObject *parent = Q_NULLPTR); virtual ~QSerialPort(); void setPortName(const QString &name); QString portName() const; void setPort(const QSerialPortInfo &info); bool open(OpenMode mode) Q_DECL_OVERRIDE; void close() Q_DECL_OVERRIDE; #if QT_DEPRECATED_SINCE(5, 3) QT_DEPRECATED void setSettingsRestoredOnClose(bool restore); QT_DEPRECATED bool settingsRestoredOnClose() const; #endif bool setBaudRate(qint32 baudRate, Directions directions = AllDirections); qint32 baudRate(Directions directions = AllDirections) const; bool setDataBits(DataBits dataBits); DataBits dataBits() const; bool setParity(Parity parity); Parity parity() const; bool setStopBits(StopBits stopBits); StopBits stopBits() const; bool setFlowControl(FlowControl flowControl); FlowControl flowControl() const; bool setDataTerminalReady(bool set); bool isDataTerminalReady(); bool setRequestToSend(bool set); bool isRequestToSend(); PinoutSignals pinoutSignals(); bool flush(); bool clear(Directions directions = AllDirections); bool atEnd() const Q_DECL_OVERRIDE; #if QT_DEPRECATED_SINCE(5, 2) QT_DEPRECATED bool setDataErrorPolicy(DataErrorPolicy policy = IgnorePolicy); QT_DEPRECATED DataErrorPolicy dataErrorPolicy() const; #endif SerialPortError error() const; void clearError(); qint64 readBufferSize() const; void setReadBufferSize(qint64 size); bool isSequential() const Q_DECL_OVERRIDE; qint64 bytesAvailable() const Q_DECL_OVERRIDE; qint64 bytesToWrite() const Q_DECL_OVERRIDE; bool canReadLine() const Q_DECL_OVERRIDE; bool waitForReadyRead(int msecs) Q_DECL_OVERRIDE; bool waitForBytesWritten(int msecs) Q_DECL_OVERRIDE; bool sendBreak(int duration = 0); bool setBreakEnabled(bool set = true); Handle handle() const; Q_SIGNALS: void baudRateChanged(qint32 baudRate, QSerialPort::Directions directions); void dataBitsChanged(QSerialPort::DataBits dataBits); void parityChanged(QSerialPort::Parity parity); void stopBitsChanged(QSerialPort::StopBits stopBits); void flowControlChanged(QSerialPort::FlowControl flowControl); void dataErrorPolicyChanged(QSerialPort::DataErrorPolicy policy); void dataTerminalReadyChanged(bool set); void requestToSendChanged(bool set); void error(QSerialPort::SerialPortError serialPortError); void settingsRestoredOnCloseChanged(bool restore); protected: qint64 readData(char *data, qint64 maxSize) Q_DECL_OVERRIDE; qint64 readLineData(char *data, qint64 maxSize) Q_DECL_OVERRIDE; qint64 writeData(const char *data, qint64 maxSize) Q_DECL_OVERRIDE; private: void setError(QSerialPort::SerialPortError error, const QString &errorString = QString()); QSerialPortPrivate * const d_ptr; Q_DISABLE_COPY(QSerialPort) #if defined (Q_OS_WIN32) Q_PRIVATE_SLOT(d_func(), bool _q_completeAsyncCommunication()) Q_PRIVATE_SLOT(d_func(), bool _q_completeAsyncRead()) Q_PRIVATE_SLOT(d_func(), bool _q_completeAsyncWrite()) Q_PRIVATE_SLOT(d_func(), bool _q_startAsyncWrite()) #endif }; Q_DECLARE_OPERATORS_FOR_FLAGS(QSerialPort::Directions) Q_DECLARE_OPERATORS_FOR_FLAGS(QSerialPort::PinoutSignals) QT_END_NAMESPACE #endif // QSERIALPORT_H