3. Events

Automation defines the following types of events:

  • AudioLoopTest – audio test performed  
  • CallStateChanged – call state changed
  • CardEntered – RFID card entered
  • CardHeld – RFID card held
  • CodeEntered – numeric code entered
  • Delay – delay defined
  • DoorOpenTooLong – excessively long door opening
  • DtmfEntered – DTMF numeric code detected in call
  • DtmfPressed – DTMF code received in call
  • FingerEntered – fingerprint reader authentication
  • HttpTrigger – HTTP command received
  • InputChanged – digital input changed
  • KeyPressed – key pressed
  • KeyReleased – key released
  • LockdownStateChanged – emergency lockdown
  • MobKeyEntered – Bluetooth reader authentication
  • MotionDetected – motion detected by the camera
  • MulticastTrigger – command for multiple devices received
  • OnvifVirtualOutputChanged – event received from VMS
  • NoiseDetected – noise detected by the microphone
  • RegistrationStateChanged – SIP account registration state changed
  • Rebooted – device start/restart detected
  • SilentAlarm – silent alarm activated
  • Time – specific time (alarm clock)
  • Timer – periodical event timer
  • UnauthorisedDoorOpen – unauthorised door opening
  • UserAuthorized – user authorisation
  • OutputChanged – output changed

See below for details on the events and their Input parameters and use.

AudioLoopTest

The AudioLoopTest block defines the event generated after the loudspeaker and microphone test (Audio Loop Test) is performed. The subsequent actions are executed based on the test result. 

 

Input parameters

  • Result – this parameter specifies the required test result.
    • Valid values:

      • any – the event is generated whenever the test is performed (regardless of the result).
      • passed – the event is generated whenever the test is successful.
      • failed – the event is generated whenever the test fails.
    • The parameter is optional, the default value is failed.

Output parameters

  • Event – the Event output to invoke the connected Event or Action.

 

Example

An event generated after the audio loop test if the test result is negative (i.e. the microphone or loudspeaker is out of order):

CallStateChanged

The CallStateChanged block defines the event generated by a call state change (call ringing, call connection, call termination, etc.).

 

Input parameters

  • State – define the call state change.
    • Valid values:
      • ringing – ringing start

      • connected – successful call connection

      • terminated – call termination.

  • Direction – define the call direction.
    • Valid values:
      • incoming – incoming calls

      • outgoing – outgoing calls

      • any – both directions.

    • The parameter is optional, the default value is any.
  • Number – define the identifier (phone number, IP address) to be matched against the caller's identifier to make the event happen. Enter multiple comma-separated numbers if necessary. A non-completed value is the same as any.
    • This parameter is optional, the default value is any.

Output parameters

  • Event – the Event output to invoke the connected Event or Action. 
  • State – the detected call state which generated this event. The options correspond to the State parameter.
  • Direction – the detected call direction which generated this event. The options are incoming or outgoing.
  • Uri – the output containing the opponent's complete SIP uri.

Example

Event generated by answering a call from number 1234:

CardEntered

The CardEntered block defines the event generated by tapping (swiping) of the RFID card with the defined ID (for RFID card reader models only).

 

Input parameters

  • Card – define the RFID card ID; refer to the Card Reader subsection in the Configuration Manual.
    • Valid values:
      • valid – any valid card (included in the intercom card list)

      • invalid – any invalid card

      • any – any valid or invalid card
      • < > (empty value) – the event will not be generated
      • Or, complete the card ID manually.
  • SuppressTones – suppress sound signalling initiated by detection of an invalid card. The parameter is optional.
    • Valid values:
      • disabled – tones are not suppressed

      • enabled – tones are suppressed (default value).

  • Reader – define the card reader / module to be used
    • Valid values:
      • internal_cardreader – internal card reader (2N ® IP Vario, Force)
      • external_cardreader – external card reader (2N® IP Vario, Force)
      • any – any reader / module
      • Or, complete the module name manually as configured in the Module Name parameter in the Hardware / Extenders / Modules / Used module menu (2N® IP Verso).
    • The parameter is optional, the default value is any.
  • Direction – define direction
    • Valid values:
      • in – reader with defined incoming direction
      • out – reader with defined outgoing direction
      • any – both directions
    • The parameter is optional, the default value is any.

Output parameters

  • Event – the Event output to invoke the connected Event or Action. 
  • Card – ID of the detected card which was the last to generate this event. 
  • Direction – configured direction at the card reader (in, out, any).
  • Reader – name of the module which was used (internal_cardreaderexternal_cardreader<module_name>).

Example

Event generated by entering of the card with ID 0012456:

CardHeld

The CardHeld block defines the event generated by holding of the RFID card with the defined ID (for RFID card reader models only). The event is generated by holding the RFID card for 4s at the RFID card reader.

 

Input parameters

  • Card – define the RFID card ID; refer to the Card Reader subsection in the Configuration Manual.
    • Valid values:
      • valid – any valid card (included in the intercom card list)

      • invalid – any invalid card

      • any – any valid or invalid card
      • < > (empty value) – the event will not be generated
      • Or, complete the card ID manually.
  • SuppressTones – suppress sound signalling initiated by detection of an invalid card. The parameter is optional.
    • Valid values:
      • disabled – tones are not suppressed

      • enabled – tones are suppressed (default value).

  • Reader – define used card reader / module
    • Valid values:
      • internal_cardreader – internal card reader (2N® IP Vario, Force)
      • external_cardreader – external card reader (2N® IP Vario, Force)
      • any – any reader / module
      • Or, complete the module name manually as configured in the Module Name parameter in the Hardware / Extenders / Modules / Used module menu (2N® IP Verso).
    • The parameter is optional, the default value is any.
  • Direction – define direction
    • Valid values:
      • in – reader with defined incoming direction
      • out – reader with defined outgoing direction
      • any – both directions
    • The parameter is optional, the default value is any.

Output parameters

  • Event – the Event output to invoke the connected Event or Action. 
  • Card – ID of the detected card which was the last to generate this event. 
  • Reader – name of the module which was used (internal_cardreaderexternal_cardreader<module_name>).
  • Direction – configured direction at the card reader (In, Out, Unspecified).

Example

Event generated by holding of the card with ID 0012456:

CodeEntered

The CodeEntered block defines the event generated by entering of a numeric code and confirmation with the * key (for numeric keypad models only).

 

Input parameters

  • Code – define the numeric code.
    • Valid values:
      • numeric code – 12345, e.g.

      • valid – any valid code

      • invalid – any invalid code

      • any – any valid or invalid code
      • < > (empty value) – the event will not be generated
  • SuppressTones – suppress sound signalling initiated by receiving of an invalid numeric code. The parameter is optional.
    • Valid values:
      • disabled – tones are not suppressed

      • enabled – tones are suppressed (default value).

Output parameters

  • Event – the Event output to invoke the connected Event or Action. 
  • Code – the received numeric code which was the last to generate this event. 

Example

Event generated by entering code 12345* on a keypad:

Delay

The Delay block defines the event generated with a defined delay after another specified event. Define this event to delay the response to the other event by a defined time interval (Delay).

 

Input parameters

  • Start – define the event that starts the delay.
  • Stop – define the event that stops the delay. The parameter is optional.
  • Delay – define the delay time. It is only possible to enter a numerical value, not a value from an output parameter produced by other events.
  • Example of valid values:
    • 10 – 10 seconds (units are unnecessary)
    • 10s – 10 seconds
    • 100ms – 100 milliseconds.

Output parameters

  • Event – the Event output to invoke the connected Event or Action.

 

Example

Event generated 1s after the rise of event on row 1:

DoorOpenTooLong

The DoorOpenTooLong block defines the event generated in case the door stays open longer than as set.

Input parameters

  • State – state of the door sensor that generates the event.
    • Valid values:
      • Start – event start
      • End – event end

Output parameters

  • Event – output for generating of the assigned Event or Action.


Example

The DoorOpen event is longer than set.

DtmfEntered

The DtmfEntered block defines the event that is generated by entering of a numeric code confirmed with the * key in DTMF in an incoming or outgoing call.

 

Input parameters

  • Code – define the numeric code.
    • Valid values:
      • numeric code – 12345, e.g.
      • < > (empty value) – the event will not be generated

  • SuppressTones – suppress sound signalling initiated by receiving of an invalid DTMF code. The parameter is optional.
    • Valid values:
      • disabled – tones are not suppressed

      • enabled – tones are suppressed (default value).

 

Output parameters

  • Event – the Event output to invoke the connected Event or Action. 
  • Code – the detected received numeric code which was the last to generate this event. 

 

Example

Event generated upon detection of DTMF code 12345*

DtmfPressed

The DtmfPressed block defines the event that is generated when the defined or any DTMF code is received from the defined group. DTMF codes are detected both in incoming and outgoing calls.

 

Input parameters

  • Key – define the DTMF code (or DTMF code group). If this parameter is not completed, the event is generated whenever any DTMF code is detected (default value: Any).
    • Valid values:
  • 0123456789*#ABCD
  • any for any key (default value).
  • Separate the values with a comma to specify a group of codes.
  • Direction – define the call direction.
    • Valid values:
      • incoming – incoming calls

      • outgoing – outgoing calls

      • any – both directions

    • The parameter is optional, the default value is any.

Output parameters

  • Event – the Event output to invoke the connected Event or Action.
  • Pressed Key – the recorded received DTMF code which was the last to generate the event. The DTMF is stored in the Key parameter format. 

Example

Event generated upon detection of DTMF code #:

FingerEntered

The FingerEntered block defines the event generated by identifying a known fingerprint on the fingerprint reader (for fingerprint reader equipped devices only).


Input parameters

  • Fingerprint - define validity of the entered fingerprint.
    • Valid values:
      • valid - the fingerprint belongs to a user
      • invalid - the fingerprint is unknown
      • any - any entered fingerprint
  • Finger - define one of two fingerprints stored for the user.

    • Valid values:
      • any - any fingerprint of the user
      • F1 - the fingerprint was defined as "F1" for Automation at the Fingerprint enrolment
      • F2 - a fingerprint was defined as "F2" for Automation at the Fingerprint enrolment
  • Suppress Tones - suppress sound signalling initiated by detection of an invalid user (fingerprint). The parameter is optional.
    • Valid values:
      • disabled - tones are not suppressed
      • enabled - tones are suppressed (default value).

Output parameters

  • Event – the Event output to invoke the connected Event or Action. 
  • User – UUID of the user whose fingerprint has generated this event.

 

Example

 An event generated by valid entering of a fingerprint on a biometric reader.

HttpTrigger

The HttpTrigger block defines the event generated by receiving of an HTTP command from the intercom HTTP server. When the HTTP command  http://ip_addr/enu/trigger/id  is received, the event will be generated whose ID matches the value that follows 'trigger/' in the HTTP command. The intercom sends a simple reply to this request (200 OK).

 

Input parameters

  • Name – define a unique HTTP command identifier including alphabetical characters and digits.

Output parameters

  • Event – the Event output to invoke the connected Event or Action.
  • Params – parameters sent in the SendHttpRequest block or the command coming to the 2N IP intercom.

The HttpTrigger event is always generated by the HTTP command which can carry a list of user Input parameters as included in the URI command.

http://ip_address/enu/trigger/id?param1=value1&param2=value2

The list of Input parameters follows the ? character. Each parameter must include the name and value separated with the = character. If the list includes more Input parameters than one, & is used as the separator.

The HTTP-received Input parameters are available as HttpTrigger block Output parameters. The output parameters name equals to the name of the parameter transferred - $(line.param1) a $(line.param2). 

 

Example

Event generated by receiving of the following HTTP command:  http://ip_addr/enu/trigger/opendoor :

InputChanged

The InputChanged block defines the event generated by a change of the logic level on the defined digital input.

 

Input parameters

  • Input – define the logic input.
    • Valid values:
      • tamper – tamper switch input

      • input1 – digital input 1

      • input2 – digital input 2

      • cr_input1 – digital input 1 on card reader

      • cr_input2 – digital input 2 on card reader.

    • There may be different lists of valid values for different 2N IP intercom models; refer to the Available Digital Inputs and Outputs subsection.
  • Edge  define the detected change on the digital input.
    • Valid values:
      • falling – falling edge, change from log. 1 to log. 0

      • rising – rising edge, change from log. 0 to log. 1.

    • The parameter is optional, the default value is rising.

Output parameters

  • Event – the Event output to invoke the connected Event or Action. 
  • Output – the detected ID of the input whose change was the last to generate this event. The options correspond to the Input parameter values.
  • Edge – the detected edge change which was the last to generate this event. The options are falling or rising.

Example

Event generated by disconnection of the tamper switch (device opening):

KeyPressed

The KeyPressed block defines the event generated by pressing of the defined key or any key from the defined group.

 

Input parameters

  • Key – define the key or a key group. If this parameter is not completed, the event is generated upon pressing of any key (default value: any).
    • Valid values:
      • 0123456789*# for numeric keypad buttons

      • %1%2, .., %999 for quick dial buttons

      • any for any button (default value).

    • Separate the values with a comma while defining more keys than one.
  • SuppressTones – suppress sound signalling initiated by pressing of a non-programmed quick dial button. The parameter is optional.
    • Valid values:
      • disabled – tones are not suppressed

      • enabled – tones are suppressed (default value)

Output parameters

  • Event – the Event output to invoke the the connected Event or Action.
  • Pressed Key – the recorded code of the key which was the last to generate this event. The key code is stored in the Key parameter format.

Example

Event generated by pressing of # and quick dial button 3 or 4:

KeyReleased

The KeyReleased block defines the event generated by releasing of the defined pressed key or any key from the defined group.

Note

  • Vario model: the event is generated whenever the button is pressed, the functionality is the same as with KeyReleased.


Input parameters

  • Key – define the key or a key group. If this parameter is not completed, the event is generated upon releasing of any key (default value: any).
    • Valid values:
      • 0123456789*# for numeric keypad buttons

      • %1%2, .., %999 for quick dial buttons

      • any for any button (default value).

    • Separate the values with a comma while defining more keys than one.

Output parameters

  • Event – the Event output to invoke the connected Event or Action.
  • Released Key – the recorded code of the key which was the last to generate this event. The key code is stored in the Key parameter format.

Example

Event generated by releasing of 1 and quick dial button 2:

LockdownStateChanged

The LockdownStateChanged block defines the condition to be met when the emergency lockdown is active.

Input parameters

  • Door – set the passage direction.
    • Valid values:
      • any – any type of event
      • entry – entry 
      • exit – exit
  • State – set the door sensor state to generate the event.
    • Valid values:
      • any – any type of event
      • unlocked – unlocked
      • locked – locked


Output parameters

  • Event – Event/Action generating output.
  • Door – passage direction: entry and exit.
  • State – event generating emergency lockdown: any, unlocked and locked. 

 

Example

The event generated when the emergency lockdown is active.

 

MobKeyEntered

The MobkeyEntered block defines the event generated by reading a known Mobile Key on the Bluetooth reader (for the devices with Bluetooth reader only). 


Input parameters

  • MobKey – define the current Mobile Key validity. 
    • Valid values:
      • valid - the Mobile Key belongs to a user
      • invalid - the Mobile Key is unknown
      • any - any entered Mobile Key.
  • Suppress Tones - suppress sound signalling initiated by detection of an invalid user (Mobile Key). The parameter is optional.
    • Valid values:
      • disabled - tones are not suppressed
      • enabled - tones are suppressed (default value).

Output parameters

  • Event – the Event output to invoke the connected Event or Action. 
  • User – UUID of the user whose Mobile Key has generated this event. 


 

Example 

An event generated by valid reader authorisation.

 

MotionDetected

The MotionDetected block defines the event generated at motion detection. Motion can be detected by the internal camera only. The Motion detection Input parameters are configured in the Hardware / Camera / Internal Camera menu, section Motion Detection Settings.

 

Input parameters

  • State – define whether the start or the end of the motion should be detected.
    • Valid values:
      • start – start of the motion
      • end – end of the motion
    • The parameter is optional, the default value is start.

Output parameters

  • Event – the Event output to invoke the connected Event or Action.

 

Example

Event generated at the start of the motion.

MulticastTrigger

The MulticastTrigger block defines the event generated by receiving of a command sent via SendMulticastRequest. The request is a message sent by UDP to a multicast address (235.255.255.250:4433) and can thus be received by multiple devices at the same time. The message includes the command ID (Command parameter) and additional optional Input parameters. The message can be password-secured (Password parameter).

 

Input parameters

  • Command – define the command ID to distinguish the command types. The MulticastTrigger block responds to the SendMulticastRequest action only if the command identifier is the same. Any text containing the A-Z, a-z and 0-9 characters can be used for identification. The Upper/Lower case must be respected in the command name.
  • CheckTime – enable/disable the check of the command receiving time against the time value included in the command message to eliminate attacks caused by repeating of an already processed message. Synchronised time (via the NTP server) on all command sending and receiving devices is required for this function.
    • Valid values:
      • disabled – message time is not checked
      • enabled – message time is checked (enhanced security).
    • The parameter is optional, the default value is 0.
  • Password – define the password to secure the command against unauthorised access. The password must match the value defined in the SendMulticastRequest action to which MulticastTrigger is expected to respond.

Output parameters

  • Event – the Event output to invoke the connected Event or Action.
  • Params – parameters sent in the SendMulticastRequest Action.

The MulticastTrigger event is generated whenever a mass command including the list of user Input parameters (Params parameter, MulticastRequest action) is received. Each of the Input parameters has a user-defined unique name and is available as an Output parameter of the same name in the MulticastTrigger block.

Example: Suppose a mass command generated by the MulticastRequest action is received, in which Params=“AAA=123” is included. The MulticastTrigger event which processes this command will automatically include value 123 for the AAA output parameter. This output parameter can be referred to in the interconnected blocks.

 

Example

Event generated by receiving of a mass opendoor command:

OnvifVirtualOutputChanged

The OnvifVirtualOutputChanged block helps transmit events from VMS to a 2N IP intercom. 


Input parameters

  • Port – set the port to set VMS. Valid values: 50–54.
  • Edge – define the change detected on the virtual input.
    • Valid values:
      • falling – falling edge, change from log 1 to log 0
      • rising – rising edge, change from log 0 to log 1
    • The parameter is optional, the default value is rising.

Output parameters 

  • Event – Event/Action generating output.
  • Port – port value changed from VMS. Valid values: 50–54.
  • Edge – the last virtual input change that generated this event. Valid values: falling or rising.


Example

The event generated when the virtual port value changes.

NoiseDetected

The NoiseDetected block defines the event generated at noise detection. Noise can be detected by the internal microphone only. The noise detection Input parameters are configured in the Hardware / Audio menu, section Noise Detection Settings.

 

Input parameters

  • State – define whether the start or the end of the noise should be detected.
    • Valid values:
      • start – start of the noise
      • end – end of the noise
    • The parameter is optional, the default value is start.

Output parameters

  • Event – the Event output to invoke the connected Event or Action.

 

Example

Event generated at the start of the noise

RegistrationStateChanged

The RegistrationStateChanged block defines the event generated at a SIP account registration state change. Set the SIP registration in Services / SIP 1 and SIP 2. Registration gets changed whenever the intercom is switched on, configuration is changed or registrar connection gets lost, for example.

 

Input parameters

  • Account – select the account for which events are to be monitored.
    • Valid values:
      • 1 – account 1
      • 2 – account 2
      • Any – any account
  • The parameter is optional, the default value is Any.
  • State – set the registration state that generates the event.
    • Valid values:
      • Unregistered – intercom not registered
      • Registering – registration in progress
      • Registered – intercom is registered
      • Unregistering – unregistration in progress
      • Any – any state change 
  • The parameter is optional, the default value is Any.


Output parameters

  • Event – the Event output to invoke the connected Event or Action.
  • Account – select the account for which events are to be monitored.
  • State – set the registration state that generates the event. 

Example

Event generated when the intercom has been unregistered (whenever the registrar failed to respond to a periodical registration request):

Rebooted

The Rebooted block defines the event generated in case the device is started/restarted.

Input parameters

This block has no Input parameters.


Output parameters

  • Event – output for generating of the assigned Event or Action.
  • Time – device start/restart time.
  • Reason – reboot reason.


Example

The event generated at the device startup.

 

SilentAlarm

The SilentAlarm block defines the event generated upon the silent alarm start. Silent alarm can be started by entering a code higher by 1 than the user switch code. If, thus, a user is assigned switch code 123, silent alarm is started with 124.

 

Input parameters

This block has no Input parameters.


Output parameters

  • Event – the Event output to invoke the connected Event or Action.

 

Example

Event generated by entering code 112 if some of the users is assigned code 111.

Time

The Time block defines the event generated every day at a specific time (alarm clock). To limit validity of this event for some days only, use the condition Condition.ProfileState at the started action and specify requested days in the used time profile.


Input parameters

  • Time – define time to start the event. Time is entered in hh:mm format.


Output parameters

  • Event – the Event output to invoke the connected Event or Action.


Example

Event generated every day at 17:30.

Timer

The Timer block defines the event generated with a defined delay after another specified event with a defined count of repetitions. Define this event to delay the response to the other event by a defined time interval or execute the response several times.

 

Input parameters

  • Start – define the timer starting event (i.e. the row number on the Automation tab on which the event is defined). The parameter is optional. If no value is completed, the timer will be started automatically.
  • Stop – define the timer stopping event (i.e. the row number on the Automation tab on which the event is defined). When StopEvent is executed, the timer will stop and will be restarted by StartEvent only. This parameter is optional.
  • Period – define the timer period.
    • Example of valid values:
      • 10 – 10 seconds (units are unnecessary)

      • 10s – 10 seconds

      • 100ms – 100 milliseconds.

    • The minimum period is 100ms.
  • Count – define the count of repetitions. The parameter is optional and the default value is 0, which means that the count of timer generated events is unlimited. Value 1 makes the timer behave as a Delay.

Output parameters

  • Event – the Event output to invoke the connected Event or Action.

Example

Event generated three times in 1s intervals after the rise of event on row 1:

UnauthorisedDoorOpen

The UnauthorisedDoorOpen block defines the event generated whenever an unauthorised door opening is detected.

Input parameters

  • State – state of the door sensor that generates the event.
    • Valid values:
      • Start – event start
      • End – event end

Output parameters

  • Event – output for generating of the assigned Event or Action.

 

Example

 The event generated at an unauthorised door unlocking.

UserAuthorized

The UserAuthorized block defines the event generated at user authorisation by any access method (code, PIN, RFID, Bluetooth, fingerprint).

Input parameters

  • User – define the user/user list. If no value is completed (default value), the user is irrelevant.

Output parameters

  • Event – Event/Action generating output.
  • User – user identification that generated this event. 

 

Example

The event generated by Victoria Black user authorisation.

Caution

  •  The User parameter is limited to up to 10 users.

OutputChanged

The OutputChanged defines the event generated at an output change.

  

Input parameters

  • Output – define the logical input.
    • Valid values:
      • relay1 – relay 1 on basic unit
      • relay2 – relay 2 on basic unit
      • output1 – output 1 on basic unit
      • output2 – output 2 on basic unit
    • The list of valid values can be different for each of the 2N IP intercom models, refer to Available Digital Inputs and Outputs.
  • Edge – define the detected output change.
    • Valid values:
      • falling – falling edge, change from log 1 to log 0
      • rising – rising edge, change from log 0 to log 1
    • The parameter is optional, the default value is rising.

Output parameters

  • Event – Event/Action generating output.
  • Output – detected ID of the input whose change was the last to generate this event. The available values correspond to the Input values.
  • Edge – detected change of the output that was the last to generate this event. The available values are falling or rising. 

Example

The event generated by the change of the relay 1 output.