Introduction
Purpose of This Document
This document is the user manual for the MicroPeckerX CAN FD Application Development Library for Linux.
By using this product, you can develop Linux applications that perform CAN and CAN FD monitoring and simulation with MicroPeckerX.
How to Use This Document
Each chapter describes definitions and API functions of this product.
If you have any questions, refer to the FAQ or contact us.
Please note that technical inquiries related to the MicroPeckerX CAN FD Application Development Library for Windows require a separate paid support contract.
Glossary
Descriptions of terms used in this document are listed below.
| Term | Description |
|---|---|
| CAN | Abbreviation for Controller Area Network. A communication protocol developed for in-vehicle networks. International standard specified by ISO 11898. |
| CAN FD | Abbreviation for CAN with Flexible Data-rate. An extension of CAN that enables higher-speed and larger-capacity data transmission/reception. Standardized as ISO 11898-1:2015. |
| API | Abbreviation for Application Programming Interface. Specifications and interfaces for communicating with software and devices. |
| Monitoring | Real-time monitoring and recording of communication content. In MicroPeckerX, a function to monitor communication data on CAN/CAN-FD buses. |
| Simulation | Reproducing and testing communication that emulates actual equipment/vehicles. In MicroPeckerX, testing can be performed by transmitting arbitrary CAN/CAN-FD frames. |
| Log Replay | A function that replays previously captured and recorded communication logs on the bus. Used for testing and verification. |
| Frame | One unit of communication data. In CAN/CAN-FD, it consists of ID, payload, and other fields. |
| Channel (CH) | Physical communication port of MicroPeckerX (such as CH1/CH2). |
| API Mode | One method of log acquisition. Logs are acquired by periodically calling API functions. |
| Callback Mode | One method of log acquisition. Log information is automatically passed via callback function at fixed intervals. |
| Baud Rate | Unit of communication speed, indicating bits per second (bps). Typical CAN values include 500 kbps and 1 Mbps. |
| Sample Point | Timing point for reading data bits. Affects communication quality and error reduction. |
| Termination Resistor | A 120-ohm resistor connected at both ends of a CAN bus. Required to prevent signal waveform distortion. |
| Bit Rate Switch (BRS) | CAN-FD-specific high-speed data transfer feature that increases transfer speed only in the data phase. |
| FD Format (FDF) | Bit used to identify CAN-FD frames. |
| Error Flag | Indicator that an error occurred in a frame or communication state. |
| Buffer Overrun | State where temporary storage (buffer) is full and cannot store new data, causing data loss. |
| Remote Transmission Request (RTR) | A CAN frame type that requests data only, distinct from data transmission frames. |
| ID Format (IDE) | Indicates CAN ID format. There are Standard ID (11-bit) and Extended ID (29-bit). |
| Data Length Code (DLC) | 4-bit value indicating data field length of a frame. |
| Arbitration Baud Rate | Transfer speed in section that sends frame identifier (ID), etc. In CAN-FD, this is lower than data phase speed. |
| Data Baud Rate | Transfer speed of data phase. Configurable only in CAN-FD. |
| Slot | Logical unit for setting transmission data and trigger conditions. Frame settings can be configured per slot. |
| Trigger | Signal or event that starts frame transmission, etc., when certain conditions are met. |
Notes on Using This Document
- Reproduction, modification, or translation of part or all of this document without permission of the author is prohibited except where permitted by copyright law.
- Information and images in this document are current at the time of writing and may differ from the latest product or website content (wording, design, etc.).
- Company names and product names in this document are trademarks or registered trademarks of their respective companies.
Operating Environment
Operating environment of this product is as follows.
| Item | Description |
|---|---|
| Development Language | GNU C++ |
| PC | IBM PC/AT-compatible machine running Linux |
| Supported CPU Architecture | - x86 (64-bit/32-bit)[*1] - Arm v7-A, v8-A (Cortex-A53, Cortex-A57) |
| Verified Environment | - Ubuntu 18.04/20.04 (64-bit) x86 - Raspbian 32-bit (Raspberry Pi 3 Model B) |
| Hard Disk | 10 GB or more free space |
| Memory | 8 GB or more recommended |
| USB Port | USB 2.0 (Hi-Speed)[*2] |
*1: Operation in virtual environments is not supported.
*2: When connecting MicroPeckerX via external USB hub, always use a self-powered device and connect with external power supplied.
If MicroPeckerX is connected through a bus-powered USB hub, it may not operate or may become unstable.