全部产品

附录D.6 【园区版】SNMP 协议设备接入-Rev1.0-2020-0918

修改记录及版本信息

序号

版本号

修改内容

修改时间

1

Rev1.0

文档创建

2020-09-18

1 xxx 品牌 SNMP 设备支持对接的型号

对接型号支持

TBD

对接类型

TBD

2 SNMP 设备接入操作

登录AIoT开放平台,选择数字园区引擎下的对应项目的实例,如下图所示:

image.png

点击基础能力-边缘管理-网关管理,点击对应的网关实例右侧的设备集成,如下图所示

image.png

2.1 添加SNMP协议

在设备集成页面首次集成时需要点击“新增协议”添加协议及设备:

image

在设备集成页面非首次集成时,需点击网关右侧的设置按钮中的“添加协议”:

image

然后,在下拉选择的协议列表中选择SNMP(官方)”

image

点击配置信息,进行连接通道配置。

SNMP版本支持v2和v3. 参照甲方提供的<楼宇设备信息表>的“SNMP设备信息表” TAB页,如下图所示,查看SNMP版本。如果SNMP版本v2,则请参照下面的2.1.1节(添加协议:SNMP版本为v2 )添加协议;如果SNMP版本v3-noAuthNoPriv, v3-authNoPriv, v3-authPriv,则请参照下面的2.1.2节(添加协议:SNMP版本为v3)添加协议。如果两个都有的话,则两个协议都需要添加

64CB722A-400E-47BB-B982-47531EB2D5BA.png

2.1.1: 添加协议:SNMP版本为v2

image.png

通道名称:自定义一个名称,不能与同一协议下的通道重名。输入示例为SNMP_V2

配置:如上图所示,需要以JSON格式配置以下参数:

snmp_version:当SNMP版本为v2时,固定填写2c

community:参照甲方提供的<楼宇设备信息表>的“SNMP设备信息表” TAB页社区名(SNMP版本为v2时填写)列填写

可选配置:

timeout_ms默认是200ms,对于设备所处的网络环境较差的情况,可手动增大该值,即增大每次等待应答的超时判定。

thread_count: 配置驱动创建并发采集的线程个数,适当设置线程个数可以提高多设备上报属性的效率。

线程个数计算方式:总设备数/期望每个线程控制的设备个数(期望值),例如驱动下有1200个SNMP设备,期望每个线程控制60个设备。那么thread_count=1200/60=20。

如果不配置该参数,则默认每个线程控制50个设备。

注意:线程个数还需参考硬件CPU及内存性能,设置线程数太多会适得其反,影响网关软件正常运行。

配置输入示例为 {"snmp_version":"2c","community":"public"}

2.1.2: 添加协议:SNMP版本为v3

image.png

通道名称:自定义一个名称,不能与同一协议下的通道重名。输入示例为SNMP_V3

配置:如上图所示,需要以JSON格式配置以下参数:

snmp_version: 如果SNMP版本v3-noAuthNoPriv, v3-authNoPriv, v3-authPriv,固定填写3

security_level:如果SNMP版本v3-noAuthNoPriv,填写noAuthNoPriv;

如果SNMP版本v3-authNoPriv, 填写authNoPriv

如果SNMP版本v3-authPriv,填写authPriv

usm_user:参照甲方提供的<楼宇设备信息表>的“SNMP设备信息表” TAB页用户名(SNMP版本为v3时填写)内容填写

auth_algorithm参照甲方提供的<楼宇设备信息表>的“SNMP设备信息表” TAB页认证算法(SNMP版本为v3-authNoPriv和v3-authPriv时填写)内容填写

auth_password:参照甲方提供的<楼宇设备信息表>的“SNMP设备信息表” TAB页认证密码(SNMP版本为v3-authNoPriv和v3-authPriv时填写)内容填写

privacy_algorithm:参照甲方提供的<楼宇设备信息表>的“SNMP设备信息表” TAB页加密算法(SNMP版本为v3-authPriv时填写)内容填写

privacy_password:参照甲方提供的<楼宇设备信息表>的“SNMP设备信息表” TAB页加密密码(SNMP版本为v3-authPriv时填写)内容填写

输入示例为:

{

"snmp_version":"3",

"security_level":"authPriv",

"usm_user":"rwuser_sa",

"auth_algorithm":"SHA",

"auth_password":"sha_pw111",

"privacy_algorithm":"DES",

"privacy_password":"aes_pw111"

}

2.2 添加SNMP设备

2.2.1 添加设备:SNMP版本为v2

如下图所示,通过点击2.1.1 所建协议SNMP_v2右侧的“设置”图标,选择新建设备”

image.png

设备的参数请按下图所示进行配置:

image

设备名称:参照甲方提供的<楼宇设备信息表>的“SNMP设备信息表” TAB页设备IoT编码填写

设备别名:参照甲方提供的<楼宇设备信息表>的“SNMP设备信息表” TAB页设备名称填写

功能定义:用来定义设备的功能,选择后续添加

设备配置:勾选“添加配置”,请以JSON格式为设备配置如下参数:

polling_time:网络设备属性的定时上报间隔,单位为ms。参照甲方提供的<楼宇设备信息表>的“SNMP设备信息表” TAB页点位上报周期填写

ip_address:参照甲方提供的<楼宇设备信息表>的“SNMP设备信息表” TAB页设备IP填写

agent_port:参照甲方提供的<楼宇设备信息表>的“SNMP设备信息表” TAB页设备Agent端口号填写

security_engine_id:当版本为3,且设备需要上报trap类型的事件时,需要配置此id。参照甲方提供的<楼宇设备信息表>的“SNMP设备信息表” TAB页security_engine_id(TBD)填写

change_report:0或1。1表示在每一个polling_time定义的时间间隔到达时,设备的每个属性数值有变化时才会上报到云端;0表示在每一个polling_time定义的时间间隔到达时,设备的每个属性不管数值是否有变化,均需要上报一次。参照甲方提供的<楼宇设备信息表>的“SNMP设备信息表” TAB页change_report(TBD)填写

2.2.1.1 设备点位信息配置:属性

创建好的设备如下图所列,选择右侧的上云配置”,根据设备的点位信息为其添加各个功能点。

image

设备点位有属性和事件。参照甲方提供的<楼宇设备点位信息表>的“SNMP设备点位信息表” TAB页功能类型进行区分

image.png

进入功能定义界面后,可以为设备创建一个属性点:

image

名称:参照甲方提供的<楼宇设备点位信息表>的“SNMP设备点位信息表” TAB页功能名称填写

标识符:参照甲方提供的<楼宇设备点位信息表>的“SNMP设备点位信息表” TAB页功能标识符填写

数据类型:查看甲方提供的<楼宇设备点位信息表>的“SNMP设备点位信息表” TAB页SNMP私有数据类型,然后参照下面“SNMP参数类型与物模型的对应关系表”填写。例如SNMP私有数据类型为BITS时,填写对应的物模型数据类型text

取值范围:参照甲方提供的<楼宇设备点位信息表>的“SNMP设备点位信息表” TAB页取值范围填写

步长:参照甲方提供的<楼宇设备点位信息表>的“SNMP设备点位信息表” TAB页步长填写

单位:参照甲方提供的<楼宇设备点位信息表>的“SNMP设备点位信息表” TAB页单位填写

读写:参照甲方提供的<楼宇设备点位信息表>的“SNMP设备点位信息表” TAB页读写标志(属性专用)填写

扩展参数的配置如下图:

image

oid:参照甲方提供的<楼宇设备点位信息表>的“SNMP设备点位信息表” TAB页OID节点填写

data_type:查看甲方提供的<楼宇设备点位信息表>的“SNMP设备点位信息表” TAB页SNMP私有数据类型,然后参照下表进行设置:

SNMP参数类型与物模型的对应关系表

SNMP Syntax

data_type

物模型数据类型

BITS

3

text

Boolean

1

bool

Counter32

65

int32

DateAndTime

617

text

DisplayString

614

text

Double

73

double

Float

72

float

Gauge

66

int32

Gauge32

66

int32

INTEGER

2

int32

Integer32

66

int32

IpAddress

64

text

OBJECT IDENTIFIER

6

text

OCTET STRING

4

text

Opaque

68

text

Opaque Double

121

double

Opaque Float

120

float

TimeTicks

67

text

TruthValue

600

enum

Unsigned32

66

int32

2.2.1.1 设备点位信息配置:事件

image

根据上图所示,设置事件参数:

功能名称:参照甲方提供的<楼宇设备点位信息表>的“SNMP设备点位信息表” TAB页功能名称填写

标识符:参照甲方提供的<楼宇设备点位信息表>的“SNMP设备点位信息表” TAB页功能标识符填写

事件类型:参照甲方提供的<楼宇设备点位信息表>的“SNMP设备点位信息表” TAB页事件类型(事件专用)填写

根据需要可以为事件添加输出参数,点击输出参数右侧的编辑,示例如下:

image

参数名称:参照甲方提供的<楼宇设备点位信息表>的“SNMP设备点位信息表” TAB页事件参数名称(事件专用)填写

标识符:参照甲方提供的<楼宇设备点位信息表>的“SNMP设备点位信息表” TAB页事件参数标识符(事件专用)填写

数据类型:参照甲方提供的<楼宇设备点位信息表>的“SNMP设备点位信息表” TAB页事件类型(事件专用)填写

取值范围:参照甲方提供的<楼宇设备点位信息表>的“SNMP设备点位信息表” TAB页取值范围填写

步长:参照甲方提供的<楼宇设备点位信息表>的“SNMP设备点位信息表” TAB页步长填写

单位:参照甲方提供的<楼宇设备点位信息表>的“SNMP设备点位信息表” TAB页单位填写

事件的扩展描述中,需要设置事件(trap)的oid字段和输出参数(若有)的扩展描述outputData字段(数组类型)。

image

如上图所示,每个参数的扩展描述包括:

oid:参数对象的oid值。参照甲方提供的<楼宇设备点位信息表>的“SNMP设备点位信息表” TAB页事件rapOID填写

outputData: 填写说明如下:

identifier:参照甲方提供的<楼宇设备点位信息表>的“SNMP设备点位信息表” TAB页

事件参数标识符(事件专用)填写

data_type:查看甲方提供的<楼宇设备点位信息表>的“SNMP设备点位信息表” TAB页

SNMP私有数据类型,参照前述“SNMP参数类型与物模型的对应关系表”填写

如有需要按照如上操作,可为设备定义多个属性和事件

2.2.2 添加设备:SNMP版本为v3

如下图所示,通过点击2.1.1 所建协议SNMP_v3右侧的“设置”图标,选择新建设备”

image.png

SNMP版本为v3的设备创建方法,与v2类似。请参考2.2.1节添加设备。

2.3 部署设备配置

在完成驱动和设备的配置后,点击部署,进行设备配置的协议下发到边缘服务器。如下图所示。

特别提醒:驱动部署时,网关侧对应驱动将重启,该驱动下的所有设备将出现离线后在线。这期间设备不可用,请部署人员提前与甲方沟通部署时间

image

点击部署后可以查看设备配置下发的状态和部署进度。

image

说明:如果某个设备有新更新的配置信息,重新点击部署后,只会下发有改动的设备配置协议,其余未修改的配置信息不会再次下发到边缘服务器,部署的时间根据修改的设备数量有关。