AMX NSS-VOTE - PROGRAMMER GUIDE Programmer's Manual

AMX NSS-VOTE - PROGRAMMER GUIDE Programmer's Manual

Advertisement

Quick Links

Programmer's Guide
NSS-Vote
D o c u m e n t I D : 0 3 3 - 0 0 4 - 2 6 3 5
i n t e g r a t i o n ! S o l u t i o n s
L a s t R e v i s e d : 6 / 0 2 / 2 0 0 6

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the NSS-VOTE - PROGRAMMER GUIDE and is the answer not in the manual?

Questions and answers

Summary of Contents for AMX NSS-VOTE - PROGRAMMER GUIDE

  • Page 1 Programmer’s Guide NSS-Vote D o c u m e n t I D : 0 3 3 - 0 0 4 - 2 6 3 5 i n t e g r a t i o n ! S o l u t i o n s L a s t R e v i s e d : 6 / 0 2 / 2 0 0 6...
  • Page 2 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.
  • Page 3: Table Of Contents

    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 ....................
  • Page 4 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 NSS-Vote Programmer’s Guide...
  • Page 5: Introduction

    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 ®...
  • Page 6 Introduction NSS-Vote Programmer’s Guide...
  • Page 7: Hardware Options

    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.
  • Page 8: 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...
  • Page 9: Public Speaking Podium

    Hardware Options Public Speaking Podium NSS-Vote supports a single public speaking podium’s request to speak functions though a simple AXD- MSP8 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.
  • Page 10: Pc-Based Voting Display

    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.
  • Page 11: Programming

    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.
  • Page 12: Adding Non-Graphical Voting Stations

    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.
  • Page 13: Adding Voting Displays

    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.
  • Page 14: Modifying Graphical Room View

    Programming Additionally, you can provide an "in queue" indicator. In the program, look for the send strings containing >==> [MICROPHONE IN QUEUE] STATION <==< [MICROPHONE NOT IN . At this point in the code, you can use this signal to turn any indicators on and off, QUEUE] STATION such as a red microphone LED ring, if it is available.
  • Page 15: Downloading Files

    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 ™...
  • Page 16: 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.
  • Page 17: Modules

    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, CONSOLE_TOPIC_LIST_CHECK, CONSOLE_TOPIC_LIST_CONTROL, CONSOLE_TOPIC_LIST_SELECTED, CONSOLE_LIST_INFO, CONSOLE_BODY_MANAGEMENT, CONSOLE_CONFIRMATION_DIALOG, CONSOLE_ERROR_DIALOG,...
  • Page 18 Programming NSS-VoteEngineMod Module Parameter Definitions A virtual device number for programming NetLinx events and global vdvVotingGlobal NSS-Vote internal communications. An array of virtual device numbers for programming Station NSS-Vote vdvVotingStations internal communications. An array of operator console device numbers. dvVotingConsoles A PCLink device programmed to communicate with NSS-VoteMan- dvVotingManager ager.
  • Page 19 Programming NSS-VoteEngineMod Module Parameter Definitions (Cont.) An INTEGER array with the following buttons: CONSOLE_AGENDA_LIST_CONTROL • Agenda List Page Up • Agenda List Bottom of List • Agenda List Page Down • Agenda List Select List Item • Agenda List Top of List •...
  • Page 20 Programming NSS-VoteEngineMod Module Parameter Definitions (Cont.) An INTEGER array with the following buttons: CONSOLE_KEYBOARD • Keyboard/Keypad Field 1 • Keypad/Keypad Field 4 (Primary) • Checkbox 1 • Keypad/Keypad Field 2 • Checkbox 2 • Keypad/Keypad Field 3 An INTEGER array with the following buttons and variable text codes: CONSOLE_KEYBOARD_CMD •...
  • Page 21 Programming NSS-VoteEngineMod Module Parameter Definitions (Cont.) An INTEGER array with the following buttons: CONSOLE_MAIN_CONTROLS • Start Vote • Ad Hoc Topic • Stop Vote • Display Topic Options • Intermission Mode • View Voting Progress • Roll Call • Vote in Session •...
  • Page 22 Programming NSS-VoteEngineMod Module Parameter Definitions (Cont.) An INTEGER array with the following variable text codes: CONSOLE_STATION_NAME • Station Name 1 • Station Name 12 • Station Name 2 • Station Name 13 • Station Name 3 • Station Name 14 •...
  • Page 23 Programming NSS-VoteEngineMod Module Parameter Definitions (Cont.) An INTEGER array with the following variable text codes: CONSOLE_STATION_VOTE_STATUS • Station Vote Status 1 • Station Vote Status 12 • Station Vote Status 2 • Station Vote Status 13 • Station Vote Status 3 •...
  • Page 24: Nss-Votetouchpanelstationmod Module

    Programming NSS-VoteEngineMod Module Parameter Definitions (Cont.) An INTEGER array with the following buttons: CONSOLE_RTS_OPTION_BUTTONS • Edit RTS Timer • Edit RTS Timer (from Body Default) (from RTS Options) • Edit Public Speaker Timer • Edit Public Speaker Timer (from Body Default) (from RTS Options) An INTEGER array with the following buttons: CONSOLE_RTS_OPTION_DEFAULT_...
  • Page 25: Nss-Votemspstationmod Module

    Programming NSS-VoteTouchPanelStationMod Module Parameter Definitions A virtual device number for programming NetLinx events and Global vdvVotingGlobal NSS-Vote internal communications. A virtual device number for programming Station NSS-Vote internal vdvVotingStation communications. An array of TP station device numbers. dvTouchPanelStations An INTEGER array with the following buttons and variable text codes: STATION_BUTTON_VAR_TEXT •...
  • Page 26: Nss-Votedisplayonlymod Module

    Programming NSS-VoteTouchPanelStationMod Module Parameter Definitions A virtual device number for programming NetLinx events and Global vdvVotingGlobal NSS-Vote internal communications. A virtual device number for programming Station NSS-Vote internal vdvVotingStation communications. An array of MSP station device numbers. dvMSPStations An INTEGER array with the following buttons: MSP_STATION_BUTTON_CHANNEL •...
  • Page 27 Programming NSS-VoteDisplayOnlyMod Module Parameter Definitions (Cont.) An INTEGER array with the following buttons and variable text codes: STATION_BUTTON_VAR_TEXT • Welcome Message • Vote Result ABSTAIN count • Voting Body • Vote Result EXCUSE count • Voting Agenda • Vote Result YES Percentage •...
  • Page 28: Nss-Votepublicspeakingstation Module

    Programming NSS-VoteDisplayOnlyMod Module Parameter Definitions (Cont.) An INTEGER array with the following variable text codes: DISPLAY_STATION_NAME • Station Name 1 • Station Name 12 • Station Name 2 • Station Name 13 • Station Name 3 • Station Name 14 •...
  • Page 29: Nss-Voteenginemod Api

    Programming NSS-VoteTouchPanelStationMod Module Parameter Definitions A virtual device number for programming NetLinx events and Global vdvVotingGlobal NSS-Vote internal communications. A device number for this station. dvMSPStationPS An INTEGER array with the following buttons: PUBLIC_STATION_BUTTON_ CHANNEL • RTS: Request to Speak •...
  • Page 30 Programming Global Channels (Cont.) Channel Function RTS System Enabled RTS Public Speaker Enabled RTS Timer Enabled RTS Warn Timer Enabled RTS Public Speaker Timer Enabled RTS Public Speaker Warning Timer Enabled RTS Timer Warning in Effect Allow RTS Cancel Allow Priority Hold Auto Close Microphone on Timer Expire RTS Mode –...
  • Page 31: Levels

    Programming Levels There are two level types: Global Station Specific Global Levels Level Function Level Function Vote Timer Current Time RTS Timer Current Time Vote Timer Total Time RTS Timer Total Time Vote Warn Time RTS Warn Time Default Vote RTS Speaker Seat Voting Results –...
  • Page 32 Programming The following is a list of station specific strings. Station Specific Strings String Function The station ID for the station SID. 'ID: <SID>-<Station ID>' The member name and title for the station 'NAME: <SID>-<Member Name>;<Member Title>' SID. A message for the station SID. 'MESSAGE: <SID>-<Massage Text>' If SID is 0, then this is a global message.
  • Page 33 Programming iNSS-Vote Programmer’s Guide...
  • Page 34 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...

This manual is also suitable for:

Nss-vote

Table of Contents