update: user guide doc.

This commit is contained in:
JackSun 2022-05-16 20:13:03 +08:00
parent a7aa1d7203
commit e877b226ed

View File

@ -16,6 +16,31 @@
- [x] 云服务中间件(remote): 提供云服务消息处理中间件功能。 - [x] 云服务中间件(remote): 提供云服务消息处理中间件功能。
- [ ] 传感器功能(sensor): 开发中... - [ ] 传感器功能(sensor): 开发中...
## 项目拉取
```bash
# 下载主项目代码
git clone https://gitee.com/qpy-solutions/tracker-v2.git
# 进入主项目目录
cd tracker-v2/
# 切换对应的主项目分支
git checkout master
# 子项目初始化
git submodule init
# 子项目代码拉取
git submodule update
# 进入子项目目录
cd code/modules/
# 切换对应的子项目分支
git checkout master
```
## 项目结构 ## 项目结构
``` ```
@ -49,35 +74,6 @@
|--sensor.py |--sensor.py
``` ```
### 功能模块注册流程图
![](./media/tracker_modules_registration_process.png)
## 项目拉取
```bash
# 下载主项目代码
git clone https://gitee.com/qpy-solutions/tracker-v2.git
# 进入主项目目录
cd tracker-v2/
# 切换对应的主项目分支
git checkout master
# 子项目初始化
git submodule init
# 子项目代码拉取
git submodule update
# 进入子项目目录
cd code/modules/
# 切换对应的子项目分支
git checkout master
```
## 项目配置 ## 项目配置
### 硬件设备 ### 硬件设备
@ -151,6 +147,10 @@ _wifi_cfg = {
} }
``` ```
## 功能模块注册流程图
![](./media/tracker_modules_registration_process.png)
## 启动项目 ## 启动项目
直接使用项目提供的物模型,当各个模块配置都已就绪后,将项目代码按项目结构(`code``usr`目录)导入设备`/usr/`目录下,设备会自动运行`main.py`通过QPYcom交互界面即可看到消息上传日志同时查看云服务平台设备信息即可看到上传的数据信息。 直接使用项目提供的物模型,当各个模块配置都已就绪后,将项目代码按项目结构(`code``usr`目录)导入设备`/usr/`目录下,设备会自动运行`main.py`通过QPYcom交互界面即可看到消息上传日志同时查看云服务平台设备信息即可看到上传的数据信息。