Python-DOIP客户端技术手册

---

安装指南

基于pip安装

对于希望快速开始的用户，可以通过Python包管理器pip轻松安装doipclient库。在命令行中输入以下命令即可完成安装：

pip install doipclient

从源代码运行测试及安装

若需要参与项目开发或验证其功能完整性，首先确保已具备pytest及其mock扩展。通过以下步骤安装这些依赖项，并执行测试：

pip install pytest pytest-mock
pytest

之后，若想直接从源码安装项目以供本地使用，可跳过上述测试直接执行安装：

git clone https://github.com/jacobschaer/python-doipclient.git
cd python-doipclient
pip install .

项目使用说明

doipclient是一个专为现代汽车ECU通过车载以太网进行诊断通信而设计的纯Python 3库。它遵循ISO-13400标准（2019），适用于短连接同步客户端场景。

快速启动示例

以下代码段展示如何利用doipclient与UDSonCAN库结合，实现对ECU的基本诊断操作：

import udsoncan
from doipclient import DoIPClient
from doipclient.connectors import DoIPClientUDSConnector

# 初始化配置
udsoncan.setup_logging()
ecu_ip = '127.0.0.1'  # ECUs的实际IP地址
ecu_logical_address = 0x00E0  # ECUs逻辑地址

# 创建并连接DoIP客户端
doip_client = DoIPClient(ecu_ip, ecu_logical_address)
conn = DoIPClientUDSConnector(doip_client)

with udsoncan.Client(conn, request_timeout=2) as client:
    try:
        # 执行服务请求，如切换会话、安全访问解锁等
        client.change_session(3)  # 切换到扩展诊断会话
        client.unlock_security_access(5)  # 解锁安全级别，数值依据实际需求设定
        client.write_data_by_identifier(0xF190, 'ABC123456789')  # 修改VIN
        print('VIN修改成功。')
        
        # 发送ECU重置指令
        client.ecu_reset(1)  # 硬重置ECU
        
    except udsoncan.exceptions.NegativeResponseException as e:
        print(f'服务请求{e.response.service}被拒绝，错误代码：{e.response.code_name}(0x{e.response.code:02x})')
    except (udsoncan.exceptions.InvalidResponseException, udsoncan.exceptions.UnexpectedResponseException) as e:
        print(f'收到无效响应：{e.response.original_payload}')
    
    finally:
        # 断开连接和清理资源
        doip_client.close()

项目API使用文档

虽然详细的API文档建议参考官方ReadTheDocs页面（缺失链接，但应指向https://python-doipclient.readthedocs.io/），核心类DoIPClient提供了关键接口，如初始化时指定ECU的IP和逻辑地址，reconnect()用于重新建立连接，以及close()来关闭连接。DoIPClientUDSConnector作为适配器类，将DoIP客户端与UDSonCAN或其他UDS协议客户端连接起来。

总结

本技术手册概览了doipclient的安装方法，基本使用流程，以及如何通过示例进行初步实践。此库是现代车辆网络诊断的强大工具，尤其适合那些需要通过Diagnostic over IP (DoIP)协议与汽车电子控制单元互动的开发者。深入理解和应用这些概念将使您能够在汽车诊断和通讯领域得心应手。