diff options
author | Andre Hartmann <aha_1980@gmx.de> | 2016-07-14 20:18:28 +0200 |
---|---|---|
committer | André Hartmann <aha_1980@gmx.de> | 2016-07-15 09:14:01 +0000 |
commit | c159fe0ca7b0b0c20332f6d517b0f9b33fb2c218 (patch) | |
tree | cae917a36d138616f2c0162e160ab9b009b04583 /src | |
parent | 2858e6e488dc3dc69ec4a80d314bbd4f82e46854 (diff) |
CAN: Amend PEAK CAN documentation
Change-Id: I35988b74c11517f5f0e5f7ea11038ea69f5c569c
Reviewed-by: Alex Blasche <alexander.blasche@theqtcompany.com>
Diffstat (limited to 'src')
-rw-r--r-- | src/serialbus/doc/src/peakcan.qdoc | 17 | ||||
-rw-r--r-- | src/serialbus/doc/src/qtcanbus-backends.qdoc | 2 |
2 files changed, 9 insertions, 10 deletions
diff --git a/src/serialbus/doc/src/peakcan.qdoc b/src/serialbus/doc/src/peakcan.qdoc index 4ab8760..3b18393 100644 --- a/src/serialbus/doc/src/peakcan.qdoc +++ b/src/serialbus/doc/src/peakcan.qdoc @@ -31,7 +31,7 @@ \brief Overview of how to use the PeakCAN backend. The PeakCAN backend encapsulates the low-level API to work with the - \l{http://www.peak-system.com/}{PCAN} adapters. + \l{http://www.peak-system.com/}{PEAK-System} CAN adapters. \section1 Creating CAN Bus Devices @@ -46,23 +46,22 @@ } \endcode - Where, \e peakcan is the backend name. + Where \e peakcan is the backend name. - Further, it is necessary to request from QCanBus the device with the active PeakCan - interface: + Next, a connection to a specific interface can be established: \code QCanBusDevice *device = QCanBus::instance()->createDevice("peakcan", QStringLiteral("usbbus1")); device->connectDevice(); \endcode - Where, \e usbbus1 is the active CAN interface name. The PCAN API support eight USB - interfaces from \e usbbus1 to \e usbbus8 and eight PCI interfaces from \e pcibus1 to - \e pcibus8. + Where \e usbbus1 is the active CAN interface name. The PeakCAN backend supports + eight USB interfaces from \e usbbus1 to \e usbbus8 and eight PCI interfaces from + \e pcibus1 to \e pcibus8. \note Only the USB and PCI adapters are currently supported by this backend. - The device is now open and can be written and read: + The device is now open for writing and reading CAN frames: \code QCanBusFrame frame; @@ -88,7 +87,7 @@ \li Configuration parameter key \li Description \row - \li QDCanBusDevice::BitRateKey + \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 diff --git a/src/serialbus/doc/src/qtcanbus-backends.qdoc b/src/serialbus/doc/src/qtcanbus-backends.qdoc index 6f32c5e..736e8f5 100644 --- a/src/serialbus/doc/src/qtcanbus-backends.qdoc +++ b/src/serialbus/doc/src/qtcanbus-backends.qdoc @@ -60,7 +60,7 @@ \row \li PEAK-System \li \l {Using PeakCAN Backend}{PeakCAN} (\c peakcan) - \li CAN bus backend using the PCAN adapters. + \li CAN bus backend using the PEAK CAN adapters. \row \li MHS Elektronik \li \l {Using TinyCAN Backend}{TinyCAN} (\c tinycan) |