Skip to content

SerialConfig

struct nmeasim::io::SerialConfig ยท Library API

Settings of a serial port output, applied when the port is opened.

#include <nmeasim/io/transports/serial_transport.hpp>

Declared in src/io/include/nmeasim/io/transports/serial_transport.hpp (line 26)

The defaults are the NMEA 0183 line settings: 4800 baud, 8 data bits, no parity, one stop bit, no flow control.

See also

  • NMEA 0183 (IEC 61162-1) for 4800 baud; IEC 61162-2 for 38400 baud.

Summary

Public data members

Name Description
port_name Device to open: a path such as /dev/ttyUSB0 or a name such as COM3, as listed by available_serial_ports.
baud_rate Line speed in bits per second; must be positive.
data_bits Bits per character, QSerialPort::Data5 to QSerialPort::Data8.
parity Parity: none, even, odd, mark or space.
stop_bits Stop bits: 1, 1.5 or 2.
flow_control Flow control: none, hardware (RTS/CTS) or software (XON/XOFF).

Public data members

port_name

QString port_name

Device to open: a path such as /dev/ttyUSB0 or a name such as COM3, as listed by available_serial_ports.

Required: the profile loader rejects a serial output without it.

Declared in src/io/include/nmeasim/io/transports/serial_transport.hpp:30

baud_rate

qint32 baud_rate{4800}

Line speed in bits per second; must be positive.

4800 is the NMEA 0183 default and 38400 the high-speed variant used for AIS. Any other value the driver supports is accepted; one it rejects makes SerialTransport::open fail.

Declared in src/io/include/nmeasim/io/transports/serial_transport.hpp:36

data_bits

QSerialPort::DataBits data_bits{QSerialPort::Data8}

Bits per character, QSerialPort::Data5 to QSerialPort::Data8.

Declared in src/io/include/nmeasim/io/transports/serial_transport.hpp:38

parity

QSerialPort::Parity parity{QSerialPort::NoParity}

Parity: none, even, odd, mark or space.

Declared in src/io/include/nmeasim/io/transports/serial_transport.hpp:40

stop_bits

QSerialPort::StopBits stop_bits{QSerialPort::OneStop}

Stop bits: 1, 1.5 or 2.

Declared in src/io/include/nmeasim/io/transports/serial_transport.hpp:42

flow_control

QSerialPort::FlowControl flow_control{QSerialPort::NoFlowControl}

Flow control: none, hardware (RTS/CTS) or software (XON/XOFF).

Declared in src/io/include/nmeasim/io/transports/serial_transport.hpp:44