Introduction
Purpose of This Guide
This manual covers the MicroPeckerX CAN FD Application Development Library for Windows. By using this product you can develop Windows applications that monitor and simulate CAN and CAN FD communication with MicroPeckerX.
How to Use This Guide
Each chapter explains definitions for the library, API functionality, and related features. If you have questions, consult the FAQ or contact us. Please note that technical inquiries about the MicroPeckerX CAN FD Application Development Library for Windows require a separate paid support agreement.
Terminology
The following terms are used throughout this guide.
| Term | Description |
|---|---|
| CAN | Abbreviation for Controller Area Network, an automotive communication protocol defined by ISO 11898. |
| CAN FD | Abbreviation for CAN with Flexible Data-rate. Extends CAN to support higher data rates and payload sizes. Standardized as ISO 11898-1:2015. |
| API | Application Programming Interface. Specifies how software components interact with devices or other software. |
| Monitoring | Observing and recording communication in real time. MicroPeckerX can monitor CAN/CAN FD bus traffic. |
| Simulation | Reproducing or testing communication that mimics actual devices or vehicles. MicroPeckerX can transmit arbitrary CAN/CAN FD frames for testing. |
| Log replay | Re-transmitting previously captured communication logs onto the bus for testing and verification. |
| Frame | A single unit of communication that includes an ID and payload data in CAN or CAN FD. |
| Channel (CH) | A physical communication port on MicroPeckerX (for example, CH1 or CH2). |
| API mode | One log acquisition method where the application periodically calls API functions to fetch log information. |
| Callback mode | A log acquisition method where log information is delivered automatically through a callback function at fixed intervals. |
| Baud rate | Communication speed in bits per second (bps). Typical CAN speeds include 500 kbps and 1 Mbps. |
| Sample point | Timing point used when reading data bits. Affects communication quality and error reduction. |
| Termination resistor | A 120 Ω resistor connected to each end of the CAN bus to prevent signal reflections. |
| Bit rate switch (BRS) | A CAN FD feature that increases the data phase bit rate while keeping the arbitration phase slower. |
| FD format (FDF) | A flag bit that identifies a CAN FD frame. |
| Error flag | Indicator showing that a frame or communication state encountered an error. |
| Buffer overrun | State in which a buffer is full and cannot store new data, resulting in data loss. |
| Remote transmission request (RTR) | A CAN frame type used to request data without transmitting payload data. |
| ID format (IDE) | Indicates the CAN identifier format: standard ID (11-bit) or extended ID (29-bit). |
| Data length code (DLC) | Four-bit value that specifies the payload length of a frame. |
| Arbitration bit rate | Bit rate used during the arbitration field of a frame. For CAN FD it is slower than the data phase. |
| Data bit rate | Bit rate used during the data phase of a CAN FD frame. |
| Slot | Logical unit that defines transmission data or trigger conditions. Each slot can have individual frame settings. |
| Trigger | Signal or event that initiates an action such as frame transmission when specific conditions are met. |
Usage Notes
- Do not reproduce, modify, or translate this guide without permission from the copyright holder except as allowed by copyright law.
- Information and images in this guide reflect the state at the time of writing and may differ from the latest products or website content (including wording and design).
- Company names and product names mentioned are trademarks or registered trademarks of their respective owners.
System Requirements
Operating conditions for this product are shown below.
| Item | Details |
|---|---|
| OS (Note 1) | Microsoft Windows 11 (64-bit) Microsoft Windows 10 (64-bit) Microsoft Windows 8.1 (64-bit) |
| Development environment (Note 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 | At least 10 GB free space |
| Memory | 8 GB or more recommended |
| USB ports | USB 2.0 (Hi-Speed) ports (Notes 2 and 3) |
| Login account | User with administrator privileges (required when installing USB drivers) |
Note 1: Virtualized environments are not supported.
Note 2: If you connect multiple MicroPeckerX units, prepare the corresponding number of USB ports.
Note 3: When connecting MicroPeckerX through an external USB hub, use a self-powered hub and supply external power before connecting. Using a bus-powered hub may prevent operation or cause instability.