[Add API DOC]增加API文档说明
Signed-off-by: donghongyu <donghongyu@zhidaoauto.com>
This commit is contained in:
donghongyu
41
ZD_README/README_Call.md
Normal file
41
ZD_README/README_Call.md
Normal 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
1
ZD_README/README_Main.md
Normal file
@@ -0,0 +1 @@
|
||||
### 项目说明
|
||||
105
ZD_README/README_VersionHistory.md
Normal file
105
ZD_README/README_VersionHistory.md
Normal file
@@ -0,0 +1,105 @@
|
||||
### 鹰眼 (MOGO-Autopilot) 平台接入说明
|
||||
```gradle
|
||||
// 新版本架构SDK
|
||||
MOGO_CORE_SDK_VERSION = 0.0.6
|
||||
|
||||
// 所有UI展示层
|
||||
com.mogo.eagle.core.function.impl:hmi:${MOGO_CORE_SDK_VERSION}
|
||||
// 自动驾驶/工控机相关的功能实现
|
||||
com.mogo.eagle.core.function.impl:autopilot:${MOGO_CORE_SDK_VERSION}
|
||||
// 车辆检测模块功能实现
|
||||
com.mogo.eagle.core.function.impl:check:${MOGO_CORE_SDK_VERSION}
|
||||
// 地图层
|
||||
com.mogo.eagle.core.function.impl:map:${MOGO_CORE_SDK_VERSION}
|
||||
// 超视距服务
|
||||
com.mogo.eagle.core.function.impl:monitoring:${MOGO_CORE_SDK_VERSION}
|
||||
// 推送通知服务
|
||||
com.mogo.eagle.core.function.impl:notice:${MOGO_CORE_SDK_VERSION}
|
||||
// 自研OBU功能服务
|
||||
com.mogo.eagle.core.function.impl:obu-mogo:${MOGO_CORE_SDK_VERSION}
|
||||
// 小地图功能实现
|
||||
com.mogo.eagle.core.function.impl:smp:${MOGO_CORE_SDK_VERSION}
|
||||
// 道路协同功能实现
|
||||
com.mogo.eagle.core.function.impl:v2x:${MOGO_CORE_SDK_VERSION}
|
||||
// 模块功能定义接口，回调监听接口定义
|
||||
com.mogo.eagle.core.function:api:${MOGO_CORE_SDK_VERSION}
|
||||
// 负责模块之间调用，回调监听注册
|
||||
com.mogo.eagle.core.function:call:${MOGO_CORE_SDK_VERSION}
|
||||
// 数据bean基础，用来统一模块间数据调用
|
||||
com.mogo.eagle.core:data:${MOGO_CORE_SDK_VERSION}
|
||||
// 项目公用资源
|
||||
com.mogo.eagle.core:res:${MOGO_CORE_SDK_VERSION}
|
||||
// 项目工具类
|
||||
com.mogo.eagle.core:utils:${MOGO_CORE_SDK_VERSION}
|
||||
// 网络服务
|
||||
com.mogo.eagle.core:network:${MOGO_CORE_SDK_VERSION}
|
||||
```
|
||||
|
||||
|
||||
```gradle
|
||||
MOGO_COMMONS_VERSION = 2.0.63
|
||||
tanluupload : "com.mogo.module:module-tanlu-upload:${MOGO_COMMONS_VERSION}",
|
||||
// modules
|
||||
moduleshare : "com.mogo.module:module-share:${MOGO_COMMONS_VERSION}",
|
||||
mogocommons : "com.mogo.commons:mogo-commons:${MOGO_COMMONS_VERSION}",
|
||||
mogoutils : "com.mogo.commons:mogo-utils:${MOGO_COMMONS_VERSION}",
|
||||
mapamap : "com.mogo.map:map-amap:${MOGO_COMMONS_VERSION}",
|
||||
mapautomap : "com.mogo.map:map-autonavi:${MOGO_COMMONS_VERSION}",
|
||||
mapcustom : "com.mogo.map:map-custom:${MOGO_COMMONS_VERSION}",
|
||||
mogomap : "com.mogo.map:mogo-map:${MOGO_COMMONS_VERSION}",
|
||||
mogomapapi : "com.mogo.map:mogo-map-api:${MOGO_COMMONS_VERSION}",
|
||||
mogocustommap : "com.zhidaoauto.machine:map:${MOGO_COMMONS_VERSION}",
|
||||
|
||||
modulecommon : "com.mogo.module:module-common:${MOGO_COMMONS_VERSION}",
|
||||
modulemain : "com.mogo.module:module-main:${MOGO_COMMONS_VERSION}",
|
||||
modulemainlauncher : "com.mogo.module:module-main-launcher:${MOGO_COMMONS_VERSION}",
|
||||
modulemap : "com.mogo.module:module-map:${MOGO_COMMONS_VERSION}",
|
||||
moduleservice : "com.mogo.module:module-service:${MOGO_COMMONS_VERSION}",
|
||||
mogoservice : "com.mogo.service:mogo-service:${MOGO_COMMONS_VERSION}",
|
||||
mogoserviceapi : "com.mogo.service:mogo-service-api:${MOGO_COMMONS_VERSION}",
|
||||
moduleapps : "com.mogo.module:module-apps:${MOGO_COMMONS_VERSION}",
|
||||
moduleextensions : "com.mogo.module:module-extensions:${MOGO_COMMONS_VERSION}",
|
||||
chat : "com.mogo.module.carchatout:module-chat:${MOGO_COMMONS_VERSION}",
|
||||
callchat : "com.mogo.module.carchatout:module-carchatting:${MOGO_COMMONS_VERSION}",
|
||||
callchatprovider : "com.mogo.module.carchatout:module-carchatting-provider:${MOGO_COMMONS_VERSION}",
|
||||
|
||||
// V2X
|
||||
moduleV2x : "com.mogo.module:module-v2x:${MOGO_COMMONS_VERSION}",
|
||||
moduleADAS : "com.mogo.module:mogo-module-adas:${MOGO_COMMONS_VERSION}",
|
||||
modulesearch : "com.mogo.module:module-search:${MOGO_COMMONS_VERSION}",
|
||||
// push
|
||||
modulepush : "com.mogo.module:module-push:${MOGO_COMMONS_VERSION}",
|
||||
modulepushbase : "com.mogo.module:module-push-base:${MOGO_COMMONS_VERSION}",
|
||||
modulepushnoop : "com.mogo.module:module-push-noop:${MOGO_COMMONS_VERSION}",
|
||||
//统一返回键
|
||||
mogomoduleback : "com.mogo.module:module-back:${MOGO_COMMONS_VERSION}",
|
||||
// OBU
|
||||
moduleobu : "com.mogo.module:module-obu:${MOGO_COMMONS_VERSION}",
|
||||
// 左侧面板
|
||||
moduleleftpanel : "com.mogo.module:module-left-panel:${MOGO_COMMONS_VERSION}",
|
||||
// 左侧面板空实现
|
||||
moduleleftpanelnoop : "com.mogo.module:module-left-panel-noop:${MOGO_COMMONS_VERSION}",
|
||||
// 基础服务实现
|
||||
mogobaseservicesdk : "com.mogo.base:services-sdk:${MOGO_COMMONS_VERSION}",
|
||||
mogobaseserviceapk : "com.mogo.base:services-apk:${MOGO_COMMONS_VERSION}",
|
||||
mogobasewebsocketsdk : "com.mogo.base:websocket-sdk:${MOGO_COMMONS_VERSION}",
|
||||
mogowebsocket : "com.mogo.module.carchatting:module-carchatt-socket:${MOGO_COMMONS_VERSION}",
|
||||
mogologlib : "com.mogo.module:module-loglib:${MOGO_COMMONS_VERSION}",
|
||||
mogomonitor : "com.mogo.module:module-monitor:${MOGO_COMMONS_VERSION}",
|
||||
mogomodulewidgets : "com.mogo.module:module-widgets:${MOGO_COMMONS_VERSION}",
|
||||
kotlingradleplugin : "org.jetbrains.kotlin:kotlin-gradle-plugin:${MOGO_COMMONS_VERSION}",
|
||||
skinsupport : "com.mogo.skin:skin-support:${MOGO_COMMONS_VERSION}",
|
||||
skinsupportimpl : "com.mogo.skin:skin-support-impl:${MOGO_COMMONS_VERSION}",
|
||||
skinsupportnoop : "com.mogo.skin:skin-support-noop:${MOGO_COMMONS_VERSION}",
|
||||
skinsupportlight : "com.mogo.skin:skin-light:${MOGO_COMMONS_VERSION}",
|
||||
crashreport : "com.mogo.test:crashreport:${MOGO_COMMONS_VERSION}",
|
||||
crashreportbugly : "com.mogo.test:crashreport-bugly:${MOGO_COMMONS_VERSION}",
|
||||
crashreportnoop : "com.mogo.test:crashreport-noop:${MOGO_COMMONS_VERSION}",
|
||||
crashreportupgrade : "com.mogo.test:crashreport-upgrade:${MOGO_COMMONS_VERSION}",
|
||||
skinsupportbase : "com.mogo.skin:skin-support-base:${MOGO_COMMONS_VERSION}",
|
||||
skinsupportappcompat : "com.mogo.skin:skin-support-appcompat:${MOGO_COMMONS_VERSION}",
|
||||
skinsupportcardview : "com.mogo.skin:skin-support-cardview:${MOGO_COMMONS_VERSION}",
|
||||
skinsupportconstraintlayout : "com.mogo.skin:skin-support-constraint-layout:${MOGO_COMMONS_VERSION}",
|
||||
skinsupportdesign : "com.mogo.skin:skin-support-design:${MOGO_COMMONS_VERSION}",
|
||||
|
||||
```
|
||||
Reference in New Issue
Block a user