Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

To create a macro, do the following:

  1. Create the Macro object.
    1. Choose Select the Macros object in the objects tree of the on the Programming tab (1).
    2. Specify the name of the Macro object (2).
    3. Press Click the Apply button (3).
      Image RemovedImage Added
      After the Macro object is created, its settings panel opens.
      Image RemovedImage Added
  2. Specify the parameter values . Table below gives the of the parameters. The description of the parameters is given in the table below.
    Image Modified

    Info
    titleNote.

    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.


Name

Field type

Description

Parameter name

Method of setting the parameter value

Parameter description

RepresentationFormat

Default value

Value range

The Settings group

1

State

Select the value from the drop-down list , or type inor enter the value from the keyboard

A message is displayed by the system in the data display when the macro is executed. If the The message to display during macro execution. A Standard value is selected, no message is displayed.

-Empty

Blank field

A list of available messages plus and Standard.

2

LocalCheckbox

Set the checkbox

If the checkbox is checkedset, the macro can be executed on cannot run on any other network computer except the local computer only.

Note. This checkbox does not apply to Hide and Show reactions of any Display. Regardless of the checkbox, wen called from Server/RAW, they are executed on the Server and all connected Clients; when called on Client, they are executed only on the client.

-

No

Checked - local only.

Unchecked – any computer.

3

Hidden

Checkbox

If the checkbox is checked, the macro cannot be executed manually.

-

No

Checked – execute.

Unchecked – don’t execute.

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

Setlocal only

Clearany computer

3

Hidden

Set the checkbox

Set the checkbox for those macros that are not intended to be run manually

-

Clear

Setrun

Cleardon’t run

The Events table

4

Type

DropSelect the value from the drop-down list

Defines Specifies the object to be the source of the event that will trigger this macro.. When an event is received from this object, a macro is run

-Empty

Blank field

All active device and module objectsobjects that correspond to hardware and modules

5

Number

DropSelect the value from the drop-down list

Defines Specifies the number of the object to be the source of the event that will trigger this macro.. When an event is received from this object, a macro is run

-Empty

Blank field

The Sequence numbers of all active device and module objectsobjects that correspond to hardware and modules. If you select the Computer object is selected in the Type column, enter select its name here.instead of the number

6

Name

Enters automatically on Content of the field is generated by right-clickclicking the field

Information typefield

-

Empty

Blank field

The field id formed automatically depending on the values that you select in Enters automatically according to the Type and Number values Number columns

7

Event

DropSelect the value from the drop-down list

Event Sets the type of event

-Empty

Blank field

The list of registered event types

The Parameters table (

is set, when parameter should be set for events, selected in

it is set if you want to specify event parameters from the Events table)

8NameAutomatically

Displays the name of event’s event parameter

Latin alphabet, digits numerals and service characters

EmptyBlank field

Depends on the event , selected in the Events table

9Value

Entering of the Enter text into in the field

Set the value of event’s event parameter

Latin alphabet, digits numerals and service characters

EmptyBlank field

A line containing a sequence of any characters. The number of characters is from 1 to 250.

 The Actions table

10

Type

DropSelect the value from the drop-down list

Defines the object to be the source of the event that will trigger this macro.

-

Empty

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 modulesAll active devices and module objects

11

Number

DropSelect the value from the drop-down list

Defines Specifies the number of the object to be the source of the event that will trigger this macro.for which a macro is run when a registered event is received

-Empty

Blank field

The Sequence numbers of all active devices and module objectsobjects that correspond to hardware and modules. If you select the Computer object is selected in the Type column, enter select its name hereinstead of the number.

If you leave the field is left blank, the reaction will be is performed for all objects of the selected type.
If you enter the symbol # in the field, the identifier of the object from which the event was received will be substituted into the reaction. Object types in The type of objects in the Events and Actions tables may differnot coincide. When the you run a macro is run manually from the main control panel, the # symbol is treated as if the field was blank, i.e. the macro is executed for all objects of the selected typeequivalent 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” "Detach" event is received from it.

12

Name

Automatically

Displays name of the selected object

Name of the objects , registered in the system and of the specified type

EmptyBlank field

A line containing a sequence of any characters. The number of characters is from 1 to 60.

13ActionDropSelect the value from the drop-down listReaction to be executed

Specifies the action that is performed for the object selected

object when the

in the Type column when a registered event is

registered

received

-EmptyBlank fieldThe list of registered reaction types

List of actions that can be performed for the

selected object type

object selected in the Type column

The Parameters table (it is set , when if a parameter should must be set specified to perform the action , selected in the Actions table)

14

Name

Automatically

Displays the name of action’s the action parameter

Latin alphabet, digits numerals and service characters

EmptyBlank field

Depends on the action , selected in the Actions table

15

Value

Entering of the Enter text into in the field

Set Specifies the value of action’s the action parameter

Latin alphabet, digits numerals and service characters

EmptyBlank field

A line containing a sequence of any characters. The number of characters is from 1 to 255

Outside the groups
16Response sending delay (secs)Entering of Enter the value into the field

Sets Specifies the time period ( in seconds ) that must pass after the events specified in the the Events column occur and before executing 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.

Integer Natural number series->0
17The Fast callfield

Left-click in the field and click press the required key combination

Sets Specifies a keyboard shortcut for to quickly call a macro.

If you specify the same combination of hot keys is set keyboard shortcuts for several macros, when clicking a key combination, all of these 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 key—see Registry keys reference guide.

Key combinationsNoNoneSome

Individual keys

of

on the main or numeric keyboard,

as well as

and these keys in combination with Shift, Ctrl

and

, Alt

.

18The Icon typedropdown listSelect in the dropdown list.the value from the drop-down list

Specifies Sets 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 restarting you reastart the map interface. To restart the interface, restart Axxon PSIM or log in once again under the corresponding Operator account.

Available icon appearances types on the map

-Macro 1 - Macro 7, empty value.


Infonote
titleNote. 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

As action’s parameter Play sound file may be used only files of WAV format. Otherwise action Play sound file is not carried out

.

Note
Info
titleNote.

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

Info
title

.

Compressed sound in WAV format may be played back incorrectly, that’s why it is strongly recommended to play back only PCM WAV files. Maximum values of frequency and depth of files digitization for playing back are determined by technical characteristics of digital to analog converter of the installed video card.

3. Click the the Apply button to save the settings.