How it Works
Crestron
Loading...
e-control Vote
User Manual
135 pgs734.78 Kb0

Crestron e-control Vote User Manual

CRESTRON
e-control™ Vote
(SW-VOTE)
version 1.5
© 1999, 2000 Crestron Electronics, Inc.
Crestron e-control Vote SW-VOTE
Contents
A Note on Printing This Document................................................................................................... 4
Quick Start ........................................................................................................................................ 4
A word on licensing .......................................................................................................................... 4
What is Crestron e-control™ Vote? .................................................................................................. 8
Leading Specifications ...................................................................................................................... 9
Requirements..................................................................................................................................... 9
What is the Crestron Software Server?............................................................................................ 10
System Terminology and Topology ................................................................................................ 11
Feature Summary ............................................................................................................................ 13
Installation....................................................................................................................................... 17
Licensing......................................................................................................................................... 17
Communications Setup.................................................................................................................... 21
Test Communications...................................................................................................................... 24
Additional Server Side Setup .......................................................................................................... 24
Specifying a Configuration File ...................................................................................................... 26
Creating a New Configuration File.................................................................................................. 26
Transporting a Configuration .......................................................................................................... 26
Password Access ............................................................................................................................. 27
COM Settings Configuration........................................................................................................... 28
Signal Block Configuration and Definition..................................................................................... 30
Software Server Windows and Menus ............................................................................................ 45
Database Tables............................................................................................................................... 52
The Queries table............................................................................................................................. 54
Queue scroller tables....................................................................................................................... 55
Agenda scroller tables ..................................................................................................................... 55
Vote Console operations.................................................................................................................. 57
Request-to-Speak Console operations............................................................................................. 61
Demo 1: Voting............................................................................................................................... 66
Demo 2 Request-to-Speak............................................................................................................... 66
Server Protocol................................................................................................................................68
Signal Block Definition / Activation............................................................................................... 68
Signal Block Enable / Disable......................................................................................................... 68
Signal Block Error Reporting.......................................................................................................... 68
System Connections........................................................................................................................ 70
ii •• Table of Contents Installation & Reference Guide — DOC. 5822
Crestron e-control Vote SW-VOTE
Definition of Terms......................................................................................................................... 74
String Proxies.................................................................................................................................. 74
Bit Patterns...................................................................................................................................... 74
Error Reporting ............................................................................................................................... 75
Signal Summary.............................................................................................................................. 75
Signal Reference.............................................................................................................................. 78
Serial Transmissions...................................................................................................................... 134
Signal Definitions.......................................................................................................................... 134
iii •• Table of Contents Installation & Reference Guide — DOC. 5822
Crestron e-control Vote SW-VOTE
Crestron e-control Vote
How to Use This Manual
Adobe and Acrobat are trademarks of Adobe Systems Incorporated.
A Note on Printing This Document
This Portable Document File (PDF) can be printed with Adobe Acrobat Reader. Printing from a Windows 95 platform, version 4.0 or later, is strongly recommended because the figures print poorly with earlier versions. The latest version is freely available from Adobe at http://www.adobe.com/acrobat/.
Quick Start
To see an “out-of-the-box” demonstration of Crestron e-control™ Vote as quickly as possible, turn to one of the Quick Start Guides on the next page.
You will need:
• A PC running Windows 95/98/NT
• A Crestron CNMSX-PRO control system
• A touchpanel (LC-3000, CT-3000, CT-3500, or VT-3500); and
• A programming cable (CNSP-? or equivalent)
• A null-modem cable with hardware handshaking (CNSP-532)
Follow the instructions in the guide precisely in the order given and you should be up and running in a matter of minutes.
NOTE: The demos included with this package are all compiled to two versions, a COM version for use with an RS-232 serial connection, and a TCP version for use with an Ethernet connection (the latter case requiring the CNX Gateway). The Quick Start Guides refer only to the COM versions of these programs because setting up a serial connection is far simpler. We strongly recommend getting at least one demo to work first using a serial connection. Once that works, try the TCP versions. Instructions for setting up TCP/IP communications are provided below (see “Communications Setup, Control System Side, TCP/IP,” page 22).
A word on licensing
This is a licensed software product. A license “key,” obtainable from Crestron, is required to run it. However, built into the licensing mechanism is a 15-day free trial.
4 •• How to Use This Manual Installation & Reference Guide — DOC. 5822
Crestron e-control Vote SW-VOTE
You do not need to license the software to try the demos provided you are still within the 15-day free trial period — which starts from the moment you install the product on your computer.
NOTE: The trial period of all Crestron Software Server products (SW-EMAIL, SW-DBM, SW-VOTE, etc.) all share the same trial period. That is, if you previously installed one of these products on the same computer more than 15 days ago, your free trial period for all three products has already expired, regardless of the fact that a new product has been installed. If this is the case, you can still get a free trial by installing the new product onto a different computer which has not previously had any of these products installed on it.
5 •• How to Use This Manual Installation & Reference Guide — DOC. 5822
Crestron e-control Vote SW-VOTE
Quick Start Guide 1: Request-to-Speak (demo1)
1 Install this package on your PC
Presumably, since you are reading this PDF file, you have already done this.
2 Connect a CNMSX-PRO (with touchpanel)
Connect a programming cable (CNSP or equivalent) from any COM port on your PC to the COMPUTER port on the front or back of the CNMSX-PRO control system. Connect a touchpanel to the control system set up for CRESNET ID 03.
3 Upload all control system software
The demo files can be found in the demos folder (also accessible through the Start Menu shortcut e-control Vote Demos)
Open the Crestron Viewport and establish communications with your control system. If you have not already done so, use the FileTransfer | Send Touchpanel… command to upload demovote.hex to the touchpanel at ID 03. Use the FileTransfer | Send Program… command to upload the compiled SIMPL windows file demo1COM.bin to the CNMSX-PRO. You may now close the Viewport.
4 Connect the null modem cable
Make sure pins 4, 5, and 6 are not connected.
Connect a CNSP-532 null-modem cable from COM1 on the PC to COM A on the CNMSX-PRO. (The programming cable may now be removed.)
The installer sets the server to use config file
demovote.ini.
5 Run the “server” application
Select shortcut e-control Vote Server from the Crestron folder in the Windows Start Menu. If the title bar of the window does not read “e-control Vote (SW-VOTE) Demos,” use the File | Configuration file… command to navigate to the demos folder and select the file demovote.ini.
6 Start the “server protocol”
Give the command Server | Start Server w/Signal Analyzer. (The Signal Analyzer is good for demos because it shows you the various signals going back and forth.)
7 Start the demo
On the touchpanel, touch the Start Demo button. You will see a PLEASE WAIT screen until the signal block becomes fully enabled.
8 Enter a few requests
Touch a few 1 and 2 buttons from the seven “seats.”
9 Recognize a seat!
Recognize a seat by touching a name in a queue. Recognize another seat by touching another name; force a seat to yield by touching the Yield button.
10 Options
Back out by touching Load or Save; and then Main Menu; and then Shut Down. Reconfigure the server by selecting different options in the Request button behavior frame of the Request-to-Speak Console Signal Block Definition window. These options add functionality to the seats’ request buttons. (Return to step 6.)
6 •• Quick Start Guide 1: Request-to-Speak (demo1) Installation & Reference Guide — DOC. 5822
Crestron e-control Vote SW-VOTE
Quick Start Guide 2: Voting (demo2)
1 Install this package on your PC
Presumably, since you are reading this PDF file, you have already done this.
2 Connect a CNMSX-PRO (with touchpanel)
Connect a programming cable (CNSP or equivalent) from any COM port on your PC to the COMPUTER port on the front or back of the CNMSX-PRO control system. Connect a touchpanel to the control system set up for CRESNET ID 03.
3 Upload all control system software
The demo files can be found in the demos folder (also accessible through the Start Menu shortcut
e-control Vote Demos)
Open the Crestron Viewport and establish communications with your control system. If you have not already done so, use the FileTransfer | Send Touchpanel… command to upload demovote.hex to the touchpanel at ID 03. Use the FileTransfer | Send Program… command to upload the compiled SIMPL windows file demo2COM.bin to the CNMSX-PRO. You may now close the Viewport.
4 Connect the null modem cable
Make sure pins 4, 5, and 6 are not connected.
Connect a CNSP-532 null-modem cable from COM1 on the PC to COM A on the CNMSX-PRO. (The programming cable may now be removed.)
The installer sets the server to use config file
demovote.ini.
5 Run the “server” application
Select shortcut e-control Vote Server from the Crestron folder in the Windows Start Menu. If the title bar of the window does not read “e-control Vote (SW-VOTE) Demos,” use the File | Configuration file… command to navigate to the demos folder and select the file demovote.ini.
6 Start the “server protocol”
Give the command Server | Start Server w/Signal Analyzer. (The Signal Analyzer is good for demos because it shows you the various signals going back and forth.)
7 Start the demo
Do one of the following to enable the the Voting Console:
(1) From the touchpanel, touch the Start Demo button. You will see a PLEASE
WAIT screen until the signal block becomes fully enabled.
(2) From the Voting Computer, open the Vote Proctor window by selecting the
Voting | Start Voting command from the main window.
8 Set Agenda
Select an item to vote on by touching Set Agenda on touchpanel, or by selecting an item from the combo-box in the Vote Proctor window.
9 Take a vote!
Select* Start Vote. Go to the Simulated Voting Stations Page and enter a few votes.
10 Close the floor; make a change; display results
Select End Vote. Select seat icons to adjust their votes. Select Display Results. Etc.
*
Touch button on touchpanel or click button in Vote Proctor window.
7 •• Quick Start Guide 2: Voting (demo2) Installation & Reference Guide — DOC. 5822
Crestron e-control Vote SW-VOTE
Introduction
Below, you will find introductory material on several aspects of the Crestron e-control Software Server product family, including the following specific sub­sections:
Sub-section Description Page
What is Crestron e-
control™ Vote?
Leading
Specifications Requirements What is the Crestron
Software Server? System Terminology
and Topology
Feature Summary Installation Licensing
An abstract describing the Crestron e-control Vote component of the Crestron Software Server, including a table of practical limitations.
A table summarizing Crestron products required to build an application using e-control Vote.
A section detailing minimum system requirements. page 9 Another abstract, describing the Crestron Software
Server itself. This illustrated section includes system block
diagrams. An in-depth summary of all features of the e-control
Vote server component. Brief instructions on installing the package. page 17 An explanation of the licensing requirements and
interface.
follows directly
page 9
page 10
page Error!
Bookmark
not defined.
page 13
page 17
What is Crestron e-control™ Vote?
Crestron e-control Vote (SW-VOTE) uses a Crestron control system and a PC to perform both voting and request-to-speak functions. It is licensable software which runs on the PC and communicates with Crestron control system(s) to serve the voting and request-to-speak needs of a legislative body.
NOTE: In the following table, the term “unlimited” should be read as “practically unlimited” meaning “limited only by system resources,” such as number of available control system signals, number of available indirect text fields, etc.
Table of practical limitations
Specification Range
Window sizes (pixels)
Voting Consoles
Request-to-Speak Consoles
Seats
Attendance*
Votes
Agenda item list* size Unlimited number of items Request-to-speak queues
Vote Proctor window: 1024x768, 1152x870, or 1280x1024 Vote Results window: 1024x768 (only)
One (1). The present release requires the use of the Voting Computer interface for voting, which limits operations to a single room.
Unlimited; however in the present release, all utilize the same list of seat names, again limiting operations to a single room.
Unlimited; however the Vote Results window will only display the first 80 names.
Seat signals: PRESENT, ABSENT Clerk control: PRESENT, ABSENT
Seat signals: YES, NO, ABSTAIN*, EXCUSE* (conflict-of-
interest)
Clerk control: YES, NO, ABSTAIN*, EXCUSE*, nullify a vote
Unlimited number of queues; note however that there is only
8 •• Introduction Installation & Reference Guide — DOC. 5822
Crestron e-control Vote SW-VOTE
Specification Range
room for five (5) columns (queues) across a regular 8.5”-wide paper printout.
Order in which names are recognized from queues
Times a seat can request to speak on an item
Control system signals
Items in the table above that are marked with an asterisk (*) are configuration options which may be excluded from the finished application. (Exception: The agenda item list is optional on a touchpanel interface but not an option on the Voting Computer interface.)
No particular order enforced. Seats may be recognized to speak on an item up to ten (10)
times before the queue(s) are cleared; may be set to once (1). Varies as per configuration. Make estimates using the
formulae in the following table:
Item Digital Analog Serial
Typical Request-to­Speak Console with
q queues, f files, and s seats
Voting console with
s seats each having b vote buttons
Standard Scroller (one per queue or agenda list)
10 + q + 2qs + 2f
21 + s +
bs
15 1 17
2 1 + f + q
6 + s 2 + s
Leading Specifications
The following table lists the Crestron products required to build an application using e-control Vote.
Specifications Details Version
SWSERVER.EXE
(included with this
package)
CNMS/RACK
Operating System CNMSX/RACKX
Operating System,
Monitor, and
Stack
CNX Gateway
SIMPL™ Windows VisionTools™ Pro-e Required only when designing touchpanels (if any), 2.1
Microsoft® Access
Required. Contains all the latest components although only those actually licensed will be available for use. (All components available during 15-day free trial period.)
Required for older generation racks. 3.18.12 Required. The version number at right refers to the
UPZ packages which contain all three components. Use the 51011x.upz package for CNMSX-PRO or
-AV; and 51011z.upz for CNRACKX.
Required for TCP/IP server-control system connec­tions only; not required when all connections are serial.
®
Required for programming control systems. 1.4
Required only when implementing more than sixteen (16) active request-to-speak queues (among all RTS Consoles).
1.5
5.10.11
2.08.04
Access 97
Requirements
The server should meet these minimum system requirements.
Windows 95/98/NT Operating System hardware requirements
32 MB RAM
9 •• Introduction Installation & Reference Guide — DOC. 5822
Crestron e-control Vote SW-VOTE
100 MB hard drive space 133 MHz or faster Pentium processor
A faster processor is recommended for serving multiple connections
simultaneously
COM ports
Required to make serial (RS-232) connections to control systems (one port per control system). (See Cable requirements below.)
Network Interface Card
Required to make TCP/IP connections to control systems.
TCP/IP sockets
(These are software constructs provided by your operating system. The maximum number of sockets is operating system dependent.)
Server requires one socket per server–control system connection
Required for EtherNet control system connections only. The maximum number of sockets is operating system dependent.
CNX Gateway (see below) requires one socket + one additional socket per
server–control system connection
Cables
Precise CNSP-532 specs are available in the Crestron Cable Database.
Null modem cable, Crestron model CNSP-532 or equivalent
Required for serial control system connections only. Warning: Do not use a generic null modem cable.
The term “server” should not be taken to imply a need for special­ized hardware. Any PC meeting the minimum requirements (page
9) will suffice to run the server application.
Auxiliary software
CNX Gateway
Required for TCP/IP (EtherNet) connections between the server and the control systems. Not required for serial connections.
What is the Crestron Software Server?
The actual logic involved in the functions described in the previous section is not carried out by the control systems themselves, but by the freely distributed Crestron e-control Software Server. This “server” is a software-only product which is hosted on a standard PC running Windows® 95/98 or Windows NT®. The server performs various tasks which are beyond the scope of a control system. These tasks usually involve access to and processing of large amounts of data (“large” relative to what a control system is capable of dealing with), such as:
• Exchanging data with large databases (which may be local to the server’s PC or remotely
accessed across a LAN).
• Exchanging data with other computers via the Internet (such as e-mail; and mining data
off of World Wide Web pages; etc.).
• Performing translation and report functions — and other complex logical functions — on
such data in support of specific application requirements.
The server consists of several licensable components which translate data in application-specific ways and funnel the data to and from the connected control systems. The bulk of this manual covers the specific functions provided by the SW­VOTE component.
The data from the server appears to the connected control systems as “blocks” of digital, analog, and serial signals. Separate “signal blocks” are defined in the server for each function, each of which is reflected in a control system using Intersystem Communications symbols. There are several standard types of signal blocks, all
10 •• Introduction Installation & Reference Guide — DOC. 5822
Crestron e-control Vote SW-VOTE
customizable to some extent. See “Signal Block Configuration and Definition,” page 30, for specifics.
The server is connected to each control system via either a serial cable through an RS-232 port or an Ethernet network through a LAN port. To effect the latter type of connection, the control system relies on an intermediary, the Crestron CNX Gateway, to translate communications protocols. To aid in making this clear, the following illustrated discussion of system terminology and topology should prove useful at this point.
System Terminology and Topology
The server is connected to the control system via either a serial cable through an RS-232 port or an Ethernet network through a LAN port. To effect the latter type of connection, the control system relies on an intermediary, the Crestron CNX Gateway, to translate communications protocols.
This manual simultaneously discusses several different inter-connected computer systems. To reduce confusion, throughout the manual, these systems are referred to using the terms in the following table. (Also refer to the diagrams on the next page.)
Term Explanation
The system
or the control system The server
or the software server
or the Voting Computer
The gateway
or the CNX Gateway
One of a number of Crestron control system(s), which may include any combination of the following models: CNMS,
CNRACK, CNMSX-PRO, CNMSX-AV, and CNRACKX.
The Crestron Software Server, swserver.exe, which runs on a PC under Microsoft® Windows® 95 or Windows NT®.
A communications conduit that sits between the server and the control system(s).
The control system(s) are connected to the server via direct RS-232 serial connection or via TCP/IP to the gateway and thence via TCP/IP to the server.
NOTE: “Connected via TCP/IP” means any node (computer) visible on the Local Area Network (LAN). If the LAN is connected to the Internet, this could include any node visible anywhere on the Internet. Since a node can also see itself, this implies that multiple services can run on the same machine. For example, the gateway and the server can be “self-hosted” in this way.
In the illustration that follows, the communication pathways are represented by the arrows. The physical network is not represented, however.
11 •• Introduction Installation & Reference Guide — DOC. 5822
Crestron e-control Vote SW-VOTE
System block diagram, showing communication pathways (all connections using TCP/IP):
Crestron
control system
Crestron
CNX
Gateway
Crestron
VT-3500 VT-3500 VT-3500
Software
VT-3500 VT-3500 VT-3500
Server
Database
System block diagram, showing communication pathways
(curved arrows are RS-232 serial connections; straight arrows are TCP/IP):
Crestron
control system
Crestron
control system
Crestron
control system
Crestron
VT-3500 VT-3500 VT-3500
Software
VT-3500 VT-3500 VT-3500
Server
Database
NOTE: The CNX Gateway is not necessary when using RS-232 serial communications.
TCP/IP connections between the server and the control systems require that each side of the connection be provided with the IP address of the other. This kind of connection also requires the use of the CNX Gateway which is separately licensed software that facilitates communication between the server and the control system. The CNX Gateway is typically installed on the server (when sufficient TCP/IP sockets are available) or it can be installed on any computer visible (i.e., pingable) on the TCP/IP network. There only needs to be one Gateway running on one computer to service the needs of all the computers and CNX control systems on the network. However, multiple Gateways are perfectly permissible as long as they are run on different computers.
12 •• Introduction Installation & Reference Guide — DOC. 5822
Crestron e-control Vote SW-VOTE
Feature Summary
Licensing the SW-VOTE component permits the creation and activation of the following types of signal blocks (see “Signal Block Configuration and Definition,” page 30, for more information on signal blocks):
• Voting Console signal blocks provide Operators with the ability to control, monitor,
adjust, display, and record votes.
• Request-to-Speak (RTS) Console signal blocks provide Operators with the ability to view
request-to-speak queue sets and recognize speakers.
Although the Voting Computer can simultaneously support multiple active Request­to-speak Consoles signal blocks, the present release only supports a single active Voting Console signal block. Furthermore, inasmuch as all these signal blocks use the same database table for seat names (the Members table), they are only useful when serving the needs of a single body (i.e., within a single room).
To serve the needs of multiple bodies meeting at different times, prepare alternate server configurations (each with its own database file) and switch configurations before each meeting. Switching configurations is simple, consisting of pointing to a new file with a standard file “Browse” window. You can name these files after the bodies they represent. However, it should be noted that the present release only supports switching configurations when the server is halted; and this operation must be carried out from the Voting Computer interface and is not available from a touchpanel.
In addition to — or as an alternative to — a voting console (human interface) on the control system (button panel and/or touchscreen), a full interface is also supported on the Voting Computer. Note however that this is not the case for Request-to-Speak consoles.
Voting Console signal blocks
Voting Console signal blocks accept and respond to signals from both the Operator and the individual seats in the voting chamber.
Summary of Operator functions
A Operator controls a vote from one or more of the following user interfaces, all of which may be active simultaneously:
• the PC screen using a mouse, and/or
• a Crestron touchpanel, and/or
• a hardwired control panel of buttons and tally lights (i.e., simple digital i/o)
All above user interfaces provide the following functions:
General:
• Send names
Sends the name of each seat from the Members database table
Before floor is “opened” (for a vote):
• Take attendance (all seats are assumed to be present if this step is omitted)
• Open floor to a vote (activate seats’ voting buttons)
While floor is opened:
• Close floor to further voting (deactivate voting buttons)
After floor is closed:
• Display (or redisplay) results of vote to assembly
• Abort vote before it is recorded
• Report results
13 •• Introduction Installation & Reference Guide — DOC. 5822
Crestron e-control Vote SW-VOTE
The following additional functions are only available to the PC screen or Crestron touchpanel interfaces (not available through a control panel-only interface):
Before floor is opened:
• Operator selection of a chairperson from among assembled membership (there is a
default if this step is omitted)
• Operator selection of an agenda item from a database table, or, in the case of an
impromptu vote, entered directly from the PC’s keyboard or the touchpanel’s simulated “keyboard.”
While floor is opened:
• Visual feedback of vote progress (which seats have voted, as opposed to which have not
yet voted, optionally showing how each vote has been cast)
• Provide a live tally of vote results (Yeses, Nos, Abstentions, Total votes cast, plus
number of Absentees, and number of seats excused from the present vote)
After floor is closed:
• Adjust votes (which at this point are displayed to Operator as they were actually cast),
and redisplay the results; this operation may be repeated indefinitely
Vote reporting modalities include:
• as a record added to a database table
• in a textfile
• as a print-out (optional)
• via high-resolution video display.
Summary of Seat functions
Each member’s seat has buttons for each kind of ballot they can cast, which normally would include at least
• Yes (also doubles for “present” during taking of attendance)
• No
Seats might also have the following additional buttons:
• Abstain
• Conflict (actually a Request-to-Speak button; see next section)
All vote buttons (Yes, No, and Abstain) are momentary contacts which transmit a pulse to the server. It is not necessary to worry about de-bouncing these buttons; additional pulses are ignored. Nevertheless, buttons typically display feedback to allay user anxiety about whether the system has “heard” their button press.
Feedback is not however controlled by the Voting Computer, but rather locally (by the control system). Depending on the rules of the voting body, your control system program should provide feedback to either the last vote button pressed, or to all vote buttons whenever one is pressed. In the latter case, a single Vote has been cast feedback might suffice (rather than lighting up all buttons), although after the floor has been closed, it may be desirable to go ahead and display each seat’s actual vote using the individual button feedbacks. (See the Statuss signals in the Signal Reference.)
Request-to-Speak Console signal blocks
Like the Voting Console signal block, Request-to-Speak Console signal blocks also accept and respond to signals from both the Operator and the individual seats in the voting chamber. The Request-to-Speak Console signal block automatically maintains a number of request-to-speak queues, each of which displays the order in which members have pressed their various RTS buttons to enter the queue.
14 •• Introduction Installation & Reference Guide — DOC. 5822
Crestron e-control Vote SW-VOTE
Queue sets
Each RTS signal block can support an arbitrary number of queues (called a queue set), all of which can be active simultaneously. Typically a queue set will contain at
least one queue for members to use to request time to speak on an item. Additional queues might be set up to question the speaker, to question counsel, to
raise points of order, etc. Any or all of these additional queues may be set up as dependent queues. Dependent queues are automatically cleared whenever a seat is recognized from the first queue. This feature would typically be used for a “request to question speaker” queue.
The precise state of the currently displayed queue set is implicitly saved to the database whenever a change is effected — whether by action of the Operator or any individual seat. This information, the last known state of the queue set, is automatically redisplayed upon re-enabling the signal block.
In addition, the current state of the queue set may be frozen (“put on hold”) by saving it to any of nine save files. The display might then be cleared (i.e, to open debate on a new item); or any of the save files might then be reloaded into the display (overwriting the current state — which presumably is no longer of interest or has been saved).
The information that is saved in the database includes the names in each queue in the order in which they were added to the queue and the specific states of each name. Whenever a queue set is reloaded, individual seat button feedbacks are inferred from this information and tallied back to the seats.
Note that all the queues in a queue set are saved and reloaded together. If you need to save queues separately, define separate Request-to-Speak Console signal blocks for each such queue (or sub-set of queues).
Seat marks
Before discussing specific operator and seat functions, familiarize yourself with the various possible “marks” (states) each seat can take on with regard to the Request-to­Speak functions:
Mark (state) Definition
(not in queue) Seat not in queue (button feedback dark)
WAITING
(see note)
WAITING-n
(see note)
RECOGNIZED Seat has the floor
DONE
(see note)
DONE-n
(see note)
HOLD Seat had the floor but has temporarily yielded it
EXHAUSTED
INSISTENT
Seat has requested to speak; but does not yet have the floor
Seat has already spoken n – 1 times; has requested to speak for the nth time; does not yet have the floor
Seat remains in queue after speaking (either seat yielded his time voluntarily; or was forced to yield either by Operator or by running out of time)
Seat remains in queue after speaking for the nth time
Seat has requested to speak for the nth time where n = one more than the maximum times permitted by the configuration (cannot be recognized again)
Seat has requested to speak for the nth time where n > one more than the maximum times permitted by the configuration (cannot be recognized again)
15 •• Introduction Installation & Reference Guide — DOC. 5822
Crestron e-control Vote SW-VOTE
NOTE: WAITING and DONE appear only on consoles configured for single use queues; WAITING-n and
DONE-n appear on consoles configured for re-entrant queues.
Summary of Operator functions
Through a touchpanel interface, working through the control system, the Operator has complete flexibility in recognizing seats in queues. Operator functions include:
• Send names
Sends the name of each seat from the Members database table.
• Load queue set
Reloads all queues from a previously saved file; sets feedback states of all seats’ RTS buttons.
• Recognize (a seat from a queue)
Forces previously recognized seat, if any, to yield its remaining time, if any, and killing its mic; marks selected seat as recognized; asserts its mic.
• Put a seat “on hold”
Places recognized seat “on hold”; kills its mic.
• Take a seat “off hold”
Forces recognized seat, if any, to yield its remaining time, killing its mic; asserts mic for newly recognized seat.
• Yield
Forces recognized seat to yield its remaining time; kills its mic.
• Print
Prints current state of all queues.
• Clear a queue
If queue contained recognized speaker, kills his mic; automatically clears any dependent queues as well.
• Clear all queues
Kills mic (if any active) automatically clears any dependent queues as well.
• Save queue set
Saves current state of all queues for reloading at some future date.
Speaker timer functions are not implemented in the server but are left to the control system. (See the Yield signal in the Signal Reference.)
Another popular function, printing queues whenever a queue is saved, or whenever the touchpanel leaves the RTS Console page, is also left to the control system. (See the PrintReport signal in the Signal Reference.)
Summary of Seat functions
Members have a single button for each queue. Each such button has feedback indicating the seat’s presence in the queue. Unlike the seat’s voting buttons, all request-to-speak buttons’ feedback are controlled automatically by the Voting Computer through the Request-to-Speak Console signal block.
For each queue, the functions described below are all available to each seat by momentary contact of that seat’s Request-to-Speak (RTS) button (there being one such button per queue, per seat). Functions included:
Before entering queue (button feedback is dark; mic is dead):
• Request to speak
feedback asserted; seat added to bottom of queue, marked as WAITING
In queue but not yet recognized (button feedback is hot; mic is dead):
• Cancel request to speak
seat removed from queue (loses place in queue)
16 •• Introduction Installation & Reference Guide — DOC. 5822
Crestron e-control Vote SW-VOTE
In queue and recognized (button feedback is hot; mic is hot):
• Yield remaining time
feedback goes dark; mic goes dead; seat remains in queue, marked as DONE
If the signal block is configured to allow seats to speak more than once, the following functions are also available to each seat. (In this case, the queue status symbols shown above, WAITING and DONE, would instead appear as WAITING-1 and
DONE-1.)
Done speaking (button feedback is dark; mic is dead; still in queue, marked as FINSIHED-1):
• Request to speak again
Feedback re-asserted; seat remains in queue, now marked as WAITING –2.
In queue but not yet recognized (button feedback is hot; mic is dead):
• Cancel request to speak again
Seat remains in queue, marked again as FINSIHED-1.
In queue and recognized again (button feedback is hot; mic is hot):
• Yield remaining time
Feedback goes dark; mic goes dead; seat remains in queue, now marked as DONE-2.
The specific function implied by a particular button press depends on the state of the seat vis-à-vis the queue. This state can be inferred from the following two pieces of information:
• Button feedback
Button feedbacks come from the Voting Computer; Feedbacks indicate whether or not a seat is currently in the queue.
• Has the floor (is recognized to speak)
Reflected in mic status.
Therefore, either the mic status should have a tally light of its own (at each seat), or some other display plainly visible to all seats can be used to indicate who has the floor. (Such as a large seat number display, or a public video display of the Operator’s Request-to-Speak Console screen.)
Installation
As of this writing, the Crestron Downloads page can be found at:
http://ftp.crestron.com/library/
To install the Software Server, first download the installer package from the Crestron FTP site. To do this, first go to the Crestron website and select the Downloads page. New users must register. Proceed to the ECONTROL Library. Simply click on SW-VOTE.EXE to start the download.
Once the install package arrives on your PC, double-click the icon to initiate the install. Directions for the install are provided. The package is typically installed in C:\Crestron\econtrol. During the install, the package reminds the user that a CNX Gateway is required. (This is actually only true for TCP/IP connections. Direct RS-232 connections do not require the CNX Gateway.)
Licensing
A 15-day free trial follows initial installation. If you are still within the 15-day period, you have the option to postpone licensing and skip to the next section.
17 •• Introduction Installation & Reference Guide — DOC. 5822
Both the Software Server and the CNX Gateway are a licensed products, which means that although both software packages may be freely downloaded from the Crestron FTP site, use of the software requires purchase of licenses from Crestron. Each server running the Software Server must be individually licensed. In addition, to use Ethernet, you must acquire a CNX Gateway license with sufficient connections to accommodate all servers and control systems on your network.
Crestron e-control Vote SW-VOTE
Server components are separately licensed. An SW-VOTE license must be obtained from Crestron even if other components are already in use.
Each package, once installed, generates a “Site Code” specific to the server on which it is running. Upon being provided with these Site Codes, Crestron can issue the appropriate “Site Keys,” which, once entered into each package’s licensing window, enables the full functionality of the software.
Obtaining a License
e-control Software Server – Upgrade/Transfer License window showing “unlimited” database license — shown activated (checked)
You must use the Copy button to copy the SITE CODE to the clipboard. (Copying with Ctrl+C does not work from this field.)
Open the server application. Select Server | License to open the e-control Software Server – Upgrade/Transfer License window, shown above. The license can be
obtained over the phone or via e-mail. Call Crestron Customer Support with the “Site Code” shown in the Site Code field. However, it is easier and far more reliable to copy the “Site Code” into an e-mail message addressed to license@crestron.com. Once received, Crestron Customer Support issues a “Site Key” which must either by typed or pasted into the Site Key field of the window. Once entered, click on the Update License button. If the key is valid, the licensed components appear in the list above. Before closing the License Window, be sure to activate the components you plan to use. In the above example, the user has checked the box next to SW-VOTE.
It is permissible to exit the program while waiting for a “Site Key” to be issued. The application can be restarted and the “Site Key” entered at a later time. The “Site Key” issued is only valid on the same computer. It does not work on a different computer.
The License Window of the CNX Gateway is almost identical to the above. See the documentation that comes with the Gateway package for specific instructions.
Transferring an Existing License to Another Computer
As mentioned, a license is only valid on the computer for which it was obtained. However, a license can be transferred from one computer to another without the need to contact Crestron first. There are several reasons to transfer a license. The application developer may set up the system off-site, then transfer the license to the actual computer on-site when ready. Alternatively, if the hardware or operating system on the computer where the server is licensed is upgraded, the license may
18 •• Introduction Installation & Reference Guide — DOC. 5822
Crestron e-control Vote SW-VOTE
cease to be valid, but could be transferred to another computer before the upgrade and then back to the original machine after the upgrade.
On both the source computer (where the license is currently valid) and the destination computer (where the license is to be transferred), open the server application. Select Server | License to open the e-control Software Server – Upgrade/Transfer License window (shown above). Make sure this window is active on both computers.
Step 1. On the destination computer, create a preparation file on a diskette in the A: drive by inserting a blank, formatted diskette and selecting Prepare Diskette. This creates a file on the diskette which indicates who is receiving the license. A second, backup copy of the file is also created. Alternatively, these files can be created on another portable media (e.g. Zip disc) or a network drive by simply browsing for a new file location in the save file window. If you plan to transfer via a network drive,
first make sure that both computers have the appropriate read/write access to the drive and folder being used.
Step 2. After the above step has completed, remove the diskette from the drive and insert it into the source computer’s floppy drive. Do not flip the write-protect tab; the diskette must remain write-enabled. Click on the Transfer License button. The source computer reads the preparation file to see which computer wants the license. It encodes the license for the destination and writes it back to the same file on the floppy diskette (or network drive). The source computer has now passed the license to the file. Only the designated computer can use the license, so the server is no longer licensed on the source computer.
NOTE: At this point in the transfer procedure the server license resides on a file on the diskette or network drive, and not on the computer. If this file should become lost or damaged, the license is lost as well. Because of this, please use the utmost care while performing this transfer.
Step 3. Bring the diskette back to the destination computer. Click on the Transfer License button. The computer reads the license information off the diskette and
transfers the license to itself. The server is now licensed on this machine.
19 •• Introduction Installation & Reference Guide — DOC. 5822
Crestron e-control Vote SW-VOTE
Basic Server Setup
This product requires a proper physical connection between both “sides” of the system — the server and the control system. Furthermore, the software on both sides must be properly configured. As previously discussed, the connection can be either serial via RS-232 cable or Ethernet via Local Area Network (LAN). Choose your mode of communication and refer to the following sections to make the proper physical connections and to configure the software.
The following sections include specific notes in italics for setting up the server and the control system to run the two included demo programs. Although the focus is therefore on the demos, the same basic procedures would be followed to ready the system for any other programming as well.
The files for both demos are in a folder called demos which can be located through the following Start Menu shortcut:
Start Menu
| Programs
| Crestron
| e-control Vote
| e-control Vote Demos
RS-232 is featured in the Quick Setup Guide because it is easy to set up. Because we anticipate strong interest in TCP/IP, we have pre-built both versions for your convenience.
Inside this folder there are two individual demo folders and support files:
demo1 Request-to-Speak demo demo2 Voting demo
demovote.vtp VisionTools touchpanel project file demovote.hex compiled VisionTools file demovote.ini Server’s Configuration Settings file which accommodates both demos demovote.mdb Sample database file for use with all three demos
The installer registers demovote.ini as the currently selected Configuration Settings file. (If the server’s title bar does not read “e-control Vote (SW-VOTE) Demos,” use the File | Configuration file… command to reset it.) This file configures the server for both demos.
Each demo folder contains the following files:
Demo?COM.smw SIMPL Windows project file (RS-232 version) Demo?TCP.smw SIMPL Windows project file (TCP/IP version) demo?COM.bin compiled SIMPL program code (RS-232 version) demo?TCP.bin compiled SIMPL program code (TCP/IP version)
In the above, ? stands for the demo number. The two versions of the SIMPL program for each demo, (COM and TCP) are almost identical, both being configured for a CNMSX-PRO, using the front panel device and a touchpanel with CRESNET ID = 03. Both versions have ports defined for both serial (RS-232) communications via the CNMSX-PRO’s built-in COM A port (slot 4, port A), and EtherNet (TCP/IP) communications via the LAN port on a CNXENET card installed in the CNMSX-PRO’s DPA slot. In the COM versions, the TCP/IP port is commented off while in the TCP versions, the RS-232 port is commented off. This
is the only difference between the two versions.
The following sections separately describe the setup procedures for connecting multiple control systems via either RS-232 or TCP/IP connections. Actually, a mixture of connections is permitted. For example, two control system might be connected via RS-232 (using the COM1 and COM2 ports) while two more might be simultaneously connected via the TCP/IP network connection.
20 •• Basic Server Setup Installation & Reference Guide — DOC. 5822
Crestron e-control Vote SW-VOTE
In the following, the indented, italicized paragraphs contain advice on setting up the server and a control system specifically to run the supplied demo files. You will find that most of the steps have already been accomplished because they are specified by the supplied demo configurations.
Communications Setup
Server Side
1. Run server application by selecting Database Manager from the Crestron
folder of your Start menu.
2. Select config file. Specify a Configuration Settings file (.ini file) by selecting
File | Configuration File…. Refer to “Specifying a Configuration File,” page
26.
The server is installed with a demomail.ini pre-selected as the default configuration file. (This is intended to simplify the Quick Start Guide.)
3. Set communications mode. Select Server | Configure and enter a password to
open the Configuration Options window. (Refer to “Password Access” on page 27). Select the COM Settings tab. The settings for each connection to a control system must match those on the other end (the control system side) of the actual connections. Click on each connection in turn, click the Modify… button, and choose either RS-232 (and select the port and speed) or TCP/IP (and set the IP address and IP ID). Click OK to make the changes for each connection.
The demos are pre-configured to use RS-232.
Control System Side, RS-232
Serial communication requires wiring the server directly to the control system.
NOTE: Serial communications requires neither the CNX Gateway software nor the use of an Ethernet network.
1. Connect PC for programming purposes. For each control system to be
connected to the server, temporarily connect the PC containing the control system and touchpanel project files to the control system via a serial cable between any available COM port of the server and the COMPUTER port of the CNX control system. (This could be — but need not be — the same physical machine that runs the Software Server.) Refer to the CNMSX manual (latest revision of Doc. 8118) for instructions. This connection can be removed once the control system is programmed.
2. Install control system program. Upload the compiled SIMPL Windows
program file (.bin file) to each control system.
As supplied, the demo programs are configured for a CNMSX-PRO control system. For other models, using SIMPL Windows, convert the program as described below and recompile.
3. Install touchpanel pages. Upload the compiled VT Pro-e project file (.hex
file) to each control system.
As supplied, the demo touchpanel file, which contains pages for all the demos, is configured for a LC-3000 touchpanel; and the accompanying .hex file is compiled for same. This file however also works fine with an CT-3000, CT-3500, and a VT-3500. If you have one of these models, go ahead and upload the .hex file as is. If you are working with another panel, convert the file to your target panel and recompile.
21 •• Basic Server Setup Installation & Reference Guide — DOC. 5822
Crestron e-control Vote SW-VOTE
4. Connect to server. Connect null-modem cables (Crestron model CNSP-532)
from each control system to the server. Each connection requires its own COM port on the server side. The port to use on the control system depends on the specific model:
CNMSX-PRO. Use one of the built-in COM ports.
The demo files are all configured for a CNMSX-PRO using COM A (slot 4, port A).
CNMSX-AV. Use one of the built-in COM ports.
Use SIMPL Windows to convert the demo files. In the Configuration Manager, drag & drop a CNMSX-AV system onto the CNMSX-PRO. The converted system does not have a front panel, so compile “notices” appear — which can be ignored.
CNRACKX. Install a CNXCOM-2.
Use SIMPL Windows to convert the demo files. In the Configuration Manager, drag & drop a CNRACKX system onto the CNMSX-PRO. The converted system has a CNXCOM-2 card in slot 4; use Port A. The converted system does not have a front panel, so compile “notices” appear — which can be ignored.
CNMS. Install a CNCOMH-2 card. Use of the built-in COM ports for the present
purpose is not recommended.
Use SIMPL Windows to convert the demo files. In the Configuration Manager, drag & drop a CNMS system onto the CNMSX-PRO. The converted system has a CNCOMH-2 card in slot 5; use Port A. The converted system does not have a front panel, so compile “notices” appear — which can be ignored.
CNRACK. Install a CNCOMH-2.
Use SIMPL Windows to convert the demo files. In the Configuration Manager, drag & drop a CNRACK system onto the CNMSX-PRO. The converted system has a CNCOMH-2 card in slot 4; use Port A. The converted system does not have a front panel, so compile “notices” appear — which can be ignored.
For more information on control system TCP/IP setup, consult the e-control Overview document, overview.pdf, installed with the CNX Gateway software; or the SIMPL Windows release notes, installed with SIMPL Windows.
Control System Side, TCP/IP
TCP/IP communications requires a control system with a LAN/Internet port. Therefore, a CNX generation control system is required (CNMSX-AV, CNMSX-PRO, CNRACKX, or CNRACKX-DP). The CNX control system and the server are both connected to the same network. This connection, once properly configured, can then be used both for system communications (uploading, Test Manager support, Viewport functions) and run-time server/client (server/control system) communications as well. (The latter function however requires the addition of the CNX Gateway software.)
1. Install Ethernet card. Install the CNXENET card into the Direct Processor
Access (DPA) slot of each CNMSX. Refer to the CNXENET manual (latest revision of Doc. 8129) for instructions.
2. Connect server. Connect the CNX control system(s) to the server using one of
the following two methods:
(1) Connect the control system into the same LAN as the server. Use a
commercially available Ethernet hub to expand the number of connections available by plugging in the LAN, the server, and the control system into the same hub.
(2) Alternatively, make a two-device private network by connecting an
Ethernet “crossover” cable between the Ethernet port of the server’s Network Interface Card and the LAN port of the CNX control system’s CNXENET card. Do not attempt this with a regular Ethernet cable.
3. Connect PC for programming purposes. For each control system to be
connected to the server, temporarily connect the PC containing the control system and touchpanel project files to the control system via a serial cable between any available COM port of the server and the COMPUTER port of the CNX control system. (This need not be the same machine that will run the Software Server.) Refer to the CNMSX manual (latest revision of Doc. 8118)
22 •• Basic Server Setup Installation & Reference Guide — DOC. 5822
Crestron e-control Vote SW-VOTE
for instructions. This connection can be removed once the control system is programmed. Open the Viewport and issue the Setup | Communications Settings… command to reconfigure communications for RS-232.
4. Check firmware versions. Before proceeding, however, verify that the CNX
control system has been loaded with the proper versions of firmware. Still in the Viewport, select File Transfer | Update control system to bring up a window box containing the current versions of monitor, operating system, and TCP/IP stack. Verify the versions per the
5. Leading Specifications (page 9).
In early versions of the CNMSX, it may be necessary to upgrade to an intermediate version of the monitor first and then to the required version of the monitor. (The Viewport issues a notice if this is necessary.)
To upgrade any of these files, retrieve a copy of the latest upgrade package from the Crestron website (OPSYS Library). These files have an extension of .upz which contains all three system components in one compacted file. Once downloaded, browse for the appropriate file in the Update control system window. Click Send to upload the files to the control system. (When upgrading the system in this manner, always send all three components to avoid incompatibilities.)
6. Define control system IP address. Still in the Viewport, select Functions | Set
control system IP Information. The Set control system IP Address window opens. Assign an IP address for the CNX control system. The address should be obtained from the MIS department. The IP address has four fields separated by periods (e.g. 192.168.2.3) and must be unique. Click OK.
7. Enter gateway address. Still in the Viewport, select Functions | Setup IP
Table to open the IP Table window. Click on the Retrieve Current IP Table from control system button to display the current listing. Verify that the IP
address for the PC running the CNX Gateway (often but not necessarily the server itself) appears with an IP ID of 03. If it does not appear, use the Add… button to add an entry for IP ID 03. Then click the Send IP Table to control system button.
8. Switch to TCP/IP. Now that TCP/IP is properly configured, the Ethernet
connection can be used for all subsequent system communications (from SIMPL Windows, Test Manager, Vision Tools Pro-e, and all Viewport functions). See the section 24 titled “Test Communications.” Open the Viewport and issue the Setup | Communications Settings… command to reconfigure communications for TCP/IP. The serial cable can now be removed.
9. Install control system program. Upload the compiled SIMPL Windows
program file (.bin file) to each control system.
As supplied, the demo programs are configured for a single CNMSX-PRO control system. For other models, use SIMPL Windows to convert the program as follows and recompile:
CNMSX-AV.
In the Configuration Manager, drag & drop a CNMSX-AV system onto the CNMSX-PRO. The converted system does not have a front panel, so compile “notices” appear — which can be ignored.
CNRACKX. Install a CNXCOM-2 card in slot 4 and use Port A.
In the Configuration Manager, drag & drop a CNRACKX system onto the CNMSX-PRO. The converted system has a CNXCOM-2 card in slot 4; use Port A. The converted system does not have a front panel, so compile “notices” appear — which can be ignored.
10. Install touchpanel pages. Upload the compiled VT Pro project file (.hex
file) to each control system.
As supplied, the demo touchpanel file, which contains pages for all the demos, is configured for a LC-3000 touchpanel; and the accompanying .hex file is compiled
23 •• Basic Server Setup Installation & Reference Guide — DOC. 5822
Crestron e-control Vote SW-VOTE
for same. This file however also works fine with an CT-3000, CT-3500, and a VT-3500. If you have one of these models, go ahead and upload the .hex file as is. If you are working with another panel, convert the file to your target panel and recompile.
Test Communications
At this point, test your connections.
RS-232 control systems
Use the Viewport to verify communications between the server and the CNX control system. Select Diagnostics | Establish Communications. If properly connected, the PC responds with the COM port and baud rate.
TCP/IP control systems
First test the IP address of the CNX control system by “pinging” it. From a networked PC bring up an MS-DOS prompt (Windows 95/98) or “Command Prompt” (Windows NT) and type “ping <IP ADDRESS>”, as shown below. The control system responds with several lines “Reply from address < IP ADDRESS >…”. If no response is received from the “ping” to the IP address of the CNX control system, repeat the procedure in “Control System Side, TCP/IP,” page 22.
C:\WINDOWS>ping 111.112.113.114
Pinging 111.112.113.114 with 32 bytes of data:
Reply from 11.112.113.114: bytes=32 time=8ms TTL=60 Reply from 11.112.113.114: bytes=32 time=5ms TTL=60 Reply from 11.112.113.114: bytes=32 time=5ms TTL=60 Reply from 11.112.113.114: bytes=32 time=5ms TTL=60
Once a reliable connection is established, test that the CNX control system is listening and responding properly. Reconfigure Viewport communications to use TCP/IP by selecting Setup | Communications Settings. Once the Port Settings window opens, select TCP/IP as the Connection Type. For IP Address, Click on Fixed and enter the CNX control system IP address in the active field. Test the new connection by issuing the Diagnostics | Check Operating System Version command.
Additional Server Side Setup
In addition to properly setting up and testing communications with each connected system, the following steps are also required to make the server operational:
1. Select database file. Supply the full pathname to the database under the
COM Settings tab. This file is the sole source of all database tables accessed by all signal blocks. See “Database,” page 52, for additional information.
The demos are pre-configured to point to the file demovote.mdb in the demos folder.
2. Indicate control system connection. Point each active signal block to a COM
Settings definition. (If you have not yet defined the connection through which this signal block will communicate, you can leave this blank for the now. However, the signal block cannot be activated until it references a COM Settings definition.) See “COM Settings,” page 33, for a description of how to point a signal block to a COM Settings definition.
24 •• Basic Server Setup Installation & Reference Guide — DOC. 5822
Crestron e-control Vote SW-VOTE
All the signal blocks in the demo configuration already point to a COM Settings definition.
25 •• Basic Server Setup Installation & Reference Guide — DOC. 5822
Crestron e-control Vote SW-VOTE
Server Configuration In Depth
This section is a reference to all the options available in the Configuration Options window. Changes to options in this window are saved to the current Configuration Settings file when the OK or Apply buttons are actuated. Therefore, it is important to make sure you are operating on the appropriate Configuration Settings file before opening the window.
Specifying a Configuration File
The installer registers the file demovote.ini as the current Configuration Settings file. This file pre-configures the server for all three demos, and particularly for use with the Quick Start Guide — which instructs you to load demo1.
You can use the File | Configuration file… command to select a Configuration Settings file of your choice. The file pathname so specified is stored in the Windows registry on your machine. In addition to specifying the configuration filename, this command also instantly reconfigures the server based on the named file. This is a very useful feature for the developer working on multiple projects.
NOTE: If the server cannot open a specified configuration file, it uses default values for all options, a null configuration with no connections and no signal blocks. If any changes are made, a new config file is created using the specified pathname when the OK or the Apply buttons are actuated
Creating a New Configuration File
We recommend duplicating the demo configuration file and modifying the copy, as follows:
• Locate the file and copy and paste it, renaming it appropriately.
• Point the server to the new config file using the procedure described above in
“Specifying a Configuration File.”
• Proceed to modify the duplicated configuration
An alternative approach is to use the File | Configuration file… command to enter the pathname of a non-existing config file. As per the NOTE, above, you will start out with default values. As soon as you modify this null configuration, the config file you named above is created.
Transporting a Configuration
To prepare a configuration on one machine (a development machine) and transport it to another (a target machine):
• Craft the configuration to your liking on the development machine.
• Copy the config file along with the database file it points to the target machine.
• Point the server on the target machine to the new config file using the procedure
described above in “Specifying a Configuration File.”
NOTE: If the database file was in the same folder (or a folder subordinate to) the config file’s folder, the database filename is stored as a partially qualified pathname, relative to that folder. This is useful, because if you keep that relationship between the files on the target machine, it can use the relative pathname to locate the file. If, however, you copy the database to a different folder on the target machine, or the database filename was a fully qualified pathname (beginning with a volume designator) on the development machine, you may have to reset the pathnames (for each COM Settings definition) on the target machine.
26 •• Server Configuration In Depth Installation & Reference Guide — DOC. 5822
Crestron e-control Vote SW-VOTE
Password Access
Access to the server’s Configuration Options window is password-protected. This is to prevent end-user meddling with the configuration options, which can very possibly disable the server’s proper operation.
Select Server | Configure. The server prompts the user for a password. Enter crestron2 which displays all tabs. Entering anything else displays the General tab only.
The configuration password dialog — controls access to the Configuration Options window
The Configuration options window, General tab, showing all tabs (correct password entered).
The password may be changed from the General tab. Click on the Change Password button to open the Change Password window. Enter the old password and the new password twice. Click OK to complete the change.
Resetting the Configuration Password
In the event the password is misplaced, be aware that it is not stored in readable form. Rather, values derived from the password is stored in the configuration files. The password can effectively be reset by locating the configuration file and then either deleting or editing it.
Use the File | Configuration file... command to note the pathname of the currently selected configuration file. Exit the server.
27 •• Server Configuration In Depth Installation & Reference Guide — DOC. 5822
Crestron e-control Vote SW-VOTE
Deleting the file means that all configuration variables revert to their default values the next time the server is run. The problem with this approach, of course, is that you lose any settings already made.
To reset the password only (without affecting the rest of the configuration), edit the
.ini file using the Notepad application (Start | Programs | Accessories | Notepad). Locate and delete the following key in the [GENERAL] section (the
value may differ):
privilegeLevel_2=180350152
Exit the Notepad application, saving the file. The password is now reset to its default — which is “crestron2.” Run the server again. Issue the Server | Options... command. Enter the default
password. You can now change the password to whatever you want by clicking the Change Password button.
COM Settings Configuration
A “COM Settings” data structure (also called a “[system] connection”) must be created and configured for each connection you intend to make to your control systems.
All active signal blocks (Signal Blocks tab) must reference such a structure. See “COM Settings,” page 33, for instructions on defining such a reference for your signal blocks.
The COM Settings tab
The COM Settings tab of the Configuration Options window contains a list of data structures called “COM settings definitions” which represent connections to control systems. From this tab, you can activate and deactivate such definitions, and define additional ones.
NOTE: Connections may be defined before or after signal blocks are defined. However, signal blocks cannot be activated until they reference a defined connection.
Refer to the figure below. To remove a COM settings definition, select it and click the Remove button. To duplicate an existing definition, select it and click the Duplicate button. The new
definition differs from the original in that it is given a unique name which is derived from the name of the original, incremented by one. (If the original did not end in a number, the name of the duplicate is the name of the original with a “1” suffixed to it.)
Click the Add… button to define an new connection; or select one of the definitions already listed and click Modify… to modify it. The COM Settings window opens:
28 •• Server Configuration In Depth Installation & Reference Guide — DOC. 5822
Crestron e-control Vote SW-VOTE
The Configuration Options window, COM Settings tab, showing the only connection defined in the demo configuration (selected).
COM Settings definitions (connections) can be active or inactive. A check in the box next to the definition name indicates that the connection is activated. If not activated, it is ignored when the server protocol is started.
The COM Settings window
The COM Settings window for the connection defined in the configuration for demo 1, showing RS-232 communications selected …
29 •• Server Configuration In Depth Installation & Reference Guide — DOC. 5822
Crestron e-control Vote SW-VOTE
… and if TCP/IP communications were selected, it would look like this (fictitious IP address shown):
Definition name
Each COM Settings definition requires a unique name. A field for this data can be found at the top left of the COM Settings window. We recommend choosing a name that reflects either the location of the control system (such as “SUITE3”) or its function (such as “PHONEBOOK”).
This name is used in the server’s user interface to identify the system data structure. It is also sent along with error messages to the actual control system to identify the source of an error resulting from processing one of the system-level signals defined herein.
Control system generation
Here you specify the type of control system. The server uses this information to take into account minor differences in the way the older generation of Crestron control systems functioned in terms of timing and data capacity.
Communications mode
In this frame you choose RS-232 or TCP/IP connections. If you choose RS-232, note that hardware handshaking is strongly recommended. The details are described in the Server Side configuration sections for RS-232 (page 21) and TCP/IP (page 22).
System-level signal definitions
In this window you can also define optional system-level signals by checking the appropriate boxes. Doing so defines a special signal block which communicates with its own Intersystem Communications symbol in your SIMPL Windows program. In this case, you should also fill in the Signals field, as follows:
Signals
This is the offset of the Intersystem Communications symbol in your SIMPL Windows program. The connection’s signal block must not overlap any other signal block (channel 1 of) these COM settings or else the server protocol will not be able to be started.
Refer to the “Signal Reference” section, which begins on page 78, for more information on each of the signals listed in the window.
Signal Block Configuration and Definition
Data structures called a “signal blocks” are created on the server, each communicating with its own Intersystem Communications symbol on a control system.
A signal block’s configuration includes behavior options as well as optional signal definitions. The signal block’s definition refers to its list of input and output signals, including fixed as well as optional signals.
Each active signal block must reference a “COM Settings” data structure which defines a connection to a control system. See “COM Settings ,” above.
30 •• Server Configuration In Depth Installation & Reference Guide — DOC. 5822
Loading...
+ 105 hidden pages
Buy Points How it Works FAQ Contact Us Questions and Suggestions Privacy Policy Cookie Policy Terms of Use