30303313 GSTCOM 火灾报警控制器集成应用软件接口用户手册Ver00601F2480文档格式.docx
《30303313 GSTCOM 火灾报警控制器集成应用软件接口用户手册Ver00601F2480文档格式.docx》由会员分享,可在线阅读,更多相关《30303313 GSTCOM 火灾报警控制器集成应用软件接口用户手册Ver00601F2480文档格式.docx(13页珍藏版)》请在冰豆网上搜索。
![30303313 GSTCOM 火灾报警控制器集成应用软件接口用户手册Ver00601F2480文档格式.docx](https://file1.bdocx.com/fileroot1/2022-11/16/b2bac52d-968b-4090-b0ac-2f120eecf1bf/b2bac52d-968b-4090-b0ac-2f120eecf1bf1.gif)
3.2.4关闭GstCom6
3.2.5返回状态参数说明6
3.3GstCom接口事件6
第四章在编程环境中应用7
4.1VB编程环境中GstCom的创建7
4.2VC编程环境中GstCom的创建8
第一章GSTCOM火灾报警控制器集成应用软件接口简介
1.1GSTCOM火灾报警控制器集成应用软件接口概述
GSTCOM火灾报警控制器集成应用软件接口(以下简称接口)是用于第三方进行系统集成的专用编程接口,它可与GST100中文、GST200中文、GST500中文、GST5000中文、GST9000中文、GST100英文、GST200英文、GST500英文、GST5000英文,GST9000英文控制器进行通讯。
本接口为方便用户进行二次开发,附带了VB编程样例程序,供用户参考。
1.2适用的操作系统
Windows98、Windows2000、WindowsXP中英文视窗操作系统。
1.3运行环境要求
软件:
本控件使用前需要对GstCom.Dll进行注册,安装程序已经自动将此控件注册。
硬件:
需要一块与消防控制器相适应的标准RS232通讯接口板,标准RS232通讯接口板与计算机用串口线连接。
第二章安装过程
2.1系统的安装步骤
将安装文件拷贝到任意目录下,运行Setup.exe如图1所示。
图1
步骤一:
运行安装程序如图2所示。
图2
步骤二:
确认安装内容如图3所示,选择“Next”。
图3
步骤三:
确认协议如图4所示
图4
步骤四:
填写用户姓名及公司名称如图5所示,选择“Next”。
图5
步骤五:
改变安装路径如图6所示,如果要更改安装目录,按“Browse…”按钮,否则直接选择“Next”。
图6
步骤六:
改变安装类型如图7所示,系统默认的安装方式为典型安装(Typical),并且只有典型安装一种形式。
图7
步骤七:
确认当前设置如图8所示,选择“Next”。
图8
步骤八:
等待系统注册,如图9所示。
图9
步骤九:
按“Finish”确认完成安装并退出,如图10所示。
图10
2.2安装正确性
2.2.1安装后文件清单
查看用户选择的安装目录下是否有如图11所示文件。
图11
目录下的GstCom.Dll是GstCom火灾报警控制器集成应用接口,GstComVbSample.exe是VB测试应用程序,Sample目录下就是它的VB源代码,Include目录下为接口在VC编程应用环境下所需的头文件。
2.2.2安装后程序菜单
安装完成后,开始菜单栏“程序”子菜单将如图12所示。
图12
启动GstComTestSample能正常运行。
第三章接口使用说明
3.1注册控件
用户第一次使用接口时,若该控件未注册,将弹出未注册对话框如图13所示。
若用户希望注册该控件成为正式用户,请将注册对话框中的用户信息通过电话、Email、传真等方式传递给我公司,我们将生成注册码传给用户,填入正确的注册码后,点击Register注册按钮,控件注册成功。
DebugUse用户作为试用用户在使用本控件时会有两个小时的时间限制。
图13
3.2接口方法
3.2.1打开GstCom
OpenGstComm_nCom,m_nControllerID,m_nProtocol,iParam,lResult;
m_nCom串口标识变量;
m_nControllerID控制器地址;
m_nProtocol协议变量(即:
控制器类型,数值如下);
10表示Gst100中文通讯板;
15表示Gst100英文通讯板;
20表示Gst200中文通讯板;
25表示Gst200英文通讯板;
50表示Gst500中文通讯板;
55表示Gst500英文通讯板;
51表示Gst500插件中文通讯板;
56表示Gst500插件英文通讯板;
150表示Gst5000中文通讯板;
155表示Gst5000英文通讯板;
151表示Gst5000插件中文通讯板;
156表示Gst5000插件英文通讯板;
190表示Gst9000中文通讯板;
196表示Gst9000英文通讯板;
iParam系统参数();
LResult返回状态(参见返回状态参数说明)。
3.2.2控制器复位
ResetControllerm_nControllerID,lResult;
lResult返回状态(参见返回状态参数说明)。
3.2.3启动控制器巡检命令
StartQuerym_nControllerID,nType,Reserved,lResult;
m_nControllerID控制器地址;
nType启动类型(0停止查询,2启动查询);
Reserved保留参数(0);
LResult返回状态(参见返回状态参数说明)。
3.2.4关闭GstCom
CloseGstComm_nControllerID,lResult;
3.2.5返回状态参数说明
状态参数说明见表1。
表1状态参数说明
返回参数
说明
LResult=0(RET_Successfu)l
命令执行成功
LResult=1(RET_Busy)
控制器忙
LResult=2(RET_ParamInvalide)
参数非法
LResult=3(RET_ShakeHandFail)
通讯握手失败
LResult=4(RET_GstComError)
命令执行内部错误
LResult=5(RET_ReplyError)
命令执行应答错误
LResult=6(RET_ReplyTimeout)
命令发送应答超时
LResult=10(RET_Rs232Error)
串口打开失败
LResult=255(RET_NoCommand)
不支持本命令
3.3GstCom接口事件
GstCom_AlarmEvent(ByValnControllerIDAsLong,ByValnEventTypeAsLong,ByVal
bstrDeviceIDAsString,ByValValueAsLong);
nControllerID控制器地址;
nEventType事件的类型;
bstrDeviceID相关设备编码(设备二次码);
Value对应事件类型的相关数据。
返回数据说明见表2。
表2参数详细描述
事件的类型
(nEventType)
相关设备编码(bstrDeviceID)
对应事件类型的相关数据(Value)
AE_CommNormal
(0)
---------
消防系统正常,无报警、故障等信息
AE_CommRetryFault
(2)
应答错误
AE_CommTimeout
(1)
----------
超时错误
AE_ControllerReset(3)
控制器消音复位
AE_ControllerStatus(4)
Value=状态代码:
(H->
L)
bit7-自动(1允许,0不允许)
bit6-手动(1允许,0不允许)
bit5-喷洒(1允许,0不允许)
状态代码低四位值为:
1H主电故障
2H主电恢复
3H备电故障
4H备电恢复
5H开机
例如:
67表示手动允许,备电故障
控制器状态置位
AE_ControllerMute(5)
------------
控制器消音
AE_DeviceRestore
(8)
设备编码
设备恢复
AE_DeviceAlarm(16)
设备报警
AE_DeviceStart
(32)
设备启动
AE_DeviceStop
(64)
设备停止
AE_DeviceAction
(128)
设备动作
AE_DeviceFault
(256)
设备故障
AE_DeviceIsolate
(512)
设备隔离
AE_DeviceRelease
(1024)
设备释放
第四章在编程环境中应用
4.1VB编程环境中GstCom的创建
●在VB编程环境中引用GstCom控件;
●在应用程序头部定义GstCom,如:
PublicWithEventsMyGstComAsGstComCtl;
●在程序初始化阶段,创建GstCom对象,如:
SetMyGstCom=NewGstComCtl。
4.2VC编程环境中GstCom的创建
●在应用程序的头文件中加入如下文件(可在安装路径下的Include目录下找到)
#include"
GstCom.h"
#include"
GstComDefines.h"
GstComEventSink.h"
●在应用程序的代码文件中加入如下文件
GstCom_i.c"
●在应用程序中定义GstCom的引用及相关变量,
IGstComCtl*m_IGstComCt;
CGstComEventSink*m_pGstComEventSink;
IUnknown*m_pControlUnk;
●在应用程序中创建接口实例
HRESULThr;
hr=CoInitialize(0);
hr=CoCreateInstance(CLSID_GstComCtl,NULL,CLSCTX_INPROC_SERVER,
IID_IGstComCtl,(void**)&
m_IGstComCtl);
if(!
SUCCEEDED(hr))
{
AfxMessageBox("
CoCreateInstanceFailed.