XW-AIOT/aiot-document
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
30 Commits 1 Branch 0 Tags
c71e8d31cf8aff7a581b2791dd68c441282bf2e4
Commit Graph

30 Commits

This Branch
This Branch
All Branches
Author SHA1 Message Date
lzh
c71e8d31cf docs: 基于源码分析重建 IoT 领域技术文档（8 篇） 
删除旧的规划性文档（01/02/03），替换为基于 viewsh-module-iot 模块
419 个 Java 文件全面分析生成的技术现状文档，覆盖：
- 模块架构全景、数据流、存储架构、Redis Key 清单
- 设备接入网关（MQTT/EMQX/HTTP/TCP + 7 种编解码器）
- 产品与设备管理（CRUD/状态机/认证/TDengine 双写）
- 物模型管理（9 种数据类型体系、TSL、DDL 联动）
- 规则引擎（数据转发/场景联动/数据清洗三链路）
- 告警与 OTA 升级（状态机、Quartz 调度）
- 消息总线与集成事件（Local/Redis/RocketMQ 三实现）
- API 契约与枚举汇总（5 Feign 接口、30+ 枚举）

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
 2026-04-09 23:20:31 +08:00
lzh
a1c34b4c83 docs: 扩展接口分域与维护原则文档 
- 补充接口分域架构（四大核心域）
- 补充接口 URL 规范和禁止事项
- 补充 Swagger 注解规范和变更流程
- 补充版本管理策略和跨域处理原则
- 补充 Swagger UI 地址和 OpenAPI 导出
 2026-04-07 19:55:13 +08:00
lzh
c5d100f1d4 docs: 添加 AIOT 架构可视化图片 
- 在 01-总体架构设计.md 中插入架构概念图
- 图片尺寸：2816x1536 (2K)
- 内容：三层架构可视化（客户端层 → 网关层 → 微服务层 → 数据层）
 2026-04-07 15:35:06 +08:00
lzh
0b645c72fc docs: 修复导航与架构文档中的错误引用 
- 00-阅读地图：修正协作规范文档路径
- 01-总体架构设计：修正引用路径

第二轮迭代审阅中...
 2026-04-07 13:59:14 +08:00
lzh
1c7ea60f1e docs: 清理前端重复文档 + 补全 Enum 汇总 
04-前端开发：
- 删除重复的短文件（02-API 交互、03-RBAC）
- 保留完整扩展版本（24KB + 21KB）

08-附录：
- 新增 03-Enum 汇总.md
  - 工单状态枚举（WorkOrderStatusEnum + OrderStatus）
  - 工单类型、优先级、触发来源
  - 状态流转 Mermaid 图
  - Java/TypeScript 对照
 2026-04-07 13:53:45 +08:00
lzh
b61896d3ba docs: 移动端开发文档扩展 + 附录术语表/错误码 
05-移动端开发：
- 01-移动端工程结构与页面分域.md
  - 补充 UniApp 分包策略（主包 2MB 限制）
  - 页面路由配置与生命周期规范
  - Token 双 Token 无感刷新逻辑
  - 内存泄漏防护清单

- 02-硬件交互与弱网离线策略.md
  - 智能工牌蓝牙通信协议（BadgeStatus/NotifyType）
  - iBeacon 协议格式与信标配置
  - 蓝牙扫描 Hook 实现（useBluetoothScan）
  - 权限处理与超时机制

08-附录：
- 01-术语表.md
  - IoT 设备术语（工牌、信标、RSSI）
  - 工单状态机（Mermaid 状态图）
  - 优先级与触发来源
  - 移动端 BLE 术语

- 02-错误码清单.md
  - 后端统一错误码（全局 + OPS 模块）
  - 前端 ResultEnum 状态码
  - 蓝牙扫描状态与错误处理
  - 错误码对照速查表
 2026-04-07 13:45:03 +08:00
lzh
7fb3aea295 docs: 清理重复文件并完善协作规范 
- 删除 06-平台支撑 下重复的短文件目录（已被完整文档替代）
- 新增 07-协作规范 系列文档：
  - 01-代码仓协作边界.md
  - 02-开发工作流与-Git-规约.md
  - 03-文档回补触发清单.md
  - 04-代码评审与提测标准.md
 2026-04-07 13:02:02 +08:00
lzh
2d6d1079a4 docs(前端): 重构 API 交互与 RBAC 权限控制文档 
- 02-API 交互与状态管理规范.md (21.6KB):
  - 完整的 Axios 封装（请求/响应拦截器、错误处理）
  - API 模块化管理规范（按业务域组织）
  - 完整的工单 API 示例（类型定义 + 方法封装）
  - Pinia Store 使用规范（用户 Store、字典 Store）
  - 文件上传实现（单文件/多文件）
  - 异常处理最佳实践

- 03-RBAC 权限控制与开发规范.md (16.6KB):
  - 权限体系架构（菜单级、按钮级、数据级）
  - 动态路由加载流程（含 Mermaid 时序图）
  - v-hasPermi 指令完整实现
  - usePermission Hook 使用示例
  - 数据权限（Data Scope）前端处理
  - 权限配置同步流程
  - 常见坑点与排障指南
 2026-04-07 12:40:04 +08:00
lzh
8a4aafd71f docs: 完善前端开发指南与平台支撑文档 
- 新增 04-前端开发/04-常见坑点与调试指南.md
  - 高频踩坑记录（路由、Pinia、表格分页、权限指令）
  - 调试技巧与性能优化建议
  - 开发环境配置指南

- 扩展 06-平台支撑/07-API 文档/01-接口分域与维护原则.md
  - 接口分域架构（system/infra/ops/iot）
  - Swagger 注解规范与变更流程
  - 接口版本管理与跨域处理

- 扩展 06-平台支撑/08-数据库/01-数据域划分与表关系思路.md
  - 三大核心数据域（SYSTEM/OPS/IoT）
  - 核心表结构 SQL（用户、工单、设备、物模型）
  - 跨域关联原则与索引设计规范

- 扩展 06-平台支撑/09-DevOps 运维/01-部署运行与排障视角.md
  - 系统分层架构图
  - 排障决策树与各层检查清单
  - 常用诊断命令速查

- 扩展 06-平台支撑/09-DevOps 运维/02-环境部署指南.md
  - 四环境规划（Dev/Test/Staging/Prod）
  - 本地开发环境部署详解
  - Jenkins 自动部署流程与 Docker 配置
  - 生产部署检查清单与回滚流程
 2026-04-07 12:35:49 +08:00
lzh
21126ab49d docs(移动端): 重构硬件交互与工程结构文档 
- 01-移动端工程结构与页面分域.md: 补充完整目录结构、分包策略、生命周期规约、状态管理设计
- 02-硬件交互与弱网离线策略.md: 基于真实代码重写，包含：
  - BLE 通信协议与 GATT 服务定义
  - BleManager 完整实现（连接、指令、事件监听）
  - 信标感应与到岗打卡时序图
  - 离线操作队列实现（Stale-while-revalidate）
  - 弱网图片上传策略
  - 调试排障指南
 2026-04-07 12:30:48 +08:00
lzh
a702235244 docs: 完成前端、移动端、平台支撑核心文档建设，建立全量开发者文档体系 2026-04-07 01:53:41 +08:00
lzh
6c3216cfd1 docs(fe&mobile): 完成前端与移动端核心工程结构、API规范与弱网交互策略建设 2026-04-07 01:34:29 +08:00
lzh
895cb01860 docs(ops): 补充基于楼层(floorNo)重新计算出队分数的业务设计 2026-04-07 00:39:23 +08:00
lzh
3e7e10f3cc docs(ops): 精简工单队列文档，只保留源码中真实存在的内容 2026-04-07 00:14:55 +08:00
lzh
4bd3b680a7 docs(ops): 重构工单队列系统文档，补充区域楼层模型和区域优先派单策略 2026-04-07 00:06:02 +08:00
lzh
105455ae27 docs(ops): 重构Ops领域文档结构，提取工单队列为公共基础设施文档 2026-04-06 23:58:05 +08:00
lzh
4b22d6a565 fix(docs): 修复 Mermaid 流程图语法解析错误 2026-04-06 23:51:46 +08:00
lzh
cfe83e734c docs(ops): 新增保洁巡检业务文档，剖析基于蓝牙信标的LBS校验及基于停留时长的归属判定算法 2026-04-06 23:44:36 +08:00
lzh
90cd2a7369 docs(ops): 补充保洁工单队列完整描述，引入OrderQueueStatusEnum、PriorityEnum和queueScore排序机制 2026-04-06 23:27:29 +08:00
lzh
ca544ca61a docs(iot): 基于真实代码重置IoT文档，引入Codec协议、物模型元素、场景规则引擎等底层逻辑 2026-04-06 23:11:55 +08:00
lzh
e5fa0462c5 docs(ops): 更新安保与维修业务文档，对齐底层工牌与信标感应逻辑 2026-04-06 23:04:58 +08:00
lzh
7082d01b0f docs(ops): 基于真实代码重写 Ops 文档，引入工牌(BADGE)与信标(BEACON)硬件调度逻辑 2026-04-06 23:04:47 +08:00
lzh
4337a5e3f1 docs(iot): 建设设备接入、物模型及联动策略主干规范 2026-04-06 23:01:39 +08:00
lzh
dec2b06d74 docs(ops): 深化保洁、安保核心链路与工单流转细节 2026-04-06 23:01:05 +08:00
lzh
abd15d842b docs(architecture): 重写总体技术架构图，新增业务架构与数据流转链路 2026-04-06 22:47:42 +08:00
lzh
63886a4e76 docs(nav): 移除不再需要的骨架重构说明 2026-04-06 22:43:56 +08:00
lzh
b8fb5ad761 docs(nav): 完成 四篇核心文档（阅读地图、项目总览、项目当前状态、代码仓协作边界 2026-04-06 22:33:57 +08:00
lzh
58bcb7b90b docs(ops): 补充工单生命周期、保洁/安保业务核心链路 2026-04-06 13:31:17 +08:00
lzh
2e9372bfac docs: 重构开发者文档骨架并增强入口导航 2026-04-06 00:22:42 +08:00
lzh
5ea1a0c70c 初始化项目文档结构：分离开发者文档和用户手册 2026-03-26 10:40:23 +08:00