summaryrefslogtreecommitdiffstats
path: root/src/serialbus/doc/src/tinycan.qdoc
diff options
context:
space:
mode:
Diffstat (limited to 'src/serialbus/doc/src/tinycan.qdoc')
-rw-r--r--src/serialbus/doc/src/tinycan.qdoc10
1 files changed, 6 insertions, 4 deletions
diff --git a/src/serialbus/doc/src/tinycan.qdoc b/src/serialbus/doc/src/tinycan.qdoc
index 97ceabb..43349dc 100644
--- a/src/serialbus/doc/src/tinycan.qdoc
+++ b/src/serialbus/doc/src/tinycan.qdoc
@@ -53,13 +53,15 @@
\code
QCanBusDevice *device = QCanBus::instance()->createDevice(
- QStringLiteral("tinycan"), QStringLiteral("channela"));
+ QStringLiteral("tinycan"), QStringLiteral("can0.0"));
device->connectDevice();
\endcode
- Where \e can0.0 is the active CAN interface name. TinyCAN provides the
- interfaces \e can0.0 and \e can0.1, which maps to INDEX_CAN_KANAL_A resp.
- INDEX_CAN_KANAL_B in the TinyCAN plugin.
+ Where \e can0.0 is the active CAN interface name. TinyCAN currently only provides
+ the interface \e can0.0, which maps to INDEX_CAN_KANAL_A in the TinyCAN plugin.
+
+ \note The function availableDevices() currently always returns one device
+ "can0.0" as there is no way to detect the available CAN adapters for now.
\note Only the USB adapters are currently supported by this plugin.