关于本文档
本文档面向使用 dlt698 库的开发者,提供 C++ 接口说明和 Python 使用指南。Python 章节以代码和简短说明为主,详细协议概念链接到现有 C++ 页面。
覆盖范围
阅读约定
- 接口签名以 C++ 声明形式给出,省略模板默认参数和导出宏。
- 使用指南(Python)使用 Python 代码;已开放能力复用同一 C++ 内核,不代表全部 C++ 接口都已开放。
Result<T>表示成功时用value()取值、失败时用error()取诊断;Result<void>只有成功与失败两种状态。- “执行器”指
IExecutor,会话的所有状态与回调都在其上串行执行。需要在执行器外等待结果时,使用同步客户机。 - 表格中的“返回 DAR=3”指协议原样返回的 DAR 数值,不是库自定义的错误码。
当前完成度
库目前是 0.x 阶段,核心编解码、基础会话、GET/SET/ACTION 普通与列表形式、对象服务、同步适配、TCP 与串口通道已经可用;记录查询、链路分帧、周期心跳和安全后端仍在推进。完整清单见协议覆盖范围。
文档描述的接口都可能随 0.x 阶段调整。涉及行为的变更会同步更新本文档与源码注释。
反馈
页面底部的编辑链接会跳转到 GitHub 对应文件。接口语义不清、示例无法编译或与实现不符时,建议直接提交 issue 或补充 PR。