1. 集成前端独立组件
上云 API 2 说明文档(KOC3)
  • 快速开始
  • 申请许可证
  • 联系我们
  • 软件下载
  • 使用上云 API 2 设备模拟器
  • 鉴权接入指南
  • 部署上云 API 2 应用运行与设备管控底座
    • 部署指南
    • 部署前准备
    • 开始部署
    • 能力扩展
  • 设备上云
    • 设备上云
    • 设备固件版本
  • 集成前端独立组件
    • 集成指南
    • 驾驶舱和设备小窗
    • 驾驶舱模块化配置
    • 设备管理组件
    • 航线组件
    • 直播大屏
    • 飞行记录
    • 集成参考
    • PaasJS 新增特性
  • SDK 文档
    • 基本介绍
      • SDK 简介
      • 功能特性
    • 快速入门
      • 准备工作
      • 使用流程
    • 接口调用
      • 接口调用时序图
    • SDK API 文档
      • 使用 API 文档查阅接口详情
    • SDK版本迁移指南
      • 迁移概述
      • 新增方法详情
      • API 变更详情
      • 迁移操作步骤
    • 功能集合
      • SDK初始化
      • SDK配置
      • DRC链路
      • 飞机状态监听
      • 飞向目标点
      • 飞行参数设置
      • 飞行记录导出
      • POI 环绕飞行
      • 一键起飞
      • 航线任务管理
      • 航线任务控制
      • 航线资产管理
      • 机场状态监听
      • 控制权管理
      • 机场控制
      • 飞行控制
      • AI Box 管理
      • AI 智能告警
      • 机载 AI 控制
      • 机载 AI 算法管理
      • PSDK 控制
      • PSDK 资源管理
      • RTK 标定
      • 安全服务
      • 固件管理
      • 媒体服务
      • 日志管理
      • 三维重建
      • 设备管理
      • 设备保修维护
      • 设备健康管理
      • 设备远程调试
      • 设备在线状态
      • 相机控制
      • 直播录制
      • 直播设备管理
      • 直播视频流
      • 直播同步
      • 中继器控制
      • 自定义 SEI
      • WHEP 自定义拉流
      • 网络测速
      • 地图元素管理
      • 频闪灯配置
  • 使用上云 API 2 AI Plugin
    • 上云 API 2 AI Plugin 使用指南
  • 使用上云 API 2 二次开发 Demo
    • 上云 API 2 二次开发 Demo 部署指南
    • 上云 API 2 二次开发 Demo - 无人机管理平台使用说明
  • 排障指南
    • 前端独立组件排障指南
    • SDK排障指南
  1. 集成前端独立组件

设备管理组件

目录#

1.
前置准备
2.
引入 SDK 资源
3.
初始化配置
4.
模块化挂载
通用规范
各模块速查表
设备列表
设备运维
告警信息
设备定损与反馈
维保看板
行业无忧
固件管理
5.
自留地插槽
6.
主题定制
7.
完整接入示例

一、前置准备#

已部署好上云 API 2 私有化安装包,部署方式请参考 部署上云 API 2 应用运行与设备管控底座
Demo 已集成到上云 API 底座镜像(frontend)中,部署完成后可直接访问:
http://[服务器地址]/paasjs-demo/index.html
例如:http://[服务器地址]/paasjs-demo/index.html。各组件的初始化代码均已放在对应 HTML 文件中,可直接参考。

二、引入 SDK 资源#

加载完成后,挂载在 window.UranusDeviceManagerApp,从中解构所需函数:

三、初始化配置#

在调用任何 mountXxx() 之前,必须先完成全局初始化。setupDeviceManager 为幂等设计,可安全多次调用——首次完整初始化,后续调用仅更新 callbacks 和 slots。
SetupParams 参数说明
字段类型必填说明
serverUrlstring✓API 网关地址(库内部自动添加 /gateway 前缀)
wsUrlstring✓WebSocket 推送地址
authAuthConfig✓鉴权配置,见下表
localestring✗语言,默认 'zh',支持 'zh' / 'en'
themestring | object✗主题,默认 'light',支持 'light' / 'dark' 或自定义 token 对象
antThemeBaseUrlstring✗Ant Design 双主题 CSS 产物路径,默认 '/ant-theme'
callbacks.onErrorfunction✗全局错误回调
slotsSlotRegistry✗自留地插槽注册,见第五章
AuthConfig
字段类型说明
authKeysstring[]需注入到请求 header 的 key 名列表
headersobject | () => Record<string, string>推荐函数形式,每次请求时实时取值,适配 token 刷新

四、模块化挂载#

1. 通用规范#

所有 mountXxx() 函数接受相同结构的参数,返回相同的操作句柄。
MountOptions
MountHandle(mountXxx() 的返回值)
典型生命周期
内容模式 vs 抽屉模式
内容模式(mountXxx):组件直接在容器内渲染,由调用方控制容器大小
抽屉模式(mountXxxDrawer):组件以右侧滑出抽屉形式展现,关闭时触发 close 事件,监听后调用 handle.unmount()

2. 各模块速查表#

模块内容模式抽屉模式
设备列表mountDeviceList—
设备运维mountMaintenancemountMaintenanceDrawer
告警信息mountDeviceHmsmountDeviceHmsDrawer
设备定损与反馈mountAirportReportmountAirportReportDrawer
维保看板mountMaintenanceBoardmountMaintenanceBoardDrawer
行业无忧mountIndustryWarrantymountIndustryWarrantyDrawer
固件管理mountFirmwareManagement—

3. 设备列表 mountDeviceList#

props 字段类型必填说明
deviceType'airport' | 'drone'✗默认显示的设备类型,默认 'airport'

4. 设备运维 mountMaintenance / mountMaintenanceDrawer#

props 字段类型必填说明
snstring✓机场设备 SN
hideMoreHmsboolean✗隐藏「更早告警」入口,单独挂载时建议 true
hideAirportReportboolean✗隐藏「设备定损与反馈」按钮,单独挂载时建议 true
事件名回调参数说明
close—抽屉关闭(仅抽屉模式触发)
open-airport-report{ device_sn: string }点击「设备定损与反馈」入口(hideAirportReport: false 时触发)
open-maintain-serviceairport点击维保服务入口
open-care—点击行业无忧入口
maintenance-airport-updateairport机场设备信息发生更新
maintenance-host-updatehost载机设备信息发生更新

5. 告警信息 mountDeviceHms / mountDeviceHmsDrawer#

props 字段类型必填说明
airportSnstring✓机场设备 SN
droneSnstring✗载机设备 SN
relaySnstring✗中继器设备 SN
baseStationSnstring✗基站设备 SN
currentHmsDeviceTypestring✗初始显示的设备类型选项卡,默认 'airport'
hideActionboolean✗隐藏「操作」列(反馈创建入口),单独挂载时建议 true
事件名回调参数说明
close—抽屉关闭
show-more-hms-page{ sn?, record? }跳转至告警详情

6. 设备定损与反馈 mountAirportReport / mountAirportReportDrawer#

props 字段类型必填说明
selectedSnstring✗机场设备 SN;传入时过滤该设备数据,不传则展示全量

7. 维保看板 mountMaintenanceBoard / mountMaintenanceBoardDrawer#

无需传入 props。
注意:mountMaintenanceBoardDrawer 挂载后抽屉会自动打开,无需手动触发。

8. 行业无忧#

无需传入 props。与维保看板相同,抽屉版挂载后自动打开。

9. 固件管理 mountFirmwareManagement#

无需传入 props,直接以内容模式渲染固件列表页。

五、自留地插槽#

自留地插槽允许在组件库预留的指定位置挂载自定义 UI,支持 React、Vue 或原生 JavaScript 任意框架实现。

当前开放的插槽#

插槽名所在模块位置
maintenance-remote-debug-extra设备运维远程调试面板 header 右侧,与「设备日志」按钮并排
maintenance-remote-debug-extra 的 ctx 字段
字段说明
airport当前机场设备信息
drone关联载机设备信息
node关联中继器设备信息
isDroneExist是否存在关联载机
isRelayExist是否存在关联中继器

注册方式#

通过 setupDeviceManager 的 slots 参数注册:
说明:每次 ctx 变化时,库会先执行返回的清理函数,再重新调用 handler(传入最新 ctx)。handler 内无需自行监听 ctx 变化。

六、主题定制#

内置 'light'(默认)和 'dark' 两套主题,同时支持自定义 token 对象实现品牌化定制。

使用内置主题#

自定义主题#

推荐通过可视化面板配置,无需手写 token:
1.
在已挂载的页面调用 window.UranusDeviceManagerApp.showThemePanel() 打开主题面板
2.
调整各色值直到满意
3.
点击「导出 JSON」,得到完整 token 对象
4.
将导出结果作为 theme 传入 setupDeviceManager
切换主题需重新调用 setupDeviceManager({ theme })。因为 setupDeviceManager 是幂等的,后续调用只刷新主题与回调,不会重复初始化 HTTP/WebSocket。

七、完整接入示例#

以下是典型的多选项卡宿主页面接入模式:

上一页
驾驶舱模块化配置
下一页
航线组件
Built with