采集信号发布使用手册

HOSHOO采集信号发布使用手册

 

版权说明

本手册版权归深圳市哈烁实业有限公司所有。保留一切版权。除了版权法允许的使用方法之外,未经事先许可,任何人不得复制、改编或翻译。

 

保证说明

本手册所含之内容如有改变,恕不另行通知。深圳市哈烁实业有限公司对由于本手册的错误而引起的损害不承担责任,对由于提供或使用本手册而随带发生的损害亦不承担责任。

 

商标说明

HOSHOO?是深圳市哈烁实业有限公司的注册商标。Microsoft?是美国Microsoft公司的注册商标。

  

1 集成平台配置... 1

  1.1 安装采集信号发布设备... 1

  1.2 信号组... 1

  1.3 发布点... 2

2 演示页面... 5

  2.1 信号组... 6

  2.2 发布点... 6

3 开发者文档... 8

  3.1 html js函数... 8

  3.2 集成平台回调函数... 12

  3.3 点位类型... 15

  3.4 事件类型... 15

  3.5 点位状态... 17

    3.5.1 报警用户状态... 17

    3.5.2 报警防区状态... 17

    3.5.3 巡更点状态... 17

    3.5.4 门禁门状态... 18

    3.5.5 停车场道闸状态... 18

    3.5.6 联动输出点状态... 18

    3.5.7 对讲机状态... 18

  3.6 点位控制... 18

    3.6.1 报警用户控制... 18

    3.6.2 报警防区控制... 19

    3.6.3 门禁门控制... 19

    3.6.5 停车场道闸控制... 19

    3.6.6 监控摄像机控制... 19

    3.6.7 联动输出点控制... 20

    3.6.8 对讲机控制... 20

    3.6.9 外部应用控制... 20

 

1 集成平台配置

1.1 安装采集信号发布设备

安装集成平台软件后,先运行集成平台软件,在设备管理里添加设备,在设备设置选项页里设备类型选择功能设备,驱动名称选择采集信号发布:

1.2 信号组

管理采集信号发布的信号组。

在平台软件中操作面板里的其它管理面板组上,点击【采集信号发布】下【信号组】,功能区将显示信号组数据网格,如下图:

右键菜单,可选择进行增加、修改、删除等操作。

增加信号组:

右键菜单,点击【增加】,将弹出增加信号组框,如下图:

组名称:该信号组的名称,不能为空。

组类型:该信号组的组类型。

统计类型:该信号组为类型组时,对应的统计类型。

变量名称:该信号组对应的html元素ID。

可录入信号组备注。

1.3 发布点

管理采集信号发布的发布点。

在平台软件中操作面板里的其它管理面板组上,点击【采集信号发布】下【发布点】,功能区将显示发布点数据网格,如下图:

分上下两部分,上面为发布点列表,下面为当前选中发布点的设备列表。

l  发布点资料

右键菜单,可选择进行增加、修改、删除等操作,也可对发布点进行查看发布信息控制。

增加发布点:

右键菜单,点击【增加】,将弹出增加信号组框,如下图:

发布点名称:该发布点的名称,不能为空。

发布页面:该发布点对应的页面,页面的物理位置为安装目录下的Web\SSP路径里。

附近发布点:该发布点附近的发布点。

可录入发布点的联系信息及发布点备注。

l  设备资料

右键菜单,可选择进行增加、修改、删除等操作。

增加设备:

右键菜单,点击【增加】,将弹出增加信号设备框,如下图:

区域组:该设备对应的区域组。

类型组:该设备对应的区域组。

设备类型:该设备对应的点位类型。

采集设备:该设备对应的采集点位。

开状态对应信号:该设备的开对应信号类型,当为状态或者值时,将不做统计而是只进行状态或者值发布。

状态资源ID:该设备对应的html元素ID或者其它资源ID。

可录入设备备注。

2 演示页面

集成平台打包了demo页面可供演示用,发布了开关统计、环境采集、空调采集、人流统计、人脸识别数据。

为方便演示,人流统计可通过报警防区触发报警来进行采集。环境采集使用其他系统的SNMP监视驱动获取电脑的运行时长和总内存大小。如下图:

演示配置中的变量名称/状态资源ID为html中的实际元素或者资源名称,必须保持一致且大小写完全相同。

演示页面显示效果:

2.1 信号组

配置说明:

序号

数据点名称

组类型

统计类型

变量名称

1

一楼

区域


Floor1

2

二楼

区域


Floor2

3

会议室

类型

MeetRoom

4

实验室

类型

TestRoom

5

AI训练平台

类型

TrainPlatform

5

状态更新

区域


Status

6

状态更新组

类型

Status

 配置示例:

2.2 发布点

发布页面为demo(ESMap).htm。

集成平台打包了demo页面可供演示用。

信号设置配置说明:

序号

区域组

类型组

设备类型

采集设备

开状态对应信号

状态资源ID

备注

1

一楼

会议室

门禁门

1号门

MapModel.76787

一楼空闲会议室

2

一楼

会议室

门禁门

2号门

MapModel.76789

一楼空闲会议室

3

一楼

会议室

联动输出点

闸机进

MapModel.76783

一楼空闲会议室

4

一楼

实验室

门禁门

HOSHOO正门

MapModel.76778

一楼空闲实验室

5

一楼

AI训练平台

报警防区

办公室按钮

触发

MapModel.76757

一楼空闲AI训练平台

6

二楼

会议室

报警防区

公司大门

触发

MapModel.76767

二楼空闲会议室

7

二楼

会议室

报警防区

测试

触发

MapModel.76794

二楼空闲会议室

8

二楼

实验室

门禁门

door1

MapModel.76799

二楼空闲实验室

9

状态更新

状态更新组

报警防区

展厅

状态

MapDot.AlarmZone.Test

地图测试防区

10

状态更新

状态更新组

其他系统数据点

PC.运行时长

当前值

Temperature

环境监测温度

11

状态更新

状态更新组

其他系统数据点

PC.总内存

当前值

AirQuality

环境监测空气质量

12

状态更新

状态更新组

其他系统数据点

1#温度

当前值

AirC_Temperature

空调机组温度

13

状态更新

状态更新组

其他系统数据点

1#湿度

当前值

AirC_Humidity

空调机组湿度

14

状态更新

状态更新组

其他系统数据点

1#风机手动状态

当前值

AirC_Mode

空调机组手动状态

15

状态更新

状态更新组

其他系统数据点

1#风机运行状态

当前值

AirC_FanStatus

空调机组风机状态

16

状态更新

状态更新组

其他系统数据点

1#风机故障状态

当前值

AirC_WorkStatus

空调机组工作状态

17

状态更新

状态更新组

其他系统数据点

1#水阀调节

当前值

AirC_WaterValve

空调机组水阀调节

18

状态更新

状态更新组

其他系统数据点

1#滤网压差

当前值

AirC_PressureDifference

空调机组滤网压差

19

状态更新

状态更新组

监控摄像机

大门门口外

状态

MapDot.MTCamera1

地图摄像机

20

状态更新

状态更新组

其他系统数据点

一楼人流统计

当前值

Flow_Floor1

人流统计一楼

21

状态更新

状态更新组

其他系统数据点

三楼体验中心人流统计

当前值

Flow_Floor3

人流统计三楼体验中心

22

状态更新

状态更新组

报警防区

防区3

状态

MapDot.AlarmZone1

地图报警防区

配置示例:

3 开发者文档

集成平台接口分两部分:html js函数和集成平台回调函数。

3.1 html js函数

html js函数是集成平台将数据发布到html页面里调用的js函数。

html js函数列表:

函数

函数名

参数值

说明

背景颜色

OL_   UpdateBackgroundColor (color)

color:   背景颜色,类型为字符串。形如#000000

使用跟集成平台一样的背景颜色。

数据更新

OL_ShowData(resId,   data)

resId:html元素ID或者其它资源ID,类型为字符串。类型组统计结果时对应区域组变量名_类型组变量名;区域组统计结果时对应区域组变量名,附近发布点则在前面加上Near_;其它情况时对应设备状态资源ID

data:数据内容,类型为字符串。

统计结果、状态、值更新都使用该函数。

开关状态更新

OL_ShowOnOff   (resId, bOn)

resId:html元素ID或者其它资源ID,类型为字符串。对应设备状态资源ID

bOn:开关状态,类型为布尔型。true开,false为关。

开关状态更新使用该函数。

推送事件

OL_PushEvent   (objEvent)

objEvent:事件内容,类型为对象。

{

  Kind: X, //类型标识0: 自动处理   1: 非自动处理 2: 手动处理   3: 手动触发联动

  EventTime: “X”, //事件时间   yyyy-mm-dd hh:nn:ss

  EventGUID: “X”, //事件唯一ID

  EventType: X, //事件类型

  EventText: “X”, //事件内容

  ProcResult: { //处理结果,手动处理时有该内容

    ProcResult: “X”, //处理结果

    PreResult: “X”, //预处理结果

    Note: “X”, //备注

    OperName: “X” //处理人

  },

  DotType: X, //点位类型

 

  //报警系统开始

  ClientID: “X”, //用户编号

  ZoneNo: X, //防区编号

  AlarmType: X, //报警事件类别

  ClientStatus: X, //之前用户状态

  AlarmZoneID: “X”, //防区号

  UserID: X, //使用者编号

  ExtraMsg: “X”, //补充事件描述

  //报警系统结束

 

  //系统事件开始

  SysMsg: “X”, //事件描述

  //系统事件结束

 

  //巡更系统开始

  PatrolDotID: X, //巡更点号

  PatrolManID: X, //巡更员号

  PatrolDotStatus: X, //巡更状态

  //巡更系统结束

 

  //门禁系统开始

  ACDoorNo: X, //门禁门号

  ACUserNo: “X”, //使用者号

  ACUserName: “X”, //使用者名称

  ACDetail: “X”, //事件详情

  ACStatus: X, //门状态

  ACEventDesc: “X”, //使用者部门

  //门禁系统结束

 

  //停车场系统开始

  PKDoorNo: X, //道闸编号

  PKUserNo: “X”, //使用者号

  PKUserName: “X”, //使用者名称

  PKDetail: “X”, //事件详情

  PKStatus: X, //道闸状态

  PKEventDesc: “X”, //使用者部门

  //停车场系统结束

 

  //对讲系统开始

  ICPhoneNo1: X, //主叫对讲机号

  ICPhoneNo2: X, //被叫对讲机号

  ICDetail: “X”, //事件详情

  ICStatus: X, //对讲状态

  //对讲系统结束

 

  //视频系统开始

  VSEventDot: “X”, //事件点

  VSEventText: “X”, //事件详情

  VSEventDesc: “X”, //事件描述

  //视频系统结束

 

  //其他系统开始

  OSNo: X, //数据点号
    OSStatus: “X”, //
状态

  OSEventText: “X”, //事件内容

  OSEventDesc: “X”, //事件描述

  OSUserNo: “X”, //使用者号

  OSUserName: “X”, //使用者名称

  OSEventSpecLinkDesc: “X”, //特殊联动描述

  OSUserNo2: “X”, //使用者号2

  //其他系统结束

 

  //外部事件点开始

  ExtEventDot: “X”, //事件点

  ExtEventText: “X”, //事件详情

  ExtEventDesc: “X”, //事件描述

  //外部事件点结束

 

  //定时器开始

  TimerID: X, //定时器号

  TimerEventText: “X”, //事件内容

  //定时器结束

 

RecordEvent: true,   //是否记录事件

 

//事件扩展才有开始

OnlyStatus: false,   //是否仅状态

AutoProcess: false,   //是否自动处理

//其他系统才有开始

OSEventTag: X, //事件标志

OSExtData: “X”, //扩展事件数据

OSExtJsonData: “X”,   //扩展事件json数据

OSEventTag2: X, //事件标志2

OSEventTag3: X, //事件标志3

//其他系统才有结束

MsgOnOff: “X”, //事件特殊标记

MsgExtJson: {  //事件图片

  Pictures: [{

    PictureNameType: X, //图片名称类型   0: 1: 识别照片   2: 抓拍照片 3: 场景图片   4: 视频抓拍 5: 识别图片   6: 抓拍图片

    PictureType: X, //图片类型

    FileName: “X”, //图片文件名/URL

    DeviceID: X, //通讯设备ID

    PictureInfo: “X”, //图片相关信息,如人脸相似度

}]

},

MsgJson: { //事件扩展对象数据

  DataType: X; //数据类型   0: 其他系统数据1: 雷达数据

  Data: “X”; //其他系统数据时为字符串, 雷达数据为对象

} //

//事件扩展才有结束

}

接收仅状态事件及处理后将进行推送。

推送事件扩展

OL_PushEventEx   (objEvent)

objEvent:事件内容,类型为对象。详细见上面的“推送事件”里的objEvent定义。

接收到任何事件都进行推送。

推送状态

OL_HookStatus(objStatus)

objStatus:点位状态,类型为对象。

{

  DataType: X, //数据类型   0: 点位状态 1: 点位值   2: 报警防区布/撤防

  DotType: X, //点位类型

  DotID: “X”, //点位编号

  Status: “X”, //当前状态/   [DataType30: 撤防   1: 布防]

  OldStatus: “X”, //之前状态

}

状态改变或者采集值变化时推送。

3.2 集成平台回调函数

集成平台回调函数是html js回调集成平台功能的函数,该函数为OL_CallBack(tag, data)。tag为功能名,data为参数,data为字符串时,各子参数以回车符\r(字符值为13)来分隔。函数通过变量OL_CallBack_Return返回函数值,无返回值则OL_CallBack_Return为undefined。

回调函数功能列表(点位资源ID为集成平台中信号设备配置对应的状态资源ID):

功能

功能名

参数值

返回值

加载完成

LoadComplete

json字符串

{

  "PushEvent": true, //启用推送事件

  "PushEventEx": true, //启用推送事件扩展

  "HookStatus": true, //启用推送状态

  "WebGL": false //是否有使用WebGL,如三维地图

}

无返回值

右键菜单

RightClick

json字符串

{

  "MTMonitorArray": true, //显示“监控监视器阵列”菜单项

}

无返回值

点位右键菜单

DotRightClick

字符串

参数1:点位资源ID

参数2true: 显示“电子地图菜单项;false:   不显示“电子地图菜单项

无返回值

点位点击

DotClick

字符串

参数1:点位资源ID

无返回值

显示点位详细信息

DotShowHint

字符串

参数1:点位资源ID

无返回值

报警系统控制

ControlAlarmSystem

字符串

参数1:点位资源ID

无返回值

点位控制

Control

字符串

参数1:点位资源ID

参数2控制值

参数3:控制参数1

参数4:控制参数2

参数5:控制参数3

无返回值

点位点联动

DotLink

字符串

参数1:点位资源ID

无返回值

点位点控制

DotCtrl

字符串

参数1:点位资源ID

参数2:点控制序号(1-10

无返回值

点位录像回放

RecordPlayBack

字符串

参数1:点位资源ID

参数2:参考时间节点(yyyy-mm-dd hh:nn:ss)

无返回值

点位人工登记事件

ManualRecordEvent

字符串

参数1:点位资源ID

无返回值

显示电子地图

GotoMap

字符串

参数1:电子地图ID

无返回值

跳转发布点

GotoSSPPage

字符串

参数1:发布点号

无返回值

查看点位联动设置

ViewLinkConfig

字符串

参数1:点位资源ID

无返回值

查看点位事件报表

ShowEventChart

字符串

参数1:点位资源ID

无返回值

查看点位人工登录事件报表

ShowManualRecordEventChart

字符串

参数1:点位资源ID

无返回值

显示点位电子地图

ShowMap

字符串

参数1:点位资源ID

无返回值

获取取点位详细信息

GetDotInfo

字符串

参数1:点位资源ID

字符串

点位详细信息

查询数据库

QueryDB

json字符串

{

  "SQL": “X”, //SQL语句,只支持查询

  "FromExtDB": false, //是否从外部数据库查询

  "Page": X, //页码, 从第几页开始,第一页为1,默认为1

  "Size": X //记录数,默认为100

}

对象

{

Result: true, //是否成功

Page: X, //查询页码

Size: X, //实际每页查询数量

Records : [{ //行记录对象数组,含字段名和字段内容

}]

}

取事件图片路径

GetEventPicture

字符串

参数1:图片类型

参数2:图片文件名/URL

参数3:通讯设备ID

字符串

图片路径

窗口边框切换

WindowBorderSwitch

无参数

无返回值

关闭窗口

CloseWindow

无参数

无返回值

获取窗口是否有边框

GetWindowIsNoBorder

无参数

布尔型

true:   无边框;false: 有边框。

3.3 点位类型

序号

类型值

点位名称

1

0

报警用户

2

1

报警防区

3

2

巡更点

4

3

门禁门

5

4

停车场道闸

6

5

监控摄像机

7

6

联动输出点

8

7

对讲机

9

8

视频摄像机

10

9

其他系统数据点

11

10

定时器

12

11

外部事件点

13

12

地图关联点

14

13

外部应用

15

-1

系统事件

3.4 事件类型

序号

事件值

系统类型

事件内容

1

0

报警系统

撤防

2

1

报警系统

布防

3

2

报警系统

外出布防

4

3

报警系统

留守布防

5

4

报警系统

报警

6

5

报警系统

火警

7

6

报警系统

紧急报警

8

7

报警系统

周边报警

9

8

报警系统

内部报警

10

9

报警系统

出入报警

11

10

报警系统

键盘报警

12

11

报警系统

挟持报警

13

12

报警系统

防拆报警

14

13

报警系统

医疗救助报警

15

14

报警系统

报警恢复

16

15

报警系统

故障

17

16

报警系统

未准备

18

17

报警系统

防区旁路

19

18

报警系统

防区禁用

20

19

报警系统

旁路恢复

21

20

报警系统

用户联机

22

21

报警系统

用户脱机

23

22

报警系统

防区布防

24

23

报警系统

防区撤防

25

24

报警系统

防拆恢复

26

25

报警系统

故障事件

27

26

报警系统

故障恢复

28

51

报警系统

未及时布防

29

52

报警系统

提早撤防

30

27

报警系统

用户信息

31

54

报警系统

交流电故障

32

55

报警系统

交流电故障恢复

33

56

报警系统

电池故障

34

57

报警系统

电池故障恢复

35

58

报警系统

定期测试

36

28

系统事件

主机脱机

37

29

系统事件

主机联机

38

30

系统事件

系统信息

39

31

巡更系统

巡更正常

40

32

巡更系统

巡更不正常

41

33

巡更系统

巡更无效

42

34

巡更系统

巡更超时

43

35

门禁系统

门禁开门

44

36

门禁系统

门禁关门

45

37

门禁系统

门禁非法

46

38

门禁系统

门禁报警

47

39

门禁系统

门禁恢复

48

40

门禁系统

门禁信息

49

41

门禁系统

门禁警告

50

42

停车场系统

停车场开闸

51

43

停车场系统

停车场关闸

52

44

对讲系统

对讲正常

53

45

对讲系统

对讲呼叫

54

46

对讲系统

对讲接通

55

47

对讲系统

对讲信息

56

48

视频系统

视频事件

57

49

其他系统

其他系统事件

58

50

外部事件

外部事件

59

53

定时器

定时器触发

60

59

全部系统

人工登记事件

3.5 点位状态

3.5.1 报警用户状态

序号

状态值

状态名称

1

0

未知

2

1

禁用

3

2

撤防

4

3

外出布防

5

4

留守布防

6

5

报警

7

6

未准备

8

7

布防

9

8

脱机

3.5.2 报警防区状态

序号

状态值

状态名称

1

0

未知

2

1

正常

3

2

禁用

4

3

旁路

5

4

报警

6

5

未准备

7

6

故障

8

7

布防

3.5.3 巡更点状态

序号

状态值

状态名称

1

0

未知

2

1

不活动

3

2

等待

4

3

活动

5

4

正常

6

5

超时

7

6

提前

8

7

迟到

3.5.4 门禁门状态

序号

状态值

状态名称

1

0

未知

2

1

打开

3

2

关闭

4

3

非法刷卡

5

4

报警

6

5

报警恢复

7

6

警告

8

7

信息

3.5.5 停车场道闸状态

序号

状态值

状态名称

1

0

未知

2

1

打开

3

2

关闭

3.5.6 联动输出点状态

序号

状态值

状态名称

1

0

未知

2

1

3

2

4

3

慢闪

5

4

快闪

3.5.7 对讲机状态

序号

状态值

状态名称

1

0

正常

2

1

主叫

3

2

被叫

4

3

主叫接通

5

4

被叫接通

6

5

信息

3.6 点位控制

3.6.1 报警用户控制

序号

控制值

控制名称

1

1

外出布防

2

2

留守布防

3

3

撤防

4

4

旁路未准备防区

5

5

禁用主机

6

6

启用主机

7

7

消音

8

8

消警

9

101

禁用

10

102

正常

11

201

显示未准备防区

12

202

刷新防区状态

3.6.2 报警防区控制

序号

控制值

控制名称

1

1

禁用

2

2

正常

3

3

旁路

4

4

解除旁路

5

5

强制恢复

6

6

防区布防

7

7

防区撤防

3.6.3 门禁门控制

序号

控制值

控制名称

1

1

打开

2

2

关闭

3

3

锁定

4

4

解除锁定

5

5

常开

6

6

常闭

7

7

取消常开/

3.6.5 停车场道闸控制

序号

控制值

控制名称

1

1

打开

2

2

关闭

3

3

常开

4

4

常闭

5

5

取消常开/

3.6.6 监控摄像机控制

序号

控制值

控制名称

控制参数1

1

1

视频切换

监视器编号

2

2

预置位切换

预置位号

3

6

视频抓拍

抓拍张数

4

8

回放抓拍

抓拍张数

5

9

切换到电视墙

监视器编号

6

10

打开声音

7

11

开始对讲

8

13

关闭声音

9

14

停止对讲

10

110

控制云台

整数,从低到高, 第一字节为云台命令类型, 第二字节为云台速度。

云台命令如下:

    0: 停止   1: 2: 左上   3: 4: 左下   5: 6: 右下   7: 8: 右上   100: 镜头停止 101: 光圈开   OPEN 102: 光圈闭 CLOSE 103: 焦点近   NEAR     104: 焦点远   FAR 105: 焦距长 WIDE 106: 焦距短   ELE

   云台速度取值范围: 1-64

3.6.7 联动输出点控制

序号

控制值

控制名称

控制参数1

1

1

2

2

3

3

慢闪

4

4

快闪

5

5

N

整数

6

6

N

整数

7

7

工作值

整数

3.6.8 对讲机控制

序号

控制值

控制名称

控制参数1

1

1

接听

2

2

监听

3

3

呼叫

4

4

挂断

5

5

广播

厂家机号列表,以分号(;)分隔

3.6.9 外部应用控制

序号

控制值

控制名称

1

1

运行