class QCanBus#

The QCanBus class handles registration and creation of bus plugins. More

Inheritance diagram of PySide6.QtSerialBus.QCanBus



Static functions#


This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/

Detailed Description#

QCanBus loads Qt CAN Bus plugins at runtime. The ownership of serial bus plugins is transferred to the loader.


plugin – str

Return type:


Returns the available interfaces for plugin. In case of failure, the optional parameter errorMessage returns a textual error description.


Some plugins might not or only partially support this function.

For example, the following call returns a list of all available SocketCAN interfaces (which can be used for createDevice() ):

QString errorString;
const QList<QCanBusDeviceInfo> devices = QCanBus::instance()->availableDevices(
    QStringLiteral("socketcan"), &errorString);
if (!errorString.isEmpty())
    qDebug() << errorString;

See also


The function returns a tuple of (device_list, error_string).

createDevice(plugin, interfaceName)#
  • plugin – str

  • interfaceName – str

Return type:


Creates a CAN bus device. plugin is the name of the plugin as returned by the plugins() method. interfaceName is the CAN bus interface name. In case of failure, the optional parameter errorMessage returns a textual error description.

Ownership of the returned plugin is transferred to the caller. Returns nullptr if no suitable device can be found.

For example, the following call would connect to the SocketCAN interface vcan0:

QString errorString;
QCanBusDevice *device = QCanBus::instance()->createDevice(
    QStringLiteral("socketcan"), QStringLiteral("vcan0"), &errorString);
if (!device)
    qDebug() << errorString;


The interfaceName is plugin-dependent. See the corresponding plugin documentation for more information: CAN Bus Plugins . To get a list of available interfaces, availableDevices() can be used.

The function returns a tuple of (device, error_string).

static instance()#
Return type:


Returns a pointer to the QCanBus class. The object is loaded if necessary. QCanBus uses the singleton design pattern.

Return type:

list of strings

Returns a list of identifiers for all loaded plugins.