Introduction
Purpose of This Document
This document is the user's manual for MicroPeckerX Application Development Library for Linux.
By using this product, you can develop Linux applications for monitoring and simulating CAN, CAN FD, or LIN communication with MicroPeckerX.
Up to four MicroPeckerX units can be controlled.
How to Use This Document
Each chapter describes the definitions, API functions, and other information for this product.
If you have any questions, refer to the FAQ or contact us.
However, technical inquiries about MicroPeckerX Application Development Library for Linux require a separate paid support contract.
Terminology
Terms used in this document 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, larger-capacity data transmission and reception. It is standardized as ISO 11898-1:2015. |
| LIN | Abbreviation for Local Interconnect Network. A communication protocol developed to reduce the cost of in-vehicle networks. It is an international standard specified by ISO 17987. |
| API | Abbreviation for Application Programming Interface. Specifications and interfaces for interacting with software and devices. |
| Monitoring | Monitoring and recording communication contents in real time. In MicroPeckerX, this function monitors communication data on CAN/CAN FD/LIN buses. |
| Simulation | Reproducing or testing communication that imitates actual devices or vehicles. In MicroPeckerX, tests can be performed by transmitting arbitrary CAN/CAN FD/LIN frames. |
| Frame | One unit of communication data. In CAN/CAN FD/LIN, a frame consists of an ID, data body, and other fields. |
| Channel (CH) | A physical communication port on MicroPeckerX (such as CH1/CH2). |
| API mode | One log acquisition method. Logs are acquired by periodically calling API functions. |
| Callback mode | One log acquisition method. Log information is automatically passed through a callback function at fixed intervals. |
| Baudrate | Unit of communication speed. Indicates the number of bits that can be transmitted per second (bps). Typical values are 500 kbps or 1 Mbps for CAN, and 9600 bps or 19200 bps for LIN. |
| Sample point | The point that indicates when CAN/CAN FD data bits are sampled. It affects communication quality and error reduction. |
| Termination resistor | A 120 ohm resistor connected to both ends of the CAN bus. It is required to prevent communication waveform distortion. |
| Bit rate switch (BRS) | A high-speed data transfer function specific to CAN FD that increases the transfer speed only for the data phase. |
| FD format (FDF) | A bit used to identify CAN FD frames. |
| Error flag | An indicator showing that an error occurred in a frame or communication state. |
| Buffer overrun | A state in which temporary storage (buffer) becomes full and new data cannot be stored. This can cause data loss. |
| Remote transmission request (RTR) | A CAN frame type that only requests data. It is distinguished from data transmission frames. |
| ID format (IDE) | Indicates the CAN ID format. There are standard ID (11-bit) and extended ID (29-bit) formats. |
| Data length code (DLC) | A 4-bit value indicating the length of the frame data field. |
| Arbitration baudrate | Transfer speed for the portion that sends the frame identification (ID) and other fields in CAN/CAN FD. In CAN FD, this is slower than the data phase. |
| Data baudrate | Transfer speed of the data phase. It can be configured only for CAN FD. |
| Slot | A logical unit for setting transmission data and trigger conditions in CAN/CAN FD. Individual frame settings can be configured for each slot. |
| Trigger | A signal or event that starts frame transmission or similar processing under certain conditions. |
Notes on Using This Document
- Reproducing, modifying, or translating all or part of this document without permission from the copyright holder is prohibited except as permitted by copyright law.
- Information and images in this document are current as of the time of writing and may differ from the latest product or product website content, such as text or design.
- Company names and product names in this document are trademarks or registered trademarks of their respective companies.
Operating Environment
Basic Requirements
| Item | Description |
|---|---|
| OS | Linux |
| CPU Architecture | x86 (64-bit/32-bit) (*1) Arm v7-A, v8-A |
| Development Environment | GNU C++ (G++) Python |
| Memory | 512 MB or more |
| USB Port | USB 2.0 (Hi-Speed) (*2)(*3) |
*1: Operation in virtual environments is not supported.
*2: When connecting multiple MicroPeckerX units, the same number of USB ports as the number of units is required.
*3: When connecting MicroPeckerX through an external USB hub, be sure to use a self-powered device and connect it with external power supplied.
If MicroPeckerX is connected while the USB hub is bus-powered, it may not operate or may operate unstably.
Verified Environments
The environments in which we have verified operation are listed below. This list does not indicate whether the product will operate in environments not listed below.
| Equipment Used for Verification | OS/Distribution | Kernel | CPU Architecture | Development Environment |
|---|---|---|---|---|
| x86-based PC | Ubuntu 24.04 (64-bit) | Linux 7.0.0-28-generic | x86 | gcc 13.3.0, glibc 2.39 |
| Raspberry Pi 5 | Raspberry Pi OS (Debian GNU/Linux 13 64-bit) | Linux 6.18.34+rpt-rpi-2712 | Arm v8-A | gcc 14.2.0, glibc 2.41 |
On Linux, operating conditions may vary depending on the distribution, version, system configuration, and other factors. In addition, the sample program environment setup procedures described in this document are provided solely as examples for specific environments. Adapt the settings and commands as appropriate for your environment and take any necessary action.