2N Helios IP Automation Manual v2.8

www.2n.czVersion

2N

®

Helios IP Automation

IP Intercom

Configuration Manual

2.8





The 2N TELEKOMUNIKACE a.s. 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 a.s. administers the FAQ database to help you quickly find
information and to answer your questions about 2N products and services. On
www.faq.2n.cz you can find information regarding products adjustment and instructions for
optimum use and procedures „What to do if...“.

2N TELEKOMUNIKACE a.s. hereby declares that the 2N product

®

Helios IP Automation
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 or
our website at www.2n.cz.

This device complies with part 15 of the FCC Rules. Operation is subject to the following
two conditions: (1) This device may not cause harmful interference, and (2) this device
must accept any interference received, including interference that may cause undesired
operation.

The 2N TELEKOMUNIKACE a.s. is the holder of the ISO 9001:2009 certificate. All
development, production and distribution processes of the company are managed by this
standard and guarantee a high quality, technical level and professional aspect of all our
products.

Content

1. Terms and Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

2. 2N® Helios IP Automation Configuration . . . . . . . . . . . . . . . 5

3. Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

4. Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

5. Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

6. Available Digital Inputs and Outputs . . . . . . . . . . . . . . . . . . 34

7. Examples of Use . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

1. Terms and Symbols

The following symbols and pictograms are used in the manual:

Safety

abide by this information to prevent persons from injury.Always

Warning

abide by this information to prevent damage to the device.Always

Caution

Important information for system functionality.

Tip

Useful information for quick and efficient functionality.

Note

Routines or advice for efficient use of the device.

®

42N TELEKOMUNIKACE a.s., www.2n.cz

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, is helpful for applications that require rather2N Helios IP Automation

®

complex interconnection with the third parties' systems.

Some models are equipped with a number of digital inputs and2N Helios IP

®

outputs, most of which can be configured like standard switches (refer2N Helios IP

®

to the Switches subsection). You can make use of all of these 2N Helios IP

®

inputs and outputs in variable combinations.Automation

2N Helios IP Automation® helps you combine the s arising in the systemEvent

(such as key pressing, RFID card use, digital input status change, etc.) with specific

s (such as digital output activation, user sound playing, call, etc.) as necessary.Action
Moreover, the execution of actions can be bound by selected s (time profileCondition
state, logic input state, e.g.).

Note

2N Helios IP Automation® works only with a valid Enhanced

or licence key.Integration Gold

®

52N TELEKOMUNIKACE a.s., www.2n.cz

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

®

defines a number of events, actions and conditions to be further set.Automation

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 event (logic input1InputChanged
change from log 0 to log 1) arises and the (active profile 1) condition is met.Profile

The web interface helps you configure block combinations2N Helios IP

®

(Automation) easily. The configuration shown in the figure below corresponds to the
example above.

2N Helios IP® allows up to 20 blocks at 5 pages 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 10 actions and assign them to
10 events, or create 19 actions and assign them to 1 event, for example.

®

62N TELEKOMUNIKACE a.s., www.2n.cz

Block Parameter Settings

Select the required Event (Event.xxx), Action (Action.xxx) or Condition (Condition.xxx)
in the column. Set one or more parameters for the blocks in theObject type
respective row of the column – refer to the block describing subsectionsParameters
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 button in the right-handSave
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), will be enabled. If there is a red mark, the 2N Helios IP Automation

®

function will be disabled.2N Helios IP Automation

®

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 , a red mark will appear at the respectiveSave
row.

Use of Variables

The event block variables (parameters) help transfer additional information between
blocks – send the detected card ID via HTTP to another device, use the parameters
received via 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=*

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.

®

72N TELEKOMUNIKACE a.s., www.2n.cz

Every event defines the and variables.TimeStamp Count

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.

®

82N TELEKOMUNIKACE a.s., www.2n.cz

3. Events

2N Helios IP Automation® defines the following event types:

KeyPressed – key pressed
DtmfPressed – DTMF code received in call
DtmfEntered – DTMF-received in call numeric code detected
CodeEntered – numeric code entered
CardEntered – RFID card entered
CallStateChanged – call state changed
InputChanged – digital input changed
Delay – delay defined
Timer – periodical event timer
HttpTrigger – HTTP command received
MulticastTrigger – command for multiple devices received
AudioLoopTest – audio test performed

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

Event.KeyPressed

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

®

92N TELEKOMUNIKACE a.s., www.2n.cz

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, , , , , , , , , , , for numeric keypad buttons1 2 3 4 5 6 7 8 9 * #
%1, , .., for quick dial buttons%2 %999
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 – 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:

Event.KeyPressed: Key=#, %3, %4

Event.DtmfPressed

The block defines the event that is generated when the defined or anyDtmfPressed
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.

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

®

102N TELEKOMUNIKACE a.s., www.2n.cz

Variables

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 #:

Event.KeyPressed: Key=#

Event.DtmfEntered

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

Parameters

Code efine the numeric code.– d

Valid values:

numeric code – 12345, e.g.

Variables

Code – the detected received numeric code which was the last to generate this

event.

Example

Event generated upon detection of DTMF code 12345*

Event.DtmfEntered: Code=12345

Event.CodeEntered

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

®

112N TELEKOMUNIKACE a.s., www.2n.cz

Parameters

Code – define the numeric code.

Valid values:

numeric code – 12345, e.g.
SuppressTones – suppress sound signalling initiated by receiving of an invalid
numeric code. The parameter is optional.

Valid values:

0 – tones are not suppressed

1 – tones are suppressed (default value).

Variables

Code – the received numeric code which was the last to generate this event.

Example

Event generated by entering code 12345* on a keypad:

Event.CodeEntered: Code=12345

Event.CardEntered

The block defines the event generated by tapping (swiping) of the RFIDCardEntered
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 valid or invalid card

card ID - defined card ID e.g. 3F00F34F78.
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.

®

122N TELEKOMUNIKACE a.s., www.2n.cz

Example

Event generated by entering of the card with ID 0012456:

Event.CardEntered: Card=0012456

Event.CallStateChanged

The block defines the event generated by a call state change (callCallStateChanged
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 – 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.

Example

Event generated by termination of any outgoing call:

Event.CallStateChanged: State=terminated; Direction=outgoing

Event.InputChanged

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

®

132N TELEKOMUNIKACE a.s., www.2n.cz