--- title: 教程视频 description: iotLCM 开源版的部署、使用与接口接入录屏教程 outline: deep --- # 教程视频 iotLCM 分三支:怎么装起来、怎么用起来、怎么接进去。前两支面向实施与业务方,第三支面向第三方开发者。 ## V1 部署教程:从零到可用 | 项 | 内容 | | --- | --- | | 标题 | iotLCM 开源版部署教程:从零到可用 | | 目标观众 | 具备 Linux 与 Docker 基础的实施工程师 | | 时长 | 12 ~ 15 分钟 | | 发布位置 | 官网本页 + 源码仓 README 顶部 + B 站 | | 关联文档 | [快速开始](/projects/iotlcm/guide/quickstart)、[部署与运维](/projects/iotlcm/guide/deploy) | | 关联仓库路径 | `deploy/`、`docs/` | 分镜: 1. **环境准备**(1.5 分钟):Docker 与 Compose 版本检查、机器规格建议、端口占用确认 2. **取代码**(0.5 分钟):`git clone` 公开仓库,展示目录结构 3. **启动**(4 分钟):`cd deploy && docker compose up -d`,`docker compose logs -f mysql` 看初始化直到种子数据导入完成 4. **验证**(3 分钟):登录管理端、打开文档站 `/docs/`、打开 OpenAPI 文档、跑一次卡状态查询 5. **收尾**(2 分钟):改默认口令清单、`docker compose down` 与 `down -v` 的区别 6. **踩坑预告**(1 分钟):MySQL 初始化失败要清卷、文档站必须带 `/docs/` 路径 ## V2 使用教程:核心功能实操 | 项 | 内容 | | --- | --- | | 标题 | iotLCM 开源版使用教程:核心功能实操 | | 目标观众 | 已完成部署、准备给业务方上手的管理员与运营人员 | | 时长 | 15 ~ 20 分钟 | | 发布位置 | 官网本页 + 源码仓 README 顶部 + B 站 | | 关联文档 | [功能概览](/projects/iotlcm/) | | 关联仓库路径 | `admin-ui/vue/apps/web-antd/src/views/iotlcm/`、`admin-svr/server/api/iot/v1/` | 录制环境:Web 管理端 `http://<主机>:8009/`(部署视频里那套已起好的环境),数据用 mock 挡板或测试库, 不要在压测或生产环境上录。 ### 分镜(按后台真实菜单顺序) **1. 登录与工作台**(1 分钟) - 打开管理端,用 admin 登录(口令打码) - 进「工作台」看概览:卡总量、在网量、流量与告警概览 - 一句话交代后台的菜单分组:生命周期、通信管理、资费定价、通道、预警中心、智能诊断、系统与组织 **2. 卡信息**(3 分钟)——菜单「通信管理 / 卡信息」 - 列表页看全量卡:分页、列筛选 - 按 ICCID / MSISDN / IMSI 三种卡号任一检索(`cardValue` 支持单卡与批量两种输入) - 按通道、卡状态、套餐编码再叠一层筛选,体现组合筛选能力 - 点开一张卡的详情:基本信息、状态、有效期、绑定套餐 - 说明列表右上角的导出(导出当前显示列) **3. 入库与库存**(2.5 分钟)——菜单「生命周期 / 入库管理」「库存卡信息」 - 入库管理:Excel 模板下载 → 批量导入卡 → 导入结果反馈(成功 / 失败条数) - 库存卡信息:看在库卡、按状态与维度筛、看单卡出入库轨迹 - 串一句:入库是所有下游动作(划拨、激活、续费)的前提 **4. 业务受理**(3 分钟)——菜单「通信管理 / 业务受理」 - 新建受理单:选卡 → 选动作(开卡 / 复机 / 停机 / 续费 / 变更套餐 / 销户)→ 提交 - 提交前确认卡状态与套餐是否满足该动作的前置条件 - 提交后到「批次管理」看任务生成 - 顺带展示销户卡信息页与库存的差别 **5. 批次与执行日志**(3 分钟)——菜单「生命周期 / 批次管理」「执行日志」 - 批次管理:看批次列表、批次类型(开停复机 / 续费 / 变更套餐)、处理进度 - 打开一个批次的卡明细:逐卡的成功 / 失败与失败原因 - 执行日志:看异步执行记录与耗时,失败批次点详情看日志 - 说明这里为什么是异步:批量动作走 worker 队列,页面只提交不等待 **6. 套餐与流量**(2.5 分钟)——菜单「资费定价」 - SIM 流量套餐:看套餐定义、有效期、生效与到期策略 - 流量池:看池的总量与已用量 - 流量池套餐配置:池与套餐的绑定关系 **7. 达量断网**(1.5 分钟)——菜单「通信管理 / 达量断网」 - 新建规则:选池 / 选套餐、设阈值与动作 - 说明触发时机与卡状态的关系:这是运营商侧断网前的自保手段 **8. 智能诊断**(1.5 分钟)——菜单「智能诊断」 - 输入卡号,查诊断信息:基本信息 + 会话信息 + 套餐信息三块同屏 - 查该卡的流量使用情况 - 说明诊断给的是「当前结论 + 依据」,处置仍要回到对应菜单操作 ### 录制注意 - 上面 8 段是**必须录到**的最小集合。若时间紧,4(业务受理)、5(批次与执行日志)、8(智能诊断)三段是平台区别于普通 CRUD 的核心,不可省 - 每一段开头用一句话说清「这一步在业务上解决什么问题」,观众跟得上 - 卡号、IMEI 用演示值;不要展示真实客户名与真实生产卡号 - 批次那段的异步特性建议当场等一次执行结果(mock 环境秒级),让观众看到状态从「执行中」到「成功」 - 全程不要出现真实口令与 token ### 明确不录的内容 - OpenAPI 调用演示 → 属于 V3 接口那支 - 通道与接入模板的详细配置 → 属于平台实施方内容,不是业务方日常操作 - 租户、角色、菜单的系统管理页 → 与使用教程的受众不匹配,放进「组织与账号」类材料 ## V3 OpenAPI 接入实战 | 项 | 内容 | | --- | --- | | 标题 | iotLCM OpenAPI 接入实战:从申请凭证到跑通调用 | | 目标观众 | 要把平台接进自己系统的第三方开发者 | | 时长 | 10 ~ 12 分钟 | | 发布位置 | 官网本页 + 源码仓 README 顶部 + B 站 | | 关联文档 | 文档站 OpenAPI 合同章节 | | 关联仓库路径 | `openapi/`、`docs/` | 分镜: 1. **申请凭证**(2 分钟):管理端申请 API 凭证、看凭证与权限范围 2. **鉴权方式**(2 分钟):JWT 令牌获取、令牌与权限的关系 3. **第一次调用**(3 分钟):卡信息查询接口的请求参数、响应结构、逐字段解释 4. **错误处理**(2 分钟):常见业务错误码与参数校验失败的处理路径 5. **兼容接口**(1.5 分钟):旧版兼容接口与 V3 的差异,何时该用哪套 6. **收尾**(1 分钟):接入自检清单 ## 录制备忘 - 录屏环境用干净 Ubuntu + Compose V2,不在已有业务实例上录 - 涉及口令的片段一律打码,用编排里的默认值 - 步骤与[快速开始](/projects/iotlcm/guide/quickstart)严格一致,视频里出现的每条命令都必须能原样复制执行 - 每个视频产出配套字幕或要点说明(Markdown),随视频一起发布 - 视频文件命名 `iotlcm-deploy-v1.mp4` 这类,官网用相对路径引用;改投外部托管则不进仓库