Qt Serial Bus C++ Classes

Provides classes to read and write serial bus data. More...

Namespaces

QtCanBus

Some commons enums that are used in the CAN bus handling part of the QtSerialPort module

Classes

QCanBus

Handles registration and creation of bus plugins

QCanBusDevice

The interface class for CAN bus

QCanBusDevice::Filter

QCanBusDevice::Filter struct defines a filter for CAN bus frames

QCanBusDeviceInfo

Information about CAN bus interfaces

QCanBusFactory

Factory class used as the plugin interface for CAN bus plugins

QCanBusFrame

Container class representing a single CAN frame

QCanBusFrame::TimeStamp

Timestamp information with microsecond precision

QCanDbcFileParser

Can be used to parse DBC files

QCanFrameProcessor

Can be used to decode a QCanBusFrame or to convert the input data into a QCanBusFrame that is ready to be sent to the receiver

QCanFrameProcessor::ParseResult

Struct is used as a return value for the QCanFrameProcessor::parseFrame() method

QCanMessageDescription

Describes the rules to process a CAN message and represent it in an application-defined format

QCanSignalDescription

Describes the rules to extract one value out of the CAN frame and represent it in an application-defined format

QCanSignalDescription::MultiplexValueRange

Defines a range of values for a multiplexor signal

QCanUniqueIdDescription

Describes the rules for accessing a unique identifier in a QCanBusFrame

QModbusClient

The interface to send Modbus requests

QModbusDataUnit

Container class representing single bit and 16 bit word entries in the Modbus register

QModbusDevice

The base class for Modbus classes, QModbusServer and QModbusClient

QModbusDeviceIdentification

Container class representing the physical and functional description of a Modbus server

QModbusExceptionResponse

Container class containing the function and error code inside a Modbus ADU

QModbusPdu

Abstract container class containing the function code and payload that is stored inside a Modbus ADU

QModbusReply

Contains the data for a request sent with a QModbusClient derived class

QModbusRequest

Container class containing the function code and payload that is stored inside a Modbus ADU

QModbusResponse

Container class containing the function code and payload that is stored inside a Modbus ADU

QModbusRtuSerialClient

Represents a Modbus client that uses a serial bus for its communication with the Modbus server

QModbusRtuSerialServer

Represents a Modbus server that uses a serial port for its communication with the Modbus client

QModbusServer

The interface to receive and process Modbus requests

QModbusTcpClient

The interface class for Modbus TCP client device

QModbusTcpConnectionObserver

Represents the interface for objects that can be passed to QModbusTcpServer::installConnectionObserver

QModbusTcpServer

Represents a Modbus server that uses a TCP server for its communication with the Modbus client

Detailed Description

Provides classes to access various serial buses.

For C++ projects include the header appropriate for the current use case, for example applications using the CAN bus device may use

#include <QCanBusDevice>

To use the module with CMake, use the find_package() command to locate the needed module components in the Qt6 package:

find_package(Qt6 COMPONENTS SerialBus REQUIRED)
target_link_libraries(mytarget PRIVATE Qt6::SerialBus)

To use the module for building with qmake, add the module as a value of the QT variable in the project's .pro file:

QT += serialbus

See more in the Qt Serial Bus Overview.

© 2023 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.