diff options
| author | Andre Hartmann <aha_1980@gmx.de> | 2016-07-14 21:14:17 +0200 |
|---|---|---|
| committer | André Hartmann <aha_1980@gmx.de> | 2016-07-15 12:19:23 +0000 |
| commit | 0b0caa7b1ebcd72a520148fe2a36b92eab12610e (patch) | |
| tree | 08488cc399e69b827b23346125ea937bb4d0338c /src | |
| parent | 0807ab21c1578b3ffcf808d287a1efc4f59401ad (diff) | |
CAN: Amend SocketCAN documentation
Change-Id: Iaa89eeae6c98d20719528acd6198ad10923205a2
Reviewed-by: Alex Blasche <alexander.blasche@theqtcompany.com>
Diffstat (limited to 'src')
| -rw-r--r-- | src/serialbus/doc/src/socketcan.qdoc | 16 |
1 files changed, 8 insertions, 8 deletions
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. */ |