Pelco C1553M-B - page 193

C1553M-B (4/05) 193

Load

LOAD <map tag>[.<named view>] Load the speciﬁed map or named view into the map viewport.

On Error

ON ERROR GOTO <label identiﬁer> If an error occurs, continue running the script at the speciﬁed

label.

ON ERROR GOTO 0 If an error occurs, continue running the script at the beginning of

the script.

ON ERROR RESUME NEXT If an error occurs, continue running the script at the next line.

Pause

PAUSE <duration> Pause the script for the speciﬁed number of seconds. The dura-

tion can be a decimal amount e.g. 3.5.

Prompt

PROMPT <prompt tag> Display the speciﬁed prompt in the client window.

Run

RUN <global script tag> Run the speciﬁed global script in a new thread.

Set

SET <client tag>.Workspace=“<path name>“ Set the client workspace to the workspace ﬁle speciﬁed in the

path name, e.g. SET Client1.Workspace =

“c:\Workspaces\Operator_Workspace.wsp“.

SET <device tag name>.<write property>=

<device tag name>.<state> (FOR <duration>)

Set the write property for the device to the speciﬁed state for the

speciﬁed number of seconds.

SET <global tag>.<property name> = <value> Set the global tag property to the speciﬁed value.

Refer to Properties of Objects for valid properties and values.

SET <hotlink tag>.<property name>=<value> Set the hotlink property to the speciﬁed value.

Refer to Properties of Objects for valid properties and values.

SET <label tag>.<property name>=<value> Set the label property to the speciﬁed value.

Refer to Properties of Objects for valid properties and values.

SET <variable identiﬁer>.<property

name>=<value>

Set the local variable property to the speciﬁed value.

Refer to Properties of Objects for valid properties and values.

SET RecipientObject=<window tag> Set the recipient object to the speciﬁed custom window.

SET RecipientObject=<device tag name> Set the recipient object to the speciﬁed video input device.

SET RecipientObject.<property name>=<value> Set the recipient object to the speciﬁed value.

Refer to Properties of Objects for valid properties and values.

SET <window tag>.<property name> = <value> Set the custom window property to the speciﬁed value.

Refer to Properties of Objects for valid properties and values.

VAR

VAR <variable identiﬁer> Declare a local Boolean variable. The same as DIM.

TIP: Use RecipientObject to implement sequences. For example, if you have a custom window called ‘window1’ and analog video from

cameras ‘camera1’, ‘camera2’, etc., implement a sequence as follows:

SET RecipientObject = window1

SET RecipientObject.LiveSource = camera1.analogvideo

PAUSE 5

SET RecipientObject.LiveSource = camera2.analogvideo

PAUSE 5

...

Table AN. Script Commands (Continued)

Optional arguments are in parentheses. Refer to Properties of Objects for valid properties and values of different types of objects.

COMMAND ACTION

Contents

Main Page Contents Page Page Page Page Page Page Page List of Illustrations Page Page Page Page List of Tables Introduction Conguring a New System SET UP THE MINIMAL CONFIGURATION TEST THE MINIMAL CONFIGURATION Using the Session Manager to Evaluate CPU Workload Using the Windows Task Manager to Evaluate CPU Workload Log On and Congure Operating System Settings CONFIGURE OPERATING SYSTEM SETTINGS ASSIGN AN IP ADDRESS TO THE VMX300(-E) WORKSTATION Page IDENTIFY THE VMX300(-E) WORKSTATION ON THE NETWORK DISABLE NETBIOS Disable NetBIOS in the Advanced TCP/IP Settings Dialog Box Disable the NetBIOS Helper Service Starting and Stopping the Server LAUNCH THE SERVER CONFIGURE THE SERVER WHILE IT IS RUNNING LOG OUT OF CONFIGURATION MODE AND LAUNCH RUN MODE SHUT DOWN THE SERVER SHUTTING DOWN WHILE IN RUN MODE SHUTTING DOWN WHILE IN CONFIGURATION MODE ONLY License Manager ADD A LICENSE DELETE A LICENSE Starting and Stopping Device Drivers START A DEVICE DRIVER SHUT DOWN A DEVICE DRIVER Clients, Custom Windows, and Canvases CLIENTS WORKSPACES ADD A NEW CLIENT EDIT A CLIENTS PROPERTIES DELETE A CLIENT CUSTOM WINDOWS HOW MANY CUSTOM WINDOWS TO CONFIGURE ADD A NEW CUSTOM WINDOW EDIT A CUSTOM WINDOW DELETE A CUSTOM WINDOW CANVASES ADD A NEW CANVAS (GENERAL) Page ADD A NEW CANVAS (PELCONET) Page ADD A NEW CANVAS (DX8000 OR DX9000 DVR) EDIT A CANVAS RE-ORDER A WINDOWS CANVASES DELETE A CANVAS Device Drivers ADD A NEW DEVICE DRIVER AUTODISCOVER DEVICE DRIVERS EDIT A DEVICE DRIVERS PROPERTIES DELETE A DEVICE DRIVER CONFIGURE A PELCONET MPEG TIME SERVER Congure Time Servers Remove a Time Server Devices ADD A NEW DEVICE AUTODISCOVER DEVICES DELETE A DEVICE ADD A FIXED CAMERA DEVICE ADD A PELCO PTZ DEVICE Page Page Page CONFIGURE THE CAMERA MODEL TAB ADD A PELCONET MPEG DEVICE Icon Animation Recording Miscellaneous CONFIGURE THE ENCODING TAB Number of Simultaneous Streams Multicast Encoder Parameters Selecting Lower Frame Rate Settings Restoring Factory Default Settings HOW TO CHOOSE THE VIDEO STREAM SETTINGS FOR YOUR CONFIGURATION CONFIGURE THE ENCODING/DECODING TAB (PELCONET 4001A ONLY) Number of Simultaneous Streams Multicast Decoding Encoder Parameters Selecting Lower Frame Rate Settings Restoring Factory Default Settings Unit Address Security CONFIGURE THE NVR300 RECORDING TAB Page ADD AN EXTERNAL MONITOR DEVICE ADD A DX8000 DVR PREPARING TO CONFIGURE THE DX8000 DVR Add Accounts to the Power User Group for Client Workstations Add an Account to the Power User Group for the Device Driver ADD A DX8000 DVR TO THE SERVER CONFIGURATION Page Page ADD A DX8000 CAMERA Page ADD A DX9000 DVR PREPARING TO CONFIGURE THE DX9000 DVR Adding Users to the Avusers Group Page Page Page Conguring Computers and Users Page What if Adding the DVR Failed? ADD A DX9000 DVR TO THE SERVER CONFIGURATION CONFIGURE THE ALARMS AND EVENTS TAB DVR TROUBLESHOOTING: IF YOU CHANGE THE VMX300(-E) OPERATING SYSTEM PASSWORD ADD A PELCO ASCII SWITCHER Page Page Page CONFIGURE THE I/O TAB ADD AN ASCII CAMERA Page ADD A KBD300A KEYBOARD ADD USER ACCOUNTS ADD A KBD300A KEYBOARD TO THE SERVER CONFIGURATION Page Page USING THE KBD300A LOGICAL MAPPING FEATURE ENABLE CAMERA AND MONITOR DEVICE NUMBERS CONFIGURE THE LOGICAL MAPPING TAB View Logical Mapping Settings Export Logical Mapping Settings Import Logical Mapping Settings Mapping Shortcut ADD A CM9760-ALM ALARM INTERFACE UNIT Page Page Page CONFIGURE THE ALM POINTS TAB Rename an Alarm Point ADD A CM9760-REL RELAY INTERFACE UNIT Page Page Page CONFIGURE THE RELAY POINTS TAB Rename a Relay Point Page ADD A SERIAL OUTPUT DEVICE Page Page CONFIGURE THE CUSTOM BUTTONS TAB Add a Custom Button Edit a Custom Button ASCII COMMAND SPECIAL CHARACTERS Delete a Custom Button LIMITATIONS OF CONTROLLING A SERIAL OUTPUT DEVICE ADD AN IP DEVICE STATUS MONITOR CONFIGURE THE ICON ANIMATION TAB ADD AN ACCESS CONTROL DEVICE HOW THE ACCESS CONTROL DRIVER WORKS Logic Used for the Access Control Driver ADD AN ACCESS CONTROL DEVICE TO THE SERVER CONFIGURATION Page Page CONFIGURE ACCESS CONTROL POINTS How VMX300(-E) Uses Access Control Points Add Access Control Points Page Edit an Access Control Point Delete an Access Control Point CONFIGURE PATTERN MATCHING FOR INCOMING ALARM STRINGS Select a Predened Pattern as the Pattern to Match Create a Custom Pattern as the Pattern to Match Select a Predened Pattern as the Reset Pattern to Match Create a Custom Pattern as the Reset Pattern to Match Pattern Syntax Syntax in Predened Patterns Delete a Pattern From the Predened Pattern List DEFINE ALARMS BASED ON ACCESS CONTROL POINTS Alarm Expression Resetting Alarms How to Dene Alarms Based on Access Control Points: Example Page Connections MANAGING CONNECTIONS Page PELCONET CONNECTIONS NETWORK Page DVR CONNECTIONS ASCII CONNECTIONS Archive Servers START AN ARCHIVE SERVER VIEW ARCHIVE SERVER STATUS SHUT DOWN AN ARCHIVE SERVER Project Properties NETWORK TAB CONFIGURE A PRIMARY SERVER CONFIGURE A BACKUP SERVER Page SWITCHING TAB ARCHIVING TAB DATE/TIME TAB E-MAIL TAB Page User Groups GROUP PERMISSIONS Page PTZ PERMISSIONS PELCONET DEVICE PERMISSIONS EXTERNAL MONITOR PERMISSION DX8000 PERMISSIONS DX8000 Recorder Permissions DX8000 Camera Permissions DX9000 PERMISSION ASCII DEVICE PERMISSIONS ASCII Switcher Permissions ASCII Camera Permissions KBD300A PERMISSION CM9760-ALM PERMISSIONS CM9760-REL PERMISSIONS SERIAL OUTPUT PERMISSIONS IP DEVICE STATUS MONITOR PERMISSIONS ACCESS CONTROL DEVICE PERMISSIONS THE PREDEFINED USER GROUP ADD A NEW USER GROUP EDIT A USER GROUP DELETE A USER GROUP Users PREDEFINED USER ACCOUNTS THE PREDEFINED ADMINISTRATOR ACCOUNT THE PREDEFINED OPERATOR ACCOUNT ADD A NEW USER Page EDIT A USER DELETE A USER Maps USE PRINT SCREEN TO CREATE A MAP FILE ADD A NEW MAP EDIT A MAPS PROPERTIES LOAD A MAP CUSTOMIZE YOUR MAPS DELETE A MAP Device Settings EDIT A DEVICES PROPERTIES EDIT A DEVICES LOCAL SETTINGS Page VIEW A DEVICES READ AND WRITE PROPERTIES Device Icons PLACE A DEVICE ICON ON A MAP MOVE A DEVICE ICON SCALE AND ROTATE A DEVICE ICON REMOVE A DEVICE ICON FROM A MAP MOVE A DEVICE LABEL SCALE A DEVICE LABEL EDIT A DEVICE LABEL REMOVE A DEVICE LABEL Named Views ADD A NEW NAMED VIEW EDIT A NAMED VIEW Page Hotlinks ADD A NEW HOTLINK Page EDIT A HOTLINKS PROPERTIES MODIFY A HOTLINKS SHAPE AND SIZE MOVE A VERTEX ADD A VERTEX DELETE A VERTEX DELETE A HOTLINK Labels ADD A NEW LABEL PLACE A LABEL ON A MAP EDIT A LABEL MOVE A LABEL SCALE A LABEL REMOVE A LABEL FROM A MAP DELETE A LABEL Scripts and Expressions VARIABLES AND VALUES PROPERTIES OF OBJECTS FIXED CAMERA PROPERTIES EXPOSED FOR SCRIPTS AND EXPRESSIONS PTZ CAMERA PROPERTIES EXPOSED FOR SCRIPTS AND EXPRESSIONS PELCONET DEVICE PROPERTIES EXPOSED FOR SCRIPTS AND EXPRESSIONS EXTERNAL MONITOR PROPERTIES EXPOSED FOR SCRIPTS AND EXPRESSIONS DX9000 READ PROPERTY EXPOSED FOR SCRIPTS AND EXPRESSIONS DX8000 PROPERTIES EXPOSED FOR SCRIPTS AND EXPRESSIONS Page ASCII DEVICE PROPERTIES EXPOSED FOR SCRIPTS AND EXPRESSIONS KBD300A PROPERTIES EXPOSED FOR SCRIPTS AND EXPRESSIONS CM9760-ALM PROPERTIES EXPOSED FOR SCRIPTS AND EXPRESSIONS Sample VMX300(-E) Alarm Expression Dening Normally Open and Normally Closed Alarm Inputs CM9760-REL PROPERTIES EXPOSED FOR SCRIPTS AND EXPRESSIONS Changing the State of a Relay Point Dening Normally Open and Normally Closed Relay Outputs SERIAL OUTPUT DEVICE PROPERTY EXPOSED FOR SCRIPTS AND EXPRESSIONS IP DEVICE STATUS MONITOR PROPERTY EXPOSED FOR SCRIPTS AND EXPRESSIONS ACCESS CONTROL DEVICE PROPERTIES EXPOSED FOR SCRIPTS AND EXPRESSIONS CURRENT STATUS: VIEW RUN-TIME VALUES OF VARIABLES EXPRESSIONS STATEMENTS Page MECHANICS OF EDITING SCRIPTS AND EXPRESSIONS KEYSTROKE EDITING CONTEXT-SENSITIVE HELP FOR SCRIPTS CONTEXT-SENSITIVE HELP FOR EXPRESSIONS Page THE EXPRESSION WIZARD THE SCRIPT WIZARD SYNTAX ERROR-CHECKING EXAMPLE SCRIPTS Page Global Scripts ADD A NEW GLOBAL SCRIPT EDIT A GLOBAL SCRIPT DELETE A GLOBAL SCRIPT Global Tags ADD A NEW GLOBAL TAG EDIT A GLOBAL TAG Page Prompts ADD A NEW PROMPT Page EDIT A PROMPT Page Timers ADD A NEW TIMER EDIT A TIMER DELETE A TIMER Schedules ADD A NEW SCHEDULE Page Page Page EDIT A SCHEDULE DELETE A SCHEDULE Alarms and Events HOW ALARMS AND EVENTS WORK WHEN AN ALARM OR EVENT IS TRIGGERED OPERATOR REPLAYS ACKNOWLEDGEMENT ACCESS ALARMS AND EVENTS DEFINED ON ANOTHER SERVER ALARM/EVENT CATEGORIES ADD A NEW ALARM/EVENT CATEGORY Page EDIT AN ALARM/EVENT CATEGORY DELETE AN ALARM/EVENT CATEGORY ALARMS, EVENTS, AND NORMAL OCCURRENCES ADD A NEW ALARM OR EVENT Page Page Page Page EDIT AN ALARM OR EVENT DELETE AN ALARM OR EVENT ALARM/EVENT ICONS PLACE AN ALARM/EVENT ICON ON A MAP MOVE AN ALARM/EVENT ICON SCALE AN ALARM/EVENT ICON REMOVE AN ALARM/EVENT ICON FROM A MAP MOVE AN ALARM/EVENT LABEL SCALE AN ALARM/EVENT LABEL EDIT AN ALARM/EVENT LABEL REMOVE AN ALARM/EVENT LABEL Recipient Groups THE PREDEFINED RECIPIENT GROUP ADD A NEW RECIPIENT GROUP EDIT A RECIPIENT GROUP DELETE A RECIPIENT GROUP Server Ties Page PREVENT OTHER SERVERS FROM MONOPOLIZING YOUR TIES CONFIGURE A SERVER TIE Page Page TEST A SERVER TIE ADD A NEW SERVER TIE Page FTP Sites ADD A NEW FTP SITE Page EDIT AN FTP SITE WRITE AN FTP SCRIPT THE FTP COMMAND FTP SCRIPTS DELETE AN FTP SITE Database Utilities BACKUP A DATABASE RESTORE A DATABASE System Logs VIEW SYSTEM LOGS Appendix ADJUSTING THE DISPLAY ADJUST THE OBJECT BROWSER DISPLAY Undock the Object Browser Dock the Object Browser to the Left POP-UP MENUS USE COPY AND PASTE TO CREATE A NEW OBJECT USE COPY AND PASTE MANY TO CREATE MULTIPLE NEW OBJECTS Page PRODUCT WARRANTY AND RETURN INFORMATION REVISION HISTORY