2N® Helios IP Automation Door Access Intercom Configuration Manual Version 2.7 www.2n.
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.
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 . . . . . . . . . . . . . . . . . . 35 7.
1. Terms and Symbols The following symbols and pictograms are used in the manual: Safety Always abide by this information to prevent persons from injury. Warning Always abide by this information to prevent damage to the device. Caution Important information for system functionality. Tip Useful information for quick and efficient functionality. Note Routines or advice for efficient use of the device. 2N® TELEKOMUNIKACE a.s., www.2n.
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.
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.
Block Parameter Settings Select the required Event (Event.xxx), Action (Action.xxx) or Condition (Condition.xxx) in the Object 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.
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.
3.
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 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.
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=# Event.DtmfEntered The DtmfEntered block defines the event that is generated by entering of a DTMF numeric code confirmed with the * key in an incoming or outgoing call. Parameters Code – define the numeric code.
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). Example Event generated by entering code 12345* on a keypad: Event.CodeEntered: Code=12345 Event.
Event.CardEntered: Card=0012456 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.
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.
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 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.
Event.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/i d 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). Parameters Name – define a unique HTTP command identifier including alphabetical characters and digits.
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. Password – define the password to secure the command against unauthorised access.
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.
4.
Example Activate switch 1 if the event defined on row 2 arises and the condition defined on row 3 is met: Action.ActivateSwitch: Switch=1; Event=2; Condition=3 Action.SetOutput The SetOutput block defines the action necessary for setting of the intercom output to the required level. Parameters Event – define the event that launches the action. Condition – define the condition to be met to execute the action. This parameter is optional. Output – define the output to be set.
Action.BeginCall The BeginCall block defines the action necessary for establishing of an outgoing call to the defined telephone number, SIP URI or user number included in the intercom phone book. Parameters Event – define the event to launch the action. Condition – define the condition to be met to execute the action. This parameter is optional. Number – define the phone number to be called. Uri – define the SIP URI to be called: sip:user@domain User – define the phone book number to be called.
Action.EndCall The EndCall block defines the action necessary for termination of the currently made call. In case there is no active call via the intercom, the action will not initiate any activity. Parameters Event – define the event to launch the action. Condition – define the condition to be met to execute the action. This parameter is optional. Example Terminate a call if the event defined on row 2 arises: Action.EndCall: Event=2 Action.
Action.SendMulticastRequest The SendMulticastRequest block defines the action necessary for user command sending to multiple devices. The sent command can be processed by the MulticastTrigger block. The command 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 (Params parameters).
Parameters Event – define the event to launch this action. Condition – define the condition to be met for the action to be executed. This parameter is optional. Sound – select the user sound number (1 – 10). Destination – define the user sound playing destination. Valid values: Speaker – the sound is played on the intercom. Call – the sound is played into the call. The parameter is optional, the default value is Speaker. Example Play user sound 1 if the event defined on row 2 arises: Action.
Action.StopMulticastSend The StopMulticastSend block defines the stopping action for audio stream sending to a multicast IP address. Parameters Event – define the event to launch this action. Condition – define the condition to be met for the action to be executed. This parameter is optional. Channel – define the channel number (1-4) to be controlled. Example Stop audio stream sending via channel 1 if the event defined on row 2 arises: Action.StopMulticastSend: Channel=1; Event=2 Action.
Action.StartMulticastRecv: Chanel=1; Address=239.0.0.1; Port=10000 Action.StopMulticastRecv The StopMulticastRecv block defines the stopping action for audio stream receiving to a multicast IP address. Parameters Event – define the event to launch this action. Condition – define the condition to be met for the action to be executed. This parameter is optional. Channel – define the channel number (1-4) to be controlled.
The parameter is optional, the default value is 1. Example Switch the video signal source to the first external analogue camera input if the event defined on row 2 arises: Action.SetCameraInput: Type=internal; Id=1; Event=2 Action.ControlRtpStream Block ControlRtpStream defines the action that controls the flow of the RTP streams. This action controls only call streams; multicast streams are not affected by this action. Parameters Event – define the event to launch this action.
Parameters Event – define the event to launch this action. Condition – define the condition to be met for the action to be executed. This parameter is optional. Example Send a syslog message with captured event 2 (Event.CardEntered) if the event defined on row 2 arises: Action.LogEvent: Event=2 Sent syslog message format: LOCAL0.DEBUG: Jan 10 12:49:14.305 ACT: aut_action_logevent_callback(): Logged event 'CardEntered' Action.SendEmail The SendEmail block defines the action that sends an email.
5. Conditions 2N® Helios IP Automation defines the following types of conditions: ProfileState – time profile state CallState – current call state InputState – digital input state LogicalAnd – logical AND of conditions LogicalOr – logical OR of conditions LogicalNot – condition negation True – always true condition False – always false condition FlipFlopD – D-type flip-flop FlipFlopRS – RS-type flip-flop See below for details on the conditions and their parameters and use. Condition.
Example The condition is met for inactive time profile 1: Condition.ProfileState: Profile=1; State=Inactive Condition.CallState The CallState block defines the condition to be met in the case of a defined state of the currently made call. Parameters State – define the call state. Valid values: idle – call is not being made connecting – call setup in progress ringing – ringing in progress connected – call connected. Direction – define the call direction.
Parameters Input – define the digital input. Valid values: tamper – tamper switch 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. Level – define the required digital input level. The parameter is optional. Valid values: 0 – logic 0 1 – logic 1 (default value).
Condition.LogicalOr The LogicalOr block helps you create groups of conditions. The block is fulfilled if one condition at least of the defined group is met. Parameters Condition – define the list of conditions to be met. Separate the conditions with a comma. Example The condition is met if conditions 1, 2 or 3 are met: Condition.LogicalOr: Condition=1, 2, 3 Condition.LogicalNot The LogicalNot block defines the condition to be met in case another defined condition is not met.
Example The condition is always met: Condition.True Condition.False The False block defines the condition not to be met any time. Parameters There are no parameters in the False block. Example The condition is always not met. Condition.False Condition.FlipFlopD The FlipFlopD block is a one-bit memory cell (variable), which records the state of another condition at the moment of rise of the defined event for later use.
Example The state of the condition is identical with the state of condition 2 at the rise of event 1: Condition.FlipFlopD: ClockEvent=1; Condition=2 Condition.FlipFlopRS The FlipFlopRS block is a one-bit memory cell (variable), whose state changes to 1 or 0 at the rise of defined events. The FlipFlopRS output can be used as a condition for action control in rather complex 2N® Helios IP Automation applications. It is a simulation of an RS-type flip-flop circuit.
6. Available Digital Inputs and Outputs In this section, the digital inputs and outputs available on each 2N® Helios IP model are described.
2N® Helios IP Force/Safety Outputs relay1 – relay output on basic unit output1 – active digital output on basic unit (for board version 555v3 and higher, active digital output is connected with relay output 1 in 555v2 boards) relay2 – relay output on additional switch (if installed) output2 – active digital output on additional switch (if installed) cr_relay1 – relay output on card reader (if installed) cr_output1 – active digital output on card reader (if installed) led_secured – red LED indicator on card
2N® Helios IP Audio/Video Kit Outputs relay1 – relay output output1 – digital output 1 output2 – digital output 2 led1 – LED 1 control output led2 – LED 2 control output led3 – LED 3 control output Inputs input1 – digital input 1 input2 – digital input 2 2N® Helios IP Verso Basic Unit Outputs out1 - digital output relay1 - relay output Inputs in1 – digital input on basic unit I/0 Module The inputs / outputs are addressed as ., e.g. module5.relay1.
Inputs in1 – digital output 1 in1 – digital output 1 tamper – tamper switch (if installed) Wiegand Module The input is addressed module2.tamper as follows: ., e.g. The module name is configured in the Module name parameter in the Hardware / Extenders menu. Inputs tamper – tamper switch (if installed) 2N® TELEKOMUNIKACE a.s., www.2n.
7. Examples of Use Calling to Dispatching Office in Case of Unauthorised Door Opening Specification Call the selected telephone number whenever the tamper switch gets disconnected (device opened). Block diagram The rising edge on the tamper input (1: Event.InputChanged) initiates calling to the defined telephone number (2: Action.BeginCall). Intercom settings 1: Event.InputChanged: Input=tamper 2: Action.BeginCall: Number=1111; Event=1 2N® TELEKOMUNIKACE a.s., www.2n.
Calling to Dispatching Office in Case of Unauthorised Door Opening with Service Code Blocking Option Specification Call the selected telephone number whenever the tamper switch gets disconnected (device opened). Enable blocking and re-enable numeric code alarm entered from the intercom keypad. Block diagram The rising edge on the tamper input (1: Event.InputChanged) initiates calling to the defined telephone number (5: Action.BeginCall) in case the defined condition is met. The condition (4: Condition.
Door Opening by RFID Card Specification Activate the door contact switch by tapping/swiping the proper RFID card on/through the reader. Block diagram Entering an RFID card with the defined ID (1: Event.CardEntered) activates switch 1 (2: Action.ActivateSwitch). Intercom settings 1: Event.CardEntered: Card=0*0000 2: Action.
Intercom settings 1: Event.InputChanged: Input=input1; Edge=rising 2: Event.Delay: Delay=120 s; StartEvent=1 3: Condition.InputState: Input=input1; Level=1 4: Action.BeginCall: Number=1111; Event=2; Condition=3 LED Flashing during Call / Electric Door Lock Opening Specification Enable LED flashing during an active call. Block diagram Enable LED flashing by a combination of the periodic timer (1: Event.Timer) and delay (2: Event.Delay).
Intercom settings 1: Event.Timer: Period=250 ms 2: Event.Delay: Delay=125 ms; StartEvent=1 3: Condition.CallState: State=Connected 4: Action.SetOutput: Output=led1; Level=1; Event=1; Condition=3 5: Action.SetOutput: Output=led2; Level=0; Event=2 2N® TELEKOMUNIKACE a.s., www.2n.
2N TELEKOMUNIKACE a.s. Modřanská 621, 143 01 Prague 4, Czech Republic Phone: +420 261 301 500, Fax: +420 261 301 599 E-mail: sales@2n.cz Web: www.2n.cz 1911v1 2N® TELEKOMUNIKACE a.s., www.2n.
