Introduction
Purpose of This Document
This document is the user manual for the MicroPeckerX CAN FD Application Development Library for Windows.
By using this product, you can develop Windows applications that perform CAN and CAN FD monitoring and simulation with MicroPeckerX.
This manual is for a legacy version of the library. For new development, use the newer library below.
- Latest version: MicroPeckerX Application Development Library for Windows
How to Use This Document
Each chapter explains the 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
The terms used in this document are explained 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 extended CAN protocol that enables faster and larger data transfer. Standardized as ISO 11898-1:2015. |
| API | Abbreviation for Application Programming Interface. Specifications and interfaces used to communicate with software and devices. |
| Monitoring | Real-time monitoring and recording of communication content. In MicroPeckerX, this refers to monitoring CAN/CAN-FD bus communication data. |
| Simulation | Reproduction and testing of communication that emulates actual devices/vehicles. In MicroPeckerX, testing is performed by transmitting arbitrary CAN/CAN-FD frames. |
| Log Playback | A function to replay communication logs that were previously captured and recorded on the bus. Used for testing and verification. |
| Frame | A unit of communication data. In CAN/CAN-FD, a frame consists of elements such as ID and data payload. |
| Channel (CH) | Physical communication ports provided by MicroPeckerX (such as CH1/CH2). |
| API Mode | One method of log acquisition. Log information is obtained by periodically calling API functions. |
| Callback Mode | One method of log acquisition. Log information is automatically passed via callback functions at fixed intervals. |
| Baud Rate | Unit of communication speed. Indicates the number of bits transmitted per second (bps). Typical CAN values include 500 kbps and 1 Mbps. |
| Sample Point | The timing point at which a data bit is sampled. It affects communication quality and error reduction. |
| Termination Resistor | A 120-ohm resistor connected at both ends of a CAN bus. Required to prevent waveform distortion. |
| Bit Rate Switch (BRS) | A high-speed data transfer feature unique to CAN-FD that increases transfer speed only in the data phase. |
| FD Format (FDF) | A bit used to identify CAN-FD frames. |
| Error Flag | An indicator that an error has occurred in a frame or communication state. |
| Buffer Overrun | A condition where temporary storage (buffer) becomes full and cannot store new data, causing data loss. |
| Remote Transmission Request (RTR) | A CAN frame type used only to request data. It is different from a data transmission frame. |
| ID Format (IDE) | Indicates the CAN ID format. There are Standard ID (11-bit) and Extended ID (29-bit). |
| Data Length Code (DLC) | A 4-bit value indicating the length of the frame data field. |
| Arbitration Baud Rate | Transfer speed for the section that sends frame identification (ID), etc. In CAN-FD, it is lower than the data phase speed. |
| Data Baud Rate | Transfer speed of the data phase. Configurable only in CAN-FD. |
| Slot | A logical unit for configuring transmission data and trigger conditions. Individual frame settings can be defined for each slot. |
| Trigger | A signal or event that starts operations such as frame transmission when specific conditions are met. |
Notes on Using This Document
- Reproduction, modification, or translation of all or part of this document without permission of the copyright holder is prohibited, except as 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 product site content (wording, design, etc.).
- Company names and product names in this document are trademarks or registered trademarks of their respective companies.
Operating Environment
The operating environment for this product is shown below.
| Item | Description |
|---|---|
| *OS (1) | Microsoft Windows 11 (64-bit) Microsoft Windows 10 (64-bit) Microsoft Windows 8.1 (64-bit) |
| *Development Environment (2) | Microsoft Visual C++ (2012 or later recommended) Microsoft Visual C# (2012 or later recommended) Microsoft Visual Basic .NET (2012 or later recommended) Embarcadero C++ Builder (2010 or later recommended) Microsoft Excel (2013 or later) |
| CPU | Intel Core i5 equivalent or higher recommended |
| Hard Disk | 10 GB or more free space |
| Memory | 8 GB or more recommended |
| USB Port | USB 2.0 (Hi-Speed) supported (*2)(*3) |
| Login User | User with administrator privileges (required when installing USB driver) |
*1: Operation in virtual environments is not supported.
*2: When connecting multiple MicroPeckerX units, the same number of USB ports is required.
*3: When connecting MicroPeckerX through an external USB hub, always use a self-powered hub and connect it with external power supplied.
If a bus-powered USB hub is used, MicroPeckerX may not operate or may operate unstably.