update: User's Guide doc

2025-05-18 18:48:25 +08:00 · 2022-03-21 13:54:34 +08:00 · 2022-03-21 13:54:34 +08:00 · 3eeb6b3af0
commit 3eeb6b3af0
parent 80dc661c68
1 changed files with 145 additions and 19 deletions
--- a/docs/tracker公版方案用户指导手册.md
+++ b/docs/tracker公版方案用户指导手册.md
@ -1,8 +1,134 @@
-# Tracker API v2.0.0
+# Tracker 公版方案用户指导手册

-## Tracker
+## Tracker 功能列表

-### 创建 Tracker 对象
+### 系统复位(开发中)
+
+- 长按复位键3s以上，系统自动复位
+
+### 充电开机(开发中)
+
+- 关机状态下，USB充电时唤醒系统，做开机前的准备工作。
+- 充电时，检测电量是否正常：
+    - >5%：系统启动，电量指示灯1s闪烁一次
+    - ≤5%：保持关机，电量指示灯1s闪烁一次
+
+### 低电关机
+
+- 开机状态下，电量≤5%时，自动关机，关闭一切指示灯。
+- 关机前，需向云端报告一次设备状态（位置，电量等）。
+
+### 开机自检
+
+- 检测网络、GPS模组、各类传感器、麦克风是否正常工作：
+    - 正常：运行状态指示灯2s闪烁一次。
+    - 异常：运行状态指示灯500ms闪烁一次；在网络正常的情况下，需向云端发出故障报警。
+
+### 电量指示灯(开发中)
+
+- >`low_power_alert_threshold`：长亮
+- `low_power_shutdown_threshold`~`low_power_alert_threshold`：1秒闪烁一次
+- <=`low_power_shutdown_threshold`：熄灭
+
+### 运行状态指示灯(开发中)
+
+- 参考开机自检功能的逻辑说明。
+
+### USB充电(开发中)
+
+- 关机状态下充电：参考充电开机功能的逻辑说明。
+- 开机状态下充电：电量指示灯1s闪烁一次。
+- 电量充满：电量指示灯为常亮。
+- 拔出USB线：电量指示灯的状态由当前电量决定。
+
+### 多重定位
+
+- 由GPS、AGPS、WiFi或基站综合确定位置信息。
+- 默认GPS定位，具体使用哪一种或几种定位技术，可由云端或手机APP控制。
+- 定位的工作模式，根据不同的应用场景，分别有：周期性定位、报警发生时定位。
+- 工作模式可以任意组合，由云端或手机APP控制。
+
+### 电子围栏
+
+- 由云端规划安全区域或航线。
+- 位置超出区域或偏离航线的，云端向登记的手机号发送报警短信。
+- 功能的开启，可由云端或手机APP控制。默认开启该功能。
+
+### 部标808协议(开发中)
+
+- 与云端之间的通信遵循808协议。
+
+### 设备信息上报
+
+- 上报设备定位信息，电量，开关机状态，定位方式，电话号码等信息
+
+### OTA升级(开发中)
+
+- 上电时，待网络连接后，检测是否需要更新升级。
+- 如有升级：
+    - 若非自动升级，则上云端上报有新的更新；
+    - 在云端或手机APP点击升级按钮；
+    - 下载升级包，并将升级包准备完毕的通知报给云端(移远云无需上报下载后直接升级)；
+    - 升级完毕后，将升级状态报告给云端。
+- 功能的开启，可由云端或手机APP控制。默认开启该功能。
+- 功能开启的状态下，可由云端或手机APP配置是否自动升级。默认自动升级。
+
+### 故障报警
+
+- 设备在开机自检或正常工作中遇到了故障时报警。
+- 功能的开启，可由云端或手机APP控制。默认开启该功能。
+- 报警代码：20000
+
+### 低电报警
+
+- 电量低于设定值时报警。
+- 低电的阈值默认为5%，可由云端或手机APP设置，但设定值限制在5%-30%。
+- 功能的开启，可由云端或手机APP控制。默认开启该功能。
+- 报警代码：30002
+
+### 超速报警
+
+- 速度超过设定值时报警。
+- 功能的开启，超速阈值，可由云端或手机APP控制。默认关闭该功能。
+- 报警代码：30003
+
+### 拔卡报警(开发中)
+
+- SIM卡拔出时报警，此时网络不通，按照网络不通的逻辑处理。
+- 功能的开启，可由云端或手机APP控制。默认开启该功能。
+- 报警代码：30004
+
+### 拆卸报警(开发中)
+
+- 照度传感器检测到较亮的光线时报警。
+- 功能的开启，可由云端或手机APP控制。默认开启该功能。
+- 报警代码：30005
+
+### 驾驶行为监测(开发中)
+
+- 检测到急起急停或急转弯时，报驾驶行为异常。
+- 功能的开启，可由云端或手机APP控制。默认关闭该功能。
+- 驾驶行为异常的报警代码为：
+    - 急起：40001
+    - 急停：40002
+    - 左急转弯：40003
+    - 右急转弯：40004
+
+### SOS一键报警(开发中)
+
+- 长按功能键5s，紧急求助。
+- 先向云端发送紧急报警信息，同时向内置电话号码拨打电话、发送短信。
+- 报警代码：50001
+
+### 远程配置或控制
+- 远程配置：电话号码、远程配置定位器工作模式、定位使用的技术手段、固件升级及自动升级、故障报警、低电报警、超速报警、拔卡报警、拆卸报警、振动报警和驾驶行为监测功能的开关。
+- 远程控制：远程控制固件升级的流程。
+
+## Tracker API v2.0.0
+
+### Tracker
+
+#### 创建 Tracker 对象

 1. 导入Tracker模块
 2. 创建Tracker对象
@ -14,7 +140,7 @@ from usr.tracker import Tracker
 tracker = Tracker()
 ```

-### battery 电池功能
+#### battery 电池功能

 改功能提供`energy`方法查询当前电池电量。

@ -33,11 +159,11 @@ battery_energy = tracker.battery.energy()

 返回当前电池电量百分比, 数据类型为`int`。

-### locator 定位功能
+#### locator 定位功能

 该功能提供了`read`查询当前模块的定位信息, 定位模式, 定位方式, 定位信息上报模式在`settings`模块中配置, 亦可通过云端远程进行消息控制。

-#### `read` 查询当前模块的定位信息。
+##### `read` 查询当前模块的定位信息。

 >`tracker.locator.read`

@ -70,9 +196,9 @@ location_info = tracker.locator.read()
    - `loc_method` -- 4
        - `[]`

-### remote 信息通信功能
+#### remote 信息通信功能

-#### `post_data` 向云端进行消息发送功能。
+##### `post_data` 向云端进行消息发送功能。

 - `post_data`发放支持阻塞和非阻塞两种消息发送模式, 默认为阻塞方式进行消息发送。

@ -153,7 +279,7 @@ tracker.remote.post_data(data_type, data)

 无

-### alert_report 告警功能
+#### alert_report 告警功能

 该功能提供`alert_report`方法, 将定义好的报警编码与报警信息上报到云端。

@ -204,7 +330,7 @@ res = tracker.alert_report(alert_code, alert_info)
 |-|40004|`quick_turn_right`|右急转弯|
 |50001|-|`sos_alert`|SOS求救报警|

-### `loc_report` 用于立即向云端报告设备定位信息功能。
+#### `loc_report` 用于立即向云端报告设备定位信息功能。

 >`tracker.loc_report`

@ -221,7 +347,7 @@ res = tracker.loc_report()

 返回`bool`类型数据, `True`成功, `False`失败。

-### machine_info_report 机器信息上报功能
+#### machine_info_report 机器信息上报功能

 该模块实现了机器信息的汇总上报功能, 会将机器的位置信息, 开机状态, 电池电量等相关设置信息全部实时上报云端。

@ -239,7 +365,7 @@ res = tracker.machine_info_report()

 无

-### machine_check 机器自检功能
+#### machine_check 机器自检功能

 该功能用于检测设备相关功能是否正常, 主要包括网络状态, GPS模组, 各类传感器, 麦克风是否正常工作(目前暂不支持各类传感器麦克风等外设检测)。 如异常会上报远端异常信息。 检查完毕后不论异常与否都会调用`machine_info_report`功能上报云端设备所有信息。

@ -267,7 +393,7 @@ res = tracker.machine_check()
 |20005|三轴加速度传感器异常|
 |20006|麦克风异常|

-## settings
+### settings

 该模块为配置参数模块

@ -277,7 +403,7 @@ res = tracker.machine_check()
 - 配置参数都已集成到一个字典中, 可通过`settings.get()`方式获取到具体配置参数
 - `app`配置参数具体含义见`quec_cloud_module.json`(导入移远云产品功能定义中)

-### settings 导入
+#### settings 导入

 - 例:

@ -285,7 +411,7 @@ res = tracker.machine_check()
 from usr.settings import settings
 ```

-### init 初始化
+#### init 初始化

 - 例:

@ -301,7 +427,7 @@ res = settings.init()

 返回`bool`类型数据, `True`成功, `False`失败。

-### get 获取配置参数
+#### get 获取配置参数

 - 例:

@ -364,7 +490,7 @@ current_settings = settings.get()
 }
 ```

-### set 设置配置参数
+#### set 设置配置参数

 - 例:

@ -387,7 +513,7 @@ res = settings.set(opt, val)

 - 配置参数标识符列表，见`移远云物模型属性功能定义标识符`表中可写权限数据

-### save 持久化保存配置参数
+#### save 持久化保存配置参数

 - 例:

@ -403,7 +529,7 @@ res = settings.save()

 返回`bool`类型数据, `True`成功, `False`失败。

-### reset 重置配置参数
+#### reset 重置配置参数

 - 例: