Introduction
Purpose of This Manual
This manual is the user's manual for the MicroPeckerX SocketCAN driver.
SocketCAN extends the Linux socket communication API and enables CAN communication in the same way as using Internet protocols via sockets.
How to Use This Manual
Each chapter explains how to install this product, sample scripts, and related topics.
If you have any questions, please refer to the FAQ or contact us.
However, technical inquiries regarding the MicroPeckerX SocketCAN driver require a separate paid support contract.
Terminology
The terms used in this manual are described below.
| Term | Description |
|---|---|
| CAN | Abbreviation for Controller Area Network. A communication protocol developed for in-vehicle networks. It is an international standard specified by ISO 11898. |
| CAN FD | Abbreviation for CAN with Flexible Data-rate. A communication protocol that extends CAN and enables faster and larger-capacity data transmission and reception. |
| BRS | Abbreviation for Bit Rate Switch. A CAN FD function that switches the data phase to a faster bit rate. |
| SocketCAN | The standard Linux CAN communication framework. It handles CAN devices as network interfaces and can work with can-utils and other tools. |
| Arbitration Baudrate | The transfer speed for the section that sends the frame identifier ID and similar information. In CAN FD, this is slower than the data phase. |
| Data Baudrate | The transfer speed for the data phase. This can be configured only for CAN FD. |
| Kernel module | A driver that can be dynamically added to the Linux kernel. The SocketCAN driver also falls into this category. |
| module parameter | A parameter specified when loading the driver. It specifies the default baud rate, termination, hardware timestamp, and similar settings. |
| hardware timestamp | Reception time information added on the device side. This driver supports reading receive timestamps. |
| can-utils | A standard utility set for handling CAN communication on Linux. It includes cansend, candump, and other tools. |
| mpdrv_run | A management script for the MicroPeckerX SocketCAN driver. It loads and unloads the driver, starts and stops channels, and checks the status. |
| start-all | A command of mpdrv_run. This is the normal startup method for starting can0 / can1 in sequence. |
| can0 / can1 | Examples of CAN interface names recognized on Linux. If another CAN interface already exists in the environment, different names may be used. |
| termination | CAN bus termination setting. This driver can enable or disable device-side termination with a module parameter. |
| SavvyCAN | Open-source CAN log analysis and send/receive software. It can visualize CAN bus communication with a GUI. |
| Wireshark | Network analysis software. It supports packet reception and analysis for various protocols, including CAN bus. |
| chmod | A Linux command for granting execution permission to files and scripts. |
| AppImage | A portable executable file format for Linux. Software can be run without installation. |
Notes on Using This Manual
- Reproducing, modifying, or translating part or all of this manual without permission from the copyright holder is prohibited except where permitted by copyright law.
- The information and images in this manual are current as of the time of writing and may differ from the latest product or product website content, such as wording or design.
- Company names and product names described in this manual are trademarks or registered trademarks of their respective companies.
Verified Operating Environment
The MicroPeckerX SocketCAN driver is used in a Linux SocketCAN environment.
An example of a verified operating environment is shown below.
| Item | Details |
|---|---|
| OS | Ubuntu 24.04.4 LTS (64-bit) |
| Kernel | 6.17.0-22-generic |
| Compiler | gcc 13.3.0 |
| Related tools | can-utils, iproute2 |
This manual uses can0 / can1 for explanation. In an environment where another CAN network interface already exists, the actual interface names may be other than can0 / can1. Check the actually assigned names with ip link or ./mpdrv_run status.