AEOS Message Mapper Installation & Configuration Manual English
AEOS Message Mapper Installation & Configuration Manual English
EN
23-10-2017 7 Lay-out
23-08-2017 6 Added section 3.6 - example 6 Datalogic barcode scanner
13-04-2016 5 Typo fix in picture section 4.2, new logo and icons
26-02-2016 4 Example with showing information on Alenco display added
21-04-2009 3 Free CAP fields and Export/Import (and document history) added
…
1 New document
Contents
1. INTRODUCTION 4
3. APPLICATION EXAMPLES 12
MESSAGE MAPPER EXAMPLE 1: SENT DATA (AEOS 2.2.1) 12
MESSAGE MAPPER EXAMPLE 2: SENT AND RECEIVE DATA (AEOS 2.2.1) 14
MESSAGE MAPPER EXAMPLE 3: PAGER SERVER (AEOS 2.2.5) 15
3.3.1. AEBC PROPERTIES: 17
MESSAGE MAPPER EXAMPLE 4: PAGER SERVER (AEOS 2.3.2) 19
MESSAGE MAPPER EXAMPLE 5: ALENCO DISPLAY 21
3.5.1. CONFIGURATION 21
3.5.2. SET DATA AT THE CORRECT LOCATION ON THE DISPLAY 23
MESSAGEMAPPER EXAMPLE 6: DATALOGIC BARCODE SCANNER. 25
3.6.1. SCANNER CONFIGURATION 25
3.6.2. AEPU CONFIGURATION 25
3.6.3. MESSAGE MAPPER 26
3.6.4. GENERAL 30
1. Introduction
Detailed and latest information about the Message Mapper AEbcs can be found in the document:
AEbc Message Mapper Descriptions.
In this document several examples are given, using different AEOS versions. Pay attention that
the possibilities of the Message Mapper are depending on the used AEOS version.
Translate and
“Map”
Message
Mapping
AEbcs
The translation and Mapping of commands to actions is done by the Message Mapping AEbcs.
This category AEbcs can be divided into two different parts:
• Message Mapper AEbcs
o Generic Message Mapper (IOServer )
Generic Message Mapper for both Serial and IP commands
o IntercomServer
Message Mapper to communicate with an Intercom Server
o VideoServer
Message Mapper to communicate with a video server
o PagerServer
Message Mapper to communicate with a pager system
• At the start-up of the AEpu some initial strings can be sent to the connected device
The received strings and data to be sent is all entered at the Properties of these AEbcs. The
Message Mapper AEbcs are capable of both sending and receiving data.
With the Message Mapper AEbcs it is easy possible to interface with other systems, and to inform
those systems about the status of the AEOS components, in which variable data, such as badge
data can be included.
Message Mappers can be deployed on normal (hardware AEpus) and virtual AEpus (on a PC) for
bigger configurations which need more processing power.
The Label names are connected to the LabelValueToOutput or InputToLabelValue AEbcs to get the
interface with other AEbcs or hardware.
101
02
2
03
3
Sequence:
01 The AEpu starts
02 The AEbc sends all the Commands to the connected AEpack
03 The Commands are sent to the device using the defined communication protocol
The commands are sent sequential as defined in the AEbc, the command at the top as
first.
03
02
05
Sequence:
With this example in steps is shown how the change of an input results in sending a command to
the connected device:
02 Via the AEpack this hardware input is linked to the InputToLabelValue AEbc, in which for in1
a label (“string”) is defined (e.g., Start Recording)
03
The labels belonging to the input are at each change of
this input sent to the output of this AEbc (outda1), both
as the input becomes active and passive.
At the Message Mapper AEbc Properties the Outputs
are defined for each change of the received labels and
their state change (as the input becomes active and/or
passive) commands can be defined):
• post1 begin: active Command 004000F201F20380 must be sent
• post1 begin: passive Command 004000F201FFFF80 must be sent
• post1 begin: active Command 00400044440004A3 must be sent
• post1 begin: passive Command 00400044440000A3 must be sent
In this case two commands are sent as the post1 begin becomes active.
The AEbc sends all the Commands to the connected AEpack
As soon as a label with its state change is received, the command(s) belonging to this label
and its state are sent to the output (iser) of this AEbc.
05 The command(s) is received by the connected device and this device handles this command
• For each label at the Message Mapper AEbc (e.g., IntercomServer) command(s) can be
defined for the input getting active and command(s) for the input getting passive.
• On each change of an input more than one command can be defined.
• If more than one command is defined, the commands are sent in logical sequence as
they have been defined at the AEbc.
• There is ‘no’ limitation for the amount of commands to be sent.
04
03
02
01
Sequence:
02 The AEpack sends this command to the Message Mapper AEbc (in this case the IntercomServer).
At the Message Mapper AEbc for each command that can be received from the external device
a label and a state is to be defined. At receiving a command, the AEbc is checking the defined
commands, at the associated command the label and state belonging to this command is sent
to the output (outda1)
04 At the Properties of this LabelValuetoOutput AEbc, enter a value for each logical output of this
AEbc (Output 1 label ... Output 8 label). For Output 1 label in this example: manual-UL-start.
At the LabelValueToOutput the received labels are compared against the here defined
values. If they match the corresponding output will be changed, according to the state of the
label that is received.
05 The state of the output is linked to another AEbc or as in this example directly to a physical
output
The correct state of the output is sent in this example to the AP1001
• Command 005B002222FFFF41 received: the label manual-UL-start becomes
active
Results that Out 1 becomes active
• Command 005B002222FFFF40 received: the label manual-UL-start becomes
passive
Results that Out 1 becomes passive
With AEOS version 2.3.2 a time can be stated in the properties for automatically make the
output passive after the stated time (Output x activation time).
1. The commands are read sequential as defined in the Message Mapper AEbc, this can
result that more than one action can be performed upon one received command.
2. For the Message Mapper AEbc you both have to define if an output becomes active
and passive, otherwise the output will never return to default. (With version 2.3.2 an
output activation time can be stated.)
1. Both noa (No Authorised) outputs are OR-ed to the in1 of the InputLabelToValue.
2. This succeeds in the label post1 begin is sent to the IntercomServer.
3. The Intercom for the antenna where the unauthorized badge is been offered is activated
by the command received from the IntercomServer.
4. After the conversation between the person of the unauthorized badge and the guard or
receptionist the ‘Open button’ on the Intercom system is activated.
5. The IntercomServer receives the command belonging to the activation of the ‘Open
button’. (Also a command is received as soon as the button is released)
6. Using the LabelValueToOutput the maul (manual unlock) of the AccessPoint is activated
and the door is opened.
1. The Intercom Message Mapper is specially developed for the Commend GE intercom
systems (Commend International GmbH).
2. When composing a Commend message, the string is automatically added with correct
checksum. See example beside.
3. Application examples
Below only a view examples are given. Many other applications can be build; e.g., sending
variable data to a serial port on the AEpack including Badgenumber or Not Authorised reasons.
Even a link made to the Socket Interface on the AEpu (version 2.3) is possible to check certain
data, optionally combined with substitution options. In case of request or more information
contact Nedap.
The TCP settings are made at IOServer.1 and LabelValueToOutput.1 (see Properties below):
Following commands are programmed:
• a: RY1 is activated
• A: RY1 passive
• b: RY2 is activated
• B: RY2 passive
• on: UL is activated
• off: UL passive
The commands are given at TCP protocol with server event port 4001. The outgoing protocol is
disabled the message mapper is only listening to commands, no commands are sent.
For TCP connection: Open a dosbox and enter telnet <aepuname> 4001:
The serial settings are made at IOServer.2 (see Properties below). It receives its data direct from
LabelValueDemux (all data received by this AEbcs input is transmitted to all outputs)
On RS232 connection with HyperTerminal 9600,8,n,1: following text will show regarding the
action given at the TCP protocol:
• RY1 on: after sending the a and RY1 becomes active
• RY1 off: after sending the A and RY1 becomes passive
• RY2 on: after sending the b and RY2 becomes active
• RY2 off: after sending the B and RY2 becomes passive
• INIT …. after deploy/ start AEpu
The RS232 line (iser) is connected to the AEpack AP1001’s serial channel.
Dataflow:
• On TCP terminal command is entered: e.g. b
• b is received at IO.Server.1 and looked up in the Inputs (Messages from device) part.
• if b is received, label out2 with state active must be sent to output (outda1) of this AEbc.
• The AEbc LabelValueDemux sents all received input to all outputs (outda1 ... outda4)
o At LabelValueToOuput the received string is checked against its Properties:
out2 is filled in at Output 2 label, so out2 of this AEbc is changed to the received
state (active), resulting that RY2 of the AP1002 becomes active.
o At IO.Server.2 a string out2 with its state is received (something is to be sent to
the external device) and looked up in the Outputs (Messages to device) part.
Behind the out2 – active the command RY2 on is found, and this command (text)
is sent to the output.
• At starting up (or reboot) the AEpu the Commands in the Syncs part are sent to the serial
port.
HyperTerminal is connected to the serial RS232 port of the AP1001, as settings are used:
9600,n,8,1.
TCP connection: Open HyperTerminal on the receiving PC: Connect To: Host address
<aepuname> or <address>, Portnr: <remote event port>, connect using: TCP/IP (Winsock). After
OK: a message can come Unable to connect to <name> port <remote event port>, go to top menu:
Call and activate Wait for a call. Now HyperTerminal is ready to receive the data.
Dataflow:
• Due to an action on the Access Point one (or more) of the logical outputs are activated.
(For example the unl output, for unlocking the door.)
• At the InputToLabelValue the in1 is connected to the unl output of the StandardDoor.1. At
the Properties of the InputToLabelValue for the Input 1 Label the string unl is
programmed.
• Unl of the StandardDoor.1 becomes active, in1 of the InputToLabelValue becomes active.
The string entered in the properties of the InputToLabelValue and its state (unl – active) is
sent to outda1 of this AEbc.
• On this outda1 two IOservers (inda1) are connected:
o IOserver.1 is used for the serial communication
o IOserver.2 is used for the TCP communication
At the part Outputs (Messages to device) the received string and its state are looked up,
and the string behind the match(es) will be sent (Authorised Badge).
1. In this example only messages are generated if the output of the StandardDoor
becomes active.
2. With this example you can easily make different messages for the Serial and the TCP
connection (because they are different IO severs).
3. At the Generic TCP Protocol the Keep outgoing socket alive is activated otherwise
after each message send the connection is closed.
Just as the other examples, below just one possibility is given. It is to the user what information
and flow is used, it is just a matter a being creative with the available AEbcs and their properties.
Serial channel
where Pager is
connected
Message is only sent if: Badge data output of all AccessPoints Pager Server is connected
- Door is Open is combined in the BadgeMux. At the by the Serial port of one
AND BadgeToString is determined what of the AEpacks to the
- Authorized badge is detected part and how the badge data must be communication port of
OnDelay is needed to be sure that other data included in the string to be sent the Pager Equipment
(badge data) is available at the Pager Server
The BadgeToString (by the BadgeMux) receives the badge data from both AccessPoints, this data
is sent to Strng1 of the Pager Server.
As the door is open and an authorized badge is detected (AND-2 ports), the InputToLabelValue
sends the corresponding data to inda1 of the Pager Server. This triggers the Pager Server to send
the data by iser to the Serial channel of the AEpack (and to the here connected Pager system).
The Reset circuit (NOT.1, NOT.2 and XOR.1) is here used to be sure that old data is been
removed. In cases the AEpu cannot find the correct carrier corresponding data (as been
defined with the BadgeToString) this can be useful. Be sure if you want to use this Reset
circuit.
• The labels as defined in the InputToLabelValue are used to determine what must be sent
in the Pager Server (these labels must be identical as in the Pager Server Properties,
Output part, Label name).
• In the BadgeToString is determined what data must be sent. In this example the Carrier
attributes are sent at the txt output. From the Carrier attributes now the carrierName is
selected.
Properties Send badge type with badge data and Convert badge data to text are here not
important (only useful if Badge data is sent to the output).
• String input labels: For the substitution functionality: You can leave the default Label
names, but by changing them the Pager message will be more clearly to read. In this
example we use the client label to insert the Carrier name (of the Carrier attributes of a
badge) into the Pager message.
• At the IO-provider configuration the settings for the Pager unit must be sent.
• The Outputs (Message to device) generates the message, in this example:
o To pager number 12001 the message Door 1 with the client information is sent,
e.g.,
Door1 Peterson
Peterson is the owner of the badge that has been detected, this data is been
retrieved from the Carrier data (as defined in the BadgeToString). Pay attention
for using this substitution you must enter the label name between brackets, such
as: {client}.
• Link one of the free fields to (only with Is CAP field active) to CAP field Pager number
(Maintenance – Free fields – Free fields CAP assignments).
For now only one CAP free field is available that can be sent to the AEpu.
• At AEmon, with the AEbc BadgeToString at the Properties in the Carrier attribute type the
PagerNumber can be selected.
The data field as linked to the Pager number CAP field will now be used.
• At the Pager Message Mapper, the Pager number can now be selected with Use substitution.
In the example below this string is received at strng2 (Label2).
• At the announce screens the Free field data (as normally can be added). In this example the
field Call number is used as CAP data and is sent to the AEpu. With the BadgeToString this
data is as {Label2} integrated to the ESPA 444 Pager as the Pager number.
Usage of CAP data consumes AEpu memory and capacity. Be careful with CAP data for
larger systems. (Otherwise contact Nedap in case of any doubt.)
3.5.1. Configuration
In AEmon the configuration as below can be used to get the correct information on the Alenco
display.
• The NumberToString AEbc converts the data from the Counter AEbc to a string.
• The StringFormatter AEbc is used to set the number of digits always to a fixed length of 2,
e.g.:
01, 07, 15, 99, etc...
This is set by the Properties: Maximum length = 2 and Prefix = 0.
The String input ‘Strng 1’transports the data string from the StringFormatter to
the Message Mapper.
o Select as IO Server type: Alenco (IP) Multi Line Serie so this AEbc uses the correct
protocol to connect to the Alenco display.
o Enter IP-address at the Remote event host name and port number at Remote event
port.
The general settings to connect to the Alenco display are made now. Next step is to embed the
data string (as generated by the Counter AEbc) in the commands needed to place the data on the
Alenco display. This is explained below.
Setting the data on the display is controlled by the Parser control panel at the Message Mapper
Properties, when selecting the IO server type.
In this example we need to send data to the display, so the part for Outputs (Message to device)
must be filled.
• By activating the select box behind Example text the Generic Message editor opens.
• Activate Use substitution, so the value of {cnt} (the label name as defined in String input
labels) that is recurrent at input Strng 1will be used in the message. This value is received
from the Counter (and is the string the user is interested in).
• Enter the display control bytes, the message you want to display and label {cnt} to show
the value of cnt.
f1 01 f1 f2 01 f2 f3 01 f3 fb 00 00 24 08 00 fb 4e 52 2e 7b 63 6e 74 76
The data represents:
For getting the info on the upper corner of the display we use following commands:
f1 01 f1 = Methods Control, 01 for direct display the text with no effect.
f2 01 f2 = Font Control, 01 for displaying the text with Font SS7.
f3 01 f3 = Colour Control, 01 for the default colour red.
fb 00 00 24 08 00 fb = This command has got more parameters then the other commands.
Syntax: Xposition YPosition Width Height Align.
The main component in this configuration is the MessageMapper, establishing the connection to
the scanner and receiving the scanned barcode numbers from the scanner. Three label names
(UL, NA and INIT) are configured to send different messages, depending on the authorisations of
the presented identifier. A Pulse Generator and three Delays are added to clear the message on
the display after a timeout of 30 seconds. The correct settings for the Pulse Generator and the
Delays can be found in the AEbc descriptions.
(12 1b 23 34 1b 5b 32 4a 2a 2a 20 20 20 20 20 20 20 2a 2a 1b 5b 36 71 1b 5b 35 71 1b 5b 37
71 20 0d)
The data starts with a DC2 (12 hex) in order to send messages directly to the scanner, without
scanning a label.
This message will clear the last message. It starts with selecting a large font (Esc#4) and clearing
the screen (Esc[2J). This is followed by turning on the green LED (Esc[6q), waiting for 100mSec
(Esc[5q) and then turning the green LED off again (Esc[7q).
These settings are only an example. They can be changed according to the client's demands.
Make sure that the string of data always ends with a Carriage Return (0d hex).
The next settings are for the 'OK' message and LED control.
(1b 23 34 1b 5b 32 4a 3e 3e 3e 20 4f 4b 20 3c 3c 3c 1b 5b 36 71 1b 5b 35 71 1b 5b 37 71 0d)
Make sure that the string of data always ends with a carriage return (0d hex).
Below you'll find the settings for the 'Not Authorized' message:
(1b 23 34 1b 5b 32 49 6e 76 61 6c 69 64 21 21 21 1b 5b 34 71 1b 5b 38 71 1b 5b 35 71 1b 5b
35 71 1b 5b 35 71 1b 5b 35 71 1b 5b 35 71 1b 5b 35 71 1b 5b 35 71 1b 5b 35 71 1b 5b 35 71
1b 5b 35 71 1b 5b 39 71 0d)
There are several Esc [5q sequences to make the red LED light up a little longer.
Make sure that the string of data always ends with a carriage return (0d hex).
(2e 2a 5c 72)
The most important setting is Use message as label. It will send the incoming data to the output of
the message mapper. The ‘.*\r’ data is set to search for a Carriage return in the message as an end
of line. This is a so called regular expression, other parameter can be found on the internet.
(20 0d)
3.6.4. General
To avoid scanning the same label a second time, at the same entrance or another, set Anti Pass
Back and\or blocking time for this access point. This isn’t described in this document and is more
general AEOS.
01 02
03
04
01 Click on this field and filling data in enables to enter hexadecimal characters (e.g., 0D for
Carriage return, or 03 for ETX)
02 Part two is used for all readable data
03 Part 3 is the same as part two, but can be easy to copy data.
04
With Use substitution the data according to the corresponding input {badge} is substituted
at this location (Property ‘String input labels’)
Advise: Add one Label name with Command at the normal way, use the Export and copy this line
in, e.g., Excel. This gives an example how the complete line must look.
Copyright
Copyright© Nedap 2017 Contents subject to revision without
prior notice.
Nedap AEOS is a registered trademark of N.V. Nederlandsche
Apparatenfabriek ‘’Nedap’’. The information in this document is
subject to change without notice. All other trademarks belong to
their respective owners.
Disclaimer
Nedap has made every effort to ensure the accuracy of the
information contained in this document. However, Nedap makes
no representations or warranties whatsoever whether express or
implied as to the accuracy, correctness, currency, completeness or
fitness or suitability for any purpose of such information and
therefore disclaims to the maximum extent permitted by
applicable law any and all liability for any error, damage, loss,
injury or other consequence which may arise from use in any
manner of any information contained in this document. Nedap
makes no commitment to update or keep current the information
in this document and reserves the right to make improvements to
this document and/or the products described therein at any time
without notice.