Skip to content

变更历史

2025-11-28: 文档迁移

将蓝牙协议文档从原 WikiJS 文档中心迁移至基于 VitePress 的星云文档中心。

迁移内容

蓝牙协议 | 星云-文档中心(本地路径:~/projects/docs)迁移约 25 篇文档,分为 6 个阶段完成:

阶段内容文档数量
第一阶段基础搭建、目录结构设计2 篇示例
第二阶段协议基础(数据包格式、数据类型、加密签名、指令集、错误码)6 篇
第三阶段核心功能(设备管理、用户管理、锁操作)3 篇
第四阶段扩展功能(密码、卡片、指纹、人脸、掌静脉、遥控、事件记录、功能设置)8 篇
第五阶段高级功能(固件升级、数据同步、语音包、星图WiFi配网、第三方授权)6 篇
第六阶段SDK(C语言SDK)1 篇

主要改动

结构优化

  • 重新设计文档分类,从平铺结构改为层次化目录
  • 将原 struct.md 大文件拆分为 5 个独立文档(数据包格式、数据类型、加密签名、指令集、错误码)
  • 创建 5 个分类索引页,提供模块概述和快速导航

格式清理

  • 移除所有 WikiJS 格式的 frontmatter
  • 统一表格格式和代码块语言标识
  • 使用 VitePress 容器(tip/warning/danger/info)增强可读性
  • 添加 Mermaid 时序图辅助理解

命名规范化

  • 统一密钥命名:PublicKey(公钥)、PrivateKey(私钥)、SignKey(签名密钥)
  • 配网文档重命名:星图WiFi配网(starchart-configure)用于 SLS1 架构
  • 废弃文档处理:对讲WiFi配网(talk-configure)标记为已废弃,从导航移除

内容精简

  • 移除所有"相关文档"章节,依赖站点搜索功能
  • 移除索引页的"下一步"和"快速查询"章节
  • 简化时序图,移除过于细节的注释

鑫泓佳智能硬件通信协议文档