CRESTRON e-control™ Vote (SW-VOTE) version 1.5 © 1999, 2000 Crestron Electronics, Inc.
Crestron e-control Vote SW-VOTE Contents How to Use This Manual 4 A Note on Printing This Document ................................................................................................... 4 Quick Start ........................................................................................................................................ 4 A word on licensing ..........................................................................................................................
Crestron e-control Vote SW-VOTE Appendix C: Signal Reference 74 Definition of Terms ......................................................................................................................... 74 String Proxies .................................................................................................................................. 74 Bit Patterns ......................................................................................................................................
Crestron e-control Vote SW-VOTE Crestron e-control Vote How to Use This Manual A Note on Printing This Document Adobe and Acrobat are trademarks of Adobe Systems Incorporated. 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/.
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.
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.
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.
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 subsections: Sub-section Description Page What is Crestron econtrol™ Vote? An abstract describing the Crestron e-control Vote component of the Crestron Software Server, including a table of practical limitations.
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 No particular order enforced. Times a seat can request to speak on an item 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.
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.
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.
Crestron e-control Vote SW-VOTE System block diagram, showing communication pathways (all connections using TCP/IP): Crestron control system VT-3500 VT-3500 Crestron CNX Gateway VT-3500 Crestron Software Server Crestron control system VT-3500 VT-3500 VT-3500 Database System block diagram, showing communication pathways (curved arrows are RS-232 serial connections; straight arrows are TCP/IP): Crestron control system VT-3500 VT-3500 Crestron control system VT-3500 Crestron Software Server
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.
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 “keyboar
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.
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.
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.
Crestron e-control Vote Server components are separately licensed. An SW-VOTE license must be obtained from Crestron even if other components are already in use. SW-VOTE 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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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).
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.
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”).
Crestron e-control Vote A “signal block” is a software construct defined in the server which communicates with special symbols in the SIMPL program running in your control system. Internally, the DBM Scroller logic module is simply an Intersystem Communications symbol paired with an Interlock symbol for touchpanel button feedback. SW-VOTE The Signal Blocks tab (see below) displays a list of defined signal blocks.
Crestron e-control Vote SW-VOTE The Configuration Options window, Signal Blocks tab, showing all the signal blocks defined in the demo configuration (in alphabetical order). As shown, all five signal blocks are active (checked); and the Voting Console signal block for demo2, VOTE, is selected. Signal Blocks, once defined, can be active or inactive. A check in the box next to the signal block name indicates that the signal block is activated.
Crestron e-control Vote SW-VOTE • Behavior options. These have specific effects on signal block behavior when the server protocol is running. The highest numbered signal in the signal block’s input or output signal lists is shown in the box in the upper-right corner. This is based on the signal offset entered in the adjacent box and the current signal block definition. This value is updated synchronously as the user interacts with the window.
Crestron e-control Vote SW-VOTE Proctor window to reflect the actual chamber layout (from the Operator-operator's perspective). All such edits are saved along with other options in the configuration file. NOTE: Even if you do not intend to use the Voting Computer during voting, you must still edit it at least insofar as the number of seats is concerned.
Crestron e-control Vote SW-VOTE • • • • • Loads a picture into the background. The picture will always be positioned in the upperleft corner of the window. Clear picture Unloads picture. Set border color... This button changes the color of the border around the ovals representing all seats. Discard changes and close windows Closes both the "Vote chamber layout" and the Vote Proctor window, discarding all edits. Window size Select a size for the Vote Proctor window here.
Crestron e-control Vote SW-VOTE • • • • • Disables the Open Vote button in the Vote Proctor window until attendance has been taken. If you close and re-open the Vote Proctor window, you will have to take attendance again before being allowed to take a vote. No Chairperson All the seats are occupied and fully functional. This is the normal setting.
Crestron e-control Vote SW-VOTE The following options control the display and behavior of the Vote Proctor window: • Enable Displays the Vote Proctor window when the signal block is enabled. Also enables the Voting | Start Voting command. If unchecked, the window cannot be opened at all. • Auto-name vote The server generates a name for the vote based on the current date and time, in the form yymmdd_hhmmss.
Crestron e-control Vote SW-VOTE • Additional vote signals In addition to the always defined Yess and Nos signal sets, defines the Abstains and/or Excuses signal sets. These are intended to be tied to additional seat vote buttons. • Quorum & passage lights Defines the passage digital signals, TallyQuorum, TallyCarried, Tally23Majority. These are digital signals used by the server to transmit vote status to the control system "live" (during a vote).
Crestron e-control Vote SW-VOTE The Rules Tab The Rules tab of the Voting Console Signal Block Definition window, showing part of the definition of the VOTE signal block from demo2. • Optional vote values The operator normally has the ability to alter a vote after the floor is closed. In addition to YES and NO, the options in this frame add ABSTAIN and EXCUSE to the possible vote values.
Crestron e-control Vote SW-VOTE The Reports tab of the Voting Console Signal Block Definition window, showing part of the definition of the VOTE signal block from demo2. (As shipped, however, the Print Reporting Mode is not enabled.) • Reporting Modes Save mode refers to the textfile dumps listed to the right. Fill in the number of copies for Print mode.
Crestron e-control Vote SW-VOTE keep the folder contents to a manageable size. (Note that thousands of votes could accumulate is just one year.) Some notes on the textfiles: The files are named yymmddhhnnss.TXT (year-month-day-hour-minutesecond). This forces the files to list in chronological order when sorted by name. Data in files consists of an identification line, a summary line, and a series of simple two-column (tab-delimited) tables.
Crestron e-control Vote SW-VOTE NOTE: The queue set defined in a single RTS Console is saved and reloaded as a unit; to set up queues (or queue sets) that will save and load independently, even if used within the same room, define additional RTS Consoles as needed. General options: • Seats w/ RTS buttons You must supply the number of seats here, even if you have a Voting Console defined with a specific number of seats. The two numbers do not have to be the same.
Crestron e-control Vote SW-VOTE The Request-to-Speak Queue Definition window, as it appears when adding a new queue. • • • • This window prompts you to choose from a list of currently defined scrollers (excluding those already in the list of queues for this RTS console). The new queue is added to the bottom of the list. In addition to naming a scroller, if the queue should clear automatically when a seat is recognized from the first (top) queue, check the Auto-clear box.
Crestron e-control Vote SW-VOTE Each RTS queue should be defined as either a Standard Scrollers or a Custom Scrollers, similar to the one pictured below: A Standard Scroller Signal Block Definition window, showing the defintiion of the QUEUE1 scroller from demo1. Set the (enabled) options as follows. • Default query number This value needs to point to a query (i.e., have the same value as the ID field of a record in the Queries table) which describes access to an RTS table.
Crestron e-control Vote SW-VOTE Software Server Windows and Menus This section contains descriptions of the server’s two main windows, the Server Monitor window and the Signal Analyzer window. The Server Monitor Window While the server protocol is running, the Server | Start w/Signal Analyzer command from the Server Monitor window opens the Signal Analyzer window. (If the server is already running, toggling Server | Signal Analyzer does the same thing.) The Server Monitor window.
Crestron e-control Vote SW-VOTE registry and becomes the default configuration. Use this command to select the appropriate configuration file for each demo before running it. The following command is always available: • File | Exit terminates the server application. If the server protocol is running, a warning message appears.
Crestron e-control Vote SW-VOTE the agenda item scroller at run-time. See “Database tables windows” below for instructions on how to edit the tables. The following command is only available after the server protocol has been started: • Open Vote Proctor Window. Opens the Vote Proctor window. If the Voting Console signal block was not already enabled, enables it. Once opened, the window cannot be closed while a vote is in progress.
Crestron e-control Vote SW-VOTE • Fields (or entire records) so changed (as evidenced by the little pencil icon in the row margin, visible in the figure above) can be changed back by selecting a cell (or an entire row, by clicking in the row margin) and depressing the ESC key. • Additional records can be entered by scrolling down to the row containing an asterisk (*) in the left-most column and typing the information. • Use ENTER to advance to the next cell in a row.
Crestron e-control Vote SW-VOTE Signal Simulator The top part of the window is for simulating receipt of incoming signals and transmission of outgoing signals. Signal Blocks & Connections This list contains all active signal blocks as well as all active connections that have signals defined (and hence can behave as signal blocks too). To simulate an incoming or outgoing signal, you must first select an item from this list.
Crestron e-control Vote SW-VOTE 3. Signals are only logged when the Signal Analyzer window is opened. However, in general, do not keep the window opened unnecessarily as the logging routines can cause a noticeable degradation of server responsiveness when the server is running on a slower PC.
Crestron e-control Vote SW-VOTE This option is also “sticky” like the Timestamps command. • Log | Find… brings up the following modal window which helps locate a specific signal. Signal log search window. Searches can be performed with and without case sensitivity by checking the Match Case option. When the window opens this option is unchecked — meaning that the search algorithm disregards the upper- and lower-case status of the characters in the search key.
Crestron e-control Vote SW-VOTE Database In the present release, a single database file is named in the COM Settings tab of the Configuration Options window. This one file is used as the sole source of all database tables for all the signal blocks in the configuration. Database Tables This section discusses the database tables accessed by the various signal blocks of the SW-VOTE component of the Crestron Software Server.
Crestron e-control Vote SW-VOTE in the Queries table, and from the naming of Request-to-Speak Console signal blocks, as described below. NOTE: The agenda scroller record in the Queries table must name Agenda in its table field. The reason this name must be used is that the table is also referenced by the combo-box (or list-box) in the Vote Proctor window. Queue tables The naming of the queue tables (and scroller tables in general) is completely arbitrary.
Crestron e-control Vote SW-VOTE The Queries table Complete specifications for the Queries table can be found in the SW-DBM manual, Doc. 5823. For the present purposes it is sufficient to show how to specify queries for queue scrollers and agenda scrollers. Consider the example provided in the supplied sample database file. Contents of the Queries table in the sample database file, demovote.mdb. The following tables contain all the information you need to set up queue and agenda scrollers.
Crestron e-control Vote SW-VOTE Field Condition Contents The condition field should contain the following string, precisely, for agenda scrollers: not (number=NULL and name=NULL) and (closed=NULL) This “filter” causes the query to include only non-empty, open items in the resulting agenda item list.
Crestron e-control Vote SW-VOTE Field Name Data Type Data Size Indexed YesVotes Number Integer No NoVotes Number Integer No Abstentions Number Integer No TotalVoting Number Integer No Excuses Number Integer No Absentees Number Integer No Field names are fixed and must appear exactly as shown above (case however is not significant). Set ID to be the primary key.
Crestron e-control Vote SW-VOTE Operations This section describes the operation of the Vote Console and Request-to-Speak Console signal blocks as they process signals from the control system. All signals have names and are shown set in bold type as conjoined words with initial caps. Refer to the “Signal Reference” section (beginning on page 78) for in-depth information on these signals.
Crestron e-control Vote SW-VOTE If proctoring a vote from a touchpanel, before opening the floor to the vote, you must either: This checkbox is found under the Control System Interface tab of the Voting Console Signal Block Definition window. • Pick one of the agenda item descriptions previously stored in the Agenda table from the agenda scroller; or • Send a new agenda item description to the server using the SetAgenda signal.
Crestron e-control Vote SW-VOTE Value Internal Symbol 4 BALLOT_ABSTAIN 5 BALLOT_EXCUSED 6 BALLOT_HIDDEN Typical Display Symbol ˜ ˜ ˜ Solid yellow circle Solid grey circle Solid grey circle The BALLOT_HIDDEN value is used in place of BALLOT_YES, BALLOT_NO, and BALLOT_ABSTAIN only during a secret ballot. (Votes are typically hidden from the control system when the Operator’s touchpanel is visible to the assembly until the floor is closed.
Crestron e-control Vote SW-VOTE • receipt of PrintSave signal. (see 8, below) This action results in the server transmitting the following signals to the control system: • de-assert of StateDisplay signal • If secret ballot: All the StatusI signals are sent again with their actual vote values. 9 Record Vote Recording of vote is initiated by: • clicking the Print & Save Vote button in the Voting Computer; or • receipt of PrintSave signal.
Crestron e-control Vote SW-VOTE State Coordination Several digital signals sent from the Voting Computer to the control system are used either for button feedback; or to coordinate the logical state of the control system with that of the Voting Computer; or both (as in demo2).
Crestron e-control Vote SW-VOTE • Reload the queue set from a “save file” and flip to the console page. • Flip directly to the console page without clearing or reloading the queue set. • Disable the signal block and leave RTS pages entirely.
Crestron e-control Vote SW-VOTE • Disable the signal block and leave RTS pages entirely. Typical Request-to-Speak Save Page interface elements Interface Element Signal(s) Notes DateTimef Typically, indirect text fields inside the Save buttons a set of f Save buttons, one for each “save file” Savef (where f = the number of “save files”) a Return button None Page flip. Returns to Console Page which is still displaying the “current” queue set.
Crestron e-control Vote 4 SW-VOTE Seat request To enter a request to speak: Seat pulses Req signal. Seat’s screenname enters queue. (If seat already in the queue because already had the floor at least once, seat’s WAITING state mark is incremented.) To cancel the request: Seat pulses Req signal again. Seat’s screenname removed from queue. (If seat already had the floor, seat remains in queue but WAITING state mark is decremented.
Crestron e-control Vote 10 SW-VOTE Clear a queue To clear an individual queue, pulse one of the ClearQueueq signals (typically joined to a Clear This Queue button positioned near each queue). Note that queues can be configured to automatically clear whenever a seat in the first queue is recognized to speak. (See “Auto-clear,” page 43.
Crestron e-control Vote SW-VOTE Demos Two demonstrations on the use of the Voting Computer are included with the package. Each demo is described along with an accompanying “bird’s eye view” diagram of its SIMPL program. All demos use the following three files: • A VT Pro-e source file (demovote.vtp file), containing pages for all three demos, ready to be compiled LC-3000 touchpanel. • A compiled touchpanel file (demovote.
Crestron e-control Vote SW-VOTE Demo 2 VT Pro-e Program [section incomplete] NOTE: Before proceeding to the actual demo page, start the server protocol by issuing the Server | Start command. [section incomplete] 67 • Demos Installation & Reference Guide — DOC.
Crestron e-control Vote SW-VOTE Appendix A: Theory of Operation This section describes the operation of the e-mailer signal block as it processes signals from the control system. Signal names are shown as conjoined words with initial caps set in bold type, such as SendNow. Refer to the “Signal Reference” beginning on page 78 for in-depth information on these signals. Server Protocol Run the Crestron Software Server application, swserver.
Crestron e-control Vote SW-VOTE the control system through the optional signal block that can be associated with a COM Settings definition which contains a similar set of error reporting signals.. These signals include ErrNumber, ErrString, and ErrTrigger. See the “Signal Reference,” beginning on page 78, for details. 69 • Appendices Installation & Reference Guide — DOC.
Crestron e-control Vote SW-VOTE Appendix B: Intersystem Communications and Signal Space Considerations The Send e-Mail SIMPL Windows symbol is available from the Crestron FTP site. Under SIMPLWIN, look for “Library update” (version equal to or greater than that specified in “Leading Specifications” on page 9). The DBM Scroller SIMPL logic module is installed with SIMPL Windows 1.4. The Intersystem Communications symbol is commonly known by its speedkey name, XSIG.
Crestron e-control Vote SW-VOTE Encoding and Decoding the Serial Data Stream Analog, serial, and digital signals to be sent from the control to the server are fed into the input (left) side of an Intersystem Communications symbol which encodes the signals into a serial data stream, available as an output labeled tx$ (for transmitter). This data stream is connected to the input side of the serial driver symbol, also labeled tx$, and is sent out the COM port to the server.
Crestron e-control Vote SW-VOTE to the control system. All the symbols’ rx$ and tx$ streams are tied to the same serial driver symbol. The set of signals intended for a particular Intersystem Communications symbol are distinguished from the other sets by their offset and/or their channel number. Normally, the signals in an Intersystem Communication symbol’s input list and its output list are internally enumerated starting at the top of each list with zero (0).
Crestron e-control Vote SW-VOTE NOTES: 1. Always suffix a d (for decimal) to values typed into the Offset textbox. 2. Always enter 1d into the Option textbox for all Intersystem Communications symbols. Multiple channels Multiple channels apply to connections made through Virtual COM Ports only (i.e., TCP/IP connections only). Each Virtual COM Port can have up to 128 channels, where each channel can be thought of as a separate COM port.
Crestron e-control Vote SW-VOTE Appendix C: Signal Reference Definition of Terms Data fields The indirect text fields which receive the data that is echoed when a record is opened (“picked”). Connection A connection to a system which can be either serial (RS-232) or EtherNet (TCP/IP). List fields The indirect text fields in scrollers. There can be more than one field (column) per row in the scroller.
Crestron e-control Vote SW-VOTE Base 16 used for notational purposes Straight base 2 notation (a long string of 0s and 1s) is considered to be too unwieldy to be useful to the human eye as it is too easily prone to misrepresentation and misinterpretation. Hexadecimal (base 16) notation is used to conveniently specify the bit patterns for the signals that use them (i.e., the Config and SignalAn signals).
Crestron e-control Vote SW-VOTE listing of all the inputs and outputs. To do this, start the server using the Server | Start w/o connecting command and select the signal block you are interested in from the Signal Blocks & Connections listbox. Certain signal names are used in more than one type of signal block. However, only one entry for each signal type appears in the reference.
Crestron e-control Vote SW-VOTE Signal Name Direction Type SendNames system-to-server D Yield system-to-server D Voting Console Signal Block Summary The following signals comprise a Voting Console signal block. The number and precise selection of signals varies based on the specific signal block definition.
Crestron e-control Vote SW-VOTE Signal Name Yess Direction Type system-to-server D Signal Reference The alphabetical reference proper begins on the next page. Regarding references herein to a signal raising an error condition, see “Appendix D: Error ,” page 132. 78 • Appendices Installation & Reference Guide — DOC.
Crestron e-control Vote SW-VOTE Abort Description Direction Abort voting sequence Voting Computer to control system Type Digital Value Assert: De-assert: Expected Reply Comments Voting Console Results now being recorded on Voting Computer ([Print &] Save Results button feedback ON) Results have been recorded ([Print &] Save Results button feedback OFF) AgendaEcho, NewVote, This signal is accepted by the Voting Computer while the floor is opened and after the floor is closed but before the vote is
Crestron e-control Vote SW-VOTE Abstains Description Direction Seat abstains control system to Voting Computer Type Digital Value Pulse Expected Reply None Comments Voting Console This signal is accepted by the Voting Computer while the floor is opened for voting only.
Crestron e-control Vote SW-VOTE AgendaEcho Description Direction Type Value Expected Reply Comments Voting Console Agenda item description Voting Computer to control system Serial New agenda item description; may be partial Start or Abort This signal is sent when the agenda item description has changed either from the Voting Computer interface by selecting a pre-entered agenda item from the combobox, or typing a character into same; or from the Control System Interface via the SetAgenda signal.
Crestron e-control Vote SW-VOTE AgendaTrigger Description Direction Agenda item has been set Voting Computer to control system Type Digital Value Pulse Expected Reply Comments Voting Console Start or Abort This signal is pulsed when a valid agenda item has been selected or entered either from the Voting Computer interface or from the Control System Interface.
Crestron e-control Vote SW-VOTE Attendance Description Direction Open floor to special attendance-taking “vote” Voting Computer to control system Type Digital Value Pulse Expected Reply Success: Failure: Comments See Also 83 • Appendices Voting Console StateStart assert; followed by Done pulse ErrString See comments at Start. Start, End, Abort Installation & Reference Guide — DOC.
Crestron e-control Vote SW-VOTE Changes Description Direction Change a vote control system to Voting Computer Type Digital Value Pulse Expected Reply Success: Failure: Comments Voting Console Status signal with new value for this seat Done pulse ErrString These signals are generally tied directly to touchpanel buttons positioned over each seat. (The seat is usually represented with an animation object; see Status signal.
Crestron e-control Vote ClearFiles Description Direction Value Pulse See Also 85 • Appendices Control system to Voting Computer Digital Comments Request-to-Speak Console Clears all “save files” Type Expected Reply SW-VOTE Done pulse Deletes all records from all q x f “save file” tables where q is the number of queues in the queue set and f is the number of save file sets configured for this signal block. Obviously, this is a dangerous signal.
Crestron e-control Vote SW-VOTE ClearQueueq Description Direction Clears a specific queue Control system to Voting Computer Type Digital Value Pulse Expected Reply Done Comments See Also 86 • Appendices Request-to-Speak Console th Clears the scroller which implements the q queue defined in the signal block. The table bound to the scroller is cleared, and signals are sent to the control system to clear the scroller display. If any seats were in the queue, their feedback signals are lowered.
Crestron e-control Vote SW-VOTE ClearQueueSet Description Direction Clears all queues at once Control system to Voting Computer Type Digital Value Pulse Expected Reply Done Comments Voting Console Clears all the the signal block’s queue scrollers. The tablesbound to the scrollers are cleared; and signals are sent to the control system to clear the scroller displays. All seats’ feedback signals are lowered. If any seat had the floor, it is forced to yield (i.e., MicSelect signal is set to 0).
Crestron e-control Vote SW-VOTE DateTimef Description Direction Type Value Expected Reply Comments See Also 88 • Appendices Request-to-Speak Console Sends timestamps of each “save file” Voting computer to control system Serial Timestamps for the last modification of each “save file” defined in the signal block. Format is short date, medium time, typically: month/day/year hour:minute AM-or-PM None The values are sent automatically when the signal block is enabled.
Crestron e-control Vote SW-VOTE Display Description Direction Display vote results on Voting Computer control system to Voting Computer Type Digital Value Pulse Expected Reply Success: StateEnd de-assert; followed by StateDisplay assert; followed by Done pulse ErrString Failure: Comments Voting Console This signal may be issued repeatedly to update the results display on the Voting Computer if already displayed (StateDisplay is high) or to redisplay the results if no longer displayed (StateDisp
Crestron e-control Vote Done Description Direction Request-to-Speak Console Voting Console Server operation complete Voting Computer to control system Type Digital Value Pulse Expected Reply None Comments SW-VOTE Issued after processing most “command” signals (signals which initiate a procedure as opposed to those that simply transmit states) except for those signals which have custom response signals defined along with them. See Also 90 • Appendices Installation & Reference Guide — DOC.
Crestron e-control Vote SW-VOTE Request-to-Speak Console Voting Console Enable Description Direction Type Value Expected Reply Comments This signal enables/disables the signal block. control system to Voting Computer Digital Assert to enable the signal block De-assert to disable the signal block Success: Assertion of the signal block’s Enabled signal Failure: An error condition is raised, typically Err_ENABLE Assert this signal to enable the signal block. (The signal block must be enabled prior to use.
Crestron e-control Vote See Also 92 • Appendices SW-VOTE Enabled, SendNames, Name, DateTime, MicSelect Installation & Reference Guide — DOC.
Crestron e-control Vote SW-VOTE Request-to-Speak Console Voting Console Enabled Description Direction Type Value Expected Reply Comments See Also 93 • Appendices “Handshake” response to the Enable signal. Server to System Digital Asserted in response to assert of Enable signal. De-asserted in response to de-assertion of Enable signal.
Crestron e-control Vote SW-VOTE End Description Direction Close floor to further voting control system to Voting Computer Type Digital Value Pulse Expected Reply Success: Failure: Comments Voting Console StateStart de-assert; followed by StateEnd assert; followed by Done pulse ErrString This signal is only valid during a vote when the floor is opened for voting (while StateStart is high).
Crestron e-control Vote ErrNumber Description Direction Type Value Expected Reply Comments See Also 95 • Appendices SW-VOTE COM Settings Request-to-Speak Console Voting Console When the server encounters an error processing a request from the System, it uses this signal to send an error number. Server to System Analog New error number None This signal works in conjunction with the ErrString and ErrTrigger signals which always follow immediately.
Crestron e-control Vote ErrString Description Direction Type Value Expected Reply Comments See Also 96 • Appendices SW-VOTE COM Settings Request-to-Speak Console Voting Console Description of error Server to System Serial Error message for display None Although this signal can be safely ignored, it is easily hooked to indirect text fields on a touchpanel and/or on the CNMSX-PRO front panel, etc.
Crestron e-control Vote SW-VOTE COM Settings Request-to-Speak Console Voting Console ErrTrigger Description Direction Trigger for ErrNumber and ErrString Server to System Type Digital Value Pulse Expected Reply None Comments See Also 97 • Appendices This signal is sent after the ErrNumber and ErrString to indicate that an error condition has occurred. For an e-mail scroller, this and the other Err signals are always defined.
Crestron e-control Vote SW-VOTE Excuses Description Direction Seat excuses itself control system to Voting Computer Type Digital Value Pulse Expected Reply None Comments Voting Console This signal is accepted by the Voting Computer only while the floor is opened for voting only.
Crestron e-control Vote Hold Description Direction control system to Voting Computer Digital Value Pulse Comments Request-to-Speak Console Puts the recognized seat on hold Type Expected Reply SW-VOTE Done pulse This signal is an automatic way for the control system to suspend debate. This function can also be provided to the Operator as a touchpanel button.
Crestron e-control Vote SW-VOTE Loadf Description Direction Load “save file” f into the queue-set control system to Voting Computer Type Digital Value Pulse Expected Reply Comments Request-to-Speak Console Success: Done pulse Failure: The Err_TABLE_NOT_FOUND error condition is raised Loads all the queues in the queue set. There must be a “save file” table for each queue. Each of these tables has the same structure as the queue scroller’s bound table.
Crestron e-control Vote SW-VOTE MicSelect Description Direction Type Value Expected Reply Comments Request-to-Speak Console Currently recognized seat Voting Computer to control system Analog Reset (set to 0): no seat recognized Other values: seat number of recognized speaker None This signal is sent out every time a seat is recognized to speak, or when the currently recognized seat becomes otherwise unrecognized (either by being put on hold; or by yielding — or being forced to yield — its remaining time
Crestron e-control Vote Names Description Direction Type Value Expected Reply Comments SW-VOTE Request-to-Speak Console Voting Console Seat names Voting Computer to control system Serial Screennames strings None Screennames from records in the Members table are sent (or resent) in response to receipt of a SendNames signal. Screennames may also be sent when either type of signal block is enabled (if so configured).
Crestron e-control Vote SW-VOTE NewVote Description Direction Vote sequence has been reset Voting Computer to control system Type Digital Value Pulse Expected Reply Comments Voting Console SetAgenda, Start, or Attendance This signal is pulsed when: § § § § The signal block is first enabled; a vote has concluded successfully (with print/save); a vote has been aborted; or an invalid agenda item description has been set.
Crestron e-control Vote Nos Description Direction control system to Voting Computer Digital Value Pulse Expected Reply None See Also 104 • Appendices Voting Console Seat votes NO Type Comments SW-VOTE This signal is accepted by the Voting Computer while the floor is opened for voting only.
Crestron e-control Vote SW-VOTE PingSvr, PingSys, PongSvr, PongSys Description Direction Request for acknowledgement PingSvr: System to Server PingSys: Server to System Type Digital Value Pulse Expected Reply Comments COM Settingss PongSvr: Server to System to Server PongSys: System PongSvror PongSys When the Server receives a PingSvr signal, it immediately responds with a PongSvr signal pulse. This is useful during System installation to test communications with the Server.
Crestron e-control Vote SW-VOTE PrintReport Description Direction Print displayed queue set control system to Voting Computer Type Digital Value Pulse Expected Reply Comments Voting Console Done pulse The printout is formatted for letter size paper (8.5” x 11”) to print up to five (5) queues, each in its own column, containing up to about 80 names each.
Crestron e-control Vote SW-VOTE PrintSave Description Direction Record vote; conclude voting sequence control system to Voting Computer Type Digital Value Pulse Expected Reply Success: Failure: Comments Voting Console StateEnd de-assert; followed by StatePrintSave assert ErrString Recording the vote makes the vote official; after issuing this signal, the vote can no longer be cancelled. This signal is only valid after a vote when the floor is closed (while StateEnd is high).
Crestron e-control Vote SW-VOTE Reqq,s Description Direction Type Value Expected Reply Comments Request-to-Speak Console Tied directly to the request-to-speak button for queue q at seat s control system to Voting Computer Digital Pulse (the Voting Computer responds to the trailing edge of the signal) Req-fb assert or de-assert; or nothing, depending on the circumstances The interpretation of this signal by the Voting Computer depends on the states listed in the following table.
Crestron e-control Vote SW-VOTE Req-fbq,s Description Direction Type Value Expected Reply Comments See Also 109 • Appendices Request-to-Speak Console Tied directly to the request-to-speak button feedback for queue q at seat s Voting Computer to control system Digital On: In queue and waiting to speak or speaking Off: Not in queue; or in queue and done speaking None If feedback is not responsive enough (which can be due to a large number of seats all “buzzing in” at the same time, or to EtherNet propag
Crestron e-control Vote Savef Description Direction Value Pulse See Also 110 • Appendices control system to Voting Computer Digital Comments Request-to-Speak Console Save the queue set into “save file” f Type Expected Reply SW-VOTE Success: Done pulse Failure: The Err_TABLE_NOT_FOUND error condition is raised Saves all the queues in the queue set. There must be a “save file” table for each queue. See Load for the names of these tables. Load Installation & Reference Guide — DOC.
Crestron e-control Vote SelectChair Description Direction SW-VOTE Voting Console Promote a seat to the chair control system to Voting Computer Type Value Expected Reply Comments Accept voting signals from the Chair position as if coming from the selected seat position. This signal is untested and should be considered not fully implemetned in this release. See Also 111 • Appendices Installation & Reference Guide — DOC.
Crestron e-control Vote SendNames Description Direction Value Pulse See Also 112 • Appendices control system to Voting Computer Digital Comments Request-to-Speak Console Voting Console Request names be sent Type Expected Reply SW-VOTE All Names serial signals; followed by Done signal pulse. (See notes at Name.) Name Installation & Reference Guide — DOC.
Crestron e-control Vote SW-VOTE SetAgenda Description Direction Set agenda item description. control system to Voting Computer Type Digital Value Pulse Expected Reply Voting Console AgendaEcho followed by one of: § AgendaTrigger pulse; or § NewVote pulse • Required before starting a vote from the control system with the Start signal unless the Auto-name an unnamed vote when started from Voting Computer box is checked.
Crestron e-control Vote 114 • Appendices SW-VOTE Installation & Reference Guide — DOC.
Crestron e-control Vote SW-VOTE Start Description Direction Open floor to voting control system to Voting Computer Type Digital Value Pulse Expected Reply Success: Failure: Comments Voting Console StateStart assert; followed by Done pulse ErrString This is one of two signals that can be used to start the voting sequence; the other is the Attendance signal.
Crestron e-control Vote SW-VOTE VOTE DISPLAYED: Press DISPLAY again to redisplay; SAVE RESULTS; or ABORT VOTE. See Also 116 • Appendices Attendance, End, Abort Installation & Reference Guide — DOC.
Crestron e-control Vote SW-VOTE StateDisplay Description Direction Voting Console Results on display Voting Computer to control system Type Digital Value Assert: Results now displayed on Voting Computer and/or need to be displayed on some device connected to control system (Display Results button feedback ON) De-assert: Results display down (Display Results button feedback OFF) To an assert: Display (again), PrintSave, or Abort To a de-assert: None Expected Reply Comments Results can be dis
Crestron e-control Vote SW-VOTE StateEnd Description Direction Voting concluded Voting Computer to control system Type Digital Value Assert: De-assert: Expected Reply Comments Voting Console To an assert: To a de-assert: Voting concluded, console ready to display or print/save (End Vote button feedback ON) Results displayed or printed/saved (End Vote button feedback OFF) Display, PrintSave, or Abort None Voting can be concluded either § by user interaction with the Vote Proctor window on the Vot
Crestron e-control Vote SW-VOTE StatePrintSave Description Direction Vote is being recorded Voting Computer to control system Type Digital Value Assert: De-assert: Expected Reply Comments Voting Console To an assert: To a de-assert: Results now being recorded on Voting Computer ([Print &] Save Results button feedback ON) Results have been recorded ([Print &] Save Results button feedback OFF) None None Results are saved either § by user interaction with the Vote Proctor window on the Voting Compu
Crestron e-control Vote SW-VOTE StateStart Description Direction Floor is opened to voting (i.e.
Crestron e-control Vote SW-VOTE Statuss Description Direction Type Value Expected Reply Comments Voting Console Individual seat status Voting Computer to control system Analog 0 ....... ABSENT 1 ....... PRESENT 2 ....... YES 3 ....... NO 4 ....... ABSTAIN 5 ....... EXCUSED 6 .......
Crestron e-control Vote SW-VOTE Tally23Majority Description Motion has achieved a 2/3 majority Direction Voting Computer to control system Type Value Expected Reply Comments Voting Console Digital Assert: De-assert: Motion currently has sufficient votes to qualify for “2/3 majority” Motion currently has insufficient votes to qualify for “2/3 majority” None The definition of “2/3 majority” is based on the signal block’s configuration. (See “The Rules Tab,” page 39.
Crestron e-control Vote SW-VOTE TallyAbstain Description Direction Type Value Expected Reply Comments Voting Console Total number of current abstentions Voting Computer to control system Analog 0 to s (where s = number of seats defined in signal block configuration) None Updated on any change to any seat at any time: § Reset to 0 on a new vote (following a NewVote pulse) § Updated in concert with all other “tally” signals § Sent in response to any Abstain signal, and (possibly) any Change signal See Al
Crestron e-control Vote SW-VOTE TallyCarried Description Direction Type Value Expected Reply Comments Voting Console Motion carries Voting Computer to control system Digital Assert: De-assert: Motion currently has sufficient votes to carry Motion currently has insufficient votes to carrry None The definition of “carries” is based on the signal block’s configuration. (See “The Rules Tab,” page 39.
Crestron e-control Vote SW-VOTE TallyExcused Description Direction Type Value Expected Reply Comments Voting Console Total number of excused voters Voting Computer to control system Analog 0 to s (where s = number of seats defined in signal block configuration) None Updated on any change to any seat at any time: § Reset to 0 on a new vote (following a NewVote pulse) § Updated in concert with all other “tally” signals § Sent in response to any Yes signal, and (possibly) any Change signal See Also 125 •
Crestron e-control Vote SW-VOTE TallyNo Description Direction Type Value Expected Reply Comments Voting Console Total number of current NO votes Voting Computer to control system Analog 0 to s (where s = number of seats defined in signal block configuration) None Updated on any change to any seat at any time: § Reset to 0 on a new vote (following a NewVote pulse) § Updated in concert with all other “tally” signals § Sent in response to any No signal, and (possibly) any Change signal See Also 126 • App
Crestron e-control Vote SW-VOTE TallyQuorum Description Direction Type Value Expected Reply Comments Voting Console Motion is subject to a voting quorum Voting Computer to control system Digital Assert: De-assert: Motion currently has sufficient votes to meet quorum requirements Motion currently has insufficient votes to meet quorum requirements None The definition of “voting quorum” is based on the signal block’s configuration. (See “The Rules Tab,” page 39.
Crestron e-control Vote SW-VOTE TallyTotal Description Direction Type Value Expected Reply Comments Voting Console Total number of current votes Voting Computer to control system Analog 0 to s (where s = number of seats defined in signal block configuration) None The total number of votes includes the sum of all YES votes + all NO votes + all abstentions. Excluded from this sum are all absentees, non-voters, and excused voters.
Crestron e-control Vote SW-VOTE TallyYes Description Direction Type Value Expected Reply Comments Voting Console Total number of current YES votes Voting Computer to control system Analog 0 to s (where s = number of seats defined in signal block configuration) None Updated on any change to any seat at any time: § Reset to 0 on a new vote (following a NewVote pulse) § Updated in concert with all other “tally” signals § Sent in response to any Yes signal, and (possibly) any Change signal See Also 129 •
Crestron e-control Vote Yess Description Direction control system to Voting Computer Digital Value Pulse Expected Reply None See Also 130 • Appendices Voting Console Seat votes YES Type Comments SW-VOTE This signal is accepted by the Voting Computer while the floor is opened for voting only.
Crestron e-control Vote SW-VOTE Yield Description Direction Forces the recognized seat to yield the floor control system to Voting Computer Type Digital Value Pulse Expected Reply Comments Voting Console Done pulse This signal is an automatic way for the contorl system to force the current speaker to yield. It is typically tied to the alarm of a count-down timer. This function can also be provided to the Operator as a touchpanel button to give him the ability to force a speaker to yield.
Crestron e-control Vote SW-VOTE Appendix D: Error Conditions When an error condition arises, the error number is sent via the ErrNumber analog signal through the signal block that raised the error to the control system. The error string is sent via the accompanying ErrString serial signal. Finally, the ErrTrigger digital signal is pulsed. ErrNumber is intended for use by error-handling SIMPL code. Typically, ErrString is used for display to the user who prompted the error.
Crestron e-control Vote 133 • Appendices SW-VOTE 32011 Err_FIELD_NOT_WRITTEN No such record(s) 32012 Err_CANNOT_ADD_RECORD Syntax error in query 32013 Err_CANNOT_DELETE_RECORD Field could not be written 32014 Err_NO_SUCH_RECORD A new record could not be added 32015 Err_QUERY_SYNTAX The opened record could not be deleted 32016 Err_UNIMPLEMENTED_FUNCTION Unimplemented function 32017 Err_MAIL_NOT_SENT Mail not sent 32018 Err_NEW_MAIL New mail received at time 32019 Err_NO_NEW_MAIL Mail last
Crestron e-control Vote SW-VOTE Appendix E: System limitations Serial Transmissions The length of the value of all serial signals (all the Set— signals) is limited to 83 characters. Furthermore, the total length of all signals (including header bytes) to be transmitted in a single logic “wave” must not exceed 255 characters. Another limitation is that the current generation of touchpanels do not correctly handle strings sent to indirect text fields when such strings exceed 80 characters.
Crestron e-control Vote SW-VOTE Appendix F: Standard Scrollers vs. Custom Scrollers Inspection of any standard scroller signal block, or its SIMPL Windows counterpart, the DBM Scroller logic module, shows that it defines only the most essentail scroller signals. Standard scroller options Custom scroller options no license required 135 • Appendices SW-DBM license required Enable signal non-functional except in simulation (from Signal Analyzer window).