QSerialPort Class

qint64 numReadTotal = 0;
char buffer[50];

for (;;) {
    const qint64 numRead  = serial.read(buffer, 50);

    // Do whatever with the array

    numReadTotal += numRead;
    if (numRead == 0 && !serial.waitForReadyRead())
        break;
}

Documentación de la función miembro

[explicit] QSerialPort::QSerialPort(QObject *parent = nullptr)

Construye un nuevo objeto de puerto serie con la dirección parent.

[explicit] QSerialPort::QSerialPort(const QSerialPortInfo &serialPortInfo, QObject *parent = nullptr)

Construye un nuevo objeto de puerto serie con el parent dado para representar el puerto serie con la clase de ayuda especificada serialPortInfo.

[explicit] QSerialPort::QSerialPort(const QString &name, QObject *parent = nullptr)

Construye un nuevo objeto puerto serie con el parent dado para representar el puerto serie con el name especificado.

El nombre debe tener un formato específico; véase el método setPort().

[virtual noexcept] QSerialPort::~QSerialPort()

Cierra el puerto serie, si es necesario, y luego destruye el objeto.

[signal] void QSerialPort::baudRateChanged(qint32 baudRate, QSerialPort::Directions directions)

Esta señal se emite después de cambiar la velocidad en baudios. La nueva tasa de baudios se pasa como baudRate y las direcciones como directions.

Véase también QSerialPort::baudRate.

[override virtual] qint64 QSerialPort::bytesAvailable() const

Reimplementa: QIODevice::bytesAvailable() const.

Devuelve el número de bytes entrantes que están esperando ser leídos.

Véase también bytesToWrite() y read().

[override virtual] qint64 QSerialPort::bytesToWrite() const

Reimplementa: QIODevice::bytesToWrite() const.

Devuelve el número de bytes que están esperando a ser escritos. Los bytes se escriben cuando el control vuelve al bucle de eventos o cuando se llama a flush().

Véase también bytesAvailable() y flush().

[override virtual] bool QSerialPort::canReadLine() const

Reimplementa: QIODevice::canReadLine() const.

Devuelve true si se puede leer una línea de datos del puerto serie; en caso contrario devuelve false.

Véase también readLine().

bool QSerialPort::clear(QSerialPort::Directions directions = AllDirections)

Descarta todos los caracteres del búfer de salida o de entrada, dependiendo de las direcciones dadas directions. Esto incluye borrar los buffers internos de clase y los buffers UART (driver). También termina las operaciones de lectura o escritura pendientes. Si tiene éxito, devuelve true; en caso contrario devuelve false.

[override virtual] void QSerialPort::close()

Reimplementa: QIODevice::close().

Véase también QIODevice::close().

[signal] void QSerialPort::dataBitsChanged(QSerialPort::DataBits dataBits)

Esta señal se emite después de cambiar los bits de datos de una trama. Los nuevos bits de datos de una trama se pasan como dataBits.

Véase también QSerialPort::dataBits.

[signal] void QSerialPort::dataTerminalReadyChanged(bool set)

Esta señal se emite después de cambiar el estado (alto o bajo) de la señal de línea DTR. El nuevo estado (alto o bajo) de la señal de línea DTR se pasa como set.

Véase también QSerialPort::dataTerminalReady.

[signal] void QSerialPort::errorOccurred(QSerialPort::SerialPortError error)

Esta señal se emite cuando se produce un error en el puerto serie. El error especificado describe el tipo de error que se ha producido.

Véase también QSerialPort::error.

[signal] void QSerialPort::flowControlChanged(QSerialPort::FlowControl flow)

Esta señal se emite después de cambiar el modo de control de flujo. El nuevo modo de control de flujo se pasa como flow.

Véase también QSerialPort::flowControl.

bool QSerialPort::flush()

Esta función escribe tanto como sea posible desde el búfer de escritura interno al puerto serie subyacente sin bloquearse. Si se ha escrito algún dato, esta función devuelve true; en caso contrario devuelve false.

Llame a esta función para enviar los datos almacenados inmediatamente al puerto serie. El número de bytes escritos con éxito depende del sistema operativo. En la mayoría de los casos, esta función no necesita ser llamada, porque la clase QSerialPort comenzará a enviar los datos automáticamente una vez que el control es devuelto al bucle de eventos. En ausencia de un bucle de eventos, llame a waitForBytesWritten() en su lugar.

Véase también write() y waitForBytesWritten().

QSerialPort::Handle QSerialPort::handle() const

Si la plataforma está soportada y el puerto serie está abierto, devuelve el manejador nativo del puerto serie; en caso contrario devuelve -1.

[override virtual] bool QSerialPort::isSequential() const

Reimplementa: QIODevice::isSequential() const.

Devuelve siempre true. El puerto serie es un dispositivo secuencial.

[override virtual] bool QSerialPort::open(QIODeviceBase::OpenMode mode)

Reimplementa: QIODevice::open(QIODeviceBase::OpenMode mode).

Abre el puerto serie utilizando OpenMode mode, y devuelve true si tiene éxito; en caso contrario devuelve false y establece un código de error que puede obtenerse llamando al método error().

Si se abre el puerto, pero falla la configuración de los parámetros de puerto deseados, el método devuelve false y cierra el puerto automáticamente.

Véase también QIODeviceBase::OpenMode y setPort().

[signal] void QSerialPort::parityChanged(QSerialPort::Parity parity)

Esta señal se emite después de cambiar el modo de comprobación de paridad. El nuevo modo de comprobación de paridad se pasa como parity.

Véase también QSerialPort::parity.

QSerialPort::PinoutSignals QSerialPort::pinoutSignals()

Devuelve el estado de las señales de línea en un formato de mapa de bits.

A partir de este resultado, es posible asignar el estado de la señal deseada aplicando una máscara "AND", donde la máscara es el valor de enumeración deseado de QSerialPort::PinoutSignals.

Véase también QSerialPort::dataTerminalReady y QSerialPort::requestToSend.

QString QSerialPort::portName() const

Devuelve el nombre establecido por setPort() o pasado al constructor QSerialPort. Este nombre es corto, es decir, se extrae y convierte a partir de la ubicación del sistema de variables interno del dispositivo. El algoritmo de conversión es específico de cada plataforma:

Véase también setPortName(), setPort() y QSerialPortInfo::portName().

qint64 QSerialPort::readBufferSize() const

Devuelve el tamaño del búfer de lectura interno. Esto limita la cantidad de datos que el cliente puede recibir antes de llamar a los métodos read() o readAll().

Un tamaño de búfer de lectura de 0 (el valor predeterminado) significa que el búfer no tiene límite de tamaño, lo que garantiza que no se pierda ningún dato.

Véase también setReadBufferSize() y read().

[override virtual protected] qint64 QSerialPort::readData(char *data, qint64 maxSize)

Reimplementa: QIODevice::readData(char *data, qint64 maxSize).

[override virtual protected] qint64 QSerialPort::readLineData(char *data, qint64 maxSize)

Reimplementa: QIODevice::readLineData(char *data, qint64 maxSize).

[signal] void QSerialPort::requestToSendChanged(bool set)

Esta señal se emite después de cambiar el estado (alto o bajo) de la señal de línea RTS. El nuevo estado (alto o bajo) de la señal de línea RTS se pasa como set.

Véase también QSerialPort::requestToSend.

void QSerialPort::setPort(const QSerialPortInfo &serialPortInfo)

Establece el puerto almacenado en la instancia de información del puerto serie serialPortInfo.

Véase también portName() y QSerialPortInfo.

void QSerialPort::setPortName(const QString &name)

Establece el name del puerto serie.

El nombre del puerto serie se puede pasar como un nombre corto o como la ubicación larga del sistema si es necesario.

Véase también portName() y QSerialPortInfo.

void QSerialPort::setReadBufferSize(qint64 size)

Establece el tamaño del búfer de lectura interno de QSerialPort en size bytes.

Si el tamaño del búfer está limitado a un cierto tamaño, QSerialPort no almacenará más datos que ese tamaño. El caso especial de un tamaño de búfer de 0 significa que el búfer de lectura es ilimitado y todos los datos entrantes se almacenan en el búfer. Esta es la opción por defecto.

Esta opción es útil si los datos sólo se leen en determinados momentos (por ejemplo, en una aplicación de streaming en tiempo real) o si el puerto serie debe ser protegido contra la recepción de demasiados datos, lo que eventualmente puede causar que la aplicación se quede sin memoria.

Véase también readBufferSize() y read().

[since 6.10] void QSerialPort::setWriteBufferSize(qint64 size)

Establece el tamaño del búfer de escritura interno de QSerialPort en size bytes.

El envío de datos a través del puerto serie es relativamente lento, por lo que en la práctica, cuando se llama a write(), los datos no se envían inmediatamente. Primero se almacenan en un búfer intermedio y después se escriben en trozos.

Por lo tanto, un intento de escribir demasiados datos o escribir datos a una velocidad superior a la que el puerto serie subyacente puede manejar, puede llevar a una situación en la que el buffer interno crezca. Esto puede eventualmente causar que la aplicación se quede sin memoria, especialmente en un dispositivo con pocos recursos de memoria.

Este método permite limitar el buffer interno a un tamaño determinado. Si el siguiente intento de escritura excede la capacidad del buffer, el método write() devolverá la cantidad de bytes que realmente se almacenaron en el buffer. Es responsabilidad del usuario repetir el intento de escritura con el resto de los bytes después de recibir la señal bytesWritten(), o después de que el método waitForBytesWritten() devuelva true.

Pasar 0 a este método significa que el búfer de entrada no está limitado, y todos los datos entrantes se almacenan en el búfer. Este es el valor por defecto.

Esta función se introdujo en Qt 6.10.

Véase también writeBufferSize() y write().

[signal, since 6.9] void QSerialPort::settingsRestoredOnCloseChanged(bool restore)

Esta señal se emite después de cambiar la propiedad settingsRestoredOnClose. El parámetro restore contiene el nuevo valor de la propiedad.

Esta función se introdujo en Qt 6.9.

Véase también QSerialPort::settingsRestoredOnClose.

[signal] void QSerialPort::stopBitsChanged(QSerialPort::StopBits stopBits)

Esta señal se emite después de cambiar el número de bits de parada de una trama. El nuevo número de bits de parada en una trama se pasa como stopBits.

Véase también QSerialPort::stopBits.

[override virtual] bool QSerialPort::waitForBytesWritten(int msecs = 30000)

Reimplementa: QIODevice::waitForBytesWritten(int msecs).

Esta función se bloquea hasta que se ha escrito al menos un byte en el puerto serie y se ha emitido la señal bytesWritten(). La función expirará después de msecs milisegundos; el tiempo por defecto es de 30000 milisegundos. Si msecs es -1, esta función no expirará.

La función devuelve true si se emite la señal bytesWritten(); en caso contrario, devuelve false (si se ha producido un error o si la operación ha expirado).

[override virtual] bool QSerialPort::waitForReadyRead(int msecs = 30000)

Reimplementa: QIODevice::waitForReadyRead(int msecs).

Esta función se bloquea hasta que hay nuevos datos disponibles para lectura y se ha emitido la señal readyRead(). La función expirará después de msecs milisegundos; el tiempo de espera por defecto es de 30000 milisegundos. Si msecs es -1, esta función no expirará.

La función devuelve true si se emite la señal readyRead() y hay nuevos datos disponibles para leer; en caso contrario, devuelve false (si se ha producido un error o la operación ha expirado).

Véase también waitForBytesWritten().

[since 6.10] qint64 QSerialPort::writeBufferSize() const

Devuelve el tamaño del búfer interno de escritura.

Un tamaño de búfer de escritura de 0 (por defecto) significa que el búfer no tiene límite de tamaño.

Esta función se introdujo en Qt 6.10.

Véase también setWriteBufferSize() y write().

[override virtual protected] qint64 QSerialPort::writeData(const char *data, qint64 maxSize)

Reimplementa: QIODevice::writeData(const char *data, qint64 maxSize).