[Add API DOC]增加API文档说明

Signed-off-by: donghongyu <donghongyu@zhidaoauto.com>
This commit is contained in:
donghongyu
2021-11-11 18:32:56 +08:00
parent 7823ac00ce
commit c29462e603
4 changed files with 43 additions and 1 deletions

41
ZD_README/README_Call.md Normal file
View File

@@ -0,0 +1,41 @@
## APIs
* ### HMI 视图 相关 -> [CallerHmiManager.kt][DebugSettingView.kt] -> [Demo][DebugSettingView.kt]
```
changeCountdownGreen : 修改绿灯倒计时
changeCountdownRed : 修改红灯倒计时
changeCountdownYellow : 修改黄灯倒计时
changeCountdownTrafficLightNum : 同时修改红、黄、绿倒计时
disableLimitingVelocity : 关闭限速预警
disableWarningTrafficLight : 关闭红绿灯预警
disableWarningV2X : 关闭指定floatTag 的 VR下V2X预警弹窗
setAutopilotStatusViewVisibility : 隐藏 自动驾驶触发 按钮
setCheckStatusViewVisibility : 隐藏 检测状态 按钮
setPerspectiveSwitchViewVisibility : 隐藏 切换视角 按钮
setSpeedChartViewVisibility : 隐藏 脉速表
showLimitingVelocity : 展示限速预警
showNoticeNormalData : 普通公告弹窗
showTrafficBanner : 呈现交通云公告弹窗(hmi)
showWarning : 展示指定方位上的红框预警
showWarning : 展示指定方位上的红框预警,并指定倒计时
showWarningTrafficLight : 展示红绿灯预警0-都是默认不亮起1-红2-黄3-绿
showWarningV2X : 展示VR下V2X预警
vipIdentification : VIP标志展示控制
```
* ### 高精 MAP 图层 相关 -> [CallerHDMapManager.kt][DebugSettingView.kt] -> [Demo][DebugSettingView.kt]
```
changeCurrentIcon : 修改自车3D模型
changeMaoViewAngle : 修改地图视角
```
* ### 域控制器 相关 -> [CallerAutoPilotManager.kt][DebugSettingView.kt] -> [Demo][DebugSettingView.kt]
```
cancelAutoPilot :取消自动驾驶
recordPackage 录制Bag数据
sendDataToAutopilot :发送数据给 ADAS 域控制器
startAutoPilot :开启自动驾驶
```

1
ZD_README/README_Main.md Normal file
View File

@@ -0,0 +1 @@
### 项目说明

View File

@@ -199,7 +199,7 @@ class MoGoHmiFragment : MvpFragment<MoGoWarningContract.View?, WaringPresenter?>
/** /**
* 展示红绿灯预警 * 展示红绿灯预警
* *
* @param checkLightId 0-都是默认1-红2-黄3-绿 * @param checkLightId 0-都是默认不亮起1-红2-黄3-绿
*/ */
override fun showWarningTrafficLight(checkLightId: Int) { override fun showWarningTrafficLight(checkLightId: Int) {
viewTrafficLightVr.showWarningTrafficLight(checkLightId) viewTrafficLightVr.showWarningTrafficLight(checkLightId)