AN-123 - AQURA - Configure Espa in & Espa Out Module

16 Configure Espa In & Espa Out plugins
THC_NTFY
Exported on 10/03/2022

THC_NTFY – 16 Configure Espa In & Espa Out plugins
Table of Contents
1 Version History ..................................................................................................... 3
2 Introduction ......................................................................................................... 4
2.1 In/Out..........................................................................................................................................4
2.2 Limitations .................................................................................................................................4
3 Configuration ....................................................................................................... 8
3.1 Per module .................................................................................................................................8
3.1.1 Espa In & Out ............................................................................................................................................................ 9
3.1.1.1 Serial port ................................................................................................................................................................. 9
3.1.2 Espa In .................................................................................................................................................................... 10
3.1.3 Espa Out ................................................................................................................................................................. 10
3.1.4 User properties....................................................................................................................................................... 11
3.2 Per scenario..............................................................................................................................11
3.2.1 Espa Out ................................................................................................................................................................. 11
– 2
1 Version History
Version Changes
2.8 Added description of new ESPA out functionalities: "Repeat interval",

"Confirmation timeout", "Display message when the story stops"
Added section "Introduction/Limitations".
Version History – 3

2 Introduction
2.1 In/Out
There are two separate plugins:
Use the Espa In plugin to receive messages from an Espa station over a serial connection.
Use the Espa Out plugin to send messages to an Espa station over a serial connection.
2.2 Limitations
• Espa messages have a maximum size of 128 characters. Longer messages are truncated.
• The Espa protocol uses the ISO/IEC 646 character set (ASCII).
Text in the Espa messages need to comply with the range of characters in this character set.
Control characters as well as characters beyond 0x7F are mapped onto (one or multiple) characters in the
table.
ISO/IEC 646(-INV)
0x0 NU SO ST ET EO EN AC BE
0-0x L1 H2 X3 X4 T5 Q6 K7 L8 BS9 H LF11 VT12 FF13 C SO15 SI16
0F T10 R14

1 https://en.wikipedia.org/wiki/Null_character
2 https://en.wikipedia.org/wiki/Start_of_heading
3 https://en.wikipedia.org/wiki/Start_of_text
4 https://en.wikipedia.org/wiki/End_of_text
5 https://en.wikipedia.org/wiki/End_of_transmission_character
6 https://en.wikipedia.org/wiki/Enquiry_character
7 https://en.wikipedia.org/wiki/Acknowledge_character
8 https://en.wikipedia.org/wiki/Bell_character
9 https://en.wikipedia.org/wiki/Backspace
10 https://en.wikipedia.org/wiki/Horizontal_tabulation
11 https://en.wikipedia.org/wiki/Line_feed
12 https://en.wikipedia.org/wiki/Vertical_tabulation
13 https://en.wikipedia.org/wiki/Form_feed
14 https://en.wikipedia.org/wiki/Carriage_return
15 https://en.wikipedia.org/wiki/Shift_out
16 https://en.wikipedia.org/wiki/Shift_in
Introduction – 4
0x1 DL DC DC DC DC NA SY ET CA SU ES
0-0x E17 118 219 320 421 K22 N23 B24 N25 E B27 C28 F G RS US32
26
1F M S29 S30 &31

0x2 !34 "35 #36 $37 %38 &39 '40 (41 )42 *43 +44 ,45 -46 .47 /48
33
0-0x SP
2F
0x3 049 150 251 352 453 554 655 756 857 958 :59 ;60 <61 =62 >63 ?64
0-0x
3F
17 https://en.wikipedia.org/wiki/Data_link_escape
18 https://en.wikipedia.org/wiki/Device_Control_1
22 https://en.wikipedia.org/wiki/Negative_acknowledge_character
23 https://en.wikipedia.org/wiki/Synchronous_idle
24 https://en.wikipedia.org/wiki/End_of_transmission_block
25 https://en.wikipedia.org/wiki/Cancel_character
26 https://en.wikipedia.org/wiki/End_of_medium
27 https://en.wikipedia.org/wiki/Substitute_character
28 https://en.wikipedia.org/wiki/Escape_character
29 https://en.wikipedia.org/wiki/File_separator
30 https://en.wikipedia.org/wiki/Group_separator
31 https://en.wikipedia.org/wiki/Record_separator
32 https://en.wikipedia.org/wiki/Unit_separator
33 https://en.wikipedia.org/wiki/Space_character
34 https://en.wikipedia.org/wiki/!
35 https://en.wikipedia.org/wiki/%22
36 https://en.wikipedia.org/wiki/Number_sign
37 https://en.wikipedia.org/wiki/$
41 https://en.wikipedia.org/wiki/(
42 https://en.wikipedia.org/wiki/)
43 https://en.wikipedia.org/wiki/*
44 https://en.wikipedia.org/wiki/%2B
45 https://en.wikipedia.org/wiki/,
46 https://en.wikipedia.org/wiki/-
47 https://en.wikipedia.org/wiki/Full_stop
48 https://en.wikipedia.org/wiki/Slash_(punctuation)
49 https://en.wikipedia.org/wiki/0
59 https://en.wikipedia.org/wiki/Colon_(punctuation)
60 https://en.wikipedia.org/wiki/;
61 https://en.wikipedia.org/wiki/Less-than_sign
62 https://en.wikipedia.org/wiki/%3D
63 https://en.wikipedia.org/wiki/Greater-than_sign
64 https://en.wikipedia.org/wiki/%3F
Introduction – 5
0x4 @65 A66 B67 C68 D69 E70 F71 G72 H73 I74 J75 K76 L77 M78 N79 O80
0-0x
4F
0x5 P81 Q82 R83 S84 T85 U86 V87 W88 X89 Y90 Z91 [92 \93 ]94 ^95 _96
0-0x
5F
0x6 `97 a98 b99 c100 d101 e102 f103 g104 h105 i106 j107 k108 l109 m110 n111 o112
0-0x
6F
65 https://en.wikipedia.org/wiki/@
66 https://en.wikipedia.org/wiki/A
67 https://en.wikipedia.org/wiki/B
68 https://en.wikipedia.org/wiki/C
69 https://en.wikipedia.org/wiki/D
70 https://en.wikipedia.org/wiki/E
71 https://en.wikipedia.org/wiki/F
72 https://en.wikipedia.org/wiki/G
73 https://en.wikipedia.org/wiki/H
74 https://en.wikipedia.org/wiki/I
75 https://en.wikipedia.org/wiki/J
76 https://en.wikipedia.org/wiki/K
77 https://en.wikipedia.org/wiki/L
78 https://en.wikipedia.org/wiki/M
79 https://en.wikipedia.org/wiki/N
80 https://en.wikipedia.org/wiki/O
81 https://en.wikipedia.org/wiki/P
82 https://en.wikipedia.org/wiki/Q
83 https://en.wikipedia.org/wiki/R
84 https://en.wikipedia.org/wiki/S
85 https://en.wikipedia.org/wiki/T
86 https://en.wikipedia.org/wiki/U
87 https://en.wikipedia.org/wiki/V
88 https://en.wikipedia.org/wiki/W
89 https://en.wikipedia.org/wiki/X
90 https://en.wikipedia.org/wiki/Y
91 https://en.wikipedia.org/wiki/Z
92 https://en.wikipedia.org/wiki/Left_square_bracket
93 https://en.wikipedia.org/wiki/Backslash
94 https://en.wikipedia.org/wiki/Right_square_bracket
95 https://en.wikipedia.org/wiki/%5E
96 https://en.wikipedia.org/wiki/Underscore
98 https://en.wikipedia.org/wiki/A
99 https://en.wikipedia.org/wiki/B
100 https://en.wikipedia.org/wiki/C
101 https://en.wikipedia.org/wiki/D
102 https://en.wikipedia.org/wiki/E
103 https://en.wikipedia.org/wiki/F
104 https://en.wikipedia.org/wiki/G
105 https://en.wikipedia.org/wiki/H
106 https://en.wikipedia.org/wiki/I
107 https://en.wikipedia.org/wiki/J
108 https://en.wikipedia.org/wiki/K
109 https://en.wikipedia.org/wiki/L
110 https://en.wikipedia.org/wiki/M
111 https://en.wikipedia.org/wiki/N
112 https://en.wikipedia.org/wiki/O
Introduction – 6
0x7 p113 q114 r115 s116 t117 u118 v119 w120 x121 y122 z123 {124 | } ~127 DE
125 126
0-0x L128
7F
• Pulling out the RS232 cable is supported: the connection is restored when cable is plugged in again.
• Closing a RS232 port is not supported. This can happen in case of:
→ Fixed port: RS232 port hardware failure.
→ USB to serial port convertor: when the convertor is pulled out.
113 https://en.wikipedia.org/wiki/P
114 https://en.wikipedia.org/wiki/Q
115 https://en.wikipedia.org/wiki/R
116 https://en.wikipedia.org/wiki/S
117 https://en.wikipedia.org/wiki/T
118 https://en.wikipedia.org/wiki/U
119 https://en.wikipedia.org/wiki/V
120 https://en.wikipedia.org/wiki/W
121 https://en.wikipedia.org/wiki/X
122 https://en.wikipedia.org/wiki/Y
123 https://en.wikipedia.org/wiki/Z
124 https://en.wikipedia.org/wiki/Left_curly_bracket
125 https://en.wikipedia.org/wiki/Vertical_bar
126 https://en.wikipedia.org/wiki/Right_curly_bracket
127 https://en.wikipedia.org/wiki/~
128 https://en.wikipedia.org/wiki/Delete_character
Introduction – 7
3 Configuration
3.1 Per module
Configuration – 8
3.1.1 Espa In & Out
3.1.1.1 Serial port

The Espa In/Out plugins use a serial port, for which the parameters can be set:
Configuration – 9
• Serial port name

The name of the serial port. Available ports are listed up.
• Serial port baud rate
Most Espa systems are configured for baudrate 9600, so this is the default.
• Serial port data bits
Most Espa systems are configured for 8 data bits, so this is the default.
• Serial port parity
Most Espa systems are configured to work without parity, so this is the default.
• Serial port stop bits
Most Espa systems are configured for one stop bit, so this is the default.
Important: the device that is being connected to needs to be configured with the same parameters.
Having different configuration parameters for the serial port will cause issues.
For some configuration parameters, this will be detected, and an error will be notified.
However, for other parameters, this cannot be detected and thus will get unnoticed.
Other parameters:
• Connection activity timeout
The connection is active when communication is detected within the given period of time. In seconds.
3.1.2 Espa In
• Espa address filter
Comma separated list of addresses.
An Espa message holds an address, to identify the system the message is meant for.
For instance, when connected to a pager system, the address is the pager's number.
The Espa plugin will only accept messages for the address in the comma separated list.
When left empty, all incoming messages are accepted.
3.1.3 Espa Out

• Pager number user property
Property of a user that holds the pager number for that user.
• Send reset call when scenario stops
A reset call is sent to the other Espa station when the story stops.
Espa insight: all of the message's properties (call address, display message, beep coding,...) remain the same,
except for the call type, which changes into reset.
• Repeat interval
For as long as a notification is active, it is repeated.
Value Behavior
<= 0 Repetition is disabled
>0 The notification is repeated each at the given rate

• Confirmation timeout
After having sent a message over Espa, Mobility waits for confirmation.
Value
<= 0 Waiting is disabled.
Configuration – 10
Value
>0 Mobility waits for confirmation for the configured number of seconds.
Espa insight: the message is confirmed by the other Espa station via a status information message.
Enable waiting for confirmation if the other system supports the Espa status information message.
If the other station doesn't support the status information message, the confirmation timeout can also be
(mis)used to introduce delays in between two repeated messages (each wait goes into timeout).
3.1.4 User properties

In order to be able to send a message to the pager of a user, the Mobility server needs to know the pager's number.
By default, a user has no field to enter this number → we need to add a custom user property for it.
This property has to be added only once for all of the users.
Once it has been added, it can be configured per individual user.
Currently a user property has to be created from within the "user edit" window.
The easiest way to do this is to click the "Add new user" button, and add user property EspaPagerNumber.
After having added the property, the pager number of all of the users can be configured.
3.2 Per scenario
3.2.1 Espa Out

Notification values for Espa Out
• Display message when the story starts
Text for the message that is sent to the other Espa station when the story starts.
• Display message when the story stops
Text for the message that is sent to the other Espa station when the story stops.
When left empty, no Espa message is sent.
• Beep code
Beep code for the message that is sent to the other Espa station when the story starts or stops.
• Priority
Beep code for the message that is sent to the other Espa station when the story starts or stops.

AN-123 - AQURA - Configure Espa in & Espa Out Module

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

AN-123 - AQURA - Configure Espa in & Espa Out Module

Uploaded by

Copyright:

Available Formats

16 Configure Espa In & Espa Out plugins

Exported on 10/03/2022

2.8 Added description of new ESPA out functionalities: "Repeat interval",

Version History – 3

3.1 Per module

3.1.1 Espa In & Out

3.1.1.1 Serial port

• Serial port name

3.1.3 Espa Out

<= 0 Repetition is disabled

>0 The notification is repeated each at the given rate

<= 0 Waiting is disabled.

3.1.4 User properties

3.2 Per scenario

3.2.1 Espa Out

You might also like