summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorAndre Hartmann <aha_1980@gmx.de>2016-07-14 20:27:43 +0200
committerAndré Hartmann <aha_1980@gmx.de>2016-07-15 11:08:36 +0000
commit0807ab21c1578b3ffcf808d287a1efc4f59401ad (patch)
treef4ad378b550af3c2a98e9a70cfad360877ce71ea /src
parentc159fe0ca7b0b0c20332f6d517b0f9b33fb2c218 (diff)
CAN: Amend Tiny CAN documentation
Change-Id: Iaadc554311f9c2dfd3f5c9d2970251a7ace3378b Reviewed-by: Alex Blasche <alexander.blasche@theqtcompany.com>
Diffstat (limited to 'src')
-rw-r--r--src/serialbus/doc/src/qtcanbus-backends.qdoc2
-rw-r--r--src/serialbus/doc/src/tinycan.qdoc17
2 files changed, 9 insertions, 10 deletions
diff --git a/src/serialbus/doc/src/qtcanbus-backends.qdoc b/src/serialbus/doc/src/qtcanbus-backends.qdoc
index 736e8f5..a2f504e 100644
--- a/src/serialbus/doc/src/qtcanbus-backends.qdoc
+++ b/src/serialbus/doc/src/qtcanbus-backends.qdoc
@@ -64,7 +64,7 @@
\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/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