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.
Table of Contents Table of Contents Introduction ........................................................................................................1 Supported Operating Systems .......................................................................................... 1 Minimum PC Requirements .............................................................................................. 1 Installing NSS-Vote ..............................................................................................
Table of Contents NSS-VoteEngineMod Module ................................................................................................ 13 NSS-VoteTouchPanelStationMod Module ............................................................................. 20 NSS-VoteMSPStationMod Module ........................................................................................ 21 NSS-VoteDisplayOnlyMod Module ........................................................................................
Introduction 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®/98® (with at least 48 MB of installed memory) Windows NT 4.
Introduction 2 NSS-Vote Programmer’s Guide
Hardware Options 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 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.
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.
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.
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.
Programming 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'.
Programming The remaining parameters of the NSS-VoteTouchPanelStationMod module specify the channel and variable text resources used by the voting station. These parameters are pre-defined in NSS-Vote TP Station Channels.axi to simplify programming. If you have not changed any of the channels of variable text channel in the supplied touch panel files, then no modification of NSS-Vote TP Station Channels.axi is required.
Programming See NSS-VotePublicSpeakingStation Module section on page 24 for a detailed description of the parameters used by this module. The NSS-VotePublicSpeakingStation Module is provided as an open source code module in the event that custom programming is necessary. Adding Voting Displays All voting displays are supported by NSS-VoteDisplayOnlyMod module. To add a voting display: 1. Define the device number for the voting display device. 2.
Programming Additionally, you can provide an "in queue" indicator. In the program, look for the send strings containing >==> [MICROPHONE IN QUEUE] STATION and <==< [MICROPHONE NOT IN QUEUE] STATION. At this point in the code, you can use this signal to turn any indicators on and off, such as a red microphone LED ring, if it is available. Implementing microphone control and indicators for the public speaking podium is very similar. These events are implemented in a different section of the program.
Programming AMX does not offer support for modifying XSL files. Downloading Files The Main AXS Code Once you have configured the NSS-VoteTest.axs file for your particular NSS-Vote configuration and have added any additional program as your system requires, compile and download this AXS file using the NetLinx Studio™ software program. All of the pre-compiled modules that ship with NSS-Vote are .TKO files.
Programming Software Key To run NSS-Vote, you must obtain a software key from AMX. NSS-Vote functions normally without a software key; however, the voting topic text appears as "Please obtain a Software Key from AMX to use NSS-Vote" on all voting stations and in the voting results. Obtaining a Software Key Thank you for purchasing NSS-Vote. To activate this application please contact AMX at 800-932-6993 option 3, and ask for Platinum Software Solutions Support.
Programming Modules NSS-VoteEngineMod Module To assist you in your programming the NSS-VoteEngineMod Module definition code is displayed below: DEFINE_MODULE 'NSS-VoteEngineMod' mdlVEngine (vdvVotingGlobal, vdvVotingStations, dvVotingConsoles, dvVotingManager, nRTSSystemEnabled, CONSOLE_MAIN_MENU, CONSOLE_BODY_LIST, CONSOLE_LIST_CONTROL, CONSOLE_MEMBER_LIST, CONSOLE_MEMBER_LIST_ID, CONSOLE_MEMBER_LIST_CONTROL, CONSOLE_AGENDA_LIST, CONSOLE_AGENDA_LIST_CONTROL, CONSOLE_TOPIC_LIST, CONSOLE_TOPIC_LIST_RESULTS
Programming NSS-VoteEngineMod Module Parameter Definitions vdvVotingGlobal A virtual device number for programming NetLinx events and global NSS-Vote internal communications. vdvVotingStations An array of virtual device numbers for programming Station NSS-Vote internal communications. dvVotingConsoles An array of operator console device numbers. dvVotingManager A PCLink device programmed to communicate with NSS-VoteManager.
Programming NSS-VoteEngineMod Module Parameter Definitions (Cont.
Programming NSS-VoteEngineMod Module Parameter Definitions (Cont.
Programming NSS-VoteEngineMod Module Parameter Definitions (Cont.
Programming NSS-VoteEngineMod Module Parameter Definitions (Cont.
Programming NSS-VoteEngineMod Module Parameter Definitions (Cont.
Programming NSS-VoteEngineMod Module Parameter Definitions (Cont.
Programming NSS-VoteTouchPanelStationMod Module Parameter Definitions vdvVotingGlobal A virtual device number for programming NetLinx events and Global NSS-Vote internal communications. vdvVotingStation A virtual device number for programming Station NSS-Vote internal communications. dvTouchPanelStations An array of TP station device numbers.
Programming NSS-VoteTouchPanelStationMod Module Parameter Definitions vdvVotingGlobal A virtual device number for programming NetLinx events and Global NSS-Vote internal communications. vdvVotingStation A virtual device number for programming Station NSS-Vote internal communications. dvMSPStations An array of MSP station device numbers.
Programming NSS-VoteDisplayOnlyMod Module Parameter Definitions (Cont.
Programming NSS-VoteDisplayOnlyMod Module Parameter Definitions (Cont.
Programming NSS-VoteTouchPanelStationMod Module Parameter Definitions vdvVotingGlobal A virtual device number for programming NetLinx events and Global NSS-Vote internal communications. dvMSPStationPS A device number for this station.
Programming Global Channels (Cont.
Programming Levels There are two level types: Global Station Specific Global Levels Level Function Level Function 1 Vote Timer Current Time 20 RTS Timer Current Time 2 Vote Timer Total Time 21 RTS Timer Total Time 3 Vote Warn Time 22 RTS Warn Time 4 Default Vote 23 RTS Speaker Seat 5 Voting Results – Yes 24 RTS Total Stations in Queue 6 Voting Results – No 25 Public Speaking Station Position in RTS Queue 7 Voting Results – Abstain 8 Voting Results – Excuse 9 Voting Results
Programming The following is a list of station specific strings. Station Specific Strings 28 String Function 'ID: -' The station ID for the station SID. 'NAME: -;' The member name and title for the station SID. 'MESSAGE: -' A message for the station SID. If SID is 0, then this is a global message. 'SVOTEE-' Array of voting enabled flags for all stations.
Programming iNSS-Vote Programmer’s Guide 29
It’s Your World - Take Control™ 3000 RESEARCH DRIVE, RICHARDSON, TX 75082 USA • 800.222.0193 • 469.624.8000 • 469-624-7153 fax • 800.932.6993 technical support • www.amx.com 033-004-2635 6/06 ©2006 AMX. All rights reserved. AMX and the AMX logo are registered trademarks of AMX. AMX reserves the right to alter specifications without notice at any time.
