Skip to content

📄 文档资源

在线文档

开发文档

快速开始

核心教程

物联网模块

架构文档

协议驱动文档

API文档

接口文档

部署后可访问完整的API接口文档:

访问地址: http://你的域名/doc.html

包含内容:

  • RESTful API接口说明
  • 请求参数定义
  • 响应数据结构
  • 接口调用示例
  • 认证授权说明

API分类

设备管理API

  • 设备注册
  • 设备配置
  • 设备控制
  • 设备状态查询

数据采集API

  • 实时数据查询
  • 历史数据查询
  • 数据统计分析
  • 数据导出

系统管理API

  • 用户管理
  • 权限控制
  • 系统配置
  • 日志管理

离线文档

PDF文档下载

开发中

离线PDF文档正在制作中,敬请期待。

文档导出

您可以使用浏览器的"打印"功能将在线文档保存为PDF:

  1. 打开需要保存的文档页面
  2. Ctrl + P (Windows) 或 Cmd + P (Mac)
  3. 选择"另存为PDF"
  4. 点击保存

视频教程

访问 视频教程 页面观看完整的视频教学内容:

  • 快速入门视频
  • 功能演示视频
  • 开发实战视频
  • 问题排查视频

文档贡献

发现问题

如果您在文档中发现错误或不清晰的地方:

  1. 在Gitee仓库提交Issue
  2. 标注具体页面和问题描述
  3. 如有建议,请一并提供

改进文档

欢迎提交文档改进PR:

  1. Fork文档仓库
  2. 修改markdown文件
  3. 提交Pull Request

文档源码

本文档使用VitePress构建,源码在项目中:

bash
# 文档源码目录结构
doc/
├── .vitepress/     # VitePress配置
├── guide/          # 快速开始
├── doc/            # 开发教程
├── framework/      # 架构设计
├── driver/         # 协议驱动
├── vip/            # 商业功能
├── video/          # 视频教程
└── download/       # 下载中心

文档更新

更新频率

  • 跟随系统版本同步更新
  • 重要功能及时补充文档
  • 定期优化文档结构

订阅更新

  • 关注 更新日志
  • Watch Gitee仓库获取通知
  • 加入技术交流群

常见问题

如何快速找到文档?

  • 使用页面顶部的搜索功能
  • 查看侧边栏目录结构
  • 参考文档导航菜单

文档看不懂怎么办?

  1. 先查看快速开始入门
  2. 观看视频教程
  3. 在社区提问交流
  4. 提交Issue寻求帮助

文档版本对应关系

文档版本与系统版本保持一致,建议查看对应版本的文档。

提示

建议按照文档顺序学习:快速开始 → 开发教程 → 架构设计 → 协议驱动