WIN-PAK SE/PE API

COMMUNICATION SERVER API

Public Interface Document

WIN-PAK SE/PE Communication Server API

Public Interface Document

Release 6.2

2

© 2012 Honeywell International

Notices and Trademarks
Copyright 2012 by Honeywell International Inc. Release 6.2- July 2012

While this information is presented in good faith and believed to be accurate, Honeywell disclaims the implied warranties of merchantability and fitness for a particular purpose and makes no express warranties except as may be stated in its written agreement with and for its customers. In no event is Honeywell liable to anyone for any indirect, special or consequential damages. The information and specifications in this document are subject to change without notice. WIN-PAK SE/PE™ is a registered trademark of Honeywell International Inc. Other brand or product names are trademarks of their respective owners.
© 2012 Honeywell Access Systems. All rights reserved.

Honeywell Access Systems 135 West Forest Hill Avenue Oak Creek, WI 53154 U.S.A

OFFICE HOURS: 8 AM to 5 PM (CST) PHONE: 414-766-1700 FAX: 414-766-1798 URL: http://www.honeywellaccess.com

Release 6.2

iii

© 2012 Honeywell International

Modification History
Version
1.0

Date
March 15 , 2012 May 9th 2012
th th

Author
Sathish Guru

Description
Initial Draft for WIN- PAK SE/PE Communication Server API Added the new functions and the document navigation Added the review comments Added the review comments and NetAXS IO Board statuses corrected Updated the Bookmarks and Page references

1.1

Sathish Guru

1.2 1.3 1.4

May 17 2012 July 10th 2012 July 30th 2012

Sathish Guru Sathish Guru Sathish Guru

Release 6.2

iv

© 2012 Honeywell International

........... 33 CardAndPINTimezone(put) .......................................................................................................................................................................................................................................... 24 Enumeration Types................... 33 CardOnlyPriority(get) .................................................................................................................................................................................................... 12 Prerequisites for Installing the CommunicationAPIClient ....................................................................... 30 CardOnlyTimezone(put) ............................ 21 Before you start ...................................................................................................................... 30 PINOnlyTimezone(get) ................... 37 COMMUNICATION SERVER API FUNCTIONALITIES ........................................................................................................................................................................................ 28 DisableDoorTimezone(put) ................................................................................................................................................................................................................................................................................................................................................................. 33 CardOnlyPriority(put) ........................................................................................................................................................... 34 PINOnlyPriority(put) .......................................................................... 27 NETAXSDOORINFO . 35 CardAndPINPriority(get) .................................................................................................................................................................................................................................................................................................................................................................................................................................................... 28 DisableDoorTimezone(get)........................................ 24 Device Structure ............................................ 11 INSTALLING THE COMMUNICATION SERVER APIS ................................................................................................................................................................................................................................... 21 COMMUNICATION SERVER APIS ....................... 26 OBJECT SPECIFICATIONS ......................................................................................................... 11 SUPPORTED OPERATING SYSTEMS ........................................................................................................................................................................................................................................................................................................ 27 OVERVIEW ........................................................................... 34 PINOnlyPriority(get)........................................... 23 DATA STRUCTURES ............................. 32 CardAndPINTimezone(get) ............. 27 Properties ..................................... 25 panelInitTask ................................................................................................................................................................................................................ 35 CardAndPINPriority(put) ............................................................................................. 23 OVERVIEW .. VIII INTRODUCTION............................................... 31 CardOrPINTimezone(get) .............................................................................................................................................. 16 To Install the CommunicationAPIServer.......... 31 PINOnlyTimezone(put)..................................................................................................................................................................................................... 28 LockdownReaderTimezone(get) ..Table of Contents ABOUT THIS DOCUMENT ..................................................................................... 24 wpviewTYPE ........ 25 HIDSubType1.................................................................................................................................................................................................................................................................................................................................... 10 OVERVIEW .................................................................... 29 LockdownReaderTimezone(put).................................................................................................................................... 10 COMPONENT MODEL DIAGRAM .......................................................................................................................................... 36 CardOrPINPriority(put) ................................................................ 12 To Install the CommunicationAPIClient............................ 32 CardOrPINTimezone(put) ...............................................................................................................................................................................................................................2 v © 2012 Honeywell International ................................... 12 Prerequisites for Installing the CommunicationAPIServer ............................................................................................................................................................................................ 36 CardOrPINPriority(get) ....................................................... 24 HIDType .......................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................... 38 Release 6......................................................................................................................................................................................................................................... 16 CONNECTING THE API CLIENT AND THE API SERVER ..................................................... 29 CardOnlyTimezone(get) ................................................................

...............................................2 vi © 2012 Honeywell International .. 84 Examples of WIN-PAK SE/PE Notification Messages ............................................................................ 69 NOTIFICATION MESSAGE TAGS .............................................................................................................................................................................................. 85 Release 6................................................................................................................................................................................................................................................................................. 52 PanelInitialize ......... 73 Reader and Output Events ..................................................................................................................................................................................... 41 GetDetailsByID ....................................................................................................................................................... 55 GetNetAXSDoorModeByHID .............................................................................................. 42 EntryPointUnLockByID ....................................................................................................................................................................... 83 GLOSSARY ............................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................. 61 COMMUNICATION SERVER CALLBACK PROTOCOL ............................... 49 AddFilterHID........................................................................................................................................................ 54 ExecuteDoorSchedule ................. 39 AckAlarm................................................. 38 DoneServer ............................................................................................... 70 Examples of Panel Notification Messages ..................................................................................................... 44 TimedPulseByHID .................................................................... 66 OVERVIEW ....................................................................................................................................................................................................... 50 RemoveFilterHID ......................................................................................................................................................................................... 54 IsConnected ........................................................................................................... 56 GetStatus .......................................................................................................................... 77 Input Event................................................................................................................................................................................................................................................................. 42 EntryPointLockByID .............................................................................................................................................................................................................................................................................................................................. 56 SetNetAXSDoorModeByHID ................................................................................................................................................................................................................................................................................................................................................... 53 GetDefaultACRMode .............. 48 ListConnectedDevices ..... 84 Database Server Regained Connection ................................................. 48 Energize .................................................................................................... 75 Sample Code to Extract Information from the Notification Messages .......................................................................................................................... 47 DoorModeByHID ........................................................... 49 DeEnergize ............................................................................................................................................................ 51 RemoveCommServerID ............................................................................................................................................................................................................................... 53 PanelCancelInitialize ................................................................................................................ 40 AddNote............................................................................. 46 UnBufferByHID ...........................WIN-PAK SE/PE Communication Server API Public Interface Document ABSTRACT DEVICES STATUS DEFINITIONS ............................ 68 InitServer .................................................................................. 83 Communication Server Regained Connection ............................................................................................. 44 PulseByHID .................................................................. 59 EVENT CODE LIST .................................................................... 43 AlarmShuntByHID ..................... 58 GetDoorStatus2 ................................... 82 Communication Server Lost Connection .......................................... 40 ClrAlarm .................................................................................. 44 RestoreTZByHID.......................................................... 81 Device Status ........................... 52 GetFilterCommServerIDs ................................................................................................................................................................................. 50 GetFilterHIDs ..................................................................................................................... 84 Database Server Lost Connection .............................................................................................................. 79 Panel Event ........................................................................................................................................................................................................................................................................................................................................................................................................................ 68 PROTOCOL PROCESS ............................................................................................................................................................... 78 Input Alarm ..................................................................................... 75 Reader and Output Alarms.................... 70 Tag Descriptions........................................................................................................................................................................................................................................................................................................................................................................................... 69 Process Flow Diagram ........................................................................................................................................................................................................................................................................................................................ 51 AddFilterCommServerID ......................................................................................................................................... 43 AlarmUnShuntByHID.......................................................................................................................................................... 45 BufferByHID .............................................................................................

...................... 86 Release 6.....................Table of Contents INDEX..............................2 vii © 2012 Honeywell International .....................................................................................

Provides information about data structures and functions of the Communication Server API. and lists the procedure to install the Communication Server APIs. In addition. this chapter explains the notification message tags and provides examples of the notification messages. Acronyms APB API COM DCOM MTS Descriptions AntiPassBack Application Programming Interface Component Object Model Distributed Component Object Model Microsoft Transaction Server Release 6. Communication Server APIs Communication Server Callback Protocol Acronyms The following table lists the acronyms used in this guide. Explains the callback protocol process.2 viii © 2012 Honeywell International . Document Structure The following table lists the contents in each chapter.About This Document Scope This document exposes the APIs of the WIN-PAK SE/PE communication server to develop the Communication Server API Client application. Intended Audience This document is intended for the developers of the Communication Server API Client application. Chapter Introduction Contents Gives an overview of the Communication Server APIs. explains the component model diagram.

Blue Text Indicates an Example. Convention Bold Text Navy Blue Text Green Text Use Indicates UI elements.A OFFICE HOURS: 8 AM to 5 PM (CST) PHONE: 414-766-1700 FAX: 414-766-1798 URL: http://www.honeywellaccess.About This Document Acronyms PIN UI WIN-PAK SE/PE Descriptions Personal Identification Number User Interface WIN-PAK Standard Edition/Professional Edition Document Conventions The following table lists the conventions used in this document. Indicates programming codes.S.2 ix © 2012 Honeywell International . Grey Text Contact Information Honeywell Access Systems 135 West Forest Hill Avenue Oak Creek.com Release 6. Indicates a Note. Indicates comments for the programming codes. WI 53154 U.

MTS and COM+ components of ActiveX. The WIN-PAK SE/PE provides a UI for the operator to monitor and track the access control activities of the end-users at the customer locations. ♦ Forward the event/alarm transactions to the client application. DCOM. The Communication Server API is intended for N-tier Windows applications and is based on the Microsoft Windows DNA technologies using COM. The Communication Server serves as a concentrator for communications with the access control hardware located at the customer locations. The customized Communication Server can be used to perform the following tasks.2 10 © 2012 Honeywell International . Using the Communication Server APIs.Chapter 1 INTRODUCTION Overview The Communication Server is a component of the WIN-PAK SE/PE application. Multiple Communication Server modules can be active in a client application. In this Chapter Component Model Diagram Supported Operating Systems Installing the Communication Server APIs Connecting the API Client and the API Server Page Number 11 11 12 21 Release 6. a customized Windows client application can be created to monitor and act on the events/alarms as a WIN-PAK SE/PE UI. The following sections explain the component model diagram of the Communication Server and the procedure to install the Communication Server. ♦ Track the status of the alarms from the client application. The WIN-PAK SE/PE is an access control system that authenticates employee access at security areas.

dll acts as a remote DCOM server that communicates with the client and the WIN-PAK SE/PE communication server. The IMTSCBServer is an interface that contains the various API calls for WINPAK SE/PE Communication server functionalities. The Communication Server API client is a Windows client application that monitors the events/alarms of the hardware devices at the customer locations.Introduction Component Model Diagram 1 2 The Communication Server serves as a concentrator for communication with the access control hardware located at the customer locations. IMTSCBServer and the IWPAVCallback interface. The Accw. ♦ Microsoft Windows Server 2008 Release 6. 3 Supported Operating Systems The WIN-PAK SE/PE Communication Server API is supported on the following operating systems.2 11 © 2012 Honeywell International . The client is informed about the events and alarms using the COM/DCOM callback mechanism and a tag based protocol. The Accw.dll contains the business component.

♦ CommunicationAPIServer ♦ CommunicationAPIClient Prerequisites for Installing the CommunicationAPIServer Before installing the CommunicationAPIServer.WIN-PAK SE/PE Communication Server API Public Interface Document ♦ Microsoft Windows Server 2008 R2(32/64 Bit) ♦ Microsoft Windows 7(32/64 Bit) Installing the Communication Server APIs The following modules of the WIN-PAK SE/PE Communication Server API must be installed. 2.exe on the CD.2 12 © 2012 Honeywell International . The Welcome to the InstallShield Wizard for WIN-PAK SE/PE API screen appears. To Install the CommunicationAPIServer 1. ensure that the WIN-PAK SE/PE is installed on the computer. The License Agreement screen appears. Click Next. Release 6. Double-click WIN-PAK SEPE API.

Introduction 3.2 13 © 2012 Honeywell International . Read the license agreement and select Accept and then click Next. The Custom Setup screen appears. Release 6.

To change the destination folder. The Ready to install the program screen appears. Release 6.WIN-PAK SE/PE Communication Server API Public Interface Document 4.2 14 © 2012 Honeywell International . Click Install to start the installation. Select “WIN-PAK Communication Server API”. click Change and select the destination folder. Click Next. The Setup Status screen appears showing the installation progress. 5. The InstallShield Wizard completed screen appears.

Introduction 6.2 15 © 2012 Honeywell International . Click Finish to close the InstallShield wizard. You must restart your computer to complete the installation. Release 6.

♦ The CommunicationAPIClient must be installed in the same domain/workgroup as the CommunicationAPIServer.WIN-PAK SE/PE Communication Server API Public Interface Document Prerequisites for Installing the CommunicationAPIClient Before installing the CommunicationAPIClient ensure that the following requirements are met.exe on the CD. Release 6. The Welcome to the InstallShield Wizard for WIN-PAK SE/PE API screen appears. To Install the CommunicationAPIClient 1. ♦ Make a note of the IP address or machine name of the server computer on which the WIN-PAK SE/PE communication server API is installed. Double-click WIN-PAK SEPE API.2 16 © 2012 Honeywell International .

Click Next. Release 6. The License Agreement screen appears.Introduction 2.2 17 © 2012 Honeywell International .

2 18 © 2012 Honeywell International . 4. Release 6. Type the computer name or IP address or the Machine name of the computer on which the Communication Server APIs are installed and then. 5. click Next. The Communication Server Details screen appears.. Read the license agreement and select Accept and then click on Next.WIN-PAK SE/PE Communication Server API Public Interface Document 3. Select “WIN-PAK Communication Client API”. To change the destination folder. The Custom Setup screen appears. 6. click Change and select the destination folder. Click Next.

The Ready to install the program screen appears.Introduction 7. Release 6.2 19 © 2012 Honeywell International . Click Install to start the installation.

2 20 © 2012 Honeywell International . 9.WIN-PAK SE/PE Communication Server API Public Interface Document 8. The Setup Status screen appears showing the installation progress. Release 6. The InstallShield Wizard completed screen appears. Click Finish to close the InstallShield wizard. You must restart your computer to complete the installation.

Introduction Connecting the API Client and the API Server The WIN-PAK SE/PE client must be connected to the WIN-PAK SE/PE API server to send and receive any notification messages about the events and alarms.2 21 © 2012 Honeywell International . ♦ The API Client and the API Server must be logged on with the same user name and password. Release 6. ♦ The COM+ Access must be configured if the CommunicationAPIs are installed on the Windows Operation System. Before you start To establish connection between the API Client and the API Server. ♦ The computers on which the API Client and the API Server are installed must be in the same domain or workgroup. ♦ The ICF firewall must be disabled for the CommunicationAPIs installed on Windows 2003 Server. ensure that the following conditions are met. ♦ The API Client and the API Server must be installed on different computers.

Release 6.2 22 © 2012 Honeywell International .

Using the WIN-PAK SE/PE API. the client application can monitor the events/alarms and control the access control panels at the customer location.Chapter 2 COMMUNICATION SERVER APIS Overview The developers of the WIN-PAK SE/PE API application have exposed some data structures and API functions to allow you to develop a customized client application. The following sections explain the exposed data structures and API functions. In this Chapter Data Structures Communication Server API Functionalities Abstract Device Status Definitions Event Code List Page Number 24 26 59 61 Release 6.2 23 © 2012 Honeywell International .

WIN-PAK SE/PE Communication Server API

Public Interface Document

Data Structures
The following special data structures are used to implement the functionality of the communication client component in the WIN-PAK SE/PE Communication Server.

Device Structure
Description This structure contains information about the device name, device ID, and device type. Definition
struct Device{ [helpstring(“Contains the Device Name”)] BSTR sDeviceName; [helpstring(“Contains the HID”)] long lDeviceID; [helpstring(“Contains the Device Type”)] long lDeviceType; } Device;

Enumeration Types
The Communication client component provides the following enumeration types to declare the types of views and the hardware dependent constants. ♦ wpviewTYPE ♦ HIDType ♦ HIDSubType1 wpviewTYPE Description Defines the following types of views. ♦ Alarm ♦ Event ♦ Alarm and Event Definition
enum wpviewTYPE { [helpstring("AlarmView")]wpviewAlarm= 0x0001, [helpstring("EventView")]wpviewEvent= 0x0002,

Release 6.2

24

© 2012 Honeywell International

Communication Server APIs [helpstring("AlarmEventView")]wpviewAlarmEvent= 0x0003 } wpviewTYPE;

HIDType Description Defines the types of hardware devices. Definition
enum HIDType { HID_SERVER = 1 END_HID_SERVER = 10 HID_LOOP = 12 HID_PANEL = 22 HID_INPUT = 30 HID_OUTPUT = 40 HID_ENTRANCE = 50 HID_CCTV = 60 HID_MODEM_POOL = 80 END_HID_MODEM_POOL = 83 HID_EXTERNAL_SYSTEM_LINK = 90 END_HID_EXTERNAL_SYSTEM_LINK = 94 HID_PW5000_SIO = 95 } HIDType;

HIDSubType1 Description Defines the sub types of the hardware devices. Definition
enum HIDSubType1 { HID_SERVER_COMM = 2 HID_SERVER_SCHEDULER = 3 HID_SERVER_GUARD_TOUR = 4 HID_SEQUENCED_CHK_PT = 5 HID_UNSEQUENCED_CHK_PT = 6 HID_SERVER_CAMERA_TOUR = 7 HID_SERVER_CMD_FILE = 8 HID_SERVER_MUSTER = 9 HID_LOOP_N1000 = 13 HID_LOOP_N1000_C100 = 14 HID_LOOP_N1000_485 = 15

Release 6.2

25

© 2012 Honeywell International

WIN-PAK SE/PE Communication Server API HID_LOOP_N1000_485_ACKNAK = 16 END_HID_LOOP_N1000 = 17 HID_LOOP_N750 = 18 HID_LOOP_SYMPHONY = 19 HID_LOOP_SYMPHONY_LEGACY = 20 HID_LOOP_PW5000 = 21 HID_PANEL_N1000 = 23 HID_PANEL_N1000_II OR HID_PANEL_PW2000 (X) 24 HID_PANEL_N1000_III OR HID_PANEL_PW2000-3 (X) 25 HID_PANEL_N1000_IV OR HID_PANEL_PW2000-4 (X) 26 HID_PANEL_N750 = 27 HID_PANEL_SYMPHONY = 28 HID_PANEL_PW5000 = 29 HID_PANEL_PW5000_DIALUP = 130 HID_INPUT_STD = 31 HID_INPUT_SUPERVISED = 32 HID_INPUT_PW5000_STD = 33 HID_INPUT_PW5000_SUPER = 34 HID_OUTPUT_STD = 41 HID_GROUP_STD = 42 HID_OUTPUT_PW5000 = 43 HID_ENTRANCE_DOOR = 51 HID_ENTRANCE_READER = 52 HID_ENTRANCE_PW5000_DOOR = 53 HID_CCTV_SWITCHER = 61 END_HID_CCTV_SWITCHER = 71 HID_CCTV_CAMERA = 72 HID_CCTV_MONITOR = 75 HID_MODEM_POOL_C100 = 81 HID_MODEM_POOL_PCI = 82 HID_MODEM_POOL_PW5000 = 84 HID_JCI_MNI = 91 HID_LANDIS_STAEFA_S600 = 92 HID_RS_232_LINK = 93 } HIDSubType1;

Public Interface Document

panelInitTask Description Defines the constituent steps needed for the Panel initialization task. Definition
enum panelInitTask { taskINIT = 0, taskTIMEDATE = 1, taskCARD = 2,

Release 6.2

26

© 2012 Honeywell International

Object Specifications taskCMDFILE = 3, taskHOLIDAY = 4, taskTIMEZONE = 5 , taskINPUT = 6, taskOUTPUT = 7, taskGROUP = 8, taskMCBCONFIG = 9, taskINPUTSCAN = 10, taskCARDFORMAT = 11, taskSIOBOARD = 12, taskACCESSLEVELS = 13, taskTRIGGERS = 14, taskPROCEDURES = 15, taskMPGROUPS = 16, taskACCESSAREAS = 17, taskREADERLED = 18, taskTZREFRESH = 19 }panelInitTask;

OBJECT SPECIFICATIONS
Overview
The developers of the WIN-PAK SE/PE application have developed the COM object for encapsulating the various fields that constitute the Door Mode of the NetAXS Panel. This object enables the client applications to access the current Door Modes of the NetAXS Readers and also to set new Door Modes to the NetAXS Readers configured in the WIN-PAK SE/PE. This Interface and the associated class is compiled inside the Accw.dll The list of COM objects in NCIHelper.dll are as follows: ♦ Accw.NetAXSDoorInfo

NetAXSDoorInfo
The NetAXSDoorInfo object is used to access the WIN-PAK SE/PE Door Mode information of the NetAXS readers. In addition, this object is used to assign the Door Mode to a NetAXS reader.

Release 6.2

27

© 2012 Honeywell International

♦ ♦ ♦ ♦ ♦ ♦ ♦ ♦ ♦ ♦ DisableDoorTimezone LockdownReaderTimezone CardOnlyTimezone PINOnlyTimezone CardOrPINTimezone CardAndPINTimezone CardOnlyPriority PINOnlyPriority CardAndPINPriority CardOrPINPriority The following section explains the Card properties. Parameters Parameters pVal Description The retrieved Timezone ID set for the Disable Door Time zone Return Type The HRESULT value is returned. the value zero is returned. The following table displays the return codes. DisableDoorTimezone(put) Description Sets the timezone ID of the Disable Door Timezone.2 28 © 2012 Honeywell International . DisableDoorTimezone(get) Description Gets the timezone ID of the Disable Door Timezone. Visual C++ Signature Release 6. retval] long *pVal). Return Code S_OK Description For a successful operation. Visual C++ Signature HRESULT DisableDoorTimezone([out.WIN-PAK SE/PE Communication Server API Public Interface Document Properties The following methods help you to get and set the NetAXSDoorMode properties in the WIN-PAK SE/PE.

the value zero is returned. Parameters Parameters pVal Description The retrieved Timezone ID set for the Lockdown Reader Timezone.2 Description 29 © 2012 Honeywell International . Visual C++ Signature HRESULT LockdownReaderTimezone ([out. The following table displays the return codes. LockdownReaderTimezone(put) Description Sets the timezone ID of the Lockdown Reader Timezone. Return Type The HRESULT value is returned. retval] long *pVal). Parameters Parameters newVal Description The new Timezone ID to be set as the Disable Door Timezone. Parameters Parameters Release 6.Object Specifications HRESULT DisableDoorTimezone([in] long newVal). Return Code S_OK Description For a successful operation. the value zero is returned. LockdownReaderTimezone(get) Description Gets the timezone ID of the Lockdown Reader Timezone. The following table displays the return codes. Return Code S_OK Description For a successful operation. Visual C++ Signature HRESULT LockdownReaderTimezone ([in] long newVal). Return Type The HRESULT value is returned.

WIN-PAK SE/PE Communication Server API Public Interface Document Parameters newVal Description The new Timezone ID to be set as the Lockdown Reader Timezone. Return Type The HRESULT value is returned. Return Type The HRESULT value is returned. Parameters Parameters pVal Description The retrieved Timezone ID set for the Card Only Timezone.2 30 © 2012 Honeywell International . Parameters Parameters newVal Description The new Timezone ID to be set as the Card Only Timezone. Release 6. Visual C++ Signature HRESULT CardOnlyTimezone([in] long newVal). Return Code S_OK Description For a successful operation. the value zero is returned. the value zero is returned. retval] long *pVal). CardOnlyTimezone(get) Description Gets the timezone ID of the Card Only Timezone. Visual C++ Signature HRESULT CardOnlyTimezone([out. The following table displays the return codes: Return Code S_OK Description For a successful operation. The following table displays the return codes. CardOnlyTimezone(put) Description Sets the timezone ID of the Card Only Timezone.

PINOnlyTimezone(get) Description Gets the timezone ID of the PIN Only Timezone. The following table displays the return codes.Object Specifications Return Type The HRESULT value is returned. Parameters Parameters newVal Description The new Timezone ID to be set as the Disable PIN Only Timezone. Return Type The HRESULT value is returned. Visual C++ Signature HRESULT PINOnlyTimezone([out. The following table displays the return codes.2 31 © 2012 Honeywell International . The following table displays the return codes. the value zero is returned. Visual C++ Signature HRESULT PINOnlyTimezone([in] long newVal). Return Type The HRESULT value is returned. Parameters Parameters pVal Description The retrieved Timezone ID set for the PIN Only Timezone. Return Code Description Release 6. Return Code S_OK Description For a successful operation. PINOnlyTimezone(put) Description Sets the timezone ID of the PIN Only Timezone. the value zero is returned. Return Code S_OK Description For a successful operation. retval] long *pVal).

Return Code S_OK Description For a successful operation. Return Code S_OK Description For a successful operation. the value zero is returned. The following table displays the return codes. retval] long *pVal).2 32 © 2012 Honeywell International . Release 6. the value zero is returned.WIN-PAK SE/PE Communication Server API Public Interface Document S_OK For a successful operation. Parameters Parameters pVal Description The retrieved Timezone ID set for the Card Or PIN Timezone. Visual C++ Signature HRESULT CardOrPINTimezone([in] long newVal). CardOrPINTimezone(get) Description Gets the timezone ID of the Card or PIN Timezone. CardOrPINTimezone(put) Description Sets the timezone ID of the Card or PIN Timezone. Visual C++ Signature HRESULT CardOrPINTimezone([out. Return Type The HRESULT value is returned. Return Type The HRESULT value is returned. Parameters Parameters newVal Description The new Timezone ID to be set as the Card Or PIN Timezone. the value zero is returned. The following table displays the return codes.

Parameters Parameters newVal Description The new Timezone ID to be set as the Card and PIN Timezone. retval] long *pVal). Return Code S_OK Description For a successful operation. CardOnlyPriority(get) Description Gets the value of the Card Only Priority. Visual C++ Signature HRESULT CardAndPINTimezone([in] long newVal). CardAndPINTimezone(put) Description Sets the timezone ID of the Card and PIN Timezone.2 33 © 2012 Honeywell International . Visual C++ Signature HRESULT CardAndPINTimezone([out. Return Type The HRESULT value is returned. Return Type The HRESULT value is returned. The following table displays the return codes. Release 6. The following table displays the return codes. the value zero is returned. Parameters Parameters pVal Description The retrieved Timezone ID set for the Card And PIN Timezone. Return Code S_OK Description For a successful operation. the value zero is returned.Object Specifications CardAndPINTimezone(get) Description Gets the timezone ID of the Disable Door Timezone.

retval] long *pVal). CardOnlyPriority(put) Description Sets the value of the Card Only Priority. PINOnlyPriority(get) Description Gets the value of the PIN Only Priority. The following table displays the return codes: Return Code S_OK Description For a successful operation. Visual C++ Signature HRESULT CardOnlyPriority([in] long newVal). the value zero is returned. the value zero is returned. Return Type The HRESULT value is returned. Visual C++ Signature HRESULT PINOnlyPriority([out.2 34 © 2012 Honeywell International .WIN-PAK SE/PE Communication Server API Public Interface Document Visual C++ Signature HRESULT CardOnlyPriority([out. Parameters Parameters pVal Description The retrieved value set for the Card Only Priority. The following table displays the return codes: Return Code S_OK Description For a successful operation. retval] long *pVal). Parameters Release 6. Parameters Parameters newVal Description The new value to be set as the Card Only Priority Return Type The HRESULT value is returned.

Parameters Parameters newVal Description The new value to be set as the PIN Only Priority. Parameters Parameters pVal Description The retrieved value set for the Disable Door Timezone. The following table displays the return codes. Visual C++ Signature HRESULT PINOnlyPriority([in] long newVal). Return Code S_OK Description For a successful operation. CardAndPINPriority(get) Description Gets the value of the Card And PIN Priority. Return Code S_OK Description For a successful operation. The following table displays the return codes. the value zero is returned. Release 6. Return Type The HRESULT value is returned.2 35 © 2012 Honeywell International . Return Type The HRESULT value is returned. Visual C++ Signature HRESULT CardAndPINPriority([out. PINOnlyPriority(put) Description Sets the value of the PIN Only Priority. the value zero is returned.Object Specifications Parameters pVal Description The retrieved value set for the PIN Only Priority. retval] long *pVal).

Parameters Parameters newVal Description The new value to be set as the Card And PIN Priority. Parameters Parameters pVal Description The retrieved value set for the Card Or PIN Priority.2 36 © 2012 Honeywell International . The following table displays the return codes. CardOrPINPriority(get) Description Gets the value of the Card Or PIN Priority. Visual C++ Signature HRESULT CardAndPINPriority ([in] long newVal). the value zero is returned. Return Code S_OK Description For a successful operation. The following table displays the return codes.WIN-PAK SE/PE Communication Server API Public Interface Document Return Type The HRESULT value is returned. retval] long *pVal). Return Type The HRESULT value is returned. Return Code Description Release 6. The following table displays the return codes. Visual C++ Signature HRESULT CardOrPINPriority([out. Return Code S_OK Description For a successful operation. CardAndPINPriority(put) Description Sets the value of the Card And PIN Priority. the value zero is returned. Return Type The HRESULT value is returned.

the value zero is returned. Visual C++ Signature HRESULT CardOrPINPriority([in] long newVal).2 37 © 2012 Honeywell International . Return Type The HRESULT value is returned. the value zero is returned. The following table displays the return codes. CardOrPINPriority(put) Description Sets the value of the Card Or PIN Priority.Object Specifications S_OK For a successful operation. Release 6. Parameters Parameters newVal Description The new value to be set as the Card Or PIN Priority. Return Code S_OK Description For a successful operation.

[in] BSTR sUserName.dll. [in] BSTR sPassword. description. Release 6. [out.exe as the surrogate process. parameters.dll acts as a remote DCOM server by using the DLLHost. Visual C++ Signature HRESULT InitServer( [in] IDispatch* Caller. ACCW. [in] long lUserid. This dll uses the ActiveX components to provide the communication server functionalities. and remarks of each of the Communication Server APIs are as follows: InitServer Description Registers the client computer in the Communication Server API computer. The name. VC++ signature. retval] VARIANT_BOOL *pbResult ).WIN-PAK SE/PE Communication Server API Public Interface Document COMMUNICATION SERVER API FUNCTIONALITIES The communication server APIs are complied into the dynamic linked library.2 38 © 2012 Honeywell International . [in] long enumViewType. return type. The Accw.

Note The Boolean values are as follows:  TRUE – Operation is successful. Remarks This method must be called before you access the Communication Server functionalities. sUserName sPassword lUserID pbResult A valid WIN-PAK user name.Communication Server API Functionalities Parameters Parameters Caller enumViewType Description A reference to the client callback interface. Visual C++ Signature HRESULT DoneServer( [in] IDispatch* Caller. A valid WIN-PAK ID of the user. retval] VARIANT_BOOL* ). A Boolean value that indicates if the operation is successful. Return Type The HRESULT value is returned.2 39 © 2012 Honeywell International . see wpviewTYPE. Parameters Release 6. Defines the type of view. For more information on the different types of view. [out. The following table displays the return codes. the value zero is returned.  FALSE – Operation is not successful. DoneServer Description Disconnects the client computer from the Communication Server API computer. The password of a WIN-PAK user. Return Code S_OK Description For a successful operation.

WIN-PAK SE/PE Communication Server API Public Interface Document Parameters Caller Description A reference to the client callback interface. Return Code S_OK Description For a successful operation. Remarks This method must be called after you complete all transactions with the Communication Server. AckAlarm Description Acknowledges the alarm identified by the hardware device ID and the point ID. Visual C++ Signature HRESULT AckAlarm( [in] long lHID. [in] long lPoint). Parameters Parameters lHID lPoint Description The hardware device ID. The Point ID. The following table displays the return codes. Return Code S_OK Description For a successful operation. Return Type The HRESULT value is returned. the value zero is returned. The following table displays the return codes. ClrAlarm Description Clears the alarm identified by the hardware device ID and the point ID. Return Type The HRESULT value is returned. the value zero is returned. Visual C++ Signature Release 6.2 40 © 2012 Honeywell International .

The Point ID.Communication Server API Functionalities HRESULT ClrAlarm( [in] long lHID. [in] long lPoint. AddNote Description Adds an operator note to the alarm identified by the hardware device ID and the point ID. [in] BSTR Note). Parameters Parameters lHID lPoint Description The hardware device ID. Release 6. The following table displays the return codes. the value zero is returned.2 41 © 2012 Honeywell International . The text attached to the transaction in history. Parameters Parameters lHID lPoint Note Description The hardware device ID. Return Type The HRESULT value is returned. the value zero is returned. Visual C++ Signature HRESULT AddNote( [in] long lHID. The following table displays the return codes. The Point ID. [in] long lPoint). Return Code S_OK Description For a successful operation. Return Code S_OK Description For a successful operation. Return Type The HRESULT value is returned.

the value zero is returned. Parameters Parameters lHID Description The hardware device ID. [out] BSTR* pbstrTransactionDetails). The following table displays the return codes. The complete description of the transaction to be retrieved. The Point ID. Return Type The HRESULT value is returned. Visual C++ Signature HRESULT EntryPointLockByID([in] long lHID). Release 6.WIN-PAK SE/PE Communication Server API Public Interface Document GetDetailsByID Description Obtains the transaction details for the specified hardware device ID and the point ID. Visual C++ Signature HRESULT GetDetailsByID ( [in] long lHID. The following table displays the return codes. EntryPointLockByID Description Locks the entrance or entry point.2 42 © 2012 Honeywell International . Return Code S_OK Description For a successful operation. Parameters Parameters lHID lPoint pbstrTransactionDetails Description The hardware device ID. [in] long lPoint. Return Type The HRESULT value is returned.

Visual C++ Signature HRESULT EntryPointUnLockByID([in] long lHID). Release 6. The following table displays the return codes. AlarmShuntByHID Description Shunts the alarm of the specified hardware device. the value zero is returned. Return Code S_OK Description For a successful operation. the value zero is returned. the value zero is returned. The following table displays the return codes. Parameters Parameters lHID Description The hardware device ID.2 43 © 2012 Honeywell International . Return Type The HRESULT value is returned. Return Type The HRESULT value is returned. EntryPointUnLockByID Description Unlocks the entrance or entry point. Visual C++ Signature HRESULT AlarmShuntByHID([in] long lHID).Communication Server API Functionalities Return Code S_OK Description For a successful operation. Return Code S_OK Description For a successful operation. Parameters Parameters lHID Description The hardware device ID.

Visual C++ Signature HRESULT PulseByHID([in] long lHID). TimedPulseByHID Description Pulses a hardware device for a specified time period. The following table displays the return codes.WIN-PAK SE/PE Communication Server API Public Interface Document AlarmUnShuntByHID Description Unshunt the alarm of the specified hardware device. Visual C++ Signature HRESULT AlarmUnShuntByHID([in] long lHID). Return Type The HRESULT value is returned. Parameters Parameters lHID Description The hardware device ID. the value zero is returned. The following table displays the return codes. Return Type The HRESULT value is returned. Return Code S_OK Description For a successful operation. Parameters Parameters lHID Description The hardware device ID. Release 6. the value zero is returned.2 44 © 2012 Honeywell International . PulseByHID Description Pulses the hardware device. Return Code S_OK Description For a successful operation.

The value for the unit of time.2 45 © 2012 Honeywell International .  N1000/NS2/NS2+ : 63 seconds or 63 minutes or 63 hours  P-Series(PRO2200/PW5000) : 9 hours  NetAXS(NetAXS 4/NetAXS 123) : 1 hour and 45 minutes Visual C++ Signature HRESULT TimedPulseByHID( [in] long lHID. Return Code S_OK Description For a successful operation. Release 6. Note The values for the unit of time are as follows:  0 – Seconds  1 – Minutes  2 .Communication Server API Functionalities Note Various types of Panels have different maximum for the Pulse Time that can be given to the Timed Pulse command. [in] long lUnits. [in] long lVal). Parameters Parameters lHID lUnits Description The hardware device ID. RestoreTZByHID Description Restores the time zone control in a hardware device. Return Type The HRESULT value is returned. The following table displays the return codes.Hours lVal The pulse time value. the value zero is returned.

[in] long lVal). BufferByHID Description Buffers the transactions of the device specified by the hardware device ID.WIN-PAK SE/PE Communication Server API Public Interface Document Note  The P-Series Input and Readers will work with have the RestoreTZByHID(). The buffer mode values. The following table displays the return codes. so the unbuffer operation is pending. Return Type The HRESULT value is returned. Visual C++ Signature HRESULT BufferByHID( [in] long lHID. Release 6. Return Code S_OK Description For a successful operation. the value zero is returned.2 46 © 2012 Honeywell International . These device transactions are stored and not transmitted. Parameters Parameters lHID Description The hardware device ID. Parameters Parameters lHID lVal Description The hardware device ID. Use GetDefaultACRMode() and use the returned value in the SetDoorModeByHID() to refresh the Timezone for the P-Series Readers Visual C++ Signature HRESULT RestoreTZByHID([in] long lHID).

Note The modes of the buffer are indicated by the following values. UnBufferByHID Description Unbuffer the transactions of the device specified by the hardware device ID. Return Code S_OK Description For a successful operation.  0 – Hard mode  1 – Soft mode Return Type The HRESULT value is returned. the value zero is returned. Visual C++ Signature HRESULT BufferByHID( long* lHID. Parameters Parameters lHID lVal Description The hardware device ID. The following table displays the return codes. long* lVal). The following table displays the return codes.Communication Server API Functionalities Parameters Description Note The modes of the buffer are indicated by the following values. The buffer mode values.  0 – Hard mode  1 – Soft mode Return Type The HRESULT value is returned. the value zero is returned.2 47 © 2012 Honeywell International . The stored device transactions are transmitted. Return Code S_OK Description For a successful operation. Release 6.

the device name. In addition.WIN-PAK SE/PE Communication Server API Public Interface Document DoorModeByHID Description Sets up the door mode for the specified hardware device. hardware device identification number. Note The door mode values are as follows:  1 – Disable the door  2 – Unlock (limited access)  3 – Locked (no access)  4 – Site code only  5 – Card only  6 – PIN only  7 – Card and PIN  8 – Card or PIN Return Type The HRESULT value is returned. [in] long lVal). the value zero is returned. Return Code S_OK Description For a successful operation. Visual C++ Signature Release 6. The following table displays the return codes. Visual C++ Signature HRESULT DoorModeByHID ( [in] long lHID. Parameters Parameters lHID lVal Description The hardware device ID. ListConnectedDevices Description Returns the list of abstract devices (ADVs) connected to the communication server. and the device type of the abstract devices are returned in the form of a structure. The door mode values.2 48 © 2012 Honeywell International .

Parameters Parameters pvDevices Description A pointer to the variant containing the list of abstract devices.2 49 © 2012 Honeywell International . Return Code S_OK Description For a successful operation. Parameters Release 6. Parameters Parameters lHID Description The hardware device ID. Visual C++ Signature HRESULT DeEnergize([in] long lHID). Return Type The HRESULT value is returned. Visual C++ Signature HRESULT Energize([in] long lHID). the value zero is returned. the value zero is returned.Communication Server API Functionalities HRESULT ListConnectedDevices([out. DeEnergize Description De-energizes or stops charging the output device/relay for the specified device ID. The following table displays the return codes. The following table displays the return codes. Energize Description Energizes or charges the output device/relay for the specified device ID. Return Type The HRESULT value is returned. retval] VARIANT *pvDevices). Return Code S_OK Description For a successful operation.

the value zero is returned. the value zero is returned. Return Code S_OK Description For a successful operation. Parameters Parameters lHID Description The HID of a Device Return Type The HRESULT value is returned. The following table displays the return codes.2 50 © 2012 Honeywell International . RemoveFilterHID Description Remove the Alarm filter for the particular HID Visual C++ Signature HRESULT RemoveFilterHID([in] long lHID ). Return Code S_OK Description For a successful operation. AddFilterHID Description Sets the Alarm Filter such that the Alarms are meant to be reported only from the particular HID Visual C++ Signature HRESULT AddFilterHID([in] long lHID ). Parameters Parameters lStatus Description The output parameter that have the status of the API connection with Release 6. Return Type The HRESULT value is returned. The following table displays the return codes.WIN-PAK SE/PE Communication Server API Public Interface Document Parameters lHID Description The hardware device ID.

2 51 © 2012 Honeywell International . Return Code S_OK Description For a successful operation. Parameters Parameters lStatus Description The output parameter that have the status of the API connection with the server Return Type The HRESULT value is returned. the value zero is returned. The following table displays the return codes. the value zero is returned. GetFilterHIDs Description Get all the Alarm HID filters. The following table displays the return codes.Communication Server API Functionalities Parameters Description the server Return Type The HRESULT value is returned. AddFilterCommServerID Description Sets the Alarm Filter such that the Alarms are meant to be reported only from the particular Communication Server Visual C++ Signature HRESULT AddFilterCommServerID([in] long lCommServerID ). Parameters Parameters lCommServerID Description The HID of a Communication Server Release 6. Return Code S_OK Description For a successful operation. Visual C++ Signature HRESULT GetFilterHIDs([out] BSTR* bstrHIDs ).

Release 6. the value zero is returned. RemoveCommServerID Description Remove the Alarm filter for the particular Communication Sever Visual C++ Signature HRESULT RemoveFilterCommServerID([in] long lCommServerID ). Parameters Parameters lCommServerID Description The HID of a Communication Server Return Type The HRESULT value is returned.WIN-PAK SE/PE Communication Server API Public Interface Document Return Type The HRESULT value is returned. the value zero is returned.2 52 © 2012 Honeywell International . GetFilterCommServerIDs Description Get all the Alarm Communication Server filters Visual C++ Signature HRESULT GetFilterCommServerIDs([out] BSTR* bstrCommServerIDs ). Parameters Parameters bstrCommServer IDs Description The retrieved list of Communication Server ID that currently configured in the Alarm Filter Return Type The HRESULT value is returned. The following table displays the return codes. The following table displays the return codes. Return Code S_OK Description For a successful operation. Return Code S_OK Description For a successful operation. The following table displays the return codes.

arrTasks[(int)panelInitTask.2 53 © 2012 Honeywell International . the initialization code will be as follows: int arrTasks[20]. The following table displays the return codes. .Communication Server API Functionalities Return Code S_OK Description For a successful operation. [in]long lHIDtype. Remarks If the client needs to initialize a N1000 Panel of HID 12. PanelInitialize Description Starts the Initialization of the Panels with the steps mentioned.taskCARD] = TRUE. Return Code S_OK Description For a successful operation. which is an array of integers indicates whether the initialization step is executed or not. with the initialization steps of Cards and Timezones only. arrTasks[(int)panelInitTask. . The HIDType of the Panel. Parameters Parameters lHID lHIDType vTasks Description The hardware device ID of the Panel. . the value zero is returned. [in]VARIANT vTasks). Return Type The HRESULT value is returned. Visual C++ Signature RESULT PanelInitialize( [in]long lHID.taskTIMEZONE] = TRUE. PanelCancelInitialize Description Release 6. The input parameter. the value zero is returned.

the value zero is returned. The retrieved default Door Mode of the P-Series Reader Return Type The HRESULT value is returned.WIN-PAK SE/PE Communication Server API Public Interface Document Cancels the ongoing initialization of the Panel. IsConnected Description Release 6. Parameters Parameters lHID pDoorInfo Description The hardware device ID of the P-Series Reader. Visual C++ Signature HRESULT PanelCancelInitialize([in]long lHID).2 54 © 2012 Honeywell International . Return Code S_OK Description For a successful operation. GetDefaultACRMode Description Returns the default/configured door mode of a Reader of the P-Series panel Visual C++ Signature HRESULT GetDefaultACRMode( [in] long lHID. Return Code S_OK Description For a successful operation. The following table displays the return codes. [out]int *nMode). the value zero is returned. Parameters Parameters lHID Description The hardware device ID. The following table displays the return codes. Return Type The HRESULT value is returned.

Communication Server API Functionalities Checks the connected status of the API Component with the Communication Server. ExecuteDoorSchedule Description Executes a Door Schedule at the Direct Point of a Door.2 55 © 2012 Honeywell International . The point ID of the Reader that actually the ordinal of the Reader. Visual C++ Signature HRESULT ExecuteDoorSchedule( [in]long lPanelHID. Return Code S_OK Description For a successful operation. [in]long lPanelType. Parameters Parameters lPanelHID lPanelType lEntranceID lEntrancePointID lTZID Description The hardware device ID of the Panel. The following table displays the return codes. The HID of the Reader/Entrance configured in the Panel. The ID of the Timezone of the Door Schedule. Return Type Release 6. Parameters Parameters lStatus Description The output parameter that have the status of the API connection with the server Return Type The HRESULT value is returned. [in]long lEntranceID. [in]long lTZID). Visual C++ Signature HRESULT IsConnected([out] BOOL* bStatus). the value zero is returned. [in]long lEntrancePointID. The HIDType of the Panel.

[out] VARIANT* pDoorInfo). Return Type The HRESULT value is returned. Return Code S_OK Description For a successful operation. The following table displays the return codes.2 56 © 2012 Honeywell International . the Priorities of the Reader A will be returned. The following table displays the return codes. the value zero is returned. Release 6.WIN-PAK SE/PE Communication Server API Public Interface Document The HRESULT value is returned. Parameters Parameters lHID pDoorInfo Description The hardware device ID of the NetAXS Reader. GetNetAXSDoorModeByHID Description Returns the current Door mode configuration of the NetAXS Reader. Return Code S_OK Description For a successful operation. the value zero is returned. For more information on the card details. As the Reader B has no priorities. see the NetAXSDoorInfo Properties. SetNetAXSDoorModeByHID Description Sets the Door mode of the NetAXS Reader to the supplied value. Note For NetAXS 123 Panels. The output parameter that contains the current Door Mode configuration of the Reader encapsulated in the interface INetAXSDoorInfo. Visual C++ Signature HRESULT GetNetAXSDoorModeByHID( [in] long lHID. the GetNetAXSDoorModeByHID() on Reader B will get only the timezones. not the Priorities.

see the NetAXSDoorInfoProperties. Visual C++ Signature HRESULT SetNetAXSDoorModeByHID ( [in] long lHID. For more information on the card details. Note The SetNetAXSDoorModeByHID status values are as follows:  0 – setting the Door mode for the NetAXS Reader Succeeded  1 – setting the Door mode failed  2 – Invalid HID for the Reader  3 – The DoorInfo Object passed in the pDoorInfo was empty  4 – Invalid Disable Door Timezone  5 – Invalid Lockdown Reader Timezone  6 – Invalid Card Only Timezone  7 – Invalid PIN Only Timezone  8 – Invalid Card and PIN Timezone  9 – Invalid Card or PIN Timezone  10 – Invalid Card Only Priority  11 – Invalid PIN Only Priority Release 6. All the priorities passed are truncated and the corresponding Reader A’s priorities are taken. plStatus The SetNetAXSDoorMode status value. the SetNetAXSDoorModeByHID() on Reader B will set only the timezones.Communication Server API Functionalities Note For NetAXS 123 Panels. The input parameter that contains the Door Mode configuration need to be set up for the Reader encapsulated in the interface INetAXSDoorInfo. [in] INetAXSDoorInfo* pDoorInfo. [out] long *plStatus).2 57 © 2012 Honeywell International . Parameters Parameters lHID pDoorInfo Description The hardware device ID of the NetAXS Reader. not the Priorities.

retval]long* lStatusID). Release 6. Return Code S_OK Description For a successful operation. [in] long lDeviceType. GetStatus Description Returns the status for the specified device ID and the device type.2 58 © 2012 Honeywell International .WIN-PAK SE/PE Communication Server API Public Interface Document Parameters Description  12 – Invalid Card and PIN Priority  13 – Invalid Card or PIN Priority Return Type The HRESULT value is returned. the value zero is returned. For more information on the device status. Return Code S_OK Description For a successful operation. [out. the value zero is returned. The type of hardware device. Visual C++ Signature HRESULT GetStatus ( [in] long lHID. see Abstract Devices Status Definitions. The following table displays the return codes. The following table displays the return codes. Return Type The HRESULT value is returned. The output parameter that contains the status ID of the device. Parameters Parameters lHID lDeviceType lStatusID Description The hardware device ID.

<NLZ> <ADV_Status>StatusID</ADV_Status> <ADV_HID>HID2</ADV_HID> <ADV_DeviceType>DeviceType</ADV_DeviceType> <ADV_DeviceName>DeviceName</ADV_DeviceName> </NLZ> Abstract Devices Status Definitions The GetStatus() function returns the status ID of the specified type of hardware device.Communication Server API Functionalities Remarks If the client calls the GetStatus function by passing the parameters HID and DeviceType. The following code is a sample of the information sent to the client. The following table lists the different status IDs and their descriptions. the StatusID and other additional information is sent to the client.2 59 © 2012 Honeywell International . Status ID 300 301 302 303 304 35* 401 402 403 404 405 406 408 409 405 45* Description Null String Entrance Unknown Entrance Alarm Entrance OK Entrance Trouble Shunted Input Unknown Input Alarm Door Ajar Input Normal Input Trouble Entry in Progress Exit in Progress Input Trouble Cut Input Trouble Short Shunted Release 6.

2 60 © 2012 Honeywell International .WIN-PAK SE/PE Communication Server API Public Interface Document Status ID 501 502 503 504 801 802 803 901 902 91* 92* 93* 94* 95* 96* 97* 98* 99* 903 601 602 603 1001 1002 1003 Description Output Unknown Output Deenergized Output Energized Output Trouble Server Unknown Server Trouble Server OK Panel Unknown Panel Alarms Panel Communication AUX Port Primary Power Panel Tamper Ground Fault Low Voltage Ext 5V Poll Response Remote Panel OK Loop Unknown Loop Alarm Loop OK NetAXS IO or P-Series SIO Board Unknown NetAXS IO or P-Series SIO Board OK NetAXS IO or P-Series SIO Board Trouble Release 6.

Communication Server API Functionalities Status ID 701 702 703 Description Device Unknown Device Alarm Device OK Note The * in the status ID field indicates that it can hold any number. The following table lists the different event IDs and their descriptions. EXAMPLE The status sent from the API is 452.2 61 © 2012 Honeywell International . Event ID 101 102 103 104 105 106 107 201 202 203 Description Server OK Server Trouble Check Point: Out of Sequence Check Point: Missed Check Point: Early Arrival Check Point: Late Arrival Check Point: Checked Loop OK Loop Alarm Loop Remote Dial-Up Successful Release 6. This status ID can be interpreted as follows: 45*= Shunted and 402 = Input Alarm Hence the status description for the StatusID 452 is Shunted Input Alarm. the status ID 452 does not exist. Event Code List The event code is an event ID to identify the status of events/alarms generated from the panels. However.

2 62 © 2012 Honeywell International .WIN-PAK SE/PE Communication Server API Public Interface Document Event ID 204 301 302 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 Description Loop Remote Dial-Up Failed Modem Pool OK Modem Pool Trouble Panel Communication Alarm Panel Communication Normal Auxiliary Port Alarm Auxiliary Port Normal Primary Power Failure Primary Power Normal Poll Response Alarm Poll Response Normal Tamper Switch Alarm Tamper Switch Normal Ground Fault Alarm Ground Fault Normal Low Voltage Alarm Low Voltage Normal External 5 Volt Alarm External 5 Volt Normal Panel Reset Panel configuration error Incorrect Password Panel Remote Dial-Up Failed Panel Remote Dial-Up Successful Unsupported Panel version Release 6.

2 63 © 2012 Honeywell International . door used Release 6. door not used Site code verified.Communication Server API Functionalities Event ID 423 424 425 426 427 428 429 430 431 501 502 503 504 505 506 507 508 601 602 603 701 702 703 704 705 Description Unsupported SIO Board Version Panel Restarted Panel DB Updated Panel DB Deleted Panel Common DB Updated Panel Common DB Deleted Panel Time Changed Panel switched to Hybrid Mode Panel Process Watcher restated Input Alarm Input Normal Input Trouble Input Trouble Cut Input Trouble Short Ajar State Input Exit Delay Input Entry Delay Output De-energized Output Energized Output Trouble Valid Card Trace Card Door Unlocked Site code verified.

reverse read Door locked Issue code Duress request denied Never allowed at this door No second card presented Floor Called Release 6. door used Valid Card. Card downloaded Invalid Time Zone Card Not Found Invalid PIN Invalid Site Code Anti-Passback Violation Door Normal Door Forced Open Door Ajar Door Trouble Invalid Format Invalid Format. door not used Duress. door not used APB violation. door used Duress.2 64 © 2012 Honeywell International . door used Host Grant. door not used Valid Card. Door unlocked Host Grant.WIN-PAK SE/PE Communication Server API Public Interface Document Event ID 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 Description APB violation.

Communication Server API Functionalities Event ID 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 1001 1002 1003 1004 Description Floor Selected Floor Select Timeout Free Egress. door used Hard Anti-passback Violation Soft Anti-passback Violation Site Code Violation Duress PIN Entered Card Expired VIP Card Found Supervisor Card Found Supervisor Mode not Enabled Supervisor card required Supervisor Authenticated Soft Piggy-bagging Hard Piggy-bagging Supervisor mode Enabled Supervisor mode disabled Temporary card expired by usage limit Temporary card expired by Date Basic Panel Initialization ended Time Date sending ended Sending cards ended Sending Command Files Ended Release 6. door not verified Free Egress. door not used Free Egress.2 65 © 2012 Honeywell International .

2 66 © 2012 Honeywell International . [out] BOOL* bDoorStatus). Visual C++ Signature HRESULT GetStatus ( [in] long lReaderHID. Note The status of the Door in the interlock with a Group of Output as the Direct Point will be shown “Door Opened” always Parameters Parameters lHID Description The device ID of the door Release 6.WIN-PAK SE/PE Communication Server API Public Interface Document Event ID 1005 1006 1007 1008 1009 1101 1102 1103 1104 1105 1106 Description Sending Holidays ended Sending Timezones ended Sending Inputs ended Sending Outputs ended Sending Groups ended NetAXS I/O Board Power Alarm NetAXS I/O Board Power Normal NetAXS I/O Board Tamper Alarm NetAXS I/O Board Tamper Normal NetAXS I/O Board Poll Response Alarm NetAXS I/O Board Poll Response Normal GetDoorStatus2 Description Returns the physical status for the specified Door whether is it open or not.

The following code is a sample of the information sent to the client. Return Code S_OK Description For a successful operation. <NLZ> <Door_IsOpen>DoorOpenStatus</Door_IsOpen> <Door_IsShunted>DoorShuntStatus</Door_IsShunted> <Door_ForcedOpen>DoorForcedOpenStatus</Door_ForcedOpen> <Door_Ajar>DoorAjarStatus</Door_Ajar> <ADV_Hid>ADVHID</ADV_Hid> <ADV_DeviceName>DeviceName</ADV_DeviceName> </NLZ> Release 6. the bDoorStatus is sent to the client and also the client is subscribed to the door status change notifications through the callback protocol.2 67 © 2012 Honeywell International . Return Type The HRESULT value is returned. the value zero is returned. The following table displays the return codes. Remarks If the client calls the GetDoorStatus2 function by passing the parameters HID.Communication Server API Functionalities Parameters bDoorStatus Description The output Boolean parameter that contains the status of the Door.

The callback mechanism allows the client application to pass an interface to the server. COM+. In this Chapter Protocol Process Notification Message Tags Page Number 69 70 Release 6.Chapter 3 COMMUNICATION SERVER CALLBACK PROTOCOL Overview The Communication Server API uses the asynchronous callback protocol mechanism provided by COM. Using this interface. and DCOM components of ActiveX controls.2 68 © 2012 Honeywell International . The following sections explain the callback protocol process and the notification messages. the server notifies the client about the events/alarms generated by the hardware devices.

In addition. The ACCW. These APIs act as the interface between the client and the communication server. 69 © 2012 Honeywell International 2 3 Release 6.MTSCBServer::InitServer method and passes the reference of the class that implements the IWPAVCallBack interface. The communication server collects the information about the events generated in the hardware panels. Process Flow Diagram The procedural steps for comuunication between the ActiveX enabled client application and the server are as follows: 1 The client derives the IWPAVCallBack interface and implements its methods.dll sends information about any events as a parameter in the GotMessage() method. the GotMessage() and ServerError() methods.dll contains the compiled WIN-PAK SE/PE communication server APIs. The server responds to the call using the GotMessage(sMessage) method to notify the client of any events. the server notifies the client about errors in the server using the method ServerErrors(sErrorMessage).… ) method.2 . The communication server wrapper ACCW. The client calls the ACCW.Communication Server Callback Protocol Protocol Process The client application initiates the connection to the WIN-PAK SE/PE by passing a reference using the InitServer(IDispatch* Caller.

The information about events/alarms is sent as the sMessage parameter of the GotMessage method. and the information each tag contains is listed in the following table. <NLZ> <AckStatus>1</AckStatus> <Idx>1</Idx> <TranID>1</TranID> <CommSrvID>1</CommSrvID> <Account>Test</Account> <DeviceID>4</DeviceID> <HID>23</HID> <Prio>1</Prio> <Date>2/16/07</Date> <Time>18:46:00</Time> <Cnt>1</Cnt> <Note>An operator note</Note> <SS>1</SS> <Status>Valid Card</Status> <EventID>701</EventID> <HIDSubType1>51</HIDSubType1> <Point>1008</Point> <Site>NCI</Site> <Account>NCI</Account> <CardNumber>1234</CardNumber> <FullName>Bunny Bugs</FullName> <RP>Panel 1 . Release 6. The following is an example of the sMessage parameter.2 70 © 2012 Honeywell International . Indicates the end of the message. The information about the events/alarms is in different tags of the notification message.Read 1</RP> </NLZ> Tag Descriptions The notification message tags. Tags <NLZ> </NLZ> Description Indicates the beginning of the message.WIN-PAK SE/PE Communication Server API Public Interface Document Notification Message Tags The WIN-PAK SE/PE communication server informs the client about the events generated in the hardware panels through the notification messages.

The WIN-PAK SE/PE acknowledges alarms. 1 indicates a new alarm. • • • 0 indicates alarm is cleared. The identification number of the communication server that routes the alarm.</CommSrvID> For internal use. The hardware device ID. HID is the unique identifier for the devices configured in the WIN-PAK SE/PE suite of products.</DeviceID> <HID>. <Prio>. and performs many other functions based on the priority of the events.</Time> The date of the alarm/event. the point ID is based on the panel type.</Point> The point ID. <DeviceID>.</HID> The device ID can be a PanelID or a LoopID. The HID tag in the notification message helps to identify the origin of the event. -1 indicates an event. Release 6. If the user interface is configured to multiple communication servers. Point is the ID of device locations for multipoint devices such as a panel. clears alarms.Communication Server Callback Protocol Tags <AckStatus>. 2 indicates an acknowledged alarm. Note For a panel.</Prio> The event priority. <Point>. Priorities are assigned to events and alarms.</TranID> <CommSrvID>.</Date> <Time>. <TranID>.2 71 © 2012 Honeywell International .</Idx> Indicates if the message is an alarm or event. <Date>. this tag identifies the communication server that has sent the alarm. <Idx>. • • A value greater than 0 indicates an alarm. The time of the alarm/event.</AckStatus> Description The status of the alarm.

The following is an example of an event that indicates Primary Power Failure.</TranType> The transaction type.</Status> Additional information added by an operator. see Event Code List. <Site>. EXAMPLE <Status>PrimaryPowerFailure </Status> <EventID>. Release 6. These logical groups are called sites. EXAMPLE < EventID >405</ EventID > For more information on EventIDs. The operator is the person who acknowledges or clears the alarm/event. The alarm status displays the reason for triggering of the alarm. The WIN-PAK SE/PE operator. The transaction type can be any of the following: • • • Operator Note Alarm Ack Alarm Clr Note A new alarm does not have this tag in the notification message.2 72 © 2012 Honeywell International .</Cnt> <Oper>. <TranType>.</Oper> Description The number of occurrences of the same type of alarm or event. <Note>.</EventID> The ID of the event/alarm generated from the panel.WIN-PAK SE/PE Communication Server API Public Interface Document Tags <Cnt>.</Site> The site to which the device belongs. The WIN-PAK SE/PE operator logically groups the devices for easy monitoring/operating.</Note> <Status>. The status of the alarm.

The reader/point is the source of the alarm.</FullName> <RP>.2 73 © 2012 Honeywell International . 0) End If Wend where the GetStringFromTran function is as follows: Release 6.</RP> <HIDSubType1>. The name of the device.. WIN-PAK SE/PE supports multiple accounts where the card and card holder information is partitioned.</ADV_HID> <ADV_DeviceType>.Communication Server Callback Protocol Tags <Account>.. Sample Code to Extract Information from the Notification Messages An example of the message that the server sends to a simple parser is as follows: While (sInput <> "") sStr = GetStringFromTran(sInput) //Add sStr to Alarm/Event View using GetFieldFromTran(see GetStringFromTran) //. </ADV_Status> <ADV_HID>. TRUE (any value other than 0) indicates the alarm must be replaced with an existing alarm FALSE (a zero) indicates the alarm must not be replaced and must be appended to the UI <ADV_Status>.</SS> The card number. </HIDSubType1> <SS>. The type of device. The full name of the card holder.</ADV_DeviceType> <ADV_DeviceName>. "".. sInput = Mid(sInput..</CardNumber> <FullName>. 'Error? '//Call MessageBox(0. ". Len(sStr) + 1) lCntr = lCntr + 1 If lCntr > cMaxLoopCnt Then 'TODO. "Internal Error: lCntr > cMaxLoopCnt. The sub device type ID. The field value is used for displaying alarms in the alarm window.</ADV_DeviceName> The status ID of the device. The device HID.</Account> Description The name of the account. <CardNumber>.

sFieldName As String) As String Dim lTmpB As Long Dim lTmpE As Long Dim sTmp As String On Error Resume Next GetFieldFromTran = "" lTmpB = InStr(sInTran. Public Function GetFieldFromTran(sInTran As String. "<" + sFieldName + ">") lTmpE = InStr(sTmp. lTmpB) lTmpB = InStr(sTmp.2 74 © 2012 Honeywell International . lTmpE . lTmpB + Len("<" + sFieldName + ">"). lTmpB + Len("<NLZ>"). lTmpE (lTmpB + Len("<" + sFieldName + ">"))) End If End If End Function Release 6. "</" + sFieldName + ">") If lTmpE > 0 And (lTmpB < lTmpE) Then GetFieldFromTran = Mid(sTmp.WIN-PAK SE/PE Communication Server API Public Function GetStringFromTran(sInTran As String) As String Dim lTmpB As Long Dim lTmpE As Long Dim sTmp As String On Error Resume Next Public Interface Document GetStringFromTran = "" lTmpB = InStr(sInTran.(lTmpB + Len("<NLZ>"))) + "</NLZ>" End If End If End Function To get multiple parameters from the message string. you can use the following function. "<NLZ>") lTmpE = InStr(sTmp. lTmpB) lTmpB = InStr(sTmp. "<" + sFieldName + ">") If lTmpB > 0 Then sTmp = Mid(sInTran. "</NLZ>") If lTmpE > 0 And (lTmpB < lTmpE) Then GetStringFromTran = "<NLZ>" + Mid(sTmp. "<NLZ>") If lTmpB > 0 Then sTmp = Mid(sInTran.

Communication Server Callback Protocol Examples of Panel Notification Messages A few examples of different types of alarm/event panel notification messages are listed in the following tables.2 75 © 2012 Honeywell International . Release 6. Reader and Output Events Message String Example 1: <NLZ> <AckStatus>2</AckStatus> <Idx>-1</Idx> <CommSrvID>3</CommSrvID> <Account>Test</Account> <DeviceID>4</DeviceID> <HID>74</HID> <Prio>20</Prio> <Date>11/22/2007</Date> <Time>16:28:26</Time> <Cnt>2</Cnt> <Oper>Admin</Oper> <TranType>Ack</TranType> <Note></Note> <Status>Door Ajar</Status> <EventID>721</EventID> <Point>1</Point> <Site>Pro-2200</Site> <RP>Pro-2200 .Reader 2</RP> </NLZ> Inference The source of the event is Pro2200 Reader 2.

2 76 © 2012 Honeywell International . Release 6.WIN-PAK SE/PE Communication Server API Public Interface Document Example 2: <NLZ> <AckStatus>2</AckStatus> <Idx>-1</Idx> <CommSrvID>1</CommSrvID> <Account>Test</Account> <DeviceID>3</DeviceID> <HID>31</HID> <Prio>20</Prio> <Date>2/16/2007</Date> <Time>14:47:02</Time> <Cnt>2</Cnt> <Oper>Admin</Oper> <TranType>Ack</TranType> <Note></Note> <Status>Door Ajar</Status> <EventID>721</EventID> <Point>1</Point> <Site>PW-5000 2200</Site> <RP>Loop 2 Panel 1 R2-Output</RP> </NLZ> The source of the event is Loop 2 Panel 1 R2-Output.

Communication Server Callback Protocol Reader and Output Alarms Message String Example 3: <NLZ> <AckStatus>1</AckStatus> <Idx>2</Idx> <TranID>1</TranID> <CommSrvID>3</CommSrvID> <Account>Test</Account> <DeviceID>4</DeviceID> <HID>74</HID> <Prio>20</Prio> <Date>2/16/2007</Date> <Time>14:43:10</Time> <Cnt>1</Cnt> <Note></Note> <SS>1</SS> <Status>Door Normal</Status> <EventID>719</EventID> <HIDSubType1>53</HIDSubType1> <Point>1</Point> <Site>Pro-2200</Site> <RP>Pro-2200 .2 77 © 2012 Honeywell International .Reader 2</RP> </NLZ> Inference The source of the alarm is Pro2200 Reader 2 and the device sub type is HID_ENTRANCE_PW5000_DOOR. Example 4: <NLZ> <AckStatus>2</AckStatus> <Idx>1</Idx> <TranID>1</TranID> <CommSrvID>1</CommSrvID> <Account>Test</Account> <DeviceID>3</DeviceID> <HID>31</HID> <Prio>20</Prio> <Date>2/16/2007</Date> <Time>14:47:02</Time> <Cnt>2</Cnt> <Oper>Admin</Oper> <TranType>Ack</TranType> <Note></Note> <Status>Door Ajar</Status> <EventID>721</EventID> <HIDSubType1>43</HIDSubType1> <Point>1</Point> The source of the alarm is Loop 2 Panel 1 R2-Output and the device sub type is HID_OUTPUT_PW5000. Release 6.

Input Event Message String Example 5: <NLZ> <AckStatus>2</AckStatus> <Idx>-1</Idx> <CommSrvID>1</CommSrvID> <Account>Test</Account> <DeviceID>3</DeviceID> <HID>39</HID> <Prio>20</Prio> <Date>2/16/2007</Date> <Time>14:48:01</Time> <Cnt>1</Cnt> <Oper>Admin</Oper> <TranType>Ack</TranType> <Note></Note> <Status>Input Alarm</Status> <EventID>501</EventID> <Point>4</Point> <Site>PW-5000</Site> <RP>N1000 – In4</RP> </NLZ> Inference The source of the event is from Input 4 of the N1000 panel. a -1 in the Idx tag indicates an event.2 78 © 2012 Honeywell International . A positive value in the Idx tag indicates an alarm. However.WIN-PAK SE/PE Communication Server API Public Interface Document Message String <Site>PW-5000 2200</Site> <RP>Loop 2 Panel 1 R2-Output</RP> </NLZ> Inference Note Using the Idx tag you can differentiate an alarm or an event notification message. Release 6.

2 79 © 2012 Honeywell International . Input Alarm Message String Example 7: <NLZ> <AckStatus>2</AckStatus> <Idx>1</Idx> <TransID>1</TransID> <CommSrvID>1</CommSrvID> <Account>Test</Account> <DeviceID>3</DeviceID> <HID>39</HID> <Prio>20</Prio> <Date>2/16/2007</Date> <Time>22:48:01</Time> <Cnt>1</Cnt> <Oper>Admin</Oper> <TranType>Ack</TranType> <Note></Note> <Status>Input Alarm</Status> <EventID>501</EventID> <HIDSubType1>34</HIDSubType1> <Point>4</Point> Inference The source of the alarm is from Input 4 of the N1000 panel and the device sub type is HID_INPUT_PW5000_SUPER.Communication Server Callback Protocol Message String Example 6: <NLZ> <AckStatus>2</AckStatus> <Idx>-1</Idx> <CommSrvID>1</CommSrvID> <Account>Test</Account> <DeviceID>4</DeviceID> <HID>52</HID> <Prio>20</Prio> <Date>2/16/2007</Date> <Time>14:48:01</Time> <Cnt>1</Cnt> <Oper>Admin</Oper> <TranType>Ack</TranType> <Note></Note> <Status>Input Alarm</Status> <EventID>501</EventID> <Point>4</Point> <Site>PW-5000</Site> <RP>N1000 – In4</RP> </NLZ> Inference The source of the event is from Input 4 of the N1000 panel. Release 6.

2 80 © 2012 Honeywell International .WIN-PAK SE/PE Communication Server API Public Interface Document Message String <Site>PW-5000</Site> <RP>N1000 – In4</RP> </NLZ> Inference Example 8: <NLZ> <AckStatus>2</AckStatus> <Idx>1</Idx> <TransID>1</TransID> <CommSrvID>1</CommSrvID> <Account>Test</Account> <DeviceID>4</DeviceID> <HID>52</HID> <Prio>20</Prio> <Date>2/16/2007</Date> <Time>22:48:01</Time> <Cnt>1</Cnt> <Oper>Admin</Oper> <TranType>Ack</TranType> <Note></Note> <Status>Input Alarm</Status> <EventID>501</EventID> <HIDSubType1>34</HIDSubType1> <Point>4</Point> <Site>PW-5000</Site> <RP>N1000 – In4</RP> </NLZ> The source of the alarm is from Input 4 of the N1000 panel and the device sub type is HID_INPUT_PW5000_SUPER. Release 6.

2 81 © 2012 Honeywell International .Communication Server Callback Protocol Panel Event Message String Example 9: <NLZ> <AckStatus>2</AckStatus> <Idx>-1</Idx> <CommSrvID>1</CommSrvID> <Account>Test</Account> <DeviceID>3</DeviceID> <HID>38</HID> <Prio>10</Prio> <Date>2/16/2007</Date> <Time>22:47:07</Time> <Cnt>1</Cnt> <Oper>Admin</Oper> <TranType>Ack</TranType> <Note></Note> <Status>PollResponseNormal</Status> <EventID>408</EventID> <Point>0</Point> <Site>PW-5000</Site> <RP>PW-5000</RP> </NLZ> Inference The source of the event is from the PW-5000 panel. Release 6.

Device Status Message String Example 11: <NLZ> <ADV_Status>603</ADV_Status> <ADV_Hid>20</ADV_Hid> <ADV_DeviceType>16</ADV_DeviceType> <ADV_DeviceName>Loop</ADV_DeviceName> </NLZ> Inference The status of the abstract device is Loop OK. Note The zero value in the Point tag indicates that the panel is the source of the alarm/event. Release 6.2 82 © 2012 Honeywell International .WIN-PAK SE/PE Communication Server API Public Interface Document Panel Alarm Message String Example 10: <NLZ> <AckStatus>2</AckStatus> <Idx>1</Idx> <TransID>1</TransID> <CommSrvID>1</CommSrvID> <Account>Test</Account> <DeviceID>3</DeviceID> <HID>38</HID> <Prio>10</Prio> <Date>2/16/2007</Date> <Time>22:47:07</Time> <Cnt>1</Cnt> <Oper>Admin</Oper> <TranType>Ack</TranType> <Note></Note> <Status>PollResponseNormal</Status> <EventID>408</EventID> <HIDSubType1>29</HIDSubType1> <Point>0</Point> <Site>PW-5000</Site> <RP>PW-5000</RP> </NLZ> Inference The source of the alarm is from the PW-5000 panel.

58</SrvMachineName> <Date>07/20/2007</Date> <Time>16:47:21</Time> </Message> </NLZ> Inference The Communication Server 1 lost connection. Communication Server Lost Connection Message String Example 1: <NLZ> <Message>LOST_CONNECTION <CommSrvID>1</CommSrvID> <CommSrvName>CommServer</CommSrvName> <SrvMachineName>199.Communication Server Callback Protocol Schedule Server Status Message String Example 12: <NLZ> <ADV_Status>803</ADV_Status> <ADV_Hid>43</ADV_Hid> <ADV_DeviceType>3</ADV_DeviceType> <ADV_DeviceName>SchServer</ADV_DeviceName> </NLZ> Inference The status of the abstract device is Loop OK. Release 6. Examples of WIN-PAK SE/PE Notification Messages A few examples of different types WIN-PAK SE/PE notification messages are listed in the following tables.2 83 © 2012 Honeywell International .63.39.

Database Server Regained Connection Message String Example 4: <NLZ> <Message>REGAINED_CONNECTION <DatabaseSrvID>1</DatabaseSrvID> <DatabaseSrvName>CommServer</DataSrvName> <SrvMachineName></SrvMachineName> <Date>07/20/2007</Date> <Time>16:47:21</Time> </Message> </NLZ> Inference The Database Server 1 regained the lost connection. Database Server Lost Connection Message String Example 3: <NLZ> <Message>LOST_CONNECTION <DatabaseSrvID>1</DatabaseSrvID> <DatabaseSrvName>CommServer</DataSrvName> <SrvMachineName></SrvMachineName> <Date>07/20/2007</Date> <Time>16:47:21</Time> </Message> </NLZ> Inference The Database Server 1 lost connection.63.39.WIN-PAK SE/PE Communication Server API Public Interface Document Communication Server Regained Connection Message String Example 2: <NLZ> <Message>REGAINED_CONNECTION <CommSrvID>1</CommSrvID> <CommSrvName>CommServer</CommSrvName> <SrvMachineName>199.58</SrvMachineName> <Date>07/20/2007</Date> <Time>16:47:21</Time> </Message> </NLZ> Inference The Communication Server 1 regained the lost connection.2 84 © 2012 Honeywell International . Release 6.

A peripheral device connected to the control panel that reads and sends the card information to the control panel. codes. panels. Input points or Alarm points have software states of UNSHUNTED (active) and SHUNTED (not active).2 85 © 2012 Honeywell International .Glossary Abstract Device A logical representation of a physical device. The ADVs can be associated with any hardware device. When an input is unshunted. Usually different speeds. A concentrator usually provides communication capability between many low-speed. The pulse time is the amount of time the output point is energized when triggered. usually asynchronous channels and one or more highspeed. When an input is shunted. and protocols can be accommodated on the low-speed side. including communication interfaces. alarm points and entrances. all physical changes of state (openings and closures) are recognized. The low-speed channels usually operate in contention and require buffering. The location of the peripheral device connected to the control panel. usually synchronous channels. A functional unit that permits a common path to handle more data sources than the channels currently available within the path. Concentrator Point Pulse Reader Shunt and UnShunt Release 6. physical changes of state are not recognized.

.... 11 Connecting API Client and Server ............... 55 DoneServer ......................................41 AlarmShuntByHID ..... 61 Device Status ..... 42 GetStatus............... 38.......................................... 59 ACCW....................................... 38 Component Model Diagram.......... 82 Input Alarm ............................... 83 Examples of WIN-PAK CS Notification Messages ..... 29.............................. 31.. 68 Card Properties ......... 84 Database Server Lost Connection............... 44 Panel Alarm ............................................. 31..................... 56........................... 58..........49.................... 79 Input Event .................... 78 S ServerErrors...................... 84 G GetDetailsByID. 36................................................................................................................................... 82 Panel Event .....40 Communication Server API Functionalities .................................... 42 EntryPointUnLockByID ...................................................................... 25 wpviewTYPE .................. 28 CardNumber(get).................. 37 I InitServer ............... 43 Enumeration Types HIDSubType1 ..................... 25.. 69 CommunicationAPIClient .................................................................. 43 AlarmUnShuntByHID ......... 53................................. 16 CommunicationAPIServer .......................................................................................... 21 D Data Structures.................... 12 ClrAlarm .................... 48 N Notification Message Tag Descriptions ..... 70 Tags .....................................40 AddNote... 34.................... 24 L ListConnectedDevices .... 46 Communication Server Lost Connection .................................................... 51............................................. 84 Database Server Regained Connection . 66 GotMessage...................................................................... 36 CardNumber(put) 28........................................................................................................ 44 Event Code List ......................................................................... 83 B BufferByHID ...... 38........................ 30......................................................... 81 Reader and Output Alarms ................. 54..........2 86 © 2012 Honeywell International ...49 EntryPointLockByID ........ 48 DeEnergize ............... 26 HIDType....... 54........... 35................. 35............. 27 P PulseByHID ................................................................ 52............. 70 E Energize ............... 69 AckAlarm .................. 33.................. 77 Reader and Output Events .......................................................... 70 C CallBack Protocol ... 75 Schedule Server Status ..................... 69 Installing ................................................................................................................ 33....................................Index A Abstract Devices Status Definitions ............. 39 DoorModeByHID .... 12 IWPAVCallBack ............................................................. 24 O Object Specifications.......... 75 R RestoreTZByHID ...................... 69 Release 6..... 34......... 32.............................................. 24 Enumeration Types ............................................... 61 Event ID Examples of Notification Messages ... 24 Device ............. 28.....................................................dll ................ 45 Description ... 83 Communication Server Regained Connection ............................. 32...................................... 30.... 29....................................... 69............ 50.............................................

........................ 73 <CardNumber> .......... 73 <ADV_Status>......................... 73 <ADV_HID>........ 73 <Idx>........................................................................................................................ 73 <Cnt> .............................................2 87 © 2012 Honeywell International . 70 <Account> ..................................................................................................................................... 72 <Point> .......... 71 <Prio> ............................ 71 <TranType> .. 71 TimedPulseByHID................................................................................................................................................................................................................................................................................................................................ 71 <Date> .......... 70 <Note>.......................................................................................... 47 Release 6.............. 71 <DeviceID> ....................... 72 T Tag Descriptions .................................. 71 <EventID> ......... 71 <ADV_DeviceName> ................................................................................ 73 <AckStatus>........ 73 <ADV_DeviceType>................................................. 72 <Time>........ 71 <RP> .............................. 72 <SS> ........................................................ 11 Descriptions............................................................................................................................................. 59 <HIDSubType1>............................................................................................................................................................................ 72 <CommSrvID> ............................................................................................................................................ 73 <Site>.............Index Status ID Supported Operating Systems............ 72 <Oper>................. 71 <TranID> ......... 73 <Status>............................. 71 <NLZ> .............................. 72 <FullName> ..... 44 U UnBufferByHID ....................... 73 <HID> ..............................................................................................................

.

A Tel: 800-323-4576 Fax: 414-766-1798 Office Hours: 7 AM to 7 PM (CST) E-mail: HASsupport@honeywell. RH15 9UF U.K Tel: +44 (0)1444 251180 Fax: +44 (0)1444 871074 Specifications subject to change without notice.honeywellaccess. © 2012 Honeywell International. WI 53154 U.S.Honeywell Access Systems 135 West Forest Hill Avenue Oak Creek. Burgess Hill West Sussex.com URL: http://www. All rights reserved.com Honeywell Access Systems Charles Avenue. .

Sign up to vote on this title
UsefulNot useful