Introduction
Purpose of This Document
This document is the user manual for the MicroPeckerX Application Development Library for Windows.
With this product, you can develop Windows applications that perform CAN, CAN FD, or LIN monitoring and simulation using MicroPeckerX.
Up to 4 MicroPeckerX units can be controlled.
How to Use This Document
Each chapter explains definitions and API functions of this product.
If you have questions, check the FAQ or contact us.
Technical inquiries about the MicroPeckerX Application Development Library for Windows require a separate paid support contract.
Terminology
Terms used in this document are explained below.
| Term | Description |
|---|---|
| CAN | Abbreviation of Controller Area Network. Communication protocol developed for in-vehicle networks. International standard defined by ISO 11898. |
| CAN FD | Abbreviation of CAN with Flexible Data-rate. Extended CAN protocol enabling higher speed and larger data transmission. Standardized as ISO 11898-1:2015. |
| LIN | Abbreviation of Local Interconnect Network. Communication protocol developed to reduce cost of in-vehicle networks. International standard defined by ISO 17987. |
| API | Abbreviation of Application Programming Interface. Specifications and interfaces for interacting with software/devices. |
| Monitoring | Real-time monitoring and recording of communication contents. In MicroPeckerX, function to monitor communication data on CAN/CAN FD/LIN buses. |
| Simulation | Reproducing/testing communication that emulates real devices/vehicles. In MicroPeckerX, tests can be performed by transmitting arbitrary CAN/CAN FD/LIN frames. |
| Log Replay | Function to replay previously recorded communication logs on the bus, used for testing and verification. |
| Frame | One unit of communication data. In CAN/CAN FD/LIN, consists of ID, payload, etc. |
| Channel (CH) | Physical communication port on MicroPeckerX (for example, CH1/CH2). |
| API Mode | One log acquisition method. Logs are acquired by periodically calling API functions. |
| Callback Mode | One log acquisition method. Logs are automatically passed through callback function at fixed intervals. |
| Baud Rate | Unit of communication speed. Number of bits sent per second (bps). Typical values: 500 kbps/1 Mbps for CAN, 9600 bps/19200 bps for LIN. |
| Sample Point | Bit read timing point in CAN/CAN FD. Affects communication quality and error reduction. |
| Termination Resistor | 120-ohm resistor connected at both ends of CAN bus. Required to prevent waveform disturbance. |
| Bit Rate Switch (BRS) | CAN FD feature that increases transfer speed only in data section. |
| FD Format (FDF) | Bit used to identify CAN FD frame format. |
| Error Flag | Indicator that an error occurred in frame or communication state. |
| Buffer Overrun | State where temporary storage (buffer) is full and new data cannot be stored; can cause data loss. |
| Remote Transmission Request (RTR) | CAN frame type used only to request data. Different from data transmission frame. |
| ID Format (IDE) | Indicates CAN ID format: Standard ID (11-bit) or Extended ID (29-bit). |
| Data Length Code (DLC) | 4-bit value indicating frame data length. |
| Arbitration Baud Rate | Transfer speed in CAN/CAN FD arbitration section (ID, etc.). In CAN FD, slower than data section. |
| Data Baud Rate | Transfer speed of data section. Configurable only in CAN FD. |
| Slot | Logical unit for setting transmission data and trigger conditions in CAN/CAN FD. Frame settings can be configured per slot. |
| Trigger | Signal/event that starts frame transmission or other processing when conditions are met. |
Notes on Using This Document
- Reproduction, modification, or translation of this document (in whole or part) without author permission is prohibited, except where permitted by copyright law.
- Information and images in this document are based on the time of writing and may differ from latest product/site content.
- Company and product names in this document are trademarks or registered trademarks of their respective owners.
Operating Environment
Operating environment for this product is as follows.
| Item | Details |
|---|---|
| *OS (1) | Microsoft Windows 11 (64-bit) Microsoft Windows 10 (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 | USB2.0 (Hi-Speed) (*2)(*3) |
| Login User | User with administrator privileges (required for USB driver installation) |
*1: Virtual environments are not supported.
*2: When connecting multiple MicroPeckerX units, the same number of USB ports is required.
*3: When using an external USB hub, always use a self-powered hub with external power supplied.
If a bus-powered hub is used, operation may fail or become unstable.