中文

can_uds is an RT-Thread-oriented ISO 14229-1 / UDS server-side integration repository focused on the ECU / server side. The repository currently provides:

• a generic UDS / ISO-TP protocol core and headers
• an RT-Thread port layer and runtime environment
• a set of mountable business services under service/
• example applications, including a base example and a 0x2A + ULOG periodic-streaming example

The repository contents are centered on the RT-Thread server component, and this README has been rewritten to match the code that actually exists today.

Typical use cases include:

• MCU / ECU diagnostics
• production-line test, after-sales maintenance, and remote service
• DID-backed parameter access
• 0x2F I/O control
• periodic data or log streaming through 0x2A
• remote console execution through 0x31
• file read/write workflows through 0x34 ~ 0x38

This is not just a bare protocol core. It is a practical RT-Thread UDS integration framework.

can_uds/
├── examples/
├── service/
├── docs/
│   ├── zh/
│   └── en/
├── iso14229.c
├── iso14229.h
├── iso14229_rtt.c
├── iso14229_rtt.h
├── rtt_uds_config.h
├── Kconfig
├── SConscript
├── README.md
├── README_en.md
└── package.json

This repository mainly provides a UDS server (ECU-side) implementation.

If you need a corresponding diagnostic client (tester), refer to the Linux example below:

👉 https://github.com/wdfk-prog/iso14229/tree/rtt/examples/rtt_server/client_demo

This demo is based on Linux + SocketCAN / ISO-TP and can be used for:

• Integration testing with this server
• Verifying UDS services (0x10 / 0x22 / 0x31 / file transfer, etc.)
• Serving as a base for production or debugging tools

Recommendation: use this client_demo during early bring-up and protocol validation.

1. Enable the package and the services you need in menuconfig.
2. Make sure the BSP CAN driver can send and receive frames correctly.
3. Create the runtime environment with rtt_uds_create().
4. Mount services with rtt_uds_*_service_mount().
5. Feed received CAN frames into the stack with rtt_uds_feed_can_frame().

#include "rtt_uds_service.h"

static rtt_uds_env_t *g_env;

RTT_UDS_SEC_SERVICE_DEFINE(security_service, 0x01, 0xA5A5A5A5);
RTT_UDS_IO_SERVICE_DEFINE(io_service);
RTT_UDS_FILE_SERVICE_DEFINE(file_service);
RTT_UDS_0X2A_SERVICE_DEFINE(periodic_service);

static int uds_app_init(void)
{
    rtt_uds_config_t cfg = {0};

    g_env = rtt_uds_create(&cfg);
    if (g_env == RT_NULL)
    {
        return -RT_ERROR;
    }

    rtt_uds_sec_service_mount(g_env, &security_service);
    rtt_uds_io_service_mount(g_env, &io_service);
    rtt_uds_file_service_mount(g_env, &file_service);
    rtt_uds_0x2a_service_mount(g_env, &periodic_service);

    return RT_EOK;
}

For a guided setup path, see docs/en/quick-start.md.

The complete API reference (HTML) is published through GitHub Pages:

➡️ https://wdfk-prog.space/can_uds/

• Architecture
• Quick Start
• Service Guide
• DID Design
• File Transfer
• Console Service
• 0x2A Periodic Service
• Porting Notes

See README_ZN.md for the Chinese entry, or go directly to docs/zh/.