Documentation Guide
NE503 文档按角色划分使用路径。不同角色需要的内容不同——本页帮你找到自己的起点:每个角色给出核心目标、需要读的内容板块(链接直达对应章节)与建议阅读顺序,不必从头通读全部文档。
文档板块总览
| 板块 | 内容 | 适合谁 |
|---|---|---|
| Product Information | 产品定位、核心能力、 接口与规格 | 所有人(5 分钟了解产品) |
| Quick Start | 开箱到上线的线性闭环(约 10 分钟) | 试机 / 首次部署 |
| User Guide | Web 控制台全部功能:画面、外设、模型管理、运维、安全、接线 | 运维 / 安装人员 |
| Hardware Guide | 板级硬件:核心板、接口板、开发调试 | 硬件工程师 |
| Software Guide | 系统架构、源码构建、烧录、版本矩阵 | 平台开发者 |
| Application Guide | 应用开发(SDK/教程/模型训练)、Cookbook 项目实录、Reference 参考(App/SDK/REST/视频/事件) | 应用开发者 / 集成商 / 模型工程师 |
| Troubleshooting | 按症状组织的故障排查 FAQ | 所有人(遇到问题时查) |
按角色选起点
试机用户 / 首次部署
目标:开箱到设备上线,验证画面、码流与 AI 全部正常。
路径就是 Quick Start(§1→§6 约 10 分钟),走完设备即可上线。上线后的日常使用进用户指南。
应用开发者
目标:开发自己的 AI 容器应用并部署到设备。
| 顺序 | 内容板块 | 回答的问题 |
|---|---|---|
| 1 | SDK 前提 | SDK 提供哪些能力、应用如何拿到推理结果 |
| 2 | 第一次调用 | 订阅码流、推理、外设、事件的代码怎么写 |
| 3 | 声明权限 | app.yaml 里模型与码流权限怎么声明 |
| 4 | Hello World | 从零写一个应用并跑通 |
| 5 | Cookbook:停车场管理 | 一个完整业务应用长什么样 |
集成商
目标:把设备 的视频流、AI 事件、管理接口接入现有业务系统(NVR / VMS / 平台)。
| 顺序 | 内容板块 | 回答的问题 |
|---|---|---|
| 1 | 认证 | 登录拿 token、集成密钥怎么用 |
| 2 | 视频与成像 | RTSP 拉流接 NVR/VMS/FFmpeg 的地址与参数 |
| 3 | 事件集成 | WebSocket/MQTT 订阅 AI 推理结果与设备告警 |
| 4 | REST API 接口参考 | 模型、应用、设备管理的全部端点 |
模型工程师
目标:训练自有检测模型,编译成 HEF 部署到设备 NPU。
| 顺序 | 内容板块 | 回答的问题 |
|---|---|---|
| 1 | 模型来源与选择 | 预置模型够不够用、要不要走完整流水线 |
| 2 | 版本兼容性矩阵 · 出厂预置清单 | 设备上已有哪些模型、组件版本约束 |
| 3 | 模型训练 | YOLOv8 训练:数据集、384×640 输入、超参 |
| 4 | Hailo HEF 量化编译 | ONNX → 量化 → NMS → HEF 全流程 |
| 5 | 部署到 NE503 | 导入设备、验证加载、端到端跑通 |
平台开发者
目标:理解并构建整个平台软件栈。
| 顺序 | 内容板块 | 回答的问题 |
|---|---|---|
| 1 | 四层平台架构 | 平台服务 / HAL / 应用的分层关系 |
| 2 | 端到端数据流 | 一帧图像从传感器到事件的全链路 |
| 3 | 开发者指南 · 环境搭建 | 三仓布局、工具链、Docker 环境 |
| 4 | 版本构建 | 从源码构建平台各组件 |
遇到问题时
任何角色排障先进故障排查:按症状域(设备与网络 / 视频与流 / AI 与模型 / 应用与容器 / 事件与集成 / 存储与磁盘 / 烧录与外设 / 系统与服务)组织的「现象 → 原因 → 修复」FAQ。