2N Helios IP Automation Instruction sheet

www.2n.czVersion
2N
®Helios IP Automation
IP Intercom
Configuration Manual
2.10



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 (if
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

Content
1. Terms and Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
2. 2N® Helios IP Automation Configuration . . . . . . . . . . . . . . . 5
3. Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
4. Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
5. Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
6. Available Digital Inputs and Outputs . . . . . . . . . . . . . . . . . . 37
7. Examples of Use . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41

42N TELEKOMUNIKACE a.s., www.2n.cz
®
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.

52N 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

62N 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.

72N 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.

82N 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.

92N TELEKOMUNIKACE a.s., www.2n.cz
®
3. Events
2N Helios IP Automation
® defines the following event types:
KeyPressed – key pressed
KeyReleased - key released
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 receivede
AudioLoopTest – audio test performed
Time – specific time (alarm clock)
– MotionDetected motion detected by the camera
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.

102N 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 buttons123456789*#
%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.KeyReleased
The block defines the event generated by releasing of the definedKeyReleased
pressed 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 releasing of any key (default value: any).
Valid values:
0, , , , , , , , , , , for numeric keypad buttons123456789*#
%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.
Note
Model Vario: the event is generated at the time the button is pressed,
functionality is the same as KeyPressed

112N TELEKOMUNIKACE a.s., www.2n.cz
®
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 releasing of 1 and quick dial button 2:
Event.KeyPressed: Key=1, %2
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, , , , , , , , , , , , , , , 123456789*#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
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=#

122N TELEKOMUNIKACE a.s., www.2n.cz
®
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).
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:

132N TELEKOMUNIKACE a.s., www.2n.cz
®
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.
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.).

142N TELEKOMUNIKACE a.s., www.2n.cz
®
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.
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

152N TELEKOMUNIKACE a.s., www.2n.cz
®
Variables
Input – 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):
Event.InputChanged: Input=tamper
Event.Delay
The block defines the event generated with a defined delay after anotherDelay
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
Event.Timer
The block defines the event generated with a defined delay after anotherTimer
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.

162N TELEKOMUNIKACE a.s., www.2n.cz
®
Parameters
StartEvent – 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.
StopEvent – 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.
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
Event.HttpTrigger
The block defines the event generated by receiving of an HTTP commandHttpTrigger
from the intercom HTTP server. When the HTTP command http://ip_addr/enu/trigger/i
is received, the event will be generated whose ID matches the value that followsd
'trigger/' in the HTTP command. The intercom sends a simple reply to this request (200
OK).
Parameters
Name – define a unique HTTP command identifier including alphabetical
characters and digits.
Variables
The HttpTrigger event is always generated by the HTTP command which can carry a list
of user parameters as included in the URI command.
http://ip_address/enu/trigger/id?param1=value1&param2=value2

172N TELEKOMUNIKACE a.s., www.2n.cz
®
The list of parameters follows the ? character. Each parameter must include the name
and value separated with the = character. If the list includes more parameters than
one, & is used as the separator.
The HTTP-received parameters are available as HttpTrigger block variables. The
variable 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/trigg
:er/opendoor
Event.HttpTrigger: Name=opendoor
Event.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 parameters. The message can be password-secured (Password
parameter).
Parameters
Command efine the command ID to distinguish the command types. The– d
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.
Password efine the password to secure the command against unauthorised– d
access. The password must match the value defined in the SendMulticastRequest
action to which MulticastTrigger is expected to respond.
CheckTime nable/disable the check of the command receiving time against– e
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:
0 – message time is not checked
1 – message time is checked (enhanced security).
The parameter is optional, the default value is .0
Variables
The MulticastTrigger event is generated whenever a mass command including the list
of user parameters (Params parameter, MulticastRequest action) is received. Each of
the parameters has a user-defined unique name and is available as a variable of the
same name in the MulticastTrigger block.

182N TELEKOMUNIKACE a.s., www.2n.cz
®
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 variable. This
variable can be referred to in the interconnected blocks.
Example
Event generated by receiving of a mass opendoor command:
Event.MulticastTrigger: Command=opendoor
Event.AudioLoopTest
The block defines the event generated after the loudspeaker andAudioLoopTest
microphone test (Audio Loop Test) is performed. The subsequent actions are executed
based on the test result.
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
Variables
This block does not define any specific variables.
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):
Event.AudioLoopTest: Result=failed
Event.Time
The block defines an event generated every day at a specific time (alarm clock). Time
Parameters
– define time to start the event. Time is entered in hh:mm format. To limitTime
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.

192N TELEKOMUNIKACE a.s., www.2n.cz
®
Variables
This block does not define any specific variables.
Example
Event generated every day at 17:30.
Event.Time: Time=17:30
Event.MotionDetected
The block defines the event generated at motion detection. MotionMotionDetected
can be detected by the internal camera only. The Motion detection parameters are
configured in the Hardware / Camera / Internal Camera menu, section Motion
Detection Settings.
Parameters
State – define whether the start or the end of the motion should be detected.
Valid values:
1 – start of the motion
0 – end of the motion
The parameter is optional, the default value is .1
Variables
This block does not define any specific variables.
Example
Event generated at the start of the motion
Event.MotionDetected: State=1

202N TELEKOMUNIKACE a.s., www.2n.cz
®
4. Actions
2N Helios IP Automation
® – defines the following types of actions:
ActivateSwitch – switch activation
SetOutput – digital output state setting
BeginCall – outgoing call setup
AnswerCall – incoming call answer
EndCall – call termination
SendHttpRequest – HTTP command sending
SendMulticastRequest – command sending to multiple devices
PlayUserSound – user sound playing
StartMulticastSend – audio stream sending start
StopMulticastSend – audio stream sending stop
StartMulticastRecv – audio stream receiving start
StopMulticastRecv – audio stream receiving stop
SetCameraInput – camera input selection
ControlRtpStream – call RTP stream control
LogEvent – event logging to the syslog server
SendEmail – email sending
SetOnvifVirtualInput - Virtual input for ONVIF
SendWiegandCode - Send code to the Wiegand bus
UploadSnapshotToFtp - Snapshot upload to the FTP server
StartAutoUpdate - Firmware and configuration Autoupdate
Action.ActivateSwitch
The block defines the action necessary for activation of the intercomActivateSwitch
switch as configured in the Switch 1–4 tags. The activity to be performed depends fully
on the particular switch settings (digital output activation, HTTP command sending,
etc.). Switch deactivation is controlled by the switch settings too.