En esta página

QSerialPort Class

Ofrece funciones para acceder a los puertos serie. Más información...

Encabezado: #include <QSerialPort>
CMake: find_package(Qt6 REQUIRED COMPONENTS SerialPort)
target_link_libraries(mytarget PRIVATE Qt6::SerialPort)
qmake: QT += serialport
Heredan: QIODevice

Nota: Todas las funciones de esta clase son reentrantes.

Tipos públicos

enum BaudRate { Baud1200, Baud2400, Baud4800, Baud9600, Baud19200, …, Baud115200 }
enum DataBits { Data5, Data6, Data7, Data8 }
enum Direction { Input, Output, AllDirections }
flags Directions
enum FlowControl { NoFlowControl, HardwareControl, SoftwareControl }
enum Parity { NoParity, EvenParity, OddParity, SpaceParity, MarkParity }
enum PinoutSignal { NoSignal, DataTerminalReadySignal, DataCarrierDetectSignal, DataSetReadySignal, RingIndicatorSignal, …, SecondaryReceivedDataSignal }
flags PinoutSignals
enum SerialPortError { NoError, DeviceNotFoundError, PermissionError, OpenError, NotOpenError, …, UnknownError }
enum StopBits { OneStop, OneAndHalfStop, TwoStop }

Propiedades

Funciones públicas

QSerialPort(QObject *parent = nullptr)
QSerialPort(const QSerialPortInfo &serialPortInfo, QObject *parent = nullptr)
QSerialPort(const QString &name, QObject *parent = nullptr)
virtual ~QSerialPort()
qint32 baudRate(QSerialPort::Directions directions = AllDirections) const
QBindable<QSerialPort::DataBits> bindableDataBits()
QBindable<QSerialPort::SerialPortError> bindableError() const
QBindable<QSerialPort::FlowControl> bindableFlowControl()
QBindable<bool> bindableIsBreakEnabled()
QBindable<QSerialPort::Parity> bindableParity()
QBindable<QSerialPort::StopBits> bindableStopBits()
bool clear(QSerialPort::Directions directions = AllDirections)
void clearError()
QSerialPort::DataBits dataBits() const
QSerialPort::SerialPortError error() const
QSerialPort::FlowControl flowControl() const
bool flush()
QSerialPort::Handle handle() const
bool isBreakEnabled() const
bool isDataTerminalReady()
bool isRequestToSend()
QSerialPort::Parity parity() const
QSerialPort::PinoutSignals pinoutSignals()
QString portName() const
qint64 readBufferSize() const
bool setBaudRate(qint32 baudRate, QSerialPort::Directions directions = AllDirections)
bool setBreakEnabled(bool set = true)
bool setDataBits(QSerialPort::DataBits dataBits)
bool setDataTerminalReady(bool set)
bool setFlowControl(QSerialPort::FlowControl flowControl)
bool setParity(QSerialPort::Parity parity)
void setPort(const QSerialPortInfo &serialPortInfo)
void setPortName(const QString &name)
void setReadBufferSize(qint64 size)
bool setRequestToSend(bool set)
void setSettingsRestoredOnClose(bool restore)
bool setStopBits(QSerialPort::StopBits stopBits)
(since 6.10) void setWriteBufferSize(qint64 size)
bool settingsRestoredOnClose() const
QSerialPort::StopBits stopBits() const
(since 6.10) qint64 writeBufferSize() const

Funciones públicas reimplementadas

virtual qint64 bytesAvailable() const override
virtual qint64 bytesToWrite() const override
virtual bool canReadLine() const override
virtual void close() override
virtual bool isSequential() const override
virtual bool open(QIODeviceBase::OpenMode mode) override
virtual bool waitForBytesWritten(int msecs = 30000) override
virtual bool waitForReadyRead(int msecs = 30000) override

Señales

void baudRateChanged(qint32 baudRate, QSerialPort::Directions directions)
void breakEnabledChanged(bool set)
void dataBitsChanged(QSerialPort::DataBits dataBits)
void dataTerminalReadyChanged(bool set)
void errorOccurred(QSerialPort::SerialPortError error)
void flowControlChanged(QSerialPort::FlowControl flow)
void parityChanged(QSerialPort::Parity parity)
void requestToSendChanged(bool set)
(since 6.9) void settingsRestoredOnCloseChanged(bool restore)
void stopBitsChanged(QSerialPort::StopBits stopBits)

Funciones protegidas reimplementadas

virtual qint64 readData(char *data, qint64 maxSize) override
virtual qint64 readLineData(char *data, qint64 maxSize) override
virtual qint64 writeData(const char *data, qint64 maxSize) override

Descripción detallada

Puedes obtener información sobre los puertos serie disponibles utilizando la clase auxiliar ` QSerialPortInfo `, que permite enumerar todos los puertos serie del sistema. Esto resulta útil para obtener el nombre correcto del puerto serie que deseas utilizar. Puedes pasar un objeto de la clase auxiliar como argumento a los métodos ` setPort()` o ` setPortName()` para asignar el dispositivo serie deseado.

Una vez configurado el puerto, puedes abrirlo en modo de solo lectura (r/o), solo escritura (w/o) o lectura y escritura (r/w) utilizando el método open().

Nota: El puerto serie siempre se abre con acceso exclusivo (es decir, ningún otro proceso o hilo puede acceder a un puerto serie ya abierto).

Utilice el método ` close()` para cerrar el puerto y cancelar las operaciones de E/S.

Una vez abierto correctamente, QSerialPort intenta determinar la configuración actual del puerto y se inicializa. Puede reconfigurar el puerto con los ajustes deseados utilizando los métodos setBaudRate(), setDataBits(), setParity(), setStopBits() y setFlowControl().

Existen un par de propiedades para trabajar con las señales de los pines, a saber: ` QSerialPort::dataTerminalReady` y ` QSerialPort::requestToSend`. También es posible utilizar el método ` pinoutSignals()` para consultar el conjunto actual de señales de los pines.

Una vez que sepas que los puertos están listos para leer o escribir, puedes utilizar los métodos read() o write(). Como alternativa, también se pueden invocar los métodos de conveniencia ` readLine()` y ` readAll()`. Si no se leen todos los datos de una sola vez, los datos restantes estarán disponibles más adelante, ya que los nuevos datos entrantes se añaden al búfer de lectura interno de `QSerialPort`. Se puede limitar el tamaño del búfer de lectura utilizando ` setReadBufferSize()`.

QSerialPort proporciona un conjunto de funciones que suspenden el hilo de llamada hasta que se emitan determinadas señales. Estas funciones se pueden utilizar para implementar puertos serie bloqueantes:

  • waitForReadyRead() bloquea las llamadas hasta que haya nuevos datos disponibles para su lectura.
  • waitForBytesWritten() bloquea las llamadas hasta que se haya escrito una carga útil de datos en el puerto serie.

Véase el siguiente ejemplo:

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;
}

Si waitForReadyRead() devuelve « false », la conexión se ha cerrado o se ha producido un error.

Si se produce un error en cualquier momento, QSerialPort emitirá la señal errorOccurred(). También puedes llamar a error() para averiguar el tipo de error que se ha producido por última vez.

La programación con un puerto serie bloqueante es radicalmente diferente de la programación con un puerto serie no bloqueante. Un puerto serie bloqueante no requiere un bucle de eventos y, por lo general, da lugar a un código más sencillo. Sin embargo, en una aplicación con interfaz gráfica de usuario (GUI), el puerto serie bloqueante solo debe utilizarse en subprocesos que no pertenezcan a la GUI, para evitar que se cuelgue la interfaz de usuario.

Para obtener más detalles sobre estos enfoques, consulte las aplicaciones de ejemplo.

La clase QSerialPort también se puede utilizar con los operadores de flujo de QTextStream y QDataStream(operator<<() y operator>>()). Sin embargo, hay un aspecto que hay que tener en cuenta: asegúrate de que haya datos suficientes disponibles antes de intentar leer utilizando el operador sobrecargado operator>>().

Véase también QSerialPortInfo.

Documentación sobre tipos de miembros

enum QSerialPort::BaudRate

Esta enumeración describe la velocidad de transmisión con la que funciona el dispositivo de comunicación.

Nota: En esta enumeraciónsolo se incluyen las velocidades de transmisión estándar más comunes.

ConstanteValorDescripción
QSerialPort::Baud120012001200 baudios.
QSerialPort::Baud240024002400 baudios.
QSerialPort::Baud480048004800 baudios.
QSerialPort::Baud960096009600 baudios.
QSerialPort::Baud192001920019 200 baudios.
QSerialPort::Baud384003840038 400 baudios.
QSerialPort::Baud576005760057 600 baudios.
QSerialPort::Baud115200115200115 200 baudios.

Véase también QSerialPort::baudRate.

enum QSerialPort::DataBits

Esta enumeración describe el número de bits de datos utilizados.

ConstanteValorDescripción
QSerialPort::Data55El número de bits de datos en cada carácter es 5. Se utiliza para el código Baudot. Por lo general, solo tiene sentido con equipos antiguos, como las teletipo.
QSerialPort::Data66El número de bits de datos en cada carácter es 6. Se utiliza muy raramente.
QSerialPort::Data77El número de bits de datos en cada carácter es 7. Se utiliza para el ASCII auténtico. Por lo general, solo tiene sentido con equipos antiguos, como las teletipadoras.
QSerialPort::Data88El número de bits de datos de cada carácter es 8. Se utiliza para la mayoría de los tipos de datos, ya que este tamaño coincide con el de un byte. Su uso es casi universal en las aplicaciones más recientes.

Véase también QSerialPort::dataBits.

enum QSerialPort::Direction
flags QSerialPort::Directions

Esta enumeración describe las posibles direcciones de la transmisión de datos.

Nota: Esta enumeración se utiliza para configurar la velocidad de transmisión del dispositivo por separado para cada dirección en algunos sistemas operativos (por ejemplo, los de tipo POSIX).

ConstanteValorDescripción
QSerialPort::Input1Dirección de entrada.
QSerialPort::Output2Dirección de salida.
QSerialPort::AllDirectionsInput | OutputSimultáneamente en dos direcciones.

El tipo «Directions» es un typedef para QFlags<Direction>. Almacena una combinación OR de valores de «Direction».

enum QSerialPort::FlowControl

Esta enumeración describe el control de flujo utilizado.

ConstanteValorDescripción
QSerialPort::NoFlowControl0Sin control de flujo.
QSerialPort::HardwareControl1Control de flujo por hardware (RTS/CTS).
QSerialPort::SoftwareControl2Control de flujo por software (XON/XOFF).

Véase también « QSerialPort::flowControl ».

enum QSerialPort::Parity

Esta enumeración describe el esquema de paridad utilizado.

ConstanteValorDescripción
QSerialPort::NoParity0No se envía ningún bit de paridad. Esta es la configuración de paridad más habitual. La detección de errores corre a cargo del protocolo de comunicación.
QSerialPort::EvenParity2El número de bits 1 en cada carácter, incluido el bit de paridad, es siempre par.
QSerialPort::OddParity3El número de bits 1 en cada carácter, incluido el bit de paridad, es siempre impar. Esto garantiza que se produzca al menos una transición de estado en cada carácter.
QSerialPort::SpaceParity4Paridad de espacio. El bit de paridad se envía en la condición de señal de espacio. No proporciona información de detección de errores.
QSerialPort::MarkParity5Paridad de marca. El bit de paridad se establece siempre en el estado de la señal de marca (1 lógico). No proporciona información de detección de errores.

Véase también « QSerialPort::parity ».

enum QSerialPort::PinoutSignal
flags QSerialPort::PinoutSignals

Esta enumeración describe las posibles señales de la configuración de pines RS-232.

ConstanteValorDescripción
QSerialPort::NoSignal0x00Línea inactiva
QSerialPort::DataTerminalReadySignal0x04DTR (Data Terminal Ready).
QSerialPort::DataCarrierDetectSignal0x08DCD (detección de portadora de datos).
QSerialPort::DataSetReadySignal0x10DSR (Conjunto de datos listo).
QSerialPort::RingIndicatorSignal0x20RNG (Indicador de llamada).
QSerialPort::RequestToSendSignal0x40RTS (Solicitud de envío).
QSerialPort::ClearToSendSignal0x80CTS (Listo para enviar).
QSerialPort::SecondaryTransmittedDataSignal0x100STD (Datos transmitidos secundarios).
QSerialPort::SecondaryReceivedDataSignal0x200SRD (Datos recibidos secundarios).

El tipo PinoutSignals es una definición de tipo (typedef) para QFlags<PinoutSignal>. Almacena una combinación OR de valores de PinoutSignal.

Véase también pinoutSignals(), QSerialPort::dataTerminalReady y QSerialPort::requestToSend.

enum QSerialPort::SerialPortError

Esta enumeración describe los errores que puede contener la propiedad « QSerialPort::error ».

ConstanteValorDescripción
QSerialPort::NoError0No se ha producido ningún error.
QSerialPort::DeviceNotFoundError1Se ha producido un error al intentar abrir un dispositivo que no existe.
QSerialPort::PermissionError2Se ha producido un error al intentar abrir un dispositivo que ya estaba abierto por otro proceso o por un usuario que no disponía de los permisos y credenciales suficientes para abrirlo.
QSerialPort::OpenError3Se ha producido un error al intentar abrir un dispositivo que ya estaba abierto en este objeto.
QSerialPort::NotOpenError10Este error se produce cuando se ejecuta una operación que solo puede realizarse con éxito si el dispositivo está abierto. Este valor se introdujo en la versión 5.2 de « QtSerialPort ».
QSerialPort::WriteError4Se ha producido un error de E/S al escribir los datos.
QSerialPort::ReadError5Se ha producido un error de E/S al leer los datos.
QSerialPort::ResourceError6Se ha producido un error de E/S cuando un recurso deja de estar disponible, por ejemplo, cuando el dispositivo se retira inesperadamente del sistema.
QSerialPort::UnsupportedOperationError7La operación solicitada en el dispositivo no es compatible o está prohibida por el sistema operativo en ejecución.
QSerialPort::TimeoutError9Se ha producido un error de tiempo de espera. Este valor se introdujo en QtSerialPort 5.2.
QSerialPort::UnknownError8Se ha producido un error no identificado.

Véase también QSerialPort::error.

enum QSerialPort::StopBits

Esta enumeración describe el número de bits de parada utilizados.

ConstanteValorDescripción
QSerialPort::OneStop11 bit de parada.
QSerialPort::OneAndHalfStop31,5 bits de parada. Esto es solo para la plataforma Windows.
QSerialPort::TwoStop22 bits de parada.

Véase también QSerialPort::stopBits.

Documentación de propiedades

baudRate : qint32

Esta propiedad contiene la velocidad de transmisión de datos para la dirección deseada

Si la configuración se realiza correctamente o se establece antes de abrir el puerto, devuelve ` true`; en caso contrario, devuelve ` false ` y establece un código de error al que se puede acceder consultando el valor de la propiedad ` QSerialPort::error `. Para establecer la velocidad de transmisión, utilice la enumeración ` QSerialPort::BaudRate ` o cualquier valor `qint32` positivo.

Nota: Si la configuración se establece antes de abrir el puerto, la configuración real del puerto serie se realiza automáticamente en el método QSerialPort::open() inmediatamente después de que se haya abierto el puerto con éxito.

Advertencia: La configuración del indicador ` AllDirections ` es compatible con todas las plataformas. Windows solo admite este modo.

Advertencia: En Windows,devuelve la misma velocidad de transmisión en ambas direcciones.

El valor por defecto es Baud9600, es decir, 9600 bits por segundo.

Funciones de acceso:

qint32 baudRate(QSerialPort::Directions directions = AllDirections) const
bool setBaudRate(qint32 baudRate, QSerialPort::Directions directions = AllDirections)

Señal de notificación:

void baudRateChanged(qint32 baudRate, QSerialPort::Directions directions)

[bindable] breakEnabled : bool

Nota: Esta propiedad admite enlaces de tipo « QProperty ».

Esta propiedad contiene el estado de la línea de transmisión en caso de interrupción

Devuelve « true » si la operación se realiza con éxito, y « false » en caso contrario. Si el indicador es « true », la línea de transmisión se encuentra en estado de interrupción; en caso contrario, se encuentra en estado de no interrupción.

Nota: El puerto serie debe estar abierto antes de intentar establecer u obtener esta propiedad; de lo contrario, devuelve « false » y establece el código de error « NotOpenError ». Esto resulta un tanto inusual en comparación con la configuración habitual de las propiedades Qt de una clase. Sin embargo, se trata de un caso de uso especial, ya que la propiedad se establece mediante la interacción con el núcleo y el hardware. Por lo tanto, ambos escenarios no pueden compararse completamente entre sí.

Funciones de acceso:

bool isBreakEnabled() const
bool setBreakEnabled(bool set = true)

Señal del notificador:

void breakEnabledChanged(bool set)

[bindable] dataBits : DataBits

Nota: Esta propiedad admite enlaces de tipo « QProperty ».

Esta propiedad contiene los bits de datos de una trama

Si la configuración se realiza correctamente o se establece antes de abrir el puerto, devuelve « true »; en caso contrario, devuelve « false » y establece un código de error que se puede obtener accediendo al valor de la propiedad « QSerialPort::error ».

Nota: Si la configuración se establece antes de abrir el puerto, la configuración real del puerto serie se realiza automáticamente en el método QSerialPort::open() justo después de que se haya abierto correctamente el puerto.

El valor por defecto es Data8, es decir, 8 bits de datos.

Funciones de acceso:

QSerialPort::DataBits dataBits() const
bool setDataBits(QSerialPort::DataBits dataBits)

Señal de notificación:

void dataBitsChanged(QSerialPort::DataBits dataBits)

dataTerminalReady : bool

Esta propiedad contiene el estado (alto o bajo) de la señal de línea DTR

Devuelve « true » si se realiza correctamente y « false » en caso contrario. Si el indicador es « true », la señal DTR se establece en alto; en caso contrario, en bajo.

Nota: El puerto serie debe estar abierto antes de intentar establecer u obtener esta propiedad; de lo contrario, se devuelve « false » y el código de error se establece en « NotOpenError ».

Funciones de acceso:

bool isDataTerminalReady()
bool setDataTerminalReady(bool set)

Señal de notificación:

void dataTerminalReadyChanged(bool set)

Véase también pinoutSignals().

[bindable read-only] error : SerialPortError

Nota: Esta propiedad admite enlaces de tipo « QProperty ».

Esta propiedad contiene el estado de error del puerto serie

El estado del dispositivo de E/S devuelve un código de error. Por ejemplo, si open() devuelve « false » o si una operación de lectura/escritura devuelve « -1 », esta propiedad se puede utilizar para averiguar el motivo por el que falló la operación.

El código de error se establece en el valor predeterminado QSerialPort::NoError tras llamar a clearError()

Funciones de acceso:

QSerialPort::SerialPortError error() const
void clearError()

Señal del notificador:

void errorOccurred(QSerialPort::SerialPortError error)

[bindable] flowControl : FlowControl

Nota: Esta propiedad admite enlaces de tipo « QProperty ».

Esta propiedad contiene el modo de control de flujo deseado

Si la configuración se realiza correctamente o se establece antes de abrir el puerto, devuelve « true »; en caso contrario, devuelve « false » y establece un código de error que se puede obtener accediendo al valor de la propiedad « QSerialPort::error ».

Nota: Si la configuración se establece antes de abrir el puerto, la configuración real del puerto serie se realiza automáticamente en el método QSerialPort::open() inmediatamente después de que la apertura del puerto se haya realizado con éxito.

El valor por defecto es NoFlowControl, es decir, sin control de flujo.

Funciones de acceso:

QSerialPort::FlowControl flowControl() const
bool setFlowControl(QSerialPort::FlowControl flowControl)

Señal de notificación:

void flowControlChanged(QSerialPort::FlowControl flow)

[bindable] parity : Parity

Nota: Esta propiedad es compatible con los enlaces de tipo « QProperty ».

Esta propiedad contiene el modo de comprobación de paridad

Si la configuración se realiza correctamente o se establece antes de abrir el puerto, devuelve « true »; en caso contrario, devuelve « false » y establece un código de error que puede obtenerse accediendo al valor de la propiedad « QSerialPort::error ».

Nota: Si la configuración se establece antes de abrir el puerto, la configuración real del puerto serie se realiza automáticamente en el método QSerialPort::open() justo después de que la apertura del puerto se haya completado con éxito.

El valor por defecto es NoParity, es decir, sin paridad.

Advertencia: Algunos sistemas operativos UNIX (por ejemplo, macOS) no admiten el indicador CMSPAR. En dichos sistemas, no se admite la configuración de paridad « Mark or Space ».

Funciones de acceso:

QSerialPort::Parity parity() const
bool setParity(QSerialPort::Parity parity)

Señal de notificador:

void parityChanged(QSerialPort::Parity parity)

requestToSend : bool

Esta propiedad contiene el estado (alto o bajo) de la señal de línea RTS

Devuelve « true » si se realiza correctamente, y « false » en caso contrario. Si el indicador es « true », la señal RTS se establece en alto; en caso contrario, en bajo.

Nota: El puerto serie debe estar abierto antes de intentar establecer u obtener esta propiedad; de lo contrario, se devuelve el valor « false » y el código de error se establece en « NotOpenError ».

Nota: Cualquier intento de controlar la señal RTS en el modo « HardwareControl » fallará y se establecerá el código de error UnsupportedOperationError, ya que el controlador controla automáticamente la señal.

Funciones de acceso:

bool isRequestToSend()
bool setRequestToSend(bool set)

Señal de notificación:

void requestToSendChanged(bool set)

Véase también pinoutSignals().

[since 6.9] settingsRestoredOnClose : bool

Esta propiedad define si los parámetros del puerto deben restablecerse al cerrarlo o no

Una vez abierto el puerto, la clase almacena en caché sus parámetros antes de aplicar los definidos por el usuario.

Si la propiedad es « true », el puerto serie intenta restaurar los parámetros almacenados en caché antes de cerrar el puerto; de lo contrario, los parámetros almacenados en caché se descartan.

El valor por defecto es « true ».

Nota: Es posible queesta propiedad no tenga ningún efecto en algunos sistemas operativos. Por ejemplo, macOS parece restaurar siempre la configuración predeterminada del puerto serie al cerrarlo.

Esta enumeración se introdujo en Qt 6.9.

Funciones de acceso:

bool settingsRestoredOnClose() const
void setSettingsRestoredOnClose(bool restore)

Señal Notifier:

void settingsRestoredOnCloseChanged(bool restore)

[bindable] stopBits : StopBits

Nota: Esta propiedad admite enlaces de tipo « QProperty ».

Esta propiedad contiene el número de bits de parada de una trama

Si la configuración se realiza correctamente o se establece antes de abrir el puerto, devuelve « true »; en caso contrario, devuelve « false » y establece un código de error al que se puede acceder mediante el valor de la propiedad « QSerialPort::error ».

Nota: Si la configuración se establece antes de abrir el puerto, la configuración real del puerto serie se realiza automáticamente en el método QSerialPort::open() justo después de que se haya abierto correctamente el puerto.

El valor por defecto es OneStop, es decir, 1 bit de parada.

Funciones de acceso:

QSerialPort::StopBits stopBits() const
bool setStopBits(QSerialPort::StopBits stopBits)

Señal de notificación:

void stopBitsChanged(QSerialPort::StopBits stopBits)

Documentación de las funciones de miembro

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

Crea un nuevo objeto de puerto serie con el parent especificado.

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

Crea un nuevo objeto de puerto serie con el parámetro « parent » proporcionado para representar el puerto serie mediante la clase auxiliar especificada « serialPortInfo ».

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

Crea un nuevo objeto de puerto serie con el ` parent ` proporcionado 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 a continuación destruye el objeto.

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

Esta señal se emite tras modificar la velocidad de transmisión. La nueva velocidad de transmisión se pasa como « baudRate » y las direcciones como « directions ».

Nota: Señalde notificación para la propiedad baudRate.

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 a la espera de 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 a la espera de 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)

Elimina todos los caracteres del búfer de salida o de entrada, según las instrucciones proporcionadas directions. Esto incluye el borrado de los búferes internos de la clase y de los búferes del UART (controlador). Además, finaliza las operaciones de lectura o escritura pendientes. Si se ejecuta correctamente, devuelve true; en caso contrario, devuelve false.

Nota: El puerto serie debe estar abierto antes de intentar borrar cualquier dato almacenado en el búfer; de lo contrario, devuelve false y establece el código de error NotOpenError.

[override virtual] void QSerialPort::close()

Reimplementa: ` QIODevice::close()`.

Nota: El puerto serie debe estar abierto antes de intentar cerrarlo; de lo contrario, se establece el código de error NotOpenError.

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

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

Esta señal se emite después de que se hayan modificado los bits de datos de una trama. Los nuevos bits de datos de una trama se transmiten como « dataBits ».

Nota: Señalde notificación para la propiedad « dataBits ».

Véase también « QSerialPort::dataBits ».

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

Esta señal se emite después de que haya cambiado 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 transmite como « set ».

Nota: Señalde notificación para la propiedad dataTerminalReady.

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. La propiedad « error » especificada describe el tipo de error que se ha producido.

Nota: Señalde notificación para la propiedad « error ».

Véase también « QSerialPort::error ».

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

Esta señal se emite tras cambiar el modo de control de flujo. El nuevo modo de control de flujo se transmite como ` flow`.

Nota: Señalde notificación para la propiedad flowControl.

Véase también ` QSerialPort::flowControl`.

bool QSerialPort::flush()

Esta función escribe todo lo que sea posible desde el búfer de escritura interno al puerto serie subyacente sin bloquearse. Si se han escrito datos, esta función devuelve « true »; en caso contrario, devuelve « false ».

Llama a esta función para enviar inmediatamente los datos almacenados en el búfer al puerto serie. El número de bytes escritos con éxito depende del sistema operativo. En la mayoría de los casos, no es necesario llamar a esta función, ya que la clase ` QSerialPort ` comenzará a enviar datos automáticamente una vez que se devuelva el control al bucle de eventos. Si no hay un bucle de eventos, llama en su lugar a ` waitForBytesWritten()`.

Nota: El puerto serie debe estar abierto antes de intentar vaciar cualquier dato almacenado en el búfer; de lo contrario, devuelve false y establece el código de error NotOpenError.

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

QSerialPort::Handle QSerialPort::handle() const

Si la plataforma es compatible y el puerto serie está abierto, devuelve el identificador nativo del puerto serie; en caso contrario, devuelve « -1 ».

Advertencia: Esta función está destinada exclusivamente a usuarios expertos; utilízala bajo tu propia responsabilidad. Además, esta función no garantiza la compatibilidad entre versiones menores de Qt.

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

Reimplementa: ` QIODevice::isSequential()` const.

Siempre devuelve true. El puerto serie es un dispositivo secuencial.

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

Reimplementa: QIODevice::open(modo OpenMode de QIODeviceBase).

Abre el puerto serie utilizando el modo OpenMode mode y, a continuación, devuelve true si la operación se realiza correctamente; en caso contrario, devuelve false y establece un código de error que se puede obtener llamando al método error().

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

Advertencia: El valor de « mode » debe ser « QIODeviceBase::ReadOnly », « QIODeviceBase::WriteOnly » o « QIODeviceBase::ReadWrite ». No se admiten otros modos.

Nota: Por motivos históricos, tras una apertura correcta, se emite la señal errorOccurred() con el código de error NoError. Este comportamiento se mantiene para garantizar la compatibilidad con versiones anteriores.

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

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

Esta señal se emite tras cambiar el modo de comprobación de paridad. El nuevo modo de comprobación de paridad se transmite como « parity ».

Nota: Señalde notificación para la propiedad parity.

Véase también ` QSerialPort::parity`.

QSerialPort::PinoutSignals QSerialPort::pinoutSignals()

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

A partir de este resultado, es posible determinar 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.

Nota: Este método realiza una llamada al sistema, lo que garantiza que los estados de las señales de línea se devuelvan correctamente. Esto es necesario cuando los sistemas operativos subyacentes no pueden proporcionar notificaciones adecuadas sobre los cambios.

Nota: El puerto serie debe estar abierto antes de intentar obtener las señales de los pines; de lo contrario, devuelve « NoSignal » y establece el código de error « NotOpenError ».

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

QString QSerialPort::portName() const

Devuelve el nombre establecido mediante ` setPort()` o pasado al constructor ` QSerialPort `. Este nombre es breve, es decir, se extrae y se convierte a partir de la ubicación en el sistema de variables internas del dispositivo. El algoritmo de conversión depende de la plataforma:

PlataformaBreve descripción
WindowsElimina el prefijo «\\.\» o «//./» de la ubicación del sistema y devuelve el resto de la cadena.
Unix, BSDElimina el prefijo «/dev/» de la ubicación del sistema y devuelve el resto de la cadena.

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 por defecto) significa que el búfer no tiene límite de tamaño, lo que garantiza que no se pierda ningún dato.

Véanse 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 que haya cambiado 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 transmite como set.

Nota: Señalde notificación para la propiedad requestToSend.

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 nombre de la conexión de serie ( name ) del puerto serie.

El nombre del puerto serie puede indicarse como nombre corto o, si es necesario, como la ubicación completa del sistema.

Nota: Esta función permite configurar puertos que no están incluidos en la lista de puertos ( list of available ports) o en los que la creación de una instancia de ` QSerialPortInfo ` con la cadena de nombre da como resultado un objeto ` null `. Si eso no es un requisito, utilice en su lugar ` setPort()` tras comprobar que el nombre da como resultado un objeto ` QSerialPortInfo ` válido.

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 se limita a un valor determinado, QSerialPort no almacenará en el búfer una cantidad de datos superior a dicho valor. El caso especial en el que el tamaño del búfer es de 0 significa que el búfer de lectura es ilimitado y se almacenan todos los datos entrantes. Este es el valor por defecto.

Esta opción resulta útil si los datos solo se leen en determinados momentos (por ejemplo, en una aplicación de transmisión en tiempo real) o si es necesario proteger el puerto serie para que no reciba demasiados datos, lo que podría acabar provocando que la aplicación se quedara sin memoria.

Al pasar un valor negativo se desactiva el búfer interno, lo que bloquea de hecho cualquier lectura.

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 de un puerto serie es relativamente lento, por lo que, en la práctica, los datos no se envían inmediatamente al llamar a ` write()`. Primero se almacenan en un búfer intermedio y posteriormente se escriben en bloques.

Por lo tanto, escribir demasiados datos, o hacerlo a una velocidad superior a la que puede gestionar el puerto serie subyacente, puede hacer que el búfer interno aumente de tamaño. Esto puede acabar provocando que la aplicación se quede sin memoria, especialmente en un dispositivo con pocos recursos de memoria.

Este método permite limitar el búfer interno a un tamaño determinado. Si el siguiente intento de escritura excede la capacidad del búfer, el método ` write()` devuelve el número de bytes que se han almacenado realmente en el búfer. Es responsabilidad del usuario repetir el intento de escritura con el resto de los bytes tras 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 escritura no está limitado y que todos los datos pasados a ` write()` se almacenan en el búfer. Este es el valor por defecto.

Pasar un valor negativo tiene el mismo efecto que pasar ` 0`.

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 tras modificarse la propiedad « settingsRestoredOnClose ». El parámetro « restore » contiene el nuevo valor de la propiedad.

Nota: Señalde notificación para la propiedad ` settingsRestoredOnClose`.

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 que se haya modificado el número de bits de parada de una trama. El nuevo número de bits de parada de una trama se transmite como « stopBits ».

Nota: Señalde notificación para la propiedad 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 haya escrito al menos un byte en el puerto serie y se haya emitido la señal bytesWritten(). La función agotará el tiempo de espera tras msecs milisegundos; el tiempo de espera predeterminado es de 30000 milisegundos. Si msecs es -1, esta función no agotará el tiempo de espera.

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

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

Reimplementa: ` QIODevice::waitForReadyRead(int msecs)`.

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

La función devuelve true si se emite la señal readyRead() y hay nuevos datos disponibles para su lectura; en caso contrario, devuelve false (si se ha producido un error o se ha agotado el tiempo de espera de la operación).

Véase también waitForBytesWritten().

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

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

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

Esta función se introdujo en Qt 6.10.

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

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

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

© 2026 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.