diff options
Diffstat (limited to 'src/serialbus/doc/src/peakcan.qdoc')
| -rw-r--r-- | src/serialbus/doc/src/peakcan.qdoc | 15 |
1 files changed, 13 insertions, 2 deletions
diff --git a/src/serialbus/doc/src/peakcan.qdoc b/src/serialbus/doc/src/peakcan.qdoc index fd12ab7..a38ddf7 100644 --- a/src/serialbus/doc/src/peakcan.qdoc +++ b/src/serialbus/doc/src/peakcan.qdoc @@ -34,8 +34,9 @@ \l{http://www.peak-system.com/}{PEAK-System} CAN adapters. This plugin requires the PCAN device drivers and the PCAN-Basic library - version 4.0.0 or higher. Supported platforms are Windows (pcanbasic.dll) - and Linux (libpcanbasic.so). + version 4.0.0 or higher on Windows (pcanbasic.dll) and Linux (libpcanbasic.so). + On macOS the plugin requires the PCBUSB library from + \l{http://www.mac-can.com}{UV Software}. \section1 Creating CAN Bus Devices @@ -70,6 +71,8 @@ \note Only the USB and PCI adapters are currently supported by this plugin. + \note On macOS, only USB adapters are currently supported by this plugin. + The device is now open for writing and reading CAN frames: \code @@ -117,4 +120,12 @@ this configuration parameter can only be adjusted while the QCanBusDevice is not connected. \endtable + + PeakCAN supports the following additional functions: + + \list + \li QCanBusDevice::resetController() + \li QCanBusDevice::busStatus() + \endlist + */ |