diff options
-rw-r--r-- | src/serialbus/doc/src/peakcan.qdoc | 19 | ||||
-rw-r--r-- | src/serialbus/qcanbusframe.cpp | 12 |
2 files changed, 26 insertions, 5 deletions
diff --git a/src/serialbus/doc/src/peakcan.qdoc b/src/serialbus/doc/src/peakcan.qdoc index 624e09b..a38ddf7 100644 --- a/src/serialbus/doc/src/peakcan.qdoc +++ b/src/serialbus/doc/src/peakcan.qdoc @@ -99,11 +99,26 @@ \li Configuration parameter key \li Description \row + \li QCanBusDevice::CanFdKey + \li This configuration option determines whether CAN FD frames may be sent or + received. By default, this option is disabled. CAN FD compatible hardware + is needed to enable this option. + \row \li QCanBusDevice::BitRateKey \li Determines the bit rate of the CAN bus connection. The following bit rates are supported: 5000, 10000, 20000, 33000, 47000, 50000, 83000, 95000, - 100000, 125000, 250000, 500000, 800000, 1000000. Note that this configuration - parameter can only be adjusted while the QCanBusDevice is not connected. + 100000, 125000, 250000, 500000, 800000, 1000000. + If the QCanBusDevice::CanFdKey option is enabled, the bit rates are limited + to 125000, 250000, 500000, or 1000000. + Note that this configuration parameter can only be adjusted while the + QCanBusDevice is not connected. + \row + \li QCanBusDevice::DataBitRateKey + \li Determines the data bit rate of the CAN FD bus connection. The + QCanBusDevice::CanFdKey option must be enabled to allow setting this option. + Possible data bitrates are 2000000, 4000000, 8000000, or 10000000. Note that + this configuration parameter can only be adjusted while the QCanBusDevice is + not connected. \endtable PeakCAN supports the following additional functions: diff --git a/src/serialbus/qcanbusframe.cpp b/src/serialbus/qcanbusframe.cpp index 8ba0cc7..c62539e 100644 --- a/src/serialbus/qcanbusframe.cpp +++ b/src/serialbus/qcanbusframe.cpp @@ -80,9 +80,15 @@ QT_BEGIN_NAMESPACE /*! \fn QCanBusFrame::setFrameId(quint32 newFrameId) - Sets the identifier of the CAN frame to \a newFrameId. The maximum size of a CAN frame - identifier is 11 bits, which can be extended up to 29 bits by supporting the \e {CAN extended frame - format}. The \e {CAN extended frame format} setting is automatically adapted to match \a newFrameId. + Sets the identifier of the CAN frame to \a newFrameId. + + The maximum size of a CAN frame identifier is 11 bits, which can be + extended up to 29 bits by supporting the \e {CAN extended frame format}. + The \e {CAN extended frame format} setting is automatically set when a + \a newFrameId with more than 11 bits in size is given. + + When the format is extended and a \a newFrameId with up to 11 bits or less + is passed, the \e {CAN extended frame format} setting is \a not changed. \sa frameId(), hasExtendedFrameFormat() */ |