diff options
Diffstat (limited to 'src/serialbus/doc/src/socketcan.qdoc')
| -rw-r--r-- | src/serialbus/doc/src/socketcan.qdoc | 24 |
1 files changed, 20 insertions, 4 deletions
diff --git a/src/serialbus/doc/src/socketcan.qdoc b/src/serialbus/doc/src/socketcan.qdoc index df58dae..e578969 100644 --- a/src/serialbus/doc/src/socketcan.qdoc +++ b/src/serialbus/doc/src/socketcan.qdoc @@ -179,9 +179,13 @@ By default, the connection is configured to accept any CAN bus message. \row \li QCanBusDevice::BitRateKey - \li This configuration is not supported by the socketcan plugin. However - it is possible to set the rate when configuring the CAN network interface using - the \c {ip link} command. + \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. To set + this configuration parameter, the library libsocketcan is needed at runtime + http://www.pengutronix.de/software/libsocketcan + Usually, root rights are needed to set the CAN bus bitrate. \row \li QCanBusDevice::CanFdKey \li This configuration option determines whether CANFD frames may be sent or received. @@ -192,6 +196,10 @@ \li This configuration is not supported by the socketcan plugin. However it is possible to set the data rate when configuring the CAN network interface using the \c {ip link} command. + \row + \li QCanBusDevice::ProtocolKey + \li Allows to use another protocol inside the protocol family PF_CAN. The default + value for this configuration option is CAN_RAW (1). \endtable For example: @@ -199,4 +207,12 @@ \snippet snippetmain.cpp SocketCan Filter Example Extended frame format and flexible data-rate are supported in SocketCAN. - */ + + SocketCAN supports the following additional functions: + + \list + \li QCanBusDevice::resetController() (needs libsocketcan) + \li QCanBusDevice::busStatus() (needs libsocketcan) + \endlist + +*/ |