目标
统一定义通讯与设备交互过程中的错误码、日志格式与记录策略,便于定位问题与联调。
<aside>
⚠️
后续扩展:本套“报错方案”后续可以补充错误码体系,并编写《错误说明与处理办法》说明书。
- 错误码命名规则
- 每个错误码的触发条件与影响范围
- 用户可执行的处理步骤
- 需要联系技术支持的条件与信息收集清单
</aside>
错误弹窗
- 示例
- 弹窗类型
- INFO:提示
- WARN:可恢复异常
- ERROR:需要中断或人工介入
- 弹窗内容建议
- 标题
- 简要信息
- 可选:详细信息
- 建议操作
- 错误上下文
日志
- 示例
- 日志级别
- DEBUG / INFO / WARN / ERROR
- 记录内容(可选其中各项部分输出)
- 时间戳
- 模块名
- 设备标识
- 请求与响应摘要
- 错误弹窗与错误信息
- 重试次数与耗时
关键场景建议记录
- 建连与断连
- 心跳超时
- 重连触发与结果
- FTP 上传下载开始/结束/失败
- 相机抓图与检测调用失败
- 机器人脚本下发与执行失败
输出