AMX NSS-VOTE Programmer Guide
Programmer’s Guide
NSS-Vote
integration!Solutions
Document ID: 033-004-2635
Last Revised: 6/02/2006
Software License and Warranty Agreement
LICENSE GRANT.
AMX grants to Licensee the non-exclusive right to use the AMX Software in the manner described in this License. The AMX Software is
licensed, not sold. This license does not grant Licensee the right to create derivative works of the AMX Software. The AMX Software consists
of generally available programming and development software, product documentation, sample applications, tools and utilities, and
miscellaneous technical information. Please refer to the README.TXT file on the compact disc or download for further information regarding
the components of the AMX Software. The AMX Software is subject to restrictions on distribution described in this License Agreement.
LICENSEE MAY NOT SUBLICENSE, RENT, OR LEASE THE AMX SOFTWARE. Licensee may not reverse engineer, decompile, or
disassemble the AMX Software.
INTELLECTUAL PROPERTY.
The AMX Software is owned by AMX and is protected by United States copyright laws, patent laws, international treaty provisions, and/or state
of Texas trade secret laws. Licensee may make copies of the AMX Software solely for backup or archival purposes. Licensee may not copy
the written materials accompanying the AMX Software.
TERMINATION.
AMX RESERVES THE RIGHT, IN ITS SOLE DISCRETION, TO TERMINATE THIS LICENSE FOR ANY REASON AND UPON WRITTEN
NOTICE TO LICENSEE. In the event that AMX terminates this License, the Licensee shall return or destroy all originals and copies of the
AMX Software to AMX and certify in writing that all originals and copies have been returned or destroyed.
PRE-RELEASE CODE.
Portions of the AMX Software may, from time to time, as identified in the AMX Software, include PRE-RELEASE CODE and such
code may not be at the level of performance, compatibility and functionality of the final code. The PRE-RELEASE CODE may not
operate correctly and may be substantially modified prior to final release or certain features may not be generally released. AMX is
not obligated to make or support any PRE-RELEASE CODE. ALL PRE-RELEASE CODE IS PROVIDED "AS IS" WITH NO
WARRANTIES.
LIMITED WARRANTY.
AMX warrants that the AMX Software will perform substantially in accordance with the accompanying written materials for a period of ninety
(90) days from the date of receipt. AMX DISCLAIMS ALL OTHER WARRANTIES, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT
LIMITED TO IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, WITH REGARD TO THE
AMX SOFTWARE. THIS LIMITED WARRANTY GIVES LICENSEE SPECIFIC LEGAL RIGHTS. Any supplements or updates to the AMX
SOFTWARE, including without limitation, any (if any) service packs or hot fixes provided to Licensee after the expiration of the ninety (90) day
Limited Warranty period are not covered by any warranty or condition, express, implied or statutory.
LICENSEE REMEDIES.
AMX's entire liability and Licensee's exclusive remedy shall be repair or replacement of the AMX Software that does not meet AMX's Limited
Warranty and which is returned to AMX. This Limited Warranty is void if failure of the AMX Software has resulted from accident, abuse, or
misapplication. Any replacement AMX Software will be warranted for the remainder of the original warranty period or thirty (30) days,
whichever is longer. Outside the United States, these remedies may not available.
NO LIABILITY FOR CONSEQUENTIAL DAMAGES. IN NO EVENT SHALL AMX BE LIABLE FOR ANY DAMAGES WHATSOEVER
(INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR INABILITY TO USE THIS AMX SOFTWARE,
EVEN IF AMX HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. BECAUSE SOME STATES/COUNTRIES DO NOT
ALLOW THE EXCLUSION OR LIMITATION OF LIABILITY FOR CONSEQUENTIAL OR INCIDENTAL DAMAGES, THE ABOVE LIMITATION
MAY NOT APPLY TO LICENSEE.
U.S. GOVERNMENT RESTRICTED RIGHTS.
The AMX Software is provided with RESTRICTED RIGHTS. Use, duplication, or disclosure by the Government is subject to
restrictions as set forth in subparagraph ©(1)(ii) of The Rights in Technical Data and Computer Software clause at DFARS 252.2277013 or subparagraphs ©(1) and (2) of the Commercial Computer Software Restricted Rights at 48 CFR 52.227-19, as applicable.
SOFTWARE AND OTHER MATERIALS FROM AMX.COM MAY BE SUBJECT TO EXPORT CONTROL.
The United States Export Control laws prohibit the export of certain technical data and software to certain territories. No software from this Site
may be downloaded or exported (i) into (or to a national or resident of) Cuba, Iraq, Libya, North Korea, Iran, Syria, or any other country to
which the United States has embargoed goods; or (ii) anyone on the United States Treasury Department's list of Specially Designated Nationals or the U.S. Commerce Department's Table of Deny Orders. AMX does not authorize the downloading or exporting of any software or technical data from this site to any jurisdiction prohibited by the United States Export Laws.
This Agreement replaces and supersedes all previous AMX Software License Agreements and is governed by the laws of the State of Texas,
and all disputes will be resolved in the courts in Collin County, Texas, USA. For any questions concerning this Agreement, or to contact AMX
for any reason, please write: AMX, 3000 Research Drive, Richardson, TX 75082.
Table of Contents
Table of Contents
Introduction ........................................................................................................1
Supported Operating Systems .......................................................................................... 1
Minimum PC Requirements .............................................................................................. 1
Installing NSS-Vote ........................................................................................................... 1
Hardware Options .............................................................................................. 3
Operator’s Consoles.......................................................................................................... 3
Voting Stations .................................................................................................................. 4
Public Speaking Podium ................................................................................................... 5
Voting Display ................................................................................................................... 5
PC-Based Voting Display .................................................................................................. 6
Typical Configurations....................................................................................................... 6
Configuration 1 (High-end) ....................................................................................................... 6
Configuration 2 (Medium-sized) ............................................................................................... 6
Configuration 3 (Low-end)........................................................................................................ 6
Programming ......................................................................................................7
Initial Programming ........................................................................................................... 7
Adding Operators' Consoles .................................................................................................... 7
Adding Graphical Voting Stations ............................................................................................ 7
Adding Non-Graphical Voting Stations..................................................................................... 8
Adding a Public Podium Speaking Station ............................................................................... 8
Adding Voting Displays ............................................................................................................ 9
Voting Results Display Programming................................................................................ 9
Request to Speak Programming ....................................................................................... 9
Modifying Graphical Room View ..................................................................................... 10
Custom Programming ..................................................................................................... 10
Adding Custom NSS-Vote Options ........................................................................................ 10
Customizing HTML Pages ..................................................................................................... 10
Downloading Files ........................................................................................................... 11
The Main AXS Code .............................................................................................................. 11
The TPD Files ........................................................................................................................ 11
Support for HTML Based Voting Results ............................................................................... 11
Software Key ................................................................................................................... 12
Obtaining a Software Key ...................................................................................................... 12
Entering a Software Key ........................................................................................................ 12
Running NSS-Vote .......................................................................................................... 12
Modules........................................................................................................................... 13
NSS-Vote Programmer’s Guide
i
Table of Contents
NSS-VoteEngineMod Module ................................................................................................ 13
NSS-VoteTouchPanelStationMod Module ............................................................................. 20
NSS-VoteMSPStationMod Module ........................................................................................ 21
NSS-VoteDisplayOnlyMod Module ........................................................................................ 22
NSS-VotePublicSpeakingStation Module .............................................................................. 24
NSS-VoteEngineMod API ............................................................................................... 25
Channels ................................................................................................................................ 25
Levels..................................................................................................................................... 27
Strings .................................................................................................................................... 27
ii
NSS-Vote Programmer’s Guide
Introduction
NSS-Vote™ is designed to manage voting and microphone control for small to medium city council style
meetings. NSS-Vote supports two voting/microphone management consoles, up to 21 voting/
microphone stations and one public podium microphone.
Supported Operating Systems
Windows 95
Windows NT 4.0
64 MB of installed memory)
Windows 2000
requirement); 300 MHz or faster recommended, with 96 MB of installed memory.)
Minimum PC Requirements
Windows-compatible mouse (or other pointing device)
At least 5 MB of free disk space (150 MB recommended)
VGA monitor, with a minimum screen resolution of 800 x 600
A Network adapter
Introduction
®
/98® (with at least 48 MB of installed memory)
®
Workstation or Server (service pack 6 B or greater, with at least
®
Professional or Server (running on a Pentium 233 MHz processor (minimum
Installing NSS-Vote
1. In Explorer, double-click NSS-VoteSetup.exe from the directory window where you downloaded
the NSS-Vote install program.
2. After reading the License Agreement, select I Agree and Next to proceed.
3. The Welcome To NSS-Vote Setup dialog appears, reminding you to close all Windows programs
before going any further. Click Next to proceed.
4. In the Select NSS-Vote Install Location dialog, use the Browse button to navigate to a directory
other than the default install directory, if desired. Click Next.
5. In the NSS-Vote Shortcut Creation dialog, select Install Shortcut Icons for the installed
components on your desktop, if desired.
6. Click Next in the Start NSS-Vote Installation dialog to install the selected components.
7. The program prompts you to restart your system to complete the installation.
NSS-Vote Programmer’s Guide
1
Introduction
2
NSS-Vote Programmer’s Guide
Hardware Options
NSS-Vote can support multiple hardware configurations. The following sections describe what support
NSS-Vote ships with and a few typical configurations.
Operator’s Consoles
Hardware Options
FIG. 1 Sample View of Console Main Page
NSS-Vote supports two operator consoles. The operator’s consoles control all voting and microphone
management functions. Two consoles are supported since many configurations require two operators.
The console station, if configured, can also function as one of the 21 voting stations.
NSS-Vote ships with the following touch panel pages for the operator's console.
G4 Voting console pages, 800x600 (CA/V-12 and TPI4)
G4 Voting console pages, 1024x768(CA/V-15 and TPI4)
G4 Voting console pages, 1280x768 (CV17)
G3 Voting console pages, 640x480 (CA/V/G-10, TPI3)
Due to the large number of controls per page; resolutions below 640 x 480 are not recommended for the
operator's console.
NSS-Vote Programmer’s Guide
3
Hardware Options
Voting Stations
FIG. 2 Sample View of Graphical Voting Station
NSS-Vote supports both graphical and non-graphical voting stations.
Graphical user interfaces include all AMX touch panels. NSS-Vote ships with several touch
panel designs and a station module for touch panel based voting stations. These may be used
in any current and future AMX touch panels. Graphical voting stations can display voting
topics, results and speaker management information directly on the voting station. The
following touch panel pages are included:
G4 Voting station pages, 800x480 (CV-7)
G4 Voting station pages, 800x600 (CA/V-12 and TPI4)
G4 Voting station pages, 1024x768(CA/V-15 and TPI4)
G4 Voting station pages, 1280x768 (CV17)
G3 Voting station pages, 640x480 (CA/V/G-10, TPI3)
G3 Voting station pages, 320x240 (CV6,CP4)
Non-Graphical user interfaces include many of the push-button products in the AMX product
line. NSS-Vote ships with a TXL design and station module for an AXD-MSP8 voting station.
This TXL and station module can easily be modified for use with an AXD-MSP16 or AXDMSP32. Non-graphical voting stations cannot display voting topics, results and speaker
management information directly on the voting station.
Additionally, this voting station module can be used with an NXP-CPI16 or AXP-CPI16 allowing you to
design a custom voting station. Additional programming may be required when using a custom design.
4
NSS-Vote Programmer’s Guide
Hardware Options
Public Speaking Podium
NSS-Vote supports a single public speaking podium’s request to speak functions though a simple AXDMSP8 design. Only two buttons are required for public speaking: Request to Speak and Cancel
Request. Optionally, a bargraph, if available, is used to display the speaking timer.
As with the non-graphical voting station, you may easily substitute an AXD-MSP16,
AXD-MSP32, AXP-CPI16 or NXP-CPI16 for this station.
Voting Display
FIG. 3 Sample View of Voting Display
NSS-Vote can support one or more voting display stations. Additionally, any graphical voting station
compatible product can be used as a voting display.
The most common voting display station hardware is the AXB-TPI/3 or NXP-TPI/4. Since the AXBTPI/3 or NXP-TPI/4 have video outputs, these devices can be used to display voting results to video
displays. These products also supply video feeds for use in broadcasting. The following touch panel
pages are included:
G4 Public display pages, 1024x768 (TPI4)
G3 Public display pages, 1024x768 (TPI3)
Additionally, video hardware may be required for some applications. Make sure to
see the specifications for AXB-TPI/3 or NXP-TPI/4 for details on what video
connections are available from these units.
NSS-Vote Programmer’s Guide
5
Hardware Options
PC-Based Voting Display
NSS-Vote can support voting results in a standard Internet browser window. This browser display can be
used to post voting results to a projector, if desired. More detailed voting results are available when using
a graphical voting display, but this option can provide a low-cost method for displaying voting results.
Additionally, video hardware may be required to make the PC’s video appear on the
video projector. Make sure to account for this in your design.
Typical Configurations
While NSS-Vote is extremely flexible, a few typical configurations are included below. The
configuration that is right for you is dependant on your budget and requirements. Please use these
configurations as a guideline.
Configuration 1 (High-end)
A typical high-end configuration would include:
Two AXT-CA10’s – One Operator’s console for the Mayor and one operator’s console for the
City Clerk.
Up to 21 AXT-CA10’s – One panel per voting station.
One AXD-MSP8 – One public speaking station.
One AXB-TPI/3 – One voting display station to display voting results on a projector.
Configuration 2 (Medium-sized)
A typical medium-sized configuration would include:
Two AXT-CA10’s – One Operator’s console for the Mayor and one operator’s console for the
City Clerk.
Up to 21 AXT-CP4’s or AXD-CV6’s – One panel per voting station.
One AXD-MSP8 – One public speaking station.
One AXB-TPI/3 – One voting display station to display voting results on a projector.
Configuration 3 (Low-end)
A typical low-end configuration would include:
Two AXT-CA10’s – One Operator’s console for the Mayor and one operator’s console for the
City Clerk.
Up to 21 AXD-MSP8’s – One panel per voting station.
One AXD-MSP8 – One public speaking station.
One AXB-TPI/3 – One voting display station to display voting results on a projector. This
option is recommended in this configuration to provide each member with a graphical view of
the voting results.
6
NSS-Vote Programmer’s Guide
Programming
Initial Programming
Once you have decided on the hardware configuration you intend to use, you need to customize the main
NSS-Vote program to accommodate your design. Two sample programs are provided with
NSS-Vote:
NSS-VoteTest-TP Stations is a program that implements voting with touch panel based
station.
NSS-VoteTest-MSP Stations is a program that implements MSP based voting stations.
Start by choosing one of these files to start from and saving it as 'NSS-VoteTest'. NSS-Vote is modular
so you can add and remove a module for each option you would like to support.
At the heart of the NSS-Vote system is the NSS-VoteEngineMod module. This module includes all the
functionality for voting and microphone management. This module must be included in every NSS-Vote
system.
See NSS-VoteEngineMod Module section on page 13 for a detailed description of the parameters used by
this module.
Programming
Adding Operators' Consoles
Operators’ consoles are support directly by the NSS-VoteEngineMod module. To add an operator’s
console:
1. Define the device number for the operator’s console device.
2. Include this device in the dvVotingConsole device array parameter for the
NSS-VoteEngineMod module.
Many of the remaining parameters of the NSS-VoteEngineMod module specify the channel and variable
text numbers used by the operator’s console touch panel. These parameters are pre-defined in NSS-Vote
Console Station Channels.axi to simplify programming. If you have not changed any of the channels or
variable text channel in the supplied touch panel file, then no modification of
NSS-Vote Console Station Channels.axi is required.
See NSS-VoteEngineMod Module section on page 13 for a detailed description of the parameters used by
this module.
Adding Graphical Voting Stations
All touch panel-based voting stations are supported by the NSS-VoteTouchPanelStationMod module.
To add a touch panel voting station:
1. Define the device number for the voting station device.
2. Include this device in the dvTouchPanelStations device array parameter for the
NSS-VoteTouchPanelStationMod module.
The location of the device appears in the array determining the device’s station ID. For instance, if the
device is added as the third element of the device array, it will be the third station.
To skip a station ID: Add the
is defined as 0:0:0.
dvNull device to the array at the position you would like to skip. dvNull
NSS-Vote Programmer’s Guide
7
Loading...