PySide6.QtSerialBus.QCanBusDeviceInfo

class QCanBusDeviceInfo

The QCanBusDeviceInfo provides information about CAN bus interfaces. More…

Synopsis

Methods

Note

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:/bugreports.qt.io/projects/PYSIDE

Detailed Description

Each plugin may support one or more interfaces with different capabilities. This class provides information about available functions.

__init__(other)
Parameters:

other – QCanBusDeviceInfo

Constructs a copy of other.

alias()
Return type:

str

Returns a user defineable alias associated with this CAN bus interface.

Some CAN bus interfaces can have a user defined alias associated. This is mostly done with the CAN hardware vendors tools. The alias allows to identify this hardware later, especially when multiple interfaces are connected.

Note

In contrast to serialNumber() , the alias is not guaranteed to be unique.

If this function is not supported by the CAN plugin, an empty string is returned.

See also

serialNumber()

channel()
Return type:

int

Returns the sequential channel number of the CAN bus interface, starting with zero. For example, a two channel CAN interface may have the channels 0 and 1. If the interface has only one channel or if no information about the channel is available, zero is returned.

description()
Return type:

str

Returns a textual description of the CAN bus interface, if available. Example output: “PCAN USB Pro FD”. If no description is available, an empty string is returned.

hasFlexibleDataRate()
Return type:

bool

Returns true, if the CAN bus interface is CAN FD (flexible data rate) capable.

If this information is not available, false is returned.

isVirtual()
Return type:

bool

Returns true, if the CAN bus interface is virtual (i.e. not connected to real CAN hardware).

If this information is not available, false is returned.

name()
Return type:

str

Returns the interface name of this CAN bus interface, e.g. “can0”.

This corresponds to the interfaceName parameter of createDevice() .

plugin()
Return type:

str

Returns the plugin name of this CAN bus interface, e.g. “peakcan”.

This corresponds to the plugin parameter of createDevice() .

serialNumber()
Return type:

str

Returns the serial number of the CAN bus interface as string, if available. Otherwise, an empty string is returned.

See also

alias()