Creating macros

To create a macro, do the following:

Create the Macro object.
1. Select the Macros object in the objects tree on the Programming tab (1).
2. Specify the name of the Macro object (2).
3. Click the Apply button (3).
  
  After the Macro object is created, its settings panel opens.
Specify the values of the parameters. The description of the parameters is given in the table below.
Note
To add a row to the Events or Actions table, select a cell in the bottom row of the table and press the "down" arrow on your keyboard.
To delete a row, select a cell in the row and press the Ctrl+Del buttons on the keyboard.

№	Parameter name	Method of setting the parameter value	Parameter description	Representation	Default value	Value range
The Settings group
1	State	Select the value from the drop-down list or enter the value from the keyboard	A message is displayed by the system in the data display when the macro is executed. If the Standard value is selected, no message is displayed	-	Blank field	A list of available messages and Standard
2	Local	Set the checkbox	If the checkbox is set, the macro cannot run on any other network computer except the local computer. Note. This checkbox does not apply to Hide and Show reactions of any Display. When you call these reactions from the Server/Remote Administrator’s workstation, they will run on the Server/Remote Administrator’s workstation and on all Clients connected to it. When you call these reactions from the Client, the reactions will run on the Client only, regardless of whether the checkbox is set or clear	-	Clear	Set—local only Clear—any computer
3	Hidden	Set the checkbox	Set the checkbox for those macros that are not intended to be run manually	-	Clear	Set—run Clear—don’t run
The Events table
4	Type	Select the value from the drop-down list	Specifies the object. When an event is received from this object, a macro is run	-	Blank field	All active objects that correspond to hardware and modules
5	Number	Select the value from the drop-down list	Specifies the number of the object. When an event is received from this object, a macro is run	-	Blank field	Sequence numbers of all active objects that correspond to hardware and modules. If you select the Computer object in the Type column, select its name instead of the number
6	Name	Content of the field is generated by right-clicking the field	Information field	-	Blank field	The field id formed automatically depending on the values that you select in the Type and Number columns
7	Event	Select the value from the drop-down list	Sets the type of event	-	Blank field	The list of registered event types
The Parameters table (it is set if you want to specify event parameters from the Events table)
8	Name	Automatically	Displays the name of event parameter	Latin alphabet, numerals and service characters	Blank field	Depends on the event selected in the Events table
9	Value	Enter text in the field	Set the value of event parameter	Latin alphabet, numerals and service characters	Blank field	A line containing a sequence of any characters. The number of characters is from 1 to 250
The Actions table
10	Type	Select the value from the drop-down list	Specifies the object for which a macro is run when a registered event is received	-	Blank field	All active objects that correspond to hardware and modules
11	Number	Select the value from the drop-down list	Specifies the number of the object for which a macro is run when a registered event is received	-	Blank field	Sequence numbers of all active objects that correspond to hardware and modules. If you select the Computer object in the Type column, select its name instead of the number. If you leave the field blank, the reaction is performed for all objects of the selected type. The type of objects in the Events and Actions tables may not coincide. When you run a macro manually from the main control panel, the # symbol is equivalent to an empty field, If you enter the # symbol in the field, the identifier of the object from which the event was received will be substituted in the response. Example of using the # symbol: disarm the camera, if the "Detach" event is received from it
12	Name	Automatically	Displays name of the selected object	Name of the objects registered in the system of the specified type	Blank field	A line containing a sequence of any characters. The number of characters is from 1 to 60
13	Action	Select the value from the drop-down list	Specifies the action that is performed for the object selected in the Type column when a registered event is received	-	Blank field	List of actions that can be performed for the object selected in the Type column
The Parameters table (it is set if a parameter must be specified to perform the action selected in the Actions table)
14	Name	Automatically	Displays the name of the action parameter	Latin alphabet, numerals and service characters	Blank field	Depends on the action selected in the Actions table
15	Value	Enter text in the field	Specifies the value of the action parameter	Latin alphabet, numerals and service characters	Blank field	A line containing a sequence of any characters. The number of characters is from 1 to 255
Outside the groups
16	Response sending delay (s)	Enter the value into the field	Specifies the time period in seconds that must pass after the events specified in the Events column occur and before running the reactions specified in the Actions column. *Note.* If the events reoccur before the specified time period expires, the reaction execution wait period is prolonged, i.e. reactions will be executed only once when events do not reoccur over the specified period	Natural number series	-	>0
17	Fast call	Left-click in the field and press the required key combination	Specifies a keyboard shortcut to quickly call a macro. If you specify the same keyboard shortcuts for several macros, all macros will run if you press the key combination. Note. You can disable the processing of the specified keyboard shortcuts for macros using the UseHotKeys key—see Registry keys reference guide	Key combinations	None	Individual keys on the main or numeric keyboard, and these keys in combination with Shift, Ctrl, Alt
18	Icon type	Select the value from the drop-down list	Specifies a set of icons for displaying a macro on the map. By default, an empty value is set for all macros which corresponds to the Macro 1 icon. Note. Changing the icon appearance will take effect after you reastart the map interface. To restart the interface, restart Axxon PSIM or log in once again under the corresponding Operator account	Available icon types on the map	-	Macro 1–Macro 7, empty value

Attention!

Only WAV files can be used as the Play sound file action parameter. Otherwise, the Play sound file action isn't run. Note that compressed audio in WAV format can playback incorrectly, so we recommend playing back only PCM WAV files. The maximum values of frequency and sampling depth of files for playback are determined by the DAC specifications of the installed sound card.

Note

If required action, event or parameter is absent in the corresponding table, add it to the ddi-file with the ddi.exe utility (see Editing the external setting file (Axxon PSIM.ddi) using the ddi.exe utility).

3. Click the Apply button to save the settings.

Page tree

Documentation for Axxon PSIM 1.0.0-1.0.1.