Preview only show first 10 pages with watermark. For full document please download

Script And Tcp/ip Interface Specification For The Isonas Access

Rating
Date

October 2018
Size

591.8KB
Views

6,230
Categories

Home Home security & automation Access cards

Transcript

Script and TCP/IP Interface Specification for the ISONAS Access Control System September 2012 ISONAS Security Systems 303-567-6516 www.ISONAS.com 1 4720 Walnut St, Suite 200 Boulder, CO. 80301 USA Table of Contents Revision History ................................................................................................................. 8 Introduction ....................................................................................................................... 11 Architecture....................................................................................................................... 11 Connecting to the TCP/IP Server...................................................................................... 12 Restart Interval .............................................................................................................. 12 Encrypt and Encryption Key......................................................................................... 12 LOGON Process ........................................................................................................... 13 Syntax: ...................................................................................................................... 13 Response: .................................................................................................................. 13 Command Access Levels: ......................................................................................... 13 Connecting to External Systems via TCP/IP .................................................................... 14 Defining a New External Connection ........................................................................... 14 Editing Existing Connection Definitions ...................................................................... 16 Deleting an Existing Connection .................................................................................. 17 EVENT Notification ......................................................................................................... 17 Summary of Command Functional Capabilities ............................................................... 18 Format/Syntax ............................................................................................................... 20 Command parameter validation restrictions ................................................................. 20 COMMENTS .................................................................................................................... 22 Description: ................................................................................................................... 22 Syntax: .......................................................................................................................... 22 SUPERVISOR .................................................................................................................. 22 Description: ................................................................................................................... 22 Syntax: .......................................................................................................................... 22 Response: ...................................................................................................................... 23 CONNECTION................................................................................................................. 24 Description: ................................................................................................................... 24 Syntax: .......................................................................................................................... 24 Response: ...................................................................................................................... 24 DOORS ............................................................................................................................. 24 Description: ................................................................................................................... 24 Syntax: .......................................................................................................................... 24 Response: ...................................................................................................................... 26 DOORGROUP.................................................................................................................. 26 Description: ................................................................................................................... 26 Syntax: .......................................................................................................................... 26 Response: ...................................................................................................................... 26 DOORGROUPMEMBER ................................................................................................ 26 Description: ................................................................................................................... 26 Syntax: .......................................................................................................................... 26 Response: ...................................................................................................................... 27 ISONAS Security Systems 303-567-6516 www.ISONAS.com 2 4720 Walnut St, Suite 200 Boulder, CO. 80301 USA GROUPNAME ................................................................................................................. 27 Description: ................................................................................................................... 27 Syntax: .......................................................................................................................... 27 Response: ...................................................................................................................... 27 HOLIDAYS ...................................................................................................................... 27 Description: ................................................................................................................... 27 Syntax: .......................................................................................................................... 27 Response: ...................................................................................................................... 27 IDFILE .............................................................................................................................. 28 Description: ................................................................................................................... 28 Syntax: .......................................................................................................................... 28 Response: ...................................................................................................................... 28 IDFILE Image Files .......................................................................................................... 28 Description: ................................................................................................................... 28 Syntax: .......................................................................................................................... 29 Response: ...................................................................................................................... 29 GROUPS ........................................................................................................................... 30 Description: ................................................................................................................... 30 Syntax: .......................................................................................................................... 30 Response: ...................................................................................................................... 30 BADGES........................................................................................................................... 31 Description: ................................................................................................................... 31 Syntax: .......................................................................................................................... 31 Response: ...................................................................................................................... 31 GUIDs Associated with BADGES ................................................................................... 31 Description: ................................................................................................................... 31 Syntax: .......................................................................................................................... 31 Response: ...................................................................................................................... 32 SHIFTS ............................................................................................................................. 33 Description: ................................................................................................................... 33 Syntax: .......................................................................................................................... 33 Response: ...................................................................................................................... 33 PERMISSION ................................................................................................................... 34 Description: ................................................................................................................... 34 Syntax: .......................................................................................................................... 34 Response: ...................................................................................................................... 34 PERMISSIONGROUP ..................................................................................................... 34 Description: ................................................................................................................... 34 Syntax: .......................................................................................................................... 34 APPLY .............................................................................................................................. 35 Description: ................................................................................................................... 35 Syntax: .......................................................................................................................... 35 Response: ...................................................................................................................... 36 ADMIT ............................................................................................................................. 36 Description: ................................................................................................................... 36 ISONAS Security Systems 303-567-6516 www.ISONAS.com 3 4720 Walnut St, Suite 200 Boulder, CO. 80301 USA Syntax: .......................................................................................................................... 36 Response: ...................................................................................................................... 36 UNLOCK .......................................................................................................................... 37 Description: ................................................................................................................... 37 Syntax: .......................................................................................................................... 37 Response: ...................................................................................................................... 37 LOCKDOWN ................................................................................................................... 37 Description: ................................................................................................................... 37 Syntax: .......................................................................................................................... 37 Response: ...................................................................................................................... 38 RESETNORMAL ............................................................................................................. 38 Description: ................................................................................................................... 38 Syntax: .......................................................................................................................... 38 Response: ...................................................................................................................... 38 SETHOSTOVERRIDE ..................................................................................................... 38 Description: ................................................................................................................... 38 Syntax: .......................................................................................................................... 38 Response: ...................................................................................................................... 39 SETLOCAL ...................................................................................................................... 39 Description: ................................................................................................................... 39 Syntax: .......................................................................................................................... 39 Response: ...................................................................................................................... 39 PRESENTBADGE ........................................................................................................... 39 Description: ................................................................................................................... 39 Syntax: .......................................................................................................................... 39 Response: ...................................................................................................................... 40 PRESENTGUID ............................................................................................................... 40 Description: ................................................................................................................... 40 Syntax: .......................................................................................................................... 40 Response: ...................................................................................................................... 40 QUEUE EMAIL ............................................................................................................... 41 Description: ........................................................................................................... 41 Syntax: .................................................................................................................. 41 Response: .............................................................................................................. 41 QUERY ............................................................................................................................. 42 Description: ................................................................................................................... 42 BADGE ..................................................................................................................... 42 Description: ........................................................................................................... 42 Syntax: .................................................................................................................. 42 Response: .............................................................................................................. 42 ALL DOORS ............................................................................................................ 42 Description: ........................................................................................................... 42 Syntax: .................................................................................................................. 42 Response: .............................................................................................................. 42 DOORS ..................................................................................................................... 44 ISONAS Security Systems 303-567-6516 www.ISONAS.com 4 4720 Walnut St, Suite 200 Boulder, CO. 80301 USA Description: ........................................................................................................... 44 Syntax: .................................................................................................................. 44 Response: .............................................................................................................. 44 ALL DOORGROUPS ............................................................................................... 45 Description: ........................................................................................................... 45 Syntax: .................................................................................................................. 45 Response: .............................................................................................................. 45 DOORGROUP.......................................................................................................... 45 Description: ........................................................................................................... 45 Syntax: .................................................................................................................. 45 Response: .............................................................................................................. 45 GROUPNAMES ....................................................................................................... 46 Description: ........................................................................................................... 46 Syntax: .................................................................................................................. 46 Response: .............................................................................................................. 46 GROUP ..................................................................................................................... 46 Description: ........................................................................................................... 46 Syntax: .................................................................................................................. 46 Response: .............................................................................................................. 46 ALL GROUPS .......................................................................................................... 47 Description: ........................................................................................................... 47 Syntax: .................................................................................................................. 47 Response: .............................................................................................................. 47 ALL SHIFTS ............................................................................................................ 47 Description: ........................................................................................................... 47 Syntax: .................................................................................................................. 47 Response: .............................................................................................................. 47 SHIFT ....................................................................................................................... 48 Description: ........................................................................................................... 48 Syntax: .................................................................................................................. 48 Response: .............................................................................................................. 48 ALL HOLIDAYS ..................................................................................................... 49 Description: ........................................................................................................... 49 Syntax: .................................................................................................................. 49 Response: .............................................................................................................. 49 ALL IDFILE ............................................................................................................. 49 Description: ........................................................................................................... 49 Syntax: .................................................................................................................. 49 Response: .............................................................................................................. 49 IDFILE ...................................................................................................................... 50 Description: ........................................................................................................... 50 Syntax: .................................................................................................................. 50 Response: .............................................................................................................. 50 IDFILE IMAGES...................................................................................................... 50 Description: ........................................................................................................... 50 ISONAS Security Systems 303-567-6516 www.ISONAS.com 5 4720 Walnut St, Suite 200 Boulder, CO. 80301 USA Syntax: .................................................................................................................. 50 Response: .............................................................................................................. 50 ALL BADGES .......................................................................................................... 51 Description: ........................................................................................................... 51 Syntax: .................................................................................................................. 51 Response: .............................................................................................................. 51 BADGE BADGEID .................................................................................................. 52 Description: ........................................................................................................... 52 Syntax: .................................................................................................................. 52 Response: .............................................................................................................. 52 BADGE UNIQUEID ................................................................................................ 53 Description: ........................................................................................................... 53 Syntax: .................................................................................................................. 53 Response: .............................................................................................................. 53 BADGE GUID .......................................................................................................... 54 Description: ........................................................................................................... 54 Syntax: .................................................................................................................. 54 Response: .............................................................................................................. 54 PERMISSIONS......................................................................................................... 55 Description: ........................................................................................................... 55 Syntax: .................................................................................................................. 55 Response: .............................................................................................................. 55 HISTORY ................................................................................................................. 56 Description: ........................................................................................................... 56 Syntax: .................................................................................................................. 56 Response: .............................................................................................................. 56 IO MODULES .......................................................................................................... 58 Description: ........................................................................................................... 58 Syntax: .................................................................................................................. 58 Response: .............................................................................................................. 58 IOMODULE ............................................................................................................. 60 Description: ........................................................................................................... 60 Syntax: .................................................................................................................. 60 Response: .............................................................................................................. 60 Response: .............................................................................................................. 60 STATUS ................................................................................................................... 61 Description: ........................................................................................................... 61 Syntax: .................................................................................................................. 61 Response: .............................................................................................................. 61 ACTIVE ALARMS .................................................................................................. 63 Description: ........................................................................................................... 63 Syntax: .................................................................................................................. 63 Response: .............................................................................................................. 63 CLEAR ALARMS ............................................................................................................ 63 Description: ................................................................................................................... 63 ISONAS Security Systems 303-567-6516 www.ISONAS.com 6 4720 Walnut St, Suite 200 Boulder, CO. 80301 USA Syntax: .......................................................................................................................... 63 SET IOMODULE ............................................................................................................. 64 Description: ................................................................................................................... 64 Syntax: .......................................................................................................................... 64 Response: ...................................................................................................................... 65 SETLOGGING ................................................................................................................. 66 Description: ................................................................................................................... 66 Syntax: .......................................................................................................................... 66 Response: ...................................................................................................................... 66 ENABLE ........................................................................................................................... 66 Description: ................................................................................................................... 66 Syntax: .......................................................................................................................... 66 Response: ...................................................................................................................... 66 DISABLE .......................................................................................................................... 67 Description: ................................................................................................................... 67 Syntax: .......................................................................................................................... 67 Response: ...................................................................................................................... 67 ARM ................................................................................................................................. 67 Description: ................................................................................................................... 67 Syntax: .......................................................................................................................... 67 Response: ...................................................................................................................... 68 DISARM ........................................................................................................................... 68 Description: ................................................................................................................... 68 Syntax: .......................................................................................................................... 68 Response: ...................................................................................................................... 68 SET TTL ........................................................................................................................... 69 Description: ................................................................................................................... 69 Syntax: .......................................................................................................................... 69 Response: ...................................................................................................................... 69 QUEUE SCRIPT .............................................................................................................. 69 Description: ................................................................................................................... 69 Syntax: .......................................................................................................................... 69 Response: ...................................................................................................................... 69 DEQUEUE SCRIPT ......................................................................................................... 70 Description: ................................................................................................................... 70 Syntax: .......................................................................................................................... 70 Response: ...................................................................................................................... 70 Error Table ........................................................................................................................ 70 APPENDIX A – AES Encryption Library........................................................................ 72 LOGON Process with encryption enabled.................................................................... 73 ISONAS Security Systems 303-567-6516 www.ISONAS.com 7 4720 Walnut St, Suite 200 Boulder, CO. 80301 USA Revision History Revision Date 7/16/2008 Author Roger Matsumoto 8/4/2008 Roger Matsumoto 9/11/2008 Rmb 10/6/2008 Rmb 10/13/2008 Rmb 10/21/2008 11/04/2008 Rmb Rmb 1/9/2009 Rmb 2/9/2009 Roger Matsumoto 5/4/2009 Rmb ISONAS Security Systems 303-567-6516 Description Initial revision entry – added command parameter requirements table; enhanced command descriptions; clarified parameter descriptions. Formatting changes; Added Syntax table of commands in new appendix; Updated/corrected descriptive statements of command parameters; Delete Supervisor – rmv supervisor name and port Add Doors – dual auth values 0-3 Delete Doors – rms Servername and Port as cmd parameters Updated other commands to reflect the parameter requirements specified within the INRServ code . Added commands to add and delete door groups and to add and delete doors from door groups Updated command response to include IOSupervisors. Updated to include option Added events and errors associated with IO Points going True/False/Changing and clearing IO Alarms, added Query Active Alarms and Clear Alarms, modified several other Query responses. Added multiple commands per tcp/ip message. Modified and added errors to the error table. Modified SET IOMODULE to include priorities Clarified partial compile options (APPLY). Corrected ADD DOORGROUP documentation to show AREA option Added command Updated field description for start and end date of QUERY HISTORY command Updated Event to include Disable/Enable Input and Output Points . Added disable status to QUERY IOMODULE commands. Modified UNLOCK, LOCKDOWN, RESET NORMAL and CLEAR ALARM event reports to show BadgeID or “none” www.ISONAS.com 8 4720 Walnut St, Suite 200 Boulder, CO. 80301 USA 5/20/2009 Rmb 6/12/09 Rmb 7/17/2009 Roger Matsumoto 7/26/2009 Dick Burkley 8/06/2009 Dick Burkley 9/09/2009 Dick Burkley 10/05/2010 Dick Burkley 3/28/2011 Roger Matsumoto 5/27/2011 6/23/2011 7/26/2011 8/25/2011 Dick Burkley Dick Burkley Dick Burkley Dick Burkley 12/28/2011 Dick Burkley 8/29/2012 Roger Matsumoto ISONAS Security Systems 303-567-6516 Added commands ARM,DISARM,ENABLE and DISABLE. Changed content of responses to several QUERY commands associated with IOMODULES to include additional information about the DISARM and DISABLE state. Added compile type for Resend to the APPLY command 1. ADD DOORS – the “connection” argument should be “subnet” and needs to be in the description table of the command 2. ADD HOLIDAYS – “allareaflag” default value is 0(zero) not 1(one). 3. APPLY – changed the syntax to indicate the “compiletype” flag is required and the “scope” could be optional 4. QUERY ACTIVE ALARMS – Changed response to indicate whether the “point” is an input point or an output point, and if indicated, whether the point went true or false. Added SETLOCAL command. Updated section on restart interval. Added note to PRESENT BADGE command concerning LOCAL mode Added permission group name to Add Permission command. Clarified event notification for REX and AUX alarms. Added optional specification of a doorname to the SET IOMODULE command to support the Thyssen Krupp elevator interface. Modified DOORS add command and associated error and response information. Updated RESETNORMAL description Updated SETLOCAL description Corrected ISONAS address Added List OPENED and CLOSED event as event reports and history records Added GUID to the cmd. Updated the following Event Notifications with GUID data: , , , www.ISONAS.com 9 4720 Walnut St, Suite 200 Boulder, CO. 80301 USA 9/27/2012 Dick Burkley ISONAS Security Systems 303-567-6516 , , , , , , , Updated responses from the following commands with GUID: , , , . Updated the following response types of the command: , , , , , , , , , . The following New commands have been added: , , , , . Corrections made to the following commands: , , Added SetHostOverride command www.ISONAS.com 10 4720 Walnut St, Suite 200 Boulder, CO. 80301 USA Introduction This interface provides facilities to configure the Isonas Access Control database and command specific reader controller and I/O module actions by: 1. Sending TCP/IP message to the INRServ.exe (Isonas Notification Request Server) interface program 2. Writing script commands which the system executes when specified conditions are met by events that take place within the access control system. The functions in this interface that change the state of the reader controllers (Admit, Unlock, Lockdown, Reset Normal) require that the standard Isonas Access Control System Controller Supervisor program(s) (CSUP.exe) be up and running providing access control to a number of Isonas IP, WirelessIP or serial reader controllers. Other functions provided by this interface interact directly with the database tables and do not require the existence of a running controller supervisor program. Architecture The diagram below shows the architecture of the system. Both the TCP/IP interface and the ScriptRunner are included within the INRServ application. The TCP/IP interface sends notification of all events which occur within the access control system to all of the client programs that have connected to it, including the Script Runner program. The Script Runner program compares these events to the event filters that have been specified. When an event matches the specified criteria the script itself is processed, sending commands to the TCP/IP interface for execution. ISONAS Security Systems 303-567-6516 www.ISONAS.com 11 4720 Walnut St, Suite 200 Boulder, CO. 80301 USA Connecting to the TCP/IP Server Here is the INRServ screen used to configure the TCP/IP interface. The IP address, Port and logfile name are set using the controls shown. The meaning of the connection timeout is explained below under the Logon process description. Restart Interval An earlier version of the INRServ process had a minor resource leak associated with the client connection process that would eventually cause the system to fail due to lack of system resources if the client connects/disconnected frequently. As an interim workaround we provided a mechanism that shut the process down after a specified number of seconds. Setting the restart interval to zero disabled the restart process. By configuring the INRServ process to run as a windows service and setting the service to automatically restart on abnormal termination the INRServ could be continuously available and avoid the resource problem. The resource leak has been corrected in later versions and this restart interval is no longer needed. Encrypt and Encryption Key The TCP/IP server can be configured to use AES (Advanced Encryption Standard – sometimes called Rijndael ) Encryption. If set, the system uses 256 bit encryption. You must set the 32 byte key by specifying the 32 hex bytes. (E.g., 000102030405060708090A0B0C0D0E0F101112131415161718911A1B1C1D1E1F) This same encryption mechanism is used by the ISONAS reader controllers if you configure them to do so. We have included the dll library that provides the encryption as part of the ISONAS system code, and you can use this library if you wish to do so. You may also use any other encryption software that conforms to the AES standard. Appendix 1 describes the library functions. ISONAS Security Systems 303-567-6516 www.ISONAS.com 12 4720 Walnut St, Suite 200 Boulder, CO. 80301 USA LOGON Process When the client program connects to the server, it will immediately send the following message back to the client: | If encryption is enabled, the client should send a 16 byte encryption initialization vector at this point, and all subsequent messages sent to and received from the server are encrypted. The client program must send a message within the Connection Timeout with the following format and content: Syntax: | Where: Username or Label identification for this client. Up to 20 characters. This must be the current password for Username or must be the current Isonas Administrative password | The vertical bar denotes the end of a command definition The angle brackets <> must be used as shown. Example: | Response: If the username and password are accepted, the server will send a message: | If the logon process is unsuccessful, an error message is returned (see Error Table) Command Access Levels: If a Username/Password is used to log on to the TCP/IP server, the interface will restrict the user’s access to functions based on the authority level of the userid as shown in the following table: Scope Administrator COMMON Level Na 3 Capabilities/Limitations Full access Full access – can only operate* reader controllers if the Username is valid for Monitor functions and the reader controllers require level 3 or lower. COMMON 2 Full access to read and set all information – can only operate* reader controllers if the Username is valid for Monitor functions and the reader controllers require level 2 or lower. COMMON 1 Can only access/set people, badges and group information. Can only operate* reader controllers if the Username is valid for Monitor functions and the reader controllers require level 1 or lower. AREA 3 No access to set network information. Can retrieve information for the AREA or for COMMON. Can set shifts and permissions for reader controllers that are part of the AREA or are in the COMMON AREA. Can only operate* reader controllers if the Username is valid for Monitor ISONAS Security Systems 4720 Walnut St, Suite 200 303-567-6516 www.ISONAS.com Boulder, CO. 80301 USA 13 AREA 2 AREA 1 functions and the reader controllers are in the AREA or COMMON and require level 3 or lower. No access to set network information. Can retrieve information for the AREA (but not for COMMON). Can set shifts and permissions for reader controllers that are part of the AREA only. Can only operate* reader controllers if the Username is valid for Monitor functions and the reader controllers are in the AREA (but not COMMON) and require level 2 or lower. Can only access/set people groups and badges for the AREA. Can not change permissions but can invoke compilation. Can only operate* reader controllers if the Username is valid for Monitor functions and the reader controllers are in the AREA (but not COMMON) and require level 1 or lower. Connecting to External Systems via TCP/IP The TCP/IP interface server can support outbound TCP/IP connections to external/foreign systems. The “Server Connections”, currently defined, are displayed in the list of connections. The details of a connection are displayed when it is selected in the list of connections. Defining a New External Connection A new connection to an external system can be defined by clicking on the “Insert” button. This will disable all other features of the Server Connection display and allow the connection to be defined. ISONAS Security Systems 303-567-6516 www.ISONAS.com 14 4720 Walnut St, Suite 200 Boulder, CO. 80301 USA The entry fields are defined as follows: • Connection – this field assigns a name to the defined connection and will be displayed in the list of connections (“Connected Processes”) when the interface is running. The connection can be up to 20 characters. • IP Address – This is the IP address of the device that the ISONAS TCP/IP Interface will connect to. This device will have an IP Address assigned to it. The IP Address must be in the standard form of nnn.nnn.nnn.nnn where “nnn” is a value of 0-255. • Port – This is the IP Port that the device is “listening” on for a connection. The ISONAS TCP/IP interface will connect to this Port on the specified IP Address (defined above). The Port can have a range of 1 to 65535. • Disable – This allows the connection to be defined but ignored by the ISONAS TCP/IP interface. If this is checked, the connection will be disabled. • Disconnect After Send – This will cause a disconnect to occur after each event notification message sent through the interface or after a complete response to a requested command has been sent to the external system. If this is checked, the connection will be disconnected and immediately re-established. • AES Encryption(256) – This specified that the data through this connection will be encrypted using the standard 256 bit AES encryption method. If this is checked, AES encryption will occur. • AES Key – This field is valid if AES encryption is being used. A “private key” is defined by specifying 32 pairs of two hexadecimal numbers (0 – 9 and A – F) eg. 000102030405060708090A0B0C0D0E0F101112131415161718191A1B1C1D1E 1F ISONAS Security Systems 303-567-6516 www.ISONAS.com 15 4720 Walnut St, Suite 200 Boulder, CO. 80301 USA The “Save” button will add the new connection to the list of connections and enable all of the display and browsing features of the “Server Connections” screen. The “Cancel” button will discard the information in the “Server Connection Detail” entry fields and enable all of the display and browsing features of the “Server Connections” screen. Editing Existing Connection Definitions An existing connection definition can be edited/changed by selecting(highlighting) it within the list of defined connections. The “Edit” button can be clicked to disable all other features within the “Server Connections” screen and place it in “edit” mode. Any of the entry fields can be changed to any appropriate value. The “Save” button will update the connection and enable all of the display and browsing features of the “Server Connections” screen. The “Cancel” button will discard the information in the “Server Connection Detail” entry fields and enable all of the display and browsing features of the “Server Connections” screen. ISONAS Security Systems 303-567-6516 www.ISONAS.com 16 4720 Walnut St, Suite 200 Boulder, CO. 80301 USA Deleting an Existing Connection A defined connection can be deleted by selecting(highlighting) it within the list of connections. The “Delete” button can be clicked. The confirmation above will be displayed to allow a final acknowledgement of the delete action before the actual deletion of the connection definition. EVENT Notification Once connected, clients will receive notification of events that occur within the Isonas Access Control system. Messages will be in the following format: [ additional data depending on the event as listed below] | The following event types are reported: | | | 1 | | | | | | 2 | | | | 1 The TAMPER, REX and AUX events are alarm conditions. If REX and AUX are not set to be alarm conditions, they are reported simply as either ADMIT or REJECT events. 2 The BadgeId for LOCKDOWN, UNLOCKED, NORMAL RESET and CLEAR ALARM will be “none” unless the event was triggered by a badge presentation. ISONAS Security Systems 4720 Walnut St, Suite 200 303-567-6516 www.ISONAS.com Boulder, CO. 80301 USA 17 | | | | | | | | | | | | | | | | | | | | | | | | Note: The events are reported in the sequence they are received. There are several circumstances where these will NOT be in chronological order. 1) Controller Supervisors are running on computers with different time settings (i.e., in different timezones). 2) A controller has been offline (in standalone mode) and is brought back online. The events are reported when the controller comes back online but occurred at an earlier time. Summary of Command Functional Capabilities The commands are shown in the following table. The ADD,UPDATE and DELETE commands will add or delete data from specified tables. The APPLY command will cause the Isonas system to put the changed database into effect. Command ! or REMARK ADD/DELETE ADD/DELETE ADD/DELETE ISONAS Security Systems 303-567-6516 Data ignored Supervisor name Connection (IP address) Door www.ISONAS.com 18 Table SERVERS SUBNETS DOORS 4720 Walnut St, Suite 200 Boulder, CO. 80301 USA ADD/DELETE ADDDOOR/DELETEDOOR ADD/DELETE ADD/DELETE ADD/UPDATE/DELETE ADD/DELETE ADD/UPDATE/DELETE ADD/DELETE ADD/DELETE ADMIT APPLY CLEAR ALARMS DELETE DELETE DELETE LOCKDOWN PRESENTBADGE QUEUE EMAIL QUEUE SCRIPT QUERY SETHOSTOVERRIDE RESETNORMAL SETLOCAL SET IOMODULE SETLOGGING SET TTL UNLOCK UPDATE IDFILEIMAGES ISONAS Security Systems 303-567-6516 DoorGroupName DoorGroup, DoorName Group Name Holiday Person Person Badge Shift name Group/Shift/Door Door name Full or Incremental Alarms All permissions for a GROUP All permissions for a SHIFT All permissions for a DOOR Door Name Door Name Script Name ALL DOORS DOOR doorname ALL DOORGROUPS DOORGROUP ALL GROUPNAMES GROUP groupname ALL GROUPS ALL SHIFTS SHIFT shiftname ALL HOLIDAYS ALL IDFILE IDFILE uniqueId IDFILE IMAGES ALL BADGES BADGE badgeid BADGE uniqueid PERMISSIONS HISTORY ALL IOMODULES IOMODULE STATUS Door Name Door Name Door Name IOMODULE Door Name Door Name Person, Image Files www.ISONAS.com 19 DOORGROUP DOORGROUP GROUPNAME HOLIDAYS IDFILE GROUPS BADGES SHIFTS PERMISSION (none) PERMISSION ALARMS PERMISSION PERMISSION PERMISSION (none) (none) (none) SCRIPTS DOORS DOORS DOORGROUPS DOORS GROUPNAMES GROUPS GROUPS SHIFTS SHIFTS HOLIDAYS IDFILE IDFILE BADGES BADGES BADGES RIGHTS HISTORY IOMODULES IOMODULES (none) (none) (none) (none) IOMODULES (none) DOORS (none) PICDB 4720 Walnut St, Suite 200 Boulder, CO. 80301 USA Format/Syntax The commands sent to the INRServ server are Ascii strings consisting of angle bracket (<>) enclosed tokens. The first token is the Command. There are additional required and optional tokens following based on the specific command. All fields are case sensitive. Fields shown just with < .. > are required. | in the field definition indicates a choice. Fields shown in [ … ] are optional, but the syntax is position dependant. Therefore, you may leave off all trailing optional fields but must provide all fields up to the last one with valid data in it. Leading or trailing blanks in any field are ignored. Uppercase values are keywords which must be entered exactly as shown. Lower case values are variable data. Commands sent to the INRServ process must be terminated by a vertical bar character “|”. You may send multiple commands in a single tcp/ip message, up to a maximum total of 4096 characters. One “odd” behavior that you may encounter is associated with some of the QUERY commands. Most of the QUERY commands simply retrieve information from the database but several of them send requests to other processes (CSUP or IOSUP) and wait for responses before sending a response back to the TCP/IP interface client. If multiple commands are entered with the same TCP/IP message you may see the responses in a different order than the commands. Every command sent to the interface will produce a response message of some sort. The possibilities include: • An error message • The requested data (for a QUERY) • An | message for commands that have been executed. All messages received from the INRServ will start with and will also be terminated by the vertical bar. If the command is rejected or causes an error, a response indicating the type of error will be sent back by the interface. The responses to the QUERY command are documented under the QUERY command below. Command parameter validation restrictions Parameter Name allareaflag appliestoflag area authoritylevel badgenumber badgepinflag clientId countlimitedflag credentialguid datestring debugmode ISONAS Security Systems 303-567-6516 Length Min/Max Numeric 1/1 1/1 1/20 1/1 1/10 1/1 1/20 1/1 38 1/10 1/1 Y Y Special Y Y Y Y Y Y www.ISONAS.com 20 Note 5 Note 2 4720 Walnut St, Suite 200 Boulder, CO. 80301 USA doordescription doordirection doorgroup doormodel doorname doorsubaddress dualauthentication email address endtime expirationflag firstname grouparea groupname groupname holidayflag holidayname idstring incrementalfullnetworkflag ioindex lastname middleinitial modeflag modulename password permissiongroupname port register remaininguses reset32 script name selectionmask shiftname ssn starttime subnet supervisorId supervisorname time ttln user1 - user20 ISONAS Security Systems 303-567-6516 1/30 1/1 1/20 1/20 1/20 1/3 1/1 3/255 1/7 1/1 1/10 1/20 1/20 1/20 1/1 1/20 1/15 1/1 ½ 1/20 1/1 1/1 1/20 1/22 1/20 1/5 1/32 1/6 1/32 1/20 1/32 1/20 1/9 1/7 4/15 2/2 1/20 1/7-8 1 1/25 Y Y Y Note 4 Y Y Y Y Y Y Y Y Y Y Y Y Note 1 Y Y Note 3 1 or 2 www.ISONAS.com 21 4720 Walnut St, Suite 200 Boulder, CO. 80301 USA validflag 1/1 Y Note 1 - where comport is “COM” followed by, up to 3 digits (max numeric value of 254) or for an IP address with 4 octets separated by a period (“.”), each octet up to 3 digits (max value of 254). Note 2 - where the date is in the format of mm/dd/yyyy and month is 1-12, day is 1-31 depending on month and leap year. Note 3 - if value is numeric then range check is done otherwise Time is assumed to be entered in the “hh:mm:ss” format where hh is 0-23, mm is 0-59 and ss is 0-59. Note 4 – must be a valid email address format Note 5 – must be in the standard GUID format: {00000000-0000-0000-0000-000000000000} COMMENTS Description: This command is ignored by the INRServ TCP/IP interface processor and Script interface processor, but is useful when developing script files. It provides the script author a method of commenting the script contents for maintainability. Syntax: or comments to annotate scripts. The rest of the data is ignored. SUPERVISOR Description: These commands allow for the maintenance of controller supervisors (CSUP) with the Access Control System. Syntax: | | supervisor id supervisor name port ISONAS Security Systems 303-567-6516 2 alphanumeric characters – the two character combination must be unique within the definition of all of the CSUPs currently defined up to 20 characters – a unique name that references a particular supervisor definition/process A unique TCP/IP port assigned to the Communications Supervisor (1 – 65535) www.ISONAS.com 22 4720 Walnut St, Suite 200 Boulder, CO. 80301 USA Response: | [error detail]| ISONAS Security Systems 303-567-6516 www.ISONAS.com 23 4720 Walnut St, Suite 200 Boulder, CO. 80301 USA CONNECTION Description: This command allows for the maintenance of IP or comm. port connections to readers/doors from the specified controller supervisor. Syntax: | | supervisor id The id of a previously defined supervisor subnet a comm port or an IP address (e.g., COM3 or 192.168.0.143) (COMxx where xx is a comm. port range of 1-99) Response: | [error detail]| DOORS Description: These commands are used to define the reader controller. Syntax: [] [][][][] [][][][][][][] [][][][][] [][][][] [][][][][] [][][][][] [][][][] [][][][][] [][]| | supervisorid subnet doorname doorsubaddress doormodel area doordescription ISONAS Security Systems 303-567-6516 The id of a previously defined supervisor a comm port or an IP address (e.g., COM3 or 192.168.0.143) (COMxx where xx is a comm. port range of 1-99) a Unique Door name to reference the door subaddress (always = 1 for IP and Wireless IP units)(1-254) PRC-001B , PRC-001 , dPRC-001 , KTP-Keypad , RC-01 , RC-02 Defaults to COMMON if not given Free-form description of the door www.ISONAS.com 24 4720 Walnut St, Suite 200 Boulder, CO. 80301 USA doordirection authoritylevel dualauthentication port iogroup networktimeout clearalarm latchinterval doormode admitmode rejectmode rexinput auxinput unauthopenalarm unauthopendelay extendedopenalarm extendeopentimeout tamperalarm tampercount locallatchinterval localrexttl2 localunauthopenttl2 localtamperttl1 localbeep localbeepaccept localauxinput localaddcard localvoidcard localvoidallcard locallockdown localunlockcard localnormalcard serialmode serialpassthrudevice ISONAS Security Systems 303-567-6516 0 unspecified | 1 in | 2 out | 3 in/out (see Isonas Ref Manual) 0 | 1 | 2 | 3 (authority level to control door from the Monitor program) 0 | 1 | 2 | 3 ( dual authentication: 0=Off, 1=Any Two, 2=Same Person, 3=Different Person) 1-65535, Default 10001 Default blank 0-255 secs, Default=20 if DoorMode is Host, 0 if DoorMode is Local 0-1 0=Do not Clear, 1=Clear, default= 0 0-255 secs, default = 3 0=Host, 1=Local, 2=Standalone, 3=Disable. Default is 0. Host or Standalone will default Network Timeout to 20 if not explicitly specified. Local will default Network Timeout to 0 (will override specified value). Valid values BEEP, TTL1, TTL2, WOUNLATCH. Default is blank. (Multiple entries separated by “,”) Valid values BEEP, TTL1, TTL2. Default is blank. Valid values REXUNLATCH, REXWOUNLATCH, REXALARM, or REXLOCKDOWN. Default is disabled (no entry). Valid values AUXUNLATCH, AUXWOUNLATCH, AUXALARM, or AUXLOCKDOWN. Default is disabled (no entry). Valid values BEEP, TTL1, TTL2 or DISABLE. Default Enabled 0-65535 secs. Default = 0 Valid values BEEP, TTL1, TTL2 or DISABLE. Default Enabled 0-65535 secs. Default = 0 Valid values BEEP, TTL1, TTL2 or DISABLE. Default Enabled 0-255. Default = 0 0-255 secs. Default = 3 Values 0-1. Where 0=Disabled, 1=Enabled. Default is Disabled. Values 0-1. Where 0=Disabled, 1=Enabled. Default is Disabled. Values 0-1. Where 0=Disabled, 1=Enabled. Default is Disabled. Valid values REX, TAMPER or REJECT. (Multiple entries separated by “,”). Default is REJECT. Valid values SHORT or LONG. SHORT is for a short beep and LONG is for a long beep. Default is no beeping on Accept Valid values AUTHACCESS, TTL1 or TTL2. Default is disabled. 0-4294967295. Default is 0 (zero) 0-4294967295. Default is 0 (zero) 0-4294967295. Default is 0 (zero) 0-4294967295. Default is 0 (zero) 0-4294967295. Default is 0 (zero) 0-4294967295. Default is 0 (zero) Valid values LOCAL, KEYPADSILENT, KEYPADBEEP, BITMASK, DATAMANGLE, or PASSTHROUGH. Default is Disabled. Valid values ASCII, ASCIIHEX or BINARY. Default is blank. www.ISONAS.com 25 4720 Walnut St, Suite 200 Boulder, CO. 80301 USA seriallength serialtimeout serialstart1 serialstart2 serialend1 serialend2 Values 0, 1-64, or 255. Values 0 and 255 represent a variable length serial value. Value 1-64 represent a fixed length of that value. Default is 0 (zero). 0-255 (represents a timeframe of 1/16 of a second). Values of 0 and 255 represents no timeout (disabled). Default is 0 (zero). 0-255. Default is 255. 0-255. This value will be overridden with 255 if “serialstart1” is set to 255. A value of 255 represents a non-entry value. Default is 255. 0-255. Default is 255. 0-255. This value will be overridden with 255 if “serialstart1” is set to 255. A value of 255 represents a non-entry value. Default is 255. Response: | [error detail]| DOORGROUP Description: These commands are used to define the DoorGroup. Syntax: [] | | doorgroupname area a unique name of a doorgroup a name of an area Response: | [error detail]| DOORGROUPMEMBER Description: These commands manage the names doors that are assigned to doorgroups. Syntax: | | doorgroupname a unique name of a doorgroup doorname a unique name of an door ISONAS Security Systems 303-567-6516 www.ISONAS.com 26 4720 Walnut St, Suite 200 Boulder, CO. 80301 USA Response: | [error detail]| GROUPNAME Description: These commands manage the definition of names of groups that people are assigned to. Syntax: []| []| groupname a unique name of a group that people will be assigned to area Defaults to COMMON if not given. Response: | [error detail]| HOLIDAYS Description: Defines a particular day of the year to be a holiday. Syntax: [][]| | holidayname a unique name of a holiday holidaydate the date of the holiday in the format of mm/dd/yyyy area Defaults to COMMON if not given allareaflag 0 | 1 does not | does apply to all areas. Defaults to 0 Response: | [error detail]| ISONAS Security Systems 303-567-6516 www.ISONAS.com 27 4720 Walnut St, Suite 200 Boulder, CO. 80301 USA IDFILE Description: These commands manage the definition of people within the application Syntax: [][

Script And Tcp/ip Interface Specification For The Isonas Access

Rating

Date

Size

Views

Categories

Share

Transcript

Forgot your password?.