QCanBus Class

Member Function Documentation

[since 6.8] QList<QCanBusDeviceInfo> QCanBus::availableDevices(QString *errorMessage = nullptr) const

Returns the available devices for all plugins, i.e. all available CAN interfaces.

In case of failure, the optional parameter errorMessage returns a textual error description.

This function was introduced in Qt 6.8.

See also createDevice().

QList<QCanBusDeviceInfo> QCanBus::availableDevices(const QString &plugin, QString *errorMessage = nullptr) const

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

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 createDevice().

QCanBusDevice *QCanBus::createDevice(const QString &plugin, const QString &interfaceName, QString *errorMessage = nullptr) const

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;
 else
     device->connectDevice();

See also availableDevices().

[static] QCanBus *QCanBus::instance()

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

QStringList QCanBus::plugins() const

Returns a list of identifiers for all loaded plugins.