30303313 GSTCOM 火灾报警控制器集成应用软件接口用户手册Ver.2.01,2006.01 F2.480..doc

GSTCOMGSTCOM 火灾报警控制器集成火灾报警控制器集成 应用软件接口应用软件接口 用户手册用户手册 Ver 2 01 2006 01 海湾安全技术有限公司 GSTCOM 火灾报警控制器集成应用软件接口用户手册 海湾安全技术有限公司 目目 录录 第一章第一章 GSTCOMGSTCOM 火灾报警控制器集成应用软件接口简介火灾报警控制器集成应用软件接口简介 1 1 1 1 GSTCOM 火灾报警控制器集成应用软件接口概述 1 1 2 适用的操作系统 1 1 3 运行环境要求 1 第二章第二章 安装过程安装过程 1 1 2 1 系统的安装步骤 1 2 2 安装正确性 4 2 2 1 安装后文件清单 4 2 2 2 安装后程序菜单 5 第三章第三章 接口使用说明接口使用说明 5 5 3 1 注册控件 5 3 2 接口方法 5 3 2 1 打开 GstCom 5 3 2 2 控制器复位 6 3 2 3 启动控制器巡检命令 6 3 2 4 关闭 GstCom 6 3 2 5 返回状态参数说明 6 3 3 GSTCOM接口事件 6 第四章第四章 在编程环境中应用在编程环境中应用 7 7 4 1 VB 编程环境中 GSTCOM 的创建 7 4 2 VC 编程环境中 GSTCOM 的创建 8 GSTCOM 火灾报警控制器集成应用软件接口用户手册 海湾安全技术有限公司 1 第一章第一章 GSTCOM 火灾报警控制器集成应用软件接口简介火灾报警控制器集成应用软件接口简介 1 1 GSTCOM 火灾报警控制器集成应用软件接口概述 GSTCOM 火灾报警控制器集成应用软件接口 以下简称接口 是用于第三方进行系统集成的 专用编程接口 它可与 GST100 中文 GST200 中文 GST500 中文 GST5000 中文 GST9000 中文 GST100 英文 GST200 英文 GST500 英文 GST5000 英文 GST9000 英文控制器进行 通讯 本接口为方便用户进行二次开发 附带了 VB 编程样例程序 供用户参考 1 2 适用的操作系统 Windows 98 Windows 2000 Windows XP 中英文视窗操作系统 1 3 运行环境要求 软件 本控件使用前需要对 GstCom Dll 进行注册 安装程序已经自动将此控件注册 硬件 需要一块与消防控制器相适应的标准 RS232 通讯接口板 标准 RS232 通讯接口板与 计算机用串口线连接 第二章第二章 安装过程安装过程 2 1 系统的安装步骤 将安装文件拷贝到任意目录下 运行 Setup exe 如图 1 所示 图 1 步骤一 运行安装程序如图 2 所示 图 2 GSTCOM 火灾报警控制器集成应用软件接口用户手册 海湾安全技术有限公司 2 步骤二 确认安装内容如图 3 所示 选择 Next 图 3 步骤三 确认协议如图 4 所示 图 4 步骤四 填写用户姓名及公司名称如图 5 所示 选择 Next 图 5 GSTCOM 火灾报警控制器集成应用软件接口用户手册 海湾安全技术有限公司 3 步骤五 改变安装路径如图 6 所示 如果要更改安装目录 按 Browse 按钮 否则直 接选择 Next 图 6 步骤六 改变安装类型如图 7 所示 系统默认的安装方式为典型安装 Typical 并且只有 典型安装一种形式 图 7 步骤七 确认当前设置如图 8 所示 选择 Next 图 8 GSTCOM 火灾报警控制器集成应用软件接口用户手册 海湾安全技术有限公司 4 步骤八 等待系统注册 如图 9 所示 图 9 步骤九 按 Finish 确认完成安装并退出 如图 10 所示 图 10 2 2 安装正确性 2 2 1 安装后文件清单 查看用户选择的安装目录下是否有如图 11 所示文件 图 11 目录下的 GstCom Dll 是 GstCom 火灾报警控制器集成应用接口 GstComVbSample exe 是 VB 测试应用程序 Sample 目录下就是它的 VB 源代码 Include 目录下为接口在 VC 编程应用 环境下所需的头文件 GSTCOM 火灾报警控制器集成应用软件接口用户手册 海湾安全技术有限公司 5 2 2 2 安装后程序菜单 安装完成后 开始菜单栏 程序 子菜单将如图 12 所示 图 12 启动 GstComTest Sample 能正常运行 第三章第三章 接口使用说明接口使用说明 3 1 注册控件 用户第一次使用接口时 若该控件未注册 将弹出未注册对话框如图 13 所示 若用户希望 注册该控件成为正式用户 请将注册对话框中的用户信息通过电话 Email 传真等方式传递给 我公司 我们将生成注册码传给用户 填入正确的注册码后 点击 Register 注册按钮 控件注 册成功 Debug Use 用户作为试用用户在使用本控件时会有两个小时的时间限制 图 13 3 2 接口方法 3 2 1 打开 GstCom OpenGstCom m 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 插件英文通讯板 GSTCOM 火灾报警控制器集成应用软件接口用户手册 海湾安全技术有限公司 6 190表示 Gst9000 中文通讯板 196 表示 Gst9000 英文通讯板 iParam 系统参数 LResult 返回状态 参见返回状态参数说明 3 2 2 控制器复位 ResetController m nControllerID lResult m nControllerID 控制器地址 lResult 返回状态 参见返回状态参数说明 3 2 3 启动控制器巡检命令 StartQuery m nControllerID nType Reserved lResult m nControllerID 控制器地址 nType 启动类型 0 停止查询 2 启动查询 Reserved 保留参数 0 LResult 返回状态 参见返回状态参数说明 3 2 4 关闭 GstCom CloseGstCom m nControllerID lResult m 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 3 GstCom 接口事件 GstCom AlarmEvent ByVal nControllerID As Long ByVal nEventType As Long ByVal bstrDeviceID As String ByVal Value As Long nControllerID 控制器地址 nEventType 事件的类型 bstrDeviceID 相关设备编码 设备二次码 Value 对应事件类型的相关数据 返回数据说明见表 2 表 2 参数详细描述 GSTCOM 火灾报警控制器集成应用软件接口用户手册 海湾安全技术有限公司 7 事件的类型 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 1 VB 编程环境中 GstCom 的创建 在 VB 编程环境中引用 GstCom 控件 在应用程序头部定义 GstCom 如 Public WithEvents MyGstCom As GstComCtl 在程序初始化阶段 创建 GstCom 对象 如 Set MyGstCom New GstComCtl GSTCOM 火灾报警控制器集成应用软件接口用户手册 海湾安全技术有限公司 8 4 2 VC 编程环境中 GstCom 的创建 在应用程序的头文件中加入如下文件 可在安装路径下的 Include 目录下找到 include GstCom h include GstComDefines h include GstComEventSink h 在应用程序的代码文件中加入如下文件 include GstCom i c 在应用程序中定义 GstCom 的引用及相关变量 IGstComCtl m