diff options
| author | Andre Hartmann <aha_1980@gmx.de> | 2019-07-18 10:08:29 +0200 |
|---|---|---|
| committer | Andre Hartmann <aha_1980@gmx.de> | 2019-07-18 11:45:49 +0200 |
| commit | dd9b3d7ee62019d75764be7e49468976708f16fd (patch) | |
| tree | 8ab750409992c75f057c0d576a8cdcb757f22334 | |
| parent | 43d746c2c0c87c8694e835f3b052317c8fa02482 (diff) | |
PeakCAN: Update documentation for added CAN FD functions
When adding the CAN FD functions to the PeakCAN plugin in
ac8509d992f4, the documentation was not updated properly.
This patch catches up on that.
Change-Id: Ib3d05d4aa8405226ede9616bd56ead1a8f98ea88
Reviewed-by: Alex Blasche <alexander.blasche@qt.io>
| -rw-r--r-- | src/serialbus/doc/src/peakcan.qdoc | 19 |
1 files changed, 17 insertions, 2 deletions
diff --git a/src/serialbus/doc/src/peakcan.qdoc b/src/serialbus/doc/src/peakcan.qdoc index c8f52c9..fd12ab7 100644 --- a/src/serialbus/doc/src/peakcan.qdoc +++ b/src/serialbus/doc/src/peakcan.qdoc @@ -96,10 +96,25 @@ \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 */ |