summaryrefslogtreecommitdiffstats
path: root/src/serialbus/doc
diff options
context:
space:
mode:
Diffstat (limited to 'src/serialbus/doc')
-rw-r--r--src/serialbus/doc/src/peakcan.qdoc17
-rw-r--r--src/serialbus/doc/src/qtcanbus-backends.qdoc4
-rw-r--r--src/serialbus/doc/src/socketcan.qdoc16
-rw-r--r--src/serialbus/doc/src/tinycan.qdoc17
4 files changed, 26 insertions, 28 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..a2f504e 100644
--- a/src/serialbus/doc/src/qtcanbus-backends.qdoc
+++ b/src/serialbus/doc/src/qtcanbus-backends.qdoc
@@ -60,11 +60,11 @@
\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)
- \li CAN bus backend using the Tiny-CAN adapters.
+ \li CAN bus backend using the MHS CAN adapters.
\endtable
\section1 Implementing a Custom CAN Plugin
diff --git a/src/serialbus/doc/src/socketcan.qdoc b/src/serialbus/doc/src/socketcan.qdoc
index 4a10ac7..a979103 100644
--- a/src/serialbus/doc/src/socketcan.qdoc
+++ b/src/serialbus/doc/src/socketcan.qdoc
@@ -47,20 +47,19 @@
}
\endcode
- Where, \e socketcan is the backend name.
+ Where \e socketcan is the backend name.
- Further, it is necessary to request from QCanBus the device with the active SocketCAN
- interface:
+ Next, a connection to a specific interface can be established:
\code
QCanBusDevice *device = QCanBus::instance()->createDevice("socketcan", QStringLiteral("can0"));
device->connectDevice();
\endcode
- Where, \e can0 is the active CAN interface name. CAN interfaces act like regular network interfaces
- on Linux systems and can be discovered using \c ifconfig.
+ Where \e can0 is the active CAN interface name. CAN interfaces act like regular
+ network interfaces on Linux systems and can be discovered using \c ifconfig.
- 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;
@@ -106,7 +105,8 @@
\row
\li QCanBusDevice::BitRateKey
\li This configuration is not supported by the socketcan backend. However
- it is possible to set the rate when configuring the CAN network interface using the \c {ip link} command.
+ it is possible to set the rate when configuring the CAN network interface using
+ the \c {ip link} command.
\row
\li QCanBusDevice::CanFdKey
\li This configuration option determines whether CANFD frames may be sent or received.
@@ -118,5 +118,5 @@
\snippet snippetmain.cpp SocketCan Filter Example
- Efficient frame format and flexible data-rate are supported in SocketCAN.
+ Extended frame format and flexible data-rate are supported in SocketCAN.
*/
diff --git a/src/serialbus/doc/src/tinycan.qdoc b/src/serialbus/doc/src/tinycan.qdoc
index c5156e4..da45775 100644
--- a/src/serialbus/doc/src/tinycan.qdoc
+++ b/src/serialbus/doc/src/tinycan.qdoc
@@ -31,7 +31,7 @@
\brief Overview of how to use the TinyCAN backend.
The TinyCAN backend encapsulates the low-level API to work with the
- \l{http://www.mhs-elektronik.de/}{Tiny-CAN} adapters.
+ \l{http://www.mhs-elektronik.de/}{MHS Elektronik} CAN adapters.
\section1 Creating CAN Bus Devices
@@ -46,22 +46,21 @@
}
\endcode
- Where, \e tinycan is the backend name.
+ Where \e tinycan is the backend name.
- Further, it is necessary to request from QCanBus the device with the active Tiny-CAN
- interface:
+ Next, a connection to a specific interface can be established:
\code
QCanBusDevice *device = QCanBus::instance()->createDevice("tinycan", QStringLiteral("channela"));
device->connectDevice();
\endcode
- Where, \e channela is the active CAN interface name. The Tiny-CAN API provides only two
- interfaces \e channela and \e channelb.
+ Where \e channela is the active CAN interface name. The TinyCAN backend
+ provides two interfaces, \e channela and \e channelb.
\note Only the USB 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;
@@ -79,7 +78,7 @@
QCanBusFrame frame = device->readFrame();
\endcode
- Tiny-CAN supports the following configurations that can be controlled through
+ TinyCAN supports the following configurations that can be controlled through
\l {QCanBusDevice::}{setConfigurationParameter()}:
\table
@@ -87,7 +86,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: 10000, 20000, 50000, 100000, 125000, 250000, 500000, 800000, 1000000.
\endtable