一、概述
阅读对象
本文档面向南向设备驱动接入开发者,允许开发自助接入以及调试设备驱动。
二、平台账号准备
1、申请平台账号
- 在平台物联云平台官网上注册一个企业账号
- 在账号注册创建同时申请开通【设备中心】模块
2、创建边缘产品
具体创建步骤可参考《边缘网关产品创建及配置说明》文档;
3、创建边缘证书
具体创建步骤可参考《边缘网关产品创建及配置说明》文档;
4、创建边缘实例
边缘实例创建及配置步骤可参考《边缘网关上云指引》文档;
三、本地环境准备
1、安装Docker环境
- Docker环境安装:点此访问
2、下载边缘盒子镜像
通过以下命令进行边缘盒子镜像下载
- docker pull swr.cn-south-1.myhuaweicloud.com/xlink-edge/box-south:1.0
3、启动边缘盒子容器
- 确保本地8080、1889端口可监听不被占用。
- docker run -itd –privileged –name edge-box-south -h box-south -p 8080:8080 -p 1889:1889 –net=bridge swr.cn-south-1.myhuaweicloud.com/xlink-edge/box-south:1.0
4、等待容器初始化成功
容器第一次启动时,会下载依赖软件以及启动本地XEG,等待时间跟本地环境的网络有关,网络优良情况下,一般在10分钟左右。 可通过docker命令进入容器确认是否完成:
获取边缘盒子容器ID:docker ps
进入容器:docker exec -it 容器ID /bin/bash
确认项(注意:是进入容器后执行的命令,不是在当前宿主机)
确认XEG是否启动成功:ps -ef |greo XEG,进程运行中即可
确认基础镜像是否下载成功:docker images,如有镜像:swr.cn-south-1.myhuaweicloud.com/xlink-edge/edge-common:2.0 即可。
查看本地端口监听:netstat -lntp,本地监听1889、8080、7080、2375端口即可。
四、配置边缘盒子
边缘盒子上线及配置步骤可参考《边缘网关上云指引》文档;
五、设备驱动接入调试
1、创建自定义接入产品
创建调试产品、匹配或者自定义物模型。
2、边缘实例关联产品
需要为边缘实例的证书关联对应产品才可以进行设备调试,入口在边缘实例->管理->证书管理→关联产品
3、注册调试设备
在创建的自定义产品下,注册一个调试设备,输入MAC信息:MAC必须偶数位16进制
4、基于PTP SDK进行设备上下线、上报数据
- 上报端口:1889
- 参考文档:《设备驱动自助调试指引》
六、部署驱动/应用
参考文档:《边缘驱动&应用部署指引》
七、常见问题
Q:通过镜像创建容器后,等了很久,没有发现容器内包含镜像:swr.cn-south-1.myhuaweicloud.com/xlink-edge/edge-common:2.0
A:如果没有应该是在容器初始化过程中断网或者下载失败导致,进入容器:docker exec -it 容器ID /bin/bash 后,执行命令:docker pull swr.cn-south-1.myhuaweicloud.com/xlink-edge/edge-common:2.0手动下载。
Q:通过镜像创建容器后,进入容器没有看到XEG运行中
A:进入容器:docker exec -it 容器ID /bin/bash 后,执行命令:/bin/bash /data/shell/check_XEG_running.sh
Q:连接XEG成功,但上报数据立即被断开。
A:如使用PTP SDK进行上报,XEG不允许两个相同的PTP ID的客户端同时上报数据,在PTP SDK以MqttConstants.PROCESS_NAME进行命名,排查下当前是否有2个相同的客户端在连接XEG。
Q:上报数据成功,但在平台没有显示设备在线和实时状态。
A:需要确认上报数据的产品是否在边缘实例关联了产品,如无关联产品则无法上报数据。
Q:上报数据后,平台设备为上线状态,但实时状态没有更新最新数据。
A:检查下设备驱动上报的数据字段,是否与当前产品下的物模型字段一致,否则平台会忽略设备驱动的数据。