5. Logged Events

This subsection includes a list of events to be stored in the 2N Helios IP log and specifies the transfer format via the Notify and GetMessagesResponse messages.

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

KeyPressed

The KeyPressed event is generated whenever a key is pressed on the device.

<event2n:Msg>
 <event2n:Id>{RECORD_ID}</event2n:Id>
 <event2n:Timestamp>{TIMESTAMP}</event2n:Timestamp>
  <event2n:EventName>event2n:KeyPressed</event2n:EventName>
  <event2n:Data>
    <event2n:Key>{KEYCODE}</event2n:Key>
  </event2n:Data>
</event2n:Msg>

Event Parameters

RECORD_ID

Event serial number.

TIMESTAMP

Event date and time; refer to the Format of Selected Parameters.

KEYCODE

Code of the key pressed. Applicable values:

  • 0, 1, …, 9, *, # – numerical keypad buttons
  • %1..%54 – call buttons

KeyReleased

The KeyReleased event is generated whenever a key is released on the device. 2N® Helios IP Vario generates this event immediately after event KeyPressed.

<event2n:Msg>
 <event2n:Id>{RECORD_ID}</event2n:Id>
 <event2n:Timestamp>{TIMESTAMP}</event2n:Timestamp>
  <event2n:EventName>event2n:KeyReleased</event2n:EventName>
  <event2n:Data>
    <event2n:Key>{KEYCODE}</event2n:Key>
  </event2n:Data>
</event2n:Msg>

Event Parameters

RECORD_ID

Event serial number.

TIMESTAMP

Event date and time; refer to the Format of Selected Parameters.¨

KEYCODE

Code of the key released. Applicable values:

  • 0, 1, …, 9, *, # – numerical keypad buttons
  • %1..%54 – call buttons

CallStateChanged

The CallStateChanged event is generated whenever a change of the currently made call occurs.

<event2n:Msg>
  <event2n:Id>{RECORD_ID}</event2n:Id>
  <event2n:Timestamp>{TIMESTAMP}</event2n:Timestamp>
  <event2n:EventName>event2n:CallStateChanged</event2n:EventName>
  <event2n:Data>
    <event2n:State>{STATE}</event2n:State>
    <event2n:Direction>{DIRECTION}</event2n:Direction>
  </event2n:Data>
</event2n:Msg>

Event Parameters

RECORD_ID

Event serial number.

TIMESTAMP

Event date and time; refer to the Format of Selected Parameters.

STATE

Event type specification. Applicable values:

  • ringing – ringing
  • connected – call connected
  • terminated – call terminated

DIRECTION

Call direction. Applicable values:

  • incoming – for incoming calls
  • outgoing – for outgoing calls

CardEntered

The CardEntered event is generated whenever a card is applied to the RFID card reader connected to the device.

<event2n:Msg>
  <event2n:Id>{RECORD_ID}</event2n:Id>
  <event2n:Timestamp>{TIMESTAMP}</event2n:Timestamp>
  <event2n:EventName>event2n:CardEntered</event2n:EventName>
  <event2n:Data>
    <event2n:Card>{CARD}</event2n:Card>
    <event2n:Valid>{VALID_FLAG}</event2n:Valid>
    <event2n:Reader>{READER_ID}</event2n:Reader>
    <event2n:Direction>{DIRECTION}</event2n:Direction>
 </event2n:Data>
</event2n:Msg>

Event Parameters

RECORD_ID

Event serial number.

TIMESTAMP

Event date and time; refer to the Format of Selected Parameters.

CARD

Detected card identification with a 24-64-bit number in the hexadecimal format, e.g. 54A86B87C5. 

VALID_FLAG

If the detected card is valid, the parameter value is true. If not, the parameter is set to false.

READER_ID

Card reader identification. Applicable values:

  • internal_cardreader – internal card reader at 2N® Helios IP Vario, 2N® Helios IP Force.
  • external_cardreader – external card reader connected via Wiegand interface at 2N® Helios IP Vario, 2N® Helios IP Force.
  • Module Name – for 2N® Helios IP Verso card reader ID is configured in menu Hardware / Extenders / Modules, parameter Module Name for used card reader.

DIRECTION

Inteded direction of a person configured in an intercom. Applicable values:

  • In – for incoming people.
  • Out – for outgoing people.
  • Unspecified – not specified.

CodeEntered

The CodeEntered event is generated whenever a numerical code is entered and confirmed via the device keypad.

<event2n:Msg>
  <event2n:Id>{RECORD_ID}</event2n:Id>
  <event2n:Timestamp>{TIMESTAMP}</event2n:Timestamp>
  <event2n:EventName>event2n:CodeEntered</event2n:EventName>
  <event2n:Data>
    <event2n:Code>{CODE}</event2n:Code>
    <event2n:Valid>{VALID_FLAG}</event2n:Valid>
  </event2n:Data>
</event2n:Msg>

Event Parameters

RECORD_ID

Event serial number.

TIMESTAMP

Event date and time; refer to the Format of Selected Parameters.

CODE

Numerical code entered, e.g. 1234.

VALID_FLAG

If the entered code is valid (matches the 2N  Helios IP valid codes), the parameter value is true. If not, the parameter is set to false.

DeviceState

The DeviceState event is generated whenever any of the selected device state changes occurs.

<event2n:Msg>
  <event2n:Id>{RECORD_ID}</event2n:Id>
  <event2n:Timestamp>{TIMESTAMP}</event2n:Timestamp>
  <event2n:EventName>event2n:DeviceState</event2n:EventName>
  <event2n:Data>
    <event2n:State>{STATE}</event2n:State>
  </event2n:Data>
</event2n:Msg>

Event Parameters

RECORD_ID

Event serial number.

TIMESTAMP

Event date and time; refer to the Format of Selected Parameters.

STATE

Event type specification. Applicable values:

  • startup  – event generated upon device start