2N Helios IP Automation Instruction sheet

2N® Helios IP Automation
Configuration Manual
Version 2.5.0
Firmware 2.5 www.2n.cz

The 2N TELEKOMUNIKACE a.s. joint-stock company is a Czech manufacturer and supplier
of telecommunications equipment.
The product family developed by 2N TELEKOMUNIKACE a.s. includes GSM gateways,
private branch exchanges (PBX), and door and lift communicators.
2N TELEKOMUNIKACE a.s. has been ranked among the Czech top companies for years
and represented a symbol of stability and prosperity on the telecommunications market
for almost two decades. At present, we export our products into over 120 countries
worldwide and have exclusive distributors on all continents.
2N®is a registered trademark of 2N TELEKOMUNIKACE a.s.. Any product and/or other
names mentioned herein are registered trademarks and/or trademarks or brands
protected by law.
2N TELEKOMUNIKACE administers the FAQ database to help you quickly find information
and to answer your questions about 2N products and services. On faq.2n.cz you can find
information regarding products adjustment and instructions for optimum use and
procedures „What to do if...”.
Declaration of Conformity
2N TELEKOMUNIKACE a.s. hereby declares that the 2N®Helios product complies with all
basic requirements and other relevant provisions of the 1999/5/EC directive. For the full
wording of the Declaration of Conformity see the CD-ROM enclosed and at www.2n.cz.
The 2N TELEKOMUNIKACE company is a holder of the ISO 9001:2008 certificate. All
development, production and distribution processes of the company are managed by this
standard and guarantee a high quality and advanced technical level of and a professional
approach to all of our products.

Table of Contents
1. 2N®Helios IP Automation..................................................5
1.1 Terms and Symbols ....................................................................................................... 6
Symbols Used in Manual.................................................................................................. 6
1.2 2N®Helios IP Automation Configuration ..................................................................... 7
Block Parameter Settings................................................................................................. 8
Use of Variables............................................................................................................. 10
1.3 Events............................................................................................................................ 11
Event.KeyPressed.......................................................................................................... 12
Event.CodeEntered........................................................................................................ 13
Event.DtmfPressed ........................................................................................................ 14
Event.DtmfEntered......................................................................................................... 15
Event.CardEntered......................................................................................................... 16
Event.CallStateChanged................................................................................................ 17
Event.InputChanged....................................................................................................... 18
Event.Delay.................................................................................................................... 19
Event.Timer.................................................................................................................... 20
Event.HttpTrigger ........................................................................................................... 21
Event.MulticastTrigger.................................................................................................... 22
Event.AudioLoopTest..................................................................................................... 24
1.4 Actions .......................................................................................................................... 25
Action.ActivateSwitch..................................................................................................... 26
Action.SetOutput ............................................................................................................ 27
Action.BeginCall............................................................................................................. 28
Action.AnswerCall .......................................................................................................... 29
Action.EndCall................................................................................................................ 30
Action.SendHttpRequest................................................................................................ 31
Action.SendMulticastRequest ........................................................................................ 32
Action.PlayUserSound ................................................................................................... 34
Action.StartMulticastSend .............................................................................................. 35
Action.StopMulticastSend .............................................................................................. 36
Action.StartMulticastRecv .............................................................................................. 37
Action.StopMulticastRecv............................................................................................... 38
Action.SetCameraInput .................................................................................................. 39
1.5 Conditions..................................................................................................................... 40
Condition.ProfileState..................................................................................................... 41
Condition.CallState......................................................................................................... 42
Condition.InputState....................................................................................................... 43
Condition.LogicalAnd ..................................................................................................... 44
Condition.LogicalOr........................................................................................................ 44

Condition.LogicalNot ...................................................................................................... 45
Condition.True................................................................................................................ 45
Condition.False............................................................................................................... 45
Condition.FlipFlopD........................................................................................................ 46
Condition.FlipFlopRS ..................................................................................................... 47
1.6 Available Digital Inputs and Outputs.......................................................................... 48
1.7 Examples of Use........................................................................................................... 50

1
1. 2N®Helios IP
Automation
In this section, we describe the 2N®Helios IP Automation configuration.
Here is what you can find in this section:
Terms and Symbols
2N®Helios IP Automation Configuration
Description of Configurable Blocks

Terms and Symbols
1.1
1.1 Terms and Symbols
Symbols Used in Manual
Safety
Always abide by this information to prevent injury of persons.
Warning
Always abide by this information to prevent damage to the device.
Caution
Important information for system functionality.
Tip
Useful advice for quick and efficient functionality.
Note
Routines or advice for efficient use of the device.

2N® Helios IP Automation Configuration
1.2
1.2 2N®Helios IP Automation
Configuration
2N®Helios IP provides flexible setting options depending on the user’s requirements.
If the standard setting options (switch/call settings, e.g.) are insufficient for the
intended use, apply a special programmable interface - 2N®Helios IP Automation.
Typically, 2N®Helios IP Automation is helpful for applications that require rather
complex interconnection with the third parties’ systems.
Note
2N® Helios IP Automation works only with a valid Enhanced Integration
or Gold licence key.
Some 2N®Helios IP models are equipped with a number of digital inputs and outputs,
most of which can be configured like standard 2N®Helios IP switches (refer to the
Switches subsection). You can make use of all of these 2N®Helios IP Automation
inputs and outputs in variable combinations.
2N®Helios IP Automation helps you combine the Events arising in the system (such
as key pressing, RFID card use, digital input status change, etc.) with specific Actions
(such as digital output activation, user sound playing, call, etc.) as necessary.
Moreover, the execution of actions can be bound by selected Conditions (time profile
state, logic input state, e.g.).
The figure above shows a typical interconnection of the Event, Action and Condition
blocks. It holds true in general that an action is always tied with a selected event and
is executed when a selected condition is met. The condition is optional and if none is
selected, the action is executed whenever the assigned event occurs. 2N®Helios IP
Automation defines a number of events, actions and conditions to be further set. Refer
to the subsections below for the full list.
The example shown in the figure above can be interpreted as follows: The SetOutput
action (digital output setting) is executed if the InputChanged event (logic input1
change from log.0 to log. 1) arises and the Profile (active profile 1) condition is met.
InputChanged
Input=Input1
Event
SetOutput
Output=Relay1
Action
Profile
Profile=1
Condition

2N® Helios IP Automation Configuration
1.2
The 2N®Helios IP web interface helps you configure block combinations (Automation)
easily. The configuration shown in the figure below corresponds to the example above.
2N®Helios IP allows up to 12 blocks to be created and interconnected (regardless of
the block type - events, actions and conditions). Multiple actions can be assigned to an
event or condition. Thus, you can create 6 actions and assign them to 6 events, or
create 11 actions and assign them to 1 event, for example.
Block Parameter Settings
Select the required Event (Event.xxx), Action (Action.xxx) or Condition
(Condition.xxx) in the Block type column. Set one or more parameters for the blocks
in the respective row of the Parameters column - refer to the block describing
subsections below for the supported parameters. Separate the parameters with a
colon if more parameters are required.
The changes will not be executed until you press the Save button in the right-hand
bottom corner of the page.
If you have set a parameter correctly, a green mark will appear at the end of the
respective block definition row. If not (if you enter a wrong parameter name/value or
fail to complete an obligatory block parameter), a red mark will appear at the end of
the row. Move your mouse cursor to the red mark to display the Help to find the error.
If all the required blocks have been configured correctly (there is a green mark on
every row), 2N®Helios IP Automation will be enabled. If there is a red mark, the 2N®
Helios IP Automation function will be disabled.

2N® Helios IP Automation Configuration
1.2
Most of the blocks include parameters (Event, Condition, StartEvent, e.g.) that refer to
other blocks. Set these parameters to interconnect the defined blocks. Make sure that
the value to be entered matches the row number in the table defining the block that is
referred to. If you enter a wrong value (not matching the defined block type or
matching an undefined block) and press Save, a red mark will appear at the
respective row.
Tip
The Upper/Lower case need not be respected in the parameter names.
Some block parameters are optional. If you do not enter an optional
parameter in the block definition, the default value will be applied.

2N® Helios IP Automation Configuration
1.2
Use of Variables
The event block variables (parameters) help transfer additional information between
blocks –send ID of the detected card via HTTP to another device, use parameters
received in HTTP for setting parameters of a tied action and so on. Their values are
updated whenever the event is generated. Use the following syntax to refer to a
variable in the configuration parameters of another block:
$(block_number.variable_name) –the block number and variable name are separated
with a dot.
Example:
1: Event.KeyPressed: Key=Any
2: Action.SendHttpRequest: Event=1; Uri=http://192.168.1.1/ABCD?Key=$(1.Key)
Press any key (block 1 Event.KeyPressed) to send the HTTP request (block 2
Action.SendHttpRequest) to IP address 192.168.1.1. For example, if you press *, the
HTTP request URI will be as follows: http://192.168.1.1/ABCD?Key=*
Every event defines the TimeStamp and Count variables.
TimeStamp contains encoded date and time of the last event generation in the Unix
Time format (second count from 00:00:00 1.1.1970).
Count contains the count of event generations after the device start or last block
configuration change. The variable increases by 1 after each event generation.
Refer to the following subsections for more variables with specific functions.
Tip
The Upper/Lower case is not be respected in the variable names.
Caution
You cannot use the variables in the block relation defining parameters, i.e.
Event, Condition, etc.

Events
1.3
1.3 Events
2N® Helios IP Automation defines the following event types:
KeyPressed key pressed
CodeEntered numerical code entered
CardEntered RFID card entered
DtmfPressed DTMF code received in call
DtmfEntered DTMF-received in call numerical code detected
CallStateChanged call state changed
InputChanged digital input changed
HttpTrigger HTTP command received
MulticastTrigger command for multiple devices received
Delay delay defined
Timer periodical event timer
See below for details on the events and their parameters and use.

Events
1.3
Event.KeyPressed
The KeyPressed block defines the event generated by pressing of the defined key or
any key from the defined group.
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:
0, 1, 2, 3, 4, 5, 6, 7, 8, 9, *, #for numerical keypad buttons
%1, %2, .., %54 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:
0–tones are not suppressed
1–tones are suppressed (default value)
Variables
Key
Detected 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:
Action.KeyPressed: Key=#, %3, %4

Events
1.3
Event.CodeEntered
The CodeEntered block defines the event generated by entering of the numerical
code and confirmation with the * key (for numerical keypad models only).
Parameters
Code
Define the numerical code.
Valid values:
Numerical code - 12345, e.g.
SuppressTones
Suppress sound signalling initiated by receiving of an invalid numerical code. The
parameter is optional.
Valid values:
0–tones are not suppressed
1–tones are suppressed (default value)
Variables
Code
Detected numerical code which was the last to generate this event.
Example
Event.CodeEntered: Code=12345

Events
1.3
Event.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.
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:
0, 1, 2, 3, 4, 5, 6, 7, 8, 9, *, #, A, B, C, D
any for any key (default value).
Separate the values with a comma to specify a group of codes.
Variables
Key
Detected 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 #:
Action.KeyPressed: Key=#

Events
1.3
Event.DtmfEntered
The DtmfEntered block defines the event that is generated by entering of a DTMF
numerical code confirmed with the * key in an incoming or outgoing call.
Parameters
Code
Define the numerical code.
Valid values:
Numerical code –12345, e.g.
Variables
Code
Detected received numerical code which was the last to generate this event.
Example
Event.DtmfEntered: Code=12345

Events
1.3
Event.CardEntered
The CardEntered block defines the event generated by entering of the RFID card with
the defined ID (for RFID card reader models only).
Parameters
Card
Define the RFID card ID; refer to the Card Reader subsection in the 2N®Helios IP
Configuration Manual.
Valid values:
valid –any valid card (included in the intercom card list)
invalid –any invalid card
any –any card
SuppressTones
Suppress sound signalling initiated by detection of an invalid card. The parameter
is optional.
Valid values:
0–tones are not suppressed
1–tones are suppressed (default value)
Variables
Card
ID of the detected card which was the last to generate this event.
Example
Event generated by entering of a card with ID 0*0012456:
Event.CardEntered: Card=0*0012456

Events
1.3
Event.CallStateChanged
The CallStateChanged block defines the event generated by a call state change (call
ringing, call connection, call termination, etc.)
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.
Variables
State
Detected call state which generated this event. The options correspond to the
State parameter.
Direction
Detected call direction which generated this event. The options are incoming or
outgoing.
Example
Event generated by termination of any outgoing call:
Event.CallStateChanged: State=terminated; Direction=outgoing

Events
1.3
Event.InputChanged
The InputChanged block defines the event generated by a change of the logic level
on the defined digital 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®Helios IP 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.
Variables
Input
Detected ID of the input whose change was the last to generate this event. The
options correspond to the Input parameter values.
Edge
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):
Event.InputChanged: Input=tamper

Events
1.3
Event.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).
Parameters
StartEvent
Define the event that starts the delay.
StopEvent
Define the event that stops the delay. The parameter is optional.
Delay
Define the delay time.
Example of valid values:
10 –10 seconds (units are unnecessary)
10s –10 seconds
100ms –100 milliseconds
Variables
This block does not define any specific variables.
Example
Event generated 1s after the rise of event on row 1:
Event.Delay: StartEvent=1; Delay=1s

Events
1.3
Event.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.
Parameters
StartEvent
Define the timer starting event (i.e. the row number in the Automation tag on
which the event is defined). The parameter is optional. If no value is completed,
the timer will be started automatically.
StopEvent
Define the timer stopping event (i.e. the row number in the Automation tag on
which the event is defined). When StopEvent is executed, the timer will stop and
will be restarted by Event 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
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.
Variables
This block does not define any specific variables.
Example
Event generated three times in 1s intervals after the rise of event on row 1:
Event.Timer: StartEvent=1; Period=1s; Count=3