ECA ←→ EXT

SW6000 Conference Management Software, Version 6.4.1
SW6000
ECA External Control Application
@2017 Shure Incorporated
User Manual SW6000 ECA ver 6.4.1.docx
SW 6000 Conference Management Software
User Manual
Table of Contents
Max Requests (ECA  EXT) .................. 9
System Operation Mode (ECA  EXT) . 9
System Interruptability (ECA  EXT) ... 9
Speaking Too Fast (ECA  EXT) ........... 9
Voting Start/Stop (ECA  EXT) ............ 9
Status done (ECA  EXT) ......................... 9
All microphones off (ECA  EXT) ............. 9
All replies off (ECA  EXT) ....................... 9
User Validation request (ECA  EXT) ...... 9
Alert Status change (ECA  EXT) ............ 10
Speech Time Alarm (ECA  EXT) ........... 10
Commands from external RS232 to ECA 11
Request System Status (ECA  EXT) ...... 11
User Validation response (ECA  EXT) .. 11
Table of Contents ..................................................... 2
1
Introduction.................................................... 3
Licensing ............................................... 3
2
Configuring the ECA ........................................ 4
Command line parameters for the ECA ... 6
3
Starting the ECA .............................................. 7
4
RS 232 Commands........................................... 8
“Delay” command line parameter .......... 8
Commands from ECA to external RS232
device ................................................... 8
Microphone On (ECA  EXT) ............... 8
Microphone in speak (ECA  EXT)....... 8
Microphone Off (ECA  EXT) ............... 8
Request On (ECA  EXT) ...................... 8
Microphone in request (ECA  EXT) ....... 8
Request Off (ECA  EXT) ..................... 9
Max Total Speakers (ECA  EXT) ........ 9
Max Delegate Speakers (ECA  EXT) ... 9
@2017 Shure Incorporated
5
Typical schematic using ECA .......................... 12
6
Get familiar with the RS232 commands to/from
ECA ...............................................................13
User Manual SW6000 ECA ver 6.4.1.docx
SW 6000 Conference Management Software
User Manual
1 Introduction
This document describes the RS232 protocol
for communication between customer
applications and SW6000 Conference
Management Software by use of the ECA
External Control Application.
The RS232 protocol is an easy to use
protocol.
For installation of the ECA application, please
refer to the ‘Installation Manual SW6000’.
Customer applications can include but are
not limited to AMX or Crestron room control
systems, PC’s or micro controller based
applications e.g. for button mimics.
Licensing
The ECA application is included in the
SW6000 Conference Management Software
(basic) and no separate license is needed.
3
SW 6000 Conference Management Software
User Manual
2 Configuring the ECA
#
Description
Comment or picture
1. Start the ECA by clicking the ECA shortcut on the
desktop
2. A message is shown, that the ECA configuration is
not found.
Click OK
3. Select the Configure COM port
Insert the correct parameters for the ECA
application:
Select COM port from 1 to 8 that will be used
The COM ports, which are configured, will be
highlighted.
Insert the Name of the Computer, where the
database is installed
Insert the ’Default Database name’
Insert the COM Port parameters. Set Baud Rate to
fit with connected equipment. Handshake is not
used with ECA communication.
4. Click ‘Test’.
Note: If the test fails, change the setting which
failed. If the saved configuration connects to
another Com port than selected during installation,
the command line parameter for the ECA short
must be changed to the configured port. Please
refer to next point.
Click ’Save’
Click ‘Exit’
4
SW 6000 Conference Management Software
#
User Manual
Description
Comment or picture
5. If the Com port must be changed in the ECA short
cut
Right click the ECA shortcut
Select Properties
Select the ‘Shortcut’ tab
Change COM port number in the ‘Target’ line
Click “Apply”
Click “OK”
6. Start the ECA by clicking the ECA shortcut on the
desktop
7. A message is shown, that the ECA configuration is
not found.
Click OK
8. Select the Configure COM port
Insert the correct parameters for the ECA
application:
Select COM port from 1 to 8 that will be used
The COM ports, which are configured, will be
highlighted.
Insert the Name of the Computer, where the
database is installed
Insert the ’Default Database name’
Insert the COM Port parameters. Set Baud Rate to
fit with connected equipment. Handshake is not
used with ECA communication.
5
SW 6000 Conference Management Software
#
User Manual
Description
Comment or picture
9. Click ‘Test’.
Note: If the test fails, change the setting which
failed. If the saved configuration connects to
another Com port than selected during installation,
the command line parameter for the ECA short
must be changed to the configured port. Please
refer to next point.
Click ’Save’
Click ‘Exit’
10. If the Com port must be changed in the ECA short
cut
Right click the ECA shortcut
Select Properties
Select the ‘Shortcut’ tab
Change COM port number in the ‘Target’ line
Click “Apply”
Click “OK”
Command line parameters for the ECA
-W
Show a communication window (debug) when the ECA is started. Don’t use
this parameter in normal use.
-COMx
Specifies the COM port to use. COM1 to COM8 are valid entries. When the
COM port is specified, the ‘Select COM port’ popup is disabled.
-STARTUPDELAYx
Specifies a delay that the application will wait before initializing completely.
The delay x, is given in milliseconds. This is useful if the ECA shortcut is
placed in the Start-up folder in windows, giving windows time to start
services related to SQL, before the ECA starts communicating with the SQL
server
-DELAY
Please refer to the section ’RS 232 Commands’ for details
.
6
SW 6000 Conference Management Software
User Manual
3 Starting the ECA
#
Description
Comment or picture
1. Click the ECA shortcut to start the application
2. When started an ECA icon is shown in the task
bar.
If debugging is needed right click on the ECA
icon and select display
7
SW 6000 Conference Management Software
User Manual
4 RS 232 Commands
“Delay” command line parameter
As it has been experienced that external
RS232 parsers can have difficulties in
handling commands sent in quick succession
it’s possible to introduce a minimum “deadtime” between commands from the ECA.
This delay must be an integer greater than 0
and smaller than 2000 – corresponding to 2
seconds.
Important: Introducing this delay has a
severe impact on the number of messages
that can be transmitted over the RS232
interface – so it should preferably be
avoided.
To introduce this delay use the following
command line parameter on the ECA
application “-DELAYx” where x has to be a
number specifying the delay in milliseconds.
Commands from ECA to external RS232 device
The commands sent from the ECA to an
external RS232 device are described here.
The commands are all ASCII commands –
the commands should be possible to send
and receive from any terminal e.g.
HyperTerminal. Only printable characters are
used so it’s possible to use any terminal
program to key in commands and see the
response. This approach has been used to
facilitate testing and development by
customers.
The checksum can be generated by use of
the Modulus Generator which is found in
the “Miscellaneous” folder on the SW6000
CD media.
Command direction is identified using arrows
– from ECA to EXT and from EXT to ECA, as
well as both ways.
Microphone On (ECA  EXT)
!S<Seat no>:<CHKSUM><CR>
<Seat no> 1-5 ASCII bytes with the seat
number – this is equivalent to
the content in the seat table for
identifying the microphone e.g.
“50001” or “123”
Sent when microphone is switched on.
<CHKSUM>
2 ASCII characters
representing the hexadecimal
checksum calculated over the
command and seat no. In the
command “!S1234:1D” the
checksum has been calculated
this way: ‘S’=83, ‘1’=49,
‘2’=50, ‘3’=51, ‘4’=52 now the
sum is calculated sum=
83+49+50+51+52=285 mod
256 = 29 – this is written using
hex notation as 0x1D – the 2
hex characters are used put in
the command..
Sent as a response to a microphone status
request message to indicate that the
microphone is in speak.
<CR>
Microphone in speak (ECA 
EXT)
!s<Seat no>:<CHKSUM><CR>
Microphone Off (ECA  EXT)
!O<Seat no>:<CHKSUM><CR>
Sent when microphone in speak is switched
off.
Request On (ECA  EXT)
!R<Seat no>:<CHKSUM><CR>
Sent when microphone is set into request.
Microphone in request (ECA 
EXT)
Carriage return – 0x0D = 13
!r<Seat no>:<CHKSUM><CR>
8
SW 6000 Conference Management Software
User Manual
<state> may be “0” or “1”, where “1”
indicates that currently the speaking too fast
condition is active.
Sent as a response to a microphone status
request message to indicate that the
microphone is in request.
Request Off (ECA  EXT)
Voting Start/Stop (ECA  EXT)
!N<Seat no>:<CHKSUM><CR>
!V<start-stop>:<CHKSUM><CR>
Sent when microphone is switched off from
request.
Command is used for starting and stopping a
voting session, as well as indicating whether
a voting session is running.
Max Total Speakers (ECA 
EXT)
<start-stop> may be "0" or "1", where "0"
indicates the voting session is stopped and
"1" indicates the voting session is started (or
running).
!T<max spk>:<CHKSUM><CR>
Maximum number of speakers allowed to
speak.
The type of voting session, when started
from ECA, is the default one.
<max spk> Can be set to “1” to “8”
Status done (ECA  EXT)
Max Delegate Speakers (ECA
 EXT)
!D<CR>
!K<max spk>:<CHKSUM><CR>
Sent to indicate that complete status of the
microphone system has been transmitted.
Maximum number of delegates allowed to
speak.
All microphones off (ECA  EXT)
<max spk> Can be set to “1” to “8”
!F<CR>
Sent to indicate that the number of
microphones “On” is zero. This command is
only sent when the last microphone is
switched off.
Max Requests (ECA  EXT)
!Q<max req>:<CHKSUM><CR>
Maximum number of delegates allowed in
the request list. <max req> Can be set to
“0” to “255”.
Observe that sending this command is not
enabled as default – to enable this command
use the command line parameter “ALLMICOFF” on the CUI application.
System Operation Mode (ECA
 EXT)
!E<mode>:<CHKSUM><CR>
All replies off (ECA  EXT)
System operation mode possible values are:
“AUTO”, “FIFO”, “MANU”, “VOX”, “AUTOREP”, “MANU-REP” and “VOX-REP”.
!ALLREPLYOFF<CR>
Sent when the ‘All Reply Off’ button is
activated in the CUA.
System Interruptability (ECA 
EXT)
Observe that the command is send when a
conference is started or stopped.
!I<mode>:<CHKSUM><CR>
User Validation request (ECA 
EXT)
System operation mode possible values are:
“NONE”, “LOWER”, and “SAMELOWER”
!U<User id>S<Seat id>:<CHKSUM><CR>
Speaking Too Fast (ECA 
EXT)
Sent to request external validation of user
identified by <User id> using external
validation equipment e.g. fingerprint reader
identified by <Seat id>.
!P<state>:<CHKSUM><CR>
Speaking too fast indicates that speakers
should slow down to enable interpreters to
keep up.
9
SW 6000 Conference Management Software
User Manual
•
Alert Status change (ECA  EXT)
!A<status>:<CHKSUM><CR>
Send when an alert is issued or cancelled.
<status> may be “0” or “1”, where “1”
indicates the alert is active.
•
•
Speech Time Alarm (ECA  EXT)
“0” – no alarm or expiration; issued
only after another value was indicated
in a previous “!L” for this seat, and then
the microphone was switched off. It
arrives before the corresponding “!O”
notification.
“1” – alarm (if there was one set,
otherwise this value is skipped).
“2” – time expired.
When a microphone is closed, alarm state is
always reverted to value 0.
!L<status>S<Seat no>:<CHKSUM><CR>
Sent to external units to indicate current
status of speech time for the speaker seat
(podiums).
Note – this command is only sent for seats
of Podium types.
<status> may be one of the following
values:
10
SW 6000 Conference Management Software
User Manual
Commands from external RS232 to ECA
The commands issued to control
microphones are identical to the commands
that relay status from the ECA. E.g. to set
microphone seat no 7 on the command
“!S7:8A<CR>” is issued – the same
command will return from the ECA to reflect
that the microphone has actually been
switched on.
User Validation response (ECA
 EXT)
!U<User id>S<Seat id>R”<Validation
response>”:<CHKSUM><CR>
This command should only be sent as
response to a user validation request. <User
id> and <Seat id> should be identical to
what was included in the user validation
request. <Validation response> should have
one of the following values:
Request System Status (ECA 
EXT)
?D<CR>
•
Sending this command will cause the ECA to
transmit the current status of the system as
a series of commands for max speakers,
max total speakers, max requests, operation
mode and a series of microphone in speak
and microphone in request commands.
When the ECA has transmitted all pending
status information the Status done command
is received.
•
•
Observe that activity during a status request
may cause e.g. speak on commands to be
transmitted before all microphones in speak
commands have been issued – this should
not cause problems as the two commands
use a different syntax.
•
•
11
“Verified” – used when external
verification equipment is able to verify
the presence of the user at the
specified seat
“Failed” – used when external
verification equipment evaluates user
and evaluation is negative – e.g. wrong
fingerprint.
“Seat unknown” – used when external
verification equipment has no entries
for this seat.
“User unknown” – used when external
verification equipment has no entries
for this user.
External validation system may use
other string up to 25 characters long to
describe other error situations – string
must not include character <“>.
SW 6000 Conference Management Software
User Manual
5 Typical schematic using ECA
12
SW 6000 Conference Management Software
User Manual
6 Get familiar with the RS232 commands
to/from ECA
This section describes how to test the ECA commands using a second PC and Microsoft Terminal
program.
#
Description
1
Connect the PC with the ECA installation
to a second PC with a null-modem cable.
2
Start the Microsoft Terminal program on
both PCs from
Start/Programs/Accessories/
Communications/HyperTerminal.
3
Enter a name and choose an icon for the
connection.
4
Select the proper COM port.
Comment or picture
13
SW 6000 Conference Management Software
#
Description
5
Configure as shown to the right.
User Manual
Comment or picture
Press OK.
6
Open Properties in the File menu.
Selects Settings tab.
Press ASCII Setup.
14
SW 6000 Conference Management Software
#
Description
7
Set the ACSII setup as shown to the
right on both PCs.
8
Check that communication is working
between the two PCs. If this is not the
case, one of the settings is incorrect or
the cable is defective.
9
When the communication is working
close the HyperTerminal program on the
PC with the ECA installation.
User Manual
Comment or picture
10 Configure the ECA application as
explained in the Installation Manual.
15
SW 6000 Conference Management Software
#
User Manual
Description
Comment or picture
11 Make a shortcut to the ECA, select
properties and set the command line
parameters as shown if you are using
COM1. If not type in the COM port in
use.
The –W parameter brings up a window.
Remember to make a space between the
two commands.
12 Start the ECA application using the short
cut.
16
SW 6000 Conference Management Software
#
User Manual
Description
Comment or picture
13 Check that you receive messages in the
terminal window and check that you can
send messages.
17
www.shure.com
United States, Canada, Latin
America, Caribbean:
Shure Incorporated
5800 West Touhy Avenue
Niles, IL 60714-4608
USA
Europe, Middle East, Africa:
Asia, Pacific:
Shure Europe Gmbh
Jakob-Dieffenbacher-Str. 12
75031 Eppingen
Germany
Shure Asia Limited
22/F, 625 King's Road
North Point, Island East,
Hong Kong
Phone: +1 847 600 2000
Fax: +1 847 600 1212 (USA)
Fax: +1 847 600 6446
Email: info@shure.com
Phone: +49 (0) 7262-9249-100
Fax: +49 (0) 7262-9249-114
Email: info@shure.de
Phone: (+852) 2893-4290
Fax: (+852) 2893-4055
Email: info@shure.com.hk
Download PDF