中国电信 NB网关2

admin管理员组

文章数量:1536073

2024年7月19日发(作者：)

中国电信NB网关2.0

（标准版+高级版）

正式环境指导手册

（V1.1）

天翼物联科技有限公司

二〇二二年十月

编制单位：

编写单位：

参与编写人员

修订记录

版本号

1.0

日期

20200429

初稿

描述

天翼物联科技有限公司

刘奇峰

编制说明

本文档由中国电信物联网公司组织编写，主要针对NB客户使用中国电信NB

网关，本文档主要针对客户对接、使用NB网关的操作指引。

目录

一、

申请正式环境账号 ................................................................................................ 4

二、快速入门 ....................................................................................................................... 4

3.1 新建应用 .................................................................................................................... 5

3.2 应用下导入产品 ........................................................................................................ 8

3.3 命令下发方式设置 .................................................................................................. 13

3.4 终端注册 .................................................................................................................. 14

3.5 调用北向API订阅数据 ........................................................................................... 16

三、基本操作 ..................................................................................................................... 17

3.1系统管理 ................................................................................................................... 17

3.2设备管理 ................................................................................................................... 21

四、典型问题 ..................................................................................................................... 30

4.1 APN配置不正确导致命令终端无法实时接收下行命令 ....................................... 30

5.2 平台设置不正确，导致命令缓存下发 .................................................................. 30

5.3注册单个设备进行测试时参数填写有误，导致数据上报失败 ........................... 31

5.4 终端上报数据了，但是平台没有收到。 .............................................................. 31

5.5命令下发显示“超时” ............................................................................................. 32

5.6命令下发显示“已发送” ............................................................................................ 32

5.7终端上报数据，数据已经推送到客户服务器，但是NB网关上没有记录 ......... 32

一、 申请正式环境账号

联系客户经理通过CRM受理。

二、快速入门

一个应用成功接入正式环境主要包括以下5个基本步骤：

1）新建一个应用

2）在应用下“产品模型”中导入产品（应用—产品模型—新增产

品模型—从产品中心导入）

3）命令下发方式配置

4）注册终端

5）通过北向API订阅相关数据

3.1 新建应用

新建应用

点击左侧导航栏“应用列表”->创建应用,在刷新后的页面中填

写应用的相关信息。

3.1.1基本信息：

填写应用名称，其中“所属行业”已经默认选择“公用事业”，

消息跟踪数据授权，建议客户打开，后期客户可在设备列表页面针对

设备单独开启数据跟踪能力。

3.1.2消息推送：

1）选择协议

NB网关给客户服务器推送订阅的数据，可以采用两种协议：

https和http。采用https方式，需要客户上传自己应用服务器的

CA证书，平台上已经内置CA-Baltimore、GeoTrust、Verisign、

DigiCert、GlobalSign、Entrust、Thawte这7种应用服务器证

书，请确认您的应用服务器所使用的CA证书是否已经包含在上述证

书中，如果没有，请上传CA证书。采用http方式，NB网关将会采

用http的方式给客户服务器推送数据，但是http方式是不安全

的，此方式会存在平台与应用服务器之间通信信息泄露，中间人攻

击等风险。建议客户选择https的推送方式。

2）选择方式

NB网关给客户提供了两种消息推送方式：消息缓存和消息不缓

存。消息不缓存方式，平台给应用服务器推送订阅消息失败后，不

会重新推送消息。消息缓存方式平台给应用服务器推送订阅消息失

败后，会重新推送消息，订阅消息缓存天数可配置（1-3天）。

3.1.3高级配置

主要包括平台服务相关的配置，您可以选择使用默认设置，也

可以根据需要调整设置。

邮件服务器：已经默认配置为“中国电信物联网开放平台”，客

户无需更改。

短信服务器：目前平台短信发送能力正在建设中，暂不支持客户

配置，无需更改。

平台能力：透传模式、存储模式

透传模式，网关不会缓存客户终端上报的数据，平台会根据客户

服务器的订阅结果向客户服务器推送相应的数据。推送完成后平台不

会缓存终端上报的数据。

存储模式，网关将会对终端上报的数据默认存储2天。

应用程序接口：平台预置了各个行业的行业套件，方便应用服务

器直接进行调用。默认已经配置，无需更改。

3.1.4其他

应用注册完成后，请用户注意保存弹出页面中的应用id和密钥。

填写应用的基本信息

3.2 应用下导入产品

在测试环节发布的插件，其实已经存入到产品中心，当我们正式

平台开户后，就需要从产品中心将profile、插件导入到应用下，导

入产的有效使用范围是单个应用。

步骤如下：

1、应用——产品模型——新增产品模型——从产品中心导入

2、在产品中心中填写“产品名称”，选择“产品范围”为“第三方公

开”或“自有”（根据开发者protol中选择的发布方式填写）

1）输入产品名称，产品范围为“第三方公开”，点击“搜索”，点击搜

索到的产品，进入产品详情，点击“导入”即可。

2）输入产品名称，产品范围为“自有”，点击“搜索”，点击搜索到的

产品，进入产品详情，点击“导入”，在弹出的页面里填写“产品验证

码”即可。

PS：

产品验证码需要在产品中心

180.100.217.193:8094/#/pages/home

获取(登录账号就是测试平台登录账号及密码)

Step1：找到我的产品

Step2：获取产品码

导入产品后，产品模型中该产品状态为“导入中”

产品导入成功后，产品模型中“状态”会由“导入中”变为“创建时

间”

终端上报数据进行验证

1、“历史数据”——“全量历史数据”中有终端上报成功解码的数据

2、“消息跟踪”中有编解码插件解码码流的过程

产品上传

3.3 命令下发方式设置

NB网关提供两种命令下发方式：缓存下发和立即下发。如下图所

示进入应用的NB-IOT设置标签页，客户需要根据终端中卡签约的apn

参数来配置省电模式。平台会根据这里配置的省电模式和命令下发参

数自动选择命令下发方式（缓存下发或立即下发），命令下发是通过

北向api来实现的,expireTime参数请参考北向开发API文档。

建议值：终端若会进入PSM模式，保持默认值。如终端不会进入

PSM模式，则配置为DRX模式。具体需要根据卡签约的apn来进行配

置。

配置命令下发方式

3.4 终端注册

3.5.1单个终端注册

终端注册入口

切换到设备管理列表页面，点击左侧导航栏“设备”，再点击页

面中的“注册设备”按钮，进行单个终端的注册。

基本信息

在弹出页面中选择“单一注册设备”，客户需要根据实际情况填

写相关信息，“设备标识码”请填写终端的IMEI号，

安全接入

如模组支撑DTLS和DTLS+这两种安全传输方式接入，且客户希

望采用更加安全的传输方式接入平台，这里客户选择“是”。采用安

全传输方案的模组需要在模组中配置psk码，通常由客户预先为模组

分配好，并在平台注册设备时在平台配置。批量安全设备的注册通常

通过批量注册实现。

如模组不支持安全接入或者客户希望先尽快对接，“安全设备”

可以选择“否”，然后点击“确定”，完成单个终端注册。

页面-单个终端注册

3.5.2批量注册

1）Excel文件批量注册

在弹出页面中选择“批量设备注册”，客户需要先点击“批量注

册文件模板”下载模板文件，按照要求填写需要批量注册的设备信息。

填写完成后上传模板，点击确定。

页面-多个终端注册

2）北向接口

先调用《中国电信物联网开放平台API参考1.9.1》中3.2.1的注册直连设

备接口，在调用3.2.3的修改设备信息接口，具体操作请参考api文档。

3.5 调用北向API订阅数据

《中国电信物联网开放平台API参考1.9.1》提供如下的订阅接口，具体使用说

明请见相应的api文档

三、基本操作

3.1系统管理

3.1.1认识平台

客户登录平台后，看到的第一个页面，对平台的功能进行简单介绍。

4.1.2首页

首页对于平台的使用情况进行了集中展示，包含：当前版本、下级企业数、设备接入数、

应用接入数以及当前配额等关键信息。

4.1.3 应用管理

应用管理，应用列表下，展示了客户创建的所有应用，应用名称等信息。

点开应用，可以看到应用的配置信息，主要包括“应用定义”、“服务设置”、“数据统计”、

“外部服务对接”、“被授权应用”、“授权应用”、“企业网关对接”

应用定义，主要包括应用的基本信息、安全信息、接入信息、推送信息、平台能力等一

个应用的基本信息。

服务设置，主要是可由客户进行配置的关键信息，包括工作模式、下行消息提示、安全

认证服务、推送服务控制、订阅推送服务等关键配置。

数据统计，分为系统服务统计和消息流控统计。系统服务统计对于当前应用下的邮件、

短消息、命令下发、规则、北向推送等关键信息进行统计、展示

外部服务对接，提供了NB网关与连接管理平台（CMP）关联的配置功能，可以配置CMP

的账号密码，实现机卡一体化的管理功能。

被授权应用，展示了将管理权限授权给了当前应用的应用。

授权应用，展示了当前应用被授权给了哪些应用。

企业网关对接，暂未启用。

4.1.4企业管理

企业管理为客户提供企业账号管理功能，运营商为客户分配的是一级企业账号。客户还

可以创建二级企业账号。

4.1.5系统配置

功能暂未启用

4.1.6权限

权限管理包括用户管理和角色管理。

用户管理，可以创建不同的子账号（区别于企业管理下的二级企业账号），一级企业账

号和二级企业账号都可以创建子账号，并未子账号分别不同的角色。

角色管理，分别全局角色和普通角色。全局角色具备账号级的全部权限。普通角色的权

限可以由客户自由分配。

4.1.7日志

提供了所有页面操作的详细日志。

4.1.8工具

提供了离线签名工具的下载功能。

3.2设备管理

平台的设备管理是基于应用的，切换到设备管理页面时，必须选择一个应用。

3.2.1首页

首页提供了当前应用下的基本信息，包括设备的在线、异常、离线情况、API调用情况、

上下行消息情况，以及设备和在线率的变化趋势等统计信息。

页面右上角提供了账号级的设备搜索功能，可以快速定位到设备所在的应用。

3.2.2产品模型

页面展示了当前应用下已经导入的产品，同时可以从产品中心导入客户在开发环境开发

完成的产品。

公开发布的产品可以直接在下列页面中根据产品名称、设备类型进行筛选。如果是私有

发布的产品可以通过右上角的“第三方产品”根据产品码进行加载。

PS：

产品验证码需要在产品中心

180.100.217.193:8094/#/pages/home

获取(登录账号就是测试平台登录账号及密码)

Step1：找到我的产品

Step2：获取产品码

3.2.3设备

所有设备，展示了当前应用下所有客户注册的所有设备，支持导出、搜索等功能。

点击具体设备可以查看设备的详细信息，包括设备信息、历史数据、设备追踪、操作记录、

消息跟踪、告警、设备影子、命令、子设备等信息。

设备注册，提供了设备单个注册和批量注册功能，单个注册可以通过页面进行注册，批

量注册可以填写模板进行设备的批量注册。

平台提供设备打标签功能，支撑将一批终端打上相同的标签，便于管理。可以通过页面

右上角的“添加标签”进行标签的添加。

3.2.4群组

平台提供设备的群组管理功能，可以进行群组的增删，群组分为根群组，子群组。

3.2.5告警

呈现用户通过规则引擎定义产生的该应用下所有的告警信息，可以通过定义的规则来

对设备的状态进行管理。

3.2.6批量任务

平台提供“批量命令下发”、“批量属性修改”、“批量位置上传”、“批量删除设备”、“批量

设备配置”、“批量软固件升级”等6大类批量任务。

批量命令下发，产品品模型里定义平台可以向设备下发的命令，北向应用服务器可以调

用IoT平台的“创建批量任务”接口，对批量设备下发控制指令，实现对设备的远程控制，

本界面列表显示任务执行的状态和结果。

批量属性修改，当需要修改多个设备在IoT平台上的注册信息，例如厂商、名称等基本

信息时，则可以进行批量属性修改。

批量位置上传，当需要添加多个设备的位置信息时，如经度、维度时，可以进行批量属

性修改。

批量删除设备，当需要删除多个设备时，可以上传批量设备信息，进行批量删除。

批量设备配置，暂未启用。

批量软固件升级，平台支持软固件升级功能，需要先创建升级任务、勾选差分包、选择

需要升级的设备，最后启动任务。

3.2.7规则

平台支持“规则引擎”的能力，客户可以针对终端上报数据的特点，预先配置相应的规则，

触发相应的动作。

3.2.8软件库

软件库主要用户保存客户上报的固件包/软件包，用于发起终端升级任务。上传至平台

的软件包需要签名，且需要将公钥上传至平台，然后再进行固件包或者软件包的上传工作。

3.2.9消息跟踪设备

可以查看当前应用下所有开启了消息跟踪的设备

3.2.10对接配置

暂未启用。

四、典型问题

4.1 APN配置不正确导致命令终端无法实时接收下行命令

由于在一些应用场景下NB终端是功耗敏感，对下行命令的时延要求不高的，有些是功

耗不敏感，对下行要求高的。针对不同的应用场景，中国电信推出了9个不同的APN供客

户选择，类似路灯这种有源供电的，是功耗不敏感但时延敏感的应用场景，在开卡时，需要

受理APN为。如果终端是功耗敏感，且每天多数时间是处于睡眠状态的，

如抄表类应用，在开卡时需要设置APN为 ctnb。

5.2 平台设置不正确，导致命令缓存下发

客户需要登录sp portal，针对实际应用进行配置，需要跟卡受理时配置的APN中定义的

省电模式保持一致。路灯行业建议受理的APN是，这里需要配置为DRX

模式。“下行消息指示”默认关闭。抄表类行业的APN建议受理为ctnb，这里保持默认值即

可。

5.3注册单个设备进行测试时参数填写有误，导致数据上报

失败

在终端注册时需要在“设备标识码”中填写设备的IMEI号，设备类型、制造商id、制

造商名称、型号等信息需要与客户开发编解码插件时定义的信息保持一致。“安全设备”出需

要选择“否”。

5.4 终端上报数据了，但是平台没有收到。

首先需要找到这个设备，点开前面注册的设备，去“全量历史数据”标签页下确认是否

有上报的数据。

然后查看终端的状态，如终端显示离线客户需要核实终端中配置的服务器地址，如终端

往正式平台发送数据需要配置服务器地址为117.60.157.137，端口5683，不要设置成测试平

台的地址，端口不要设置成5684。如终端显示在线，请客户核实终端上报的数据是否能够

正确被相应的编解码插件正确解析，如数据正确请使用编解码插件离线检测工具检查编解码

插件的功能是否客户需求。

终端有时会出现at+ncdp设备不起效的情况，需要设置at+ncdp设置完成后使用at+nrb

重启模组再附着。

如果以上排查后仍然不行，请拨打4008285656报障电话。

5.5命令下发显示“超时”

请客户检查终端中的SIM受理时的APN（注意从终端中读取的apn是不生效的），是否

符合客户的应用场景，结合APN分析终端是否具备收到该条下发命令的能力。

5.6命令下发显示“已发送”

此时平台正在重传下发该条命令，一段时间后命令状态会更新，如变成“超时”，请参考

上一个问题。

5.7终端上报数据，数据已经推送到客户服务器，但是NB网

关上没有记录

检查应用的配置，应用的【平台能力】需要设置为“存储模式”，NB网关才会缓存终端

上报的数据，如配置成基础能力则NB网关不会缓存终端上报的数据。

本文标签： 设备应用平台终端