AMX RMS CODECRAFTER User manual

instruction manual
Software
RMS CodeCrafter

AMX Limited Warranty and Disclaimer
AMX Corporation warrants its products to be free of defects in material and workmanship under normal use for three
(3) years from the date of purchase from AMX Corporation, with the following exceptions:
• Electroluminescent and LCD Control Panels are warranted for three (3) years, except for the display and touch
overlay components that are warranted for a period of one (1) year.
• Disk drive mechanisms, pan/tilt heads, power supplies, and MX Series products are warranted for a period of one
(1) year.
• AMX Lighting products are guaranteed to switch on and off any load that is properly connected to our lighting
products, as long as the AMX Lighting products are under warranty. AMX Corporation does guarantee the
control of dimmable loads that are properly connected to our lighting products. The dimming performance or
quality cannot be guaranteed due to the random combinations of dimmers, lamps and ballasts or transformers.
• Unless otherwise specified, OEM and custom products are warranted for a period of one (1) year.
• AMX Software is warranted for a period of ninety (90) days.
• Batteries and incandescent lamps are not covered under the warranty.
This warranty extends only to products purchased directly from AMX Corporation or an Authorized AMX Dealer.
All products returned to AMX require a Return Material Authorization (RMA) number. The RMA number is
obtained from the AMX RMA Department. The RMA number must be clearly marked on the outside of each box.
The RMA is valid for a 30-day period. After the 30-day period the RMA will be cancelled. Any shipments received
not consistent with the RMA, or after the RMA is cancelled, will be refused. AMX is not responsible for products
returned without a valid RMA number.
AMX Corporation is not liable for any damages caused by its products or for the failure of its products to perform.
This includes any lost profits, lost savings, incidental damages, or consequential damages. AMX Corporation is not
liable for any claim made by a third party or by an AMX Dealer for a third party.
This limitation of liability applies whether damages are sought, or a claim is made, under this warranty or as a tort
claim (including negligence and strict product liability), a contract claim, or any other claim. This limitation of
liability cannot be waived or amended by any person. This limitation of liability will be effective even if AMX Corpo-
ration or an authorized representative of AMX Corporation has been advised of the possibility of any such damages.
This limitation of liability, however, will not apply to claims for personal injury.
Some states do not allow a limitation of how long an implied warranty last. Some states do not allow the limitation or
exclusion of incidental or consequential damages for consumer products. In such states, the limitation or exclusion of
the Limited Warranty may not apply. This Limited Warranty gives the owner specific legal rights. The owner may
also have other rights that vary from state to state. The owner is advised to consult applicable state laws for full
determination of rights.
EXCEPT AS EXPRESSLY SET FORTH IN THIS WARRANTY, AMX CORPORATION MAKES NO
OTHER WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. AMX CORPORATION
EXPRESSLY DISCLAIMS ALL WARRANTIES NOT STATED IN THIS LIMITED WARRANTY. ANY
IMPLIED WARRANTIES THAT MAY BE IMPOSED BY LAW ARE LIMITED TO THE TERMS OF THIS
LIMITED WARRANTY.

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. 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. YOU MAY NOT LICENSE, RENT, OR LEASE THE AMX
SOFTWARE. You 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 YOU SPECIFIC LEGAL RIGHTS.
Any supplements or updates to the AMX SOFTWARE, including without limitation, any (if any) service packs or hot fixes provided to
you 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 your 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 YOU.
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 (c)(1)(ii) of The Rights in Technical Data and
Computer Software clause at DFARS 252.227-7013 or subparagraphs (c)(1) and (2) of the Commercial Computer Software
Restricted Rights at 48 CFR 52.227-19, as applicable.
This Agreement replaces and supercedes 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. Should you have any
questions concerning this Agreement, or if you desire to contact AMX for any reason, please write: AMX Corporation,
3000 Research Drive, Richardson, TX 75082.

Table of Contents
i
RMS CodeCrafter
Table of Contents
Welcome to RMS CodeCrafter .................................................................................1
System Requirements ....................................................................................................... 1
Other PC requirements: ........................................................................................................... 1
The RMS CodeCrafter Work Area ...........................................................................3
Menu Bar........................................................................................................................... 3
File Menu ................................................................................................................................. 3
Edit Menu ................................................................................................................................. 3
View Menu ............................................................................................................................... 4
Help Menu................................................................................................................................ 4
Toolbar .............................................................................................................................. 4
Text Field Context Menu ................................................................................................... 5
RMS CodeCrafter Device Template Pages .............................................................7
Device Templates.............................................................................................................. 7
Device Template Main Page ............................................................................................. 7
Device Template Parameters Page .................................................................................. 9
Add/Edit Device Template Parameters Window .................................................................... 10
Set Range for Index or Enum Parameter............................................................................... 12
Device Template Final Page ........................................................................................... 13
RMS CodeCrafter MeetingManager Project Pages ..............................................15
Introductory Page ............................................................................................................ 15
Preferences Window .............................................................................................................. 16
Code Generation Wizard - Start Page............................................................................. 17
Code File Selection Page................................................................................................ 18
Room Information/Options Page ..................................................................................... 18
RMS Server Address Page ............................................................................................. 20
RMS Virtual and Socket Device Definitions Page ........................................................... 21
Scheduling: Main Panels Page ....................................................................................... 22
Add/Edit Main Panel Window................................................................................................. 23
Scheduling: Welcome Panels Page ................................................................................ 24
Add/Edit Welcome Panel Window.......................................................................................... 25
Named NetLinx Devices Page ........................................................................................ 26
Add/Edit Named Devices Window ......................................................................................... 27
Add All Welcome and Main Panels Window .......................................................................... 27
Monitored Third-Party Devices Page .............................................................................. 28
Add/Edit Monitored Devices Window ..................................................................................... 29

ii RMS CodeCrafter
Table of Contents
Add Device from Template Window....................................................................................... 30
Device Parameters Page ................................................................................................ 31
Add/Edit Device Parameters Window .................................................................................... 32
Set Range for Index or Enum Parameter............................................................................... 34
i!-ConnectLinx Touch Panel Button Mappings Page....................................................... 35
Edit Touch Panel Button-mappings........................................................................................ 36
Generate NetLinx Code File Page .................................................................................. 37
Code Generation Wizard - Finished Page ...................................................................... 38
RMS CodeCrafter AssetManager Project Pages .................................................39
Introductory Page............................................................................................................ 39
Preferences Window .............................................................................................................. 40
Code Generation Wizard - Start Page ............................................................................ 41
Code File Selection Page................................................................................................ 42
Room Information/Options Page..................................................................................... 42
RMS Server Address Page ............................................................................................. 44
RMS Virtual and Socket Device Definitions Page........................................................... 45
Help Desk: Display Panels Page .................................................................................... 46
Add/Edit Help Desk Panel Window ........................................................................................ 47
Named NetLinx Devices Page ........................................................................................ 48
Add/Edit Named Devices Window ......................................................................................... 49
Add All Welcome and Main Panels Window .......................................................................... 50
Monitored Third-Party Devices Page .............................................................................. 50
Add/Edit Monitored Devices Window ..................................................................................... 51
Add Device from Template Window....................................................................................... 53
Device Parameters Page ................................................................................................ 54
Add/Edit Device Parameters Window .................................................................................... 55
Set Range for Index or Enum Parameter............................................................................... 57
i!-ConnectLinx Touch Panel Button Mappings Page....................................................... 58
Edit Touch Panel Button-mappings........................................................................................ 59
Generate NetLinx Code File Page .................................................................................. 60
Code Generation Wizard - Finished Page ...................................................................... 61
Basic Operations ....................................................................................................63
Creating A New Device Template ................................................................................... 63
Creating A New AssetManager Project........................................................................... 64
Creating A New MeetingManager Project....................................................................... 66
Saving A Device Template File ....................................................................................... 68
Saving A Project File....................................................................................................... 68
Opening An Existing Device Template............................................................................ 68

Table of Contents
iii
RMS CodeCrafter
Opening An Existing Project............................................................................................ 69
Closing A Project Or Template File ................................................................................. 69
Importing RMS SDK Spreadsheets................................................................................. 69
SERVERINFO.TXT Window ........................................................................................... 70
Exiting RMS CodeCrafter ................................................................................................ 71
Adjusting RMS CodeCrafter ............................................................................................ 71
Changing Visual Style ............................................................................................................ 71
Web Update ........................................................................................................................... 71
Setting Template Folder Destination...................................................................................... 71
Setting Default R.M.S. Server Address.................................................................................. 72
Setting Wizard to Generate Device Variable Warnings ......................................................... 72
Code Generation .....................................................................................................73
File Header...................................................................................................................... 73
DEFINE_DEVICES Section ............................................................................................ 73
Device definitions ................................................................................................................... 73
Device Definition Warnings .................................................................................................... 73
DEFINE_CONSTANT Section ........................................................................................ 74
Server Address Definition ...................................................................................................... 74
Maximum String/Enum Param Length ................................................................................... 74
RMSCommon.axi ............................................................................................................ 74
DEFINE_VARIABLE Section........................................................................................... 74
Device Arrays......................................................................................................................... 74
i!-ConnectLinx variables......................................................................................................... 75
Function Definitions......................................................................................................... 77
RMSCommon Callbacks ........................................................................................................ 77
RMSDevMonRegisterCallBack .............................................................................................. 77
RMSDevMonSetParamCallBack............................................................................................ 77
RMS Device Parameters........................................................................................................ 78
Module Definitions........................................................................................................... 78
Monitored Device/Support Modules ....................................................................................... 78
Source Usage ........................................................................................................................ 78
RMS Engine ........................................................................................................................... 78
RMSUIMod............................................................................................................................. 78
RMSWelcomeOnlyUIMod ...................................................................................................... 79
KeyboardMod......................................................................................................................... 79
i!-ConnectLinxEngineMod ...................................................................................................... 79
RMSHelpUIMod (AssetManager only) ................................................................................... 79
Event Definitions ............................................................................................................. 80
RMS Engine Device ............................................................................................................... 80

iv RMS CodeCrafter
Table of Contents
Named Devices...................................................................................................................... 80
Monitored Devices ................................................................................................................. 81
Device Parameters................................................................................................................. 81
i!-ConnectLinx ........................................................................................................................ 81
LEVEL_EVENT Block ............................................................................................................ 81
DATA_EVENT Block.............................................................................................................. 82
BUTTON_EVENT Block......................................................................................................... 83
CHANNEL_EVENT Block ...................................................................................................... 84
RMS Concepts ........................................................................................................85
Device Monitoring Framework ........................................................................................ 85
Device Values ........................................................................................................................ 85
Parameter Values .................................................................................................................. 86
Status Types .......................................................................................................................... 87
RMS SDK And RMS CodeCrafter................................................................................... 88
i!-ConnectLinx ........................................................................................................89
Using i!-ConnectLinx ....................................................................................................... 89

Welcome to RMS CodeCrafter
1
RMS CodeCrafter
Welcome to RMS CodeCrafter
RMS CodeCrafter allows you to create NetLinx include files that contain the code necessary for
monitoring devices using one of the products in the Resource Management Suite, i.e.,
MeetingManager.
RMS CodeCrafter is a wizard application where the output is determined by data and device
information provided by you. As you navigate through the wizard, the options you select and the
data you provide will determine the NetLinx code generated in the final page.
System Requirements
RMS CodeCrafter will support the following platforms:
 Windows 2000 (Service Pack 3 or greater)
 Windows XP Professional (Service Pack 1 or greater)
Other PC requirements:
 Windows-compatible CD-ROM drive.
 Windows-compatible mouse (or other pointing device).
 At least 250 MB of free disk space.
 RMS CodeCrafter will not work properly if your display settings is set to Large Font.
If you are installing on a Windows 2000 machine, you must have Administrator rights
to install and run all required System files.

Welcome to RMS CodeCrafter
2RMS CodeCrafter

The RMS CodeCrafter Work Area
3
RMS CodeCrafter
The RMS CodeCrafter Work Area
Menu Bar
File Menu
The File menu serves as a location for file management, project information and template
management.
New - Choose between:
 New Project - Opens a new RMS CodeCrafter project file (.CGP) and progresses to the
Project Start Page.
 New Template - Opens a new RMS CodeCrafter template file (.CGT) and progresses to
the Device Template Main Page.
Open - Choose between:
 Open Project - After selecting the desired file in the open dialog window, it opens an
existing RMS CodeCrafter project file (.CGP) and progresses to the Project Start Page.
 Open Template - After selecting the desired file in the open dialog window, it opens an
existing RMS CodeCrafter template file (.CGT) and progresses to the Device Template
Main Page.
Close - Closes the project or template file currently open. If the file has been edited, or is "dirty" as
indicated at the top of the window with an asterisks next to the file name, you are prompted to save
changes before closing.
Save - Saves changes made to either project or template file currently open. If the file has not been
previously been saved you are prompted to name and designate where to save the file.
Transfer Server Address File - Opens the SERVERINFO.TXT window.
Save As - Opens the save file dialog, allowing you to specify the file name and location which to
save.
Most Recently Used List - A list of most recently opened file names.
Exit - Closes the RMS CodeCrafter Wizard.
Edit Menu
The Edit Menu applies to text changes made within the RMS CodeCrafter wizard.
Undo - Undoes action taken in text areas.
Cut - Cut highlighted text from fields.
Copy - Copy highlighted text within fields.
Paste - Paste cut and copied text into selected fields.
Delete - Delete selected text within fields.
Preferences - Launches the Preferences window.

The RMS CodeCrafter Work Area
4RMS CodeCrafter
View Menu
The View menu allows you to toggle the toolbar and status bar of the RMS CodeCrafter wizard on
and off. A check next to the title indicates it is visible. Additionally you can change the appearance
of the application itself.
Visual Style - A list of visual appearances for the wizard. Select one of the following:
 Default
 Office XP®
 Office 2003®
Help Menu
The Help menu contains features for updating the application and provides a resource
for understanding the RMS CodeCrafter wizard.
Contents - Launches the RMS CodeCrafter help, Contents section.
Web Update - Launches the AMX Web Update utility. Internet connection is necessary.
About RMS CodeCrafter - Displays the about RMS CodeCrafter dialog containing information
pertaining to version and copyright.
Toolbar
The toolbar contains icons for the commonly used functions:
New - Launches the Project Start page.
Open - Launches the open project dialog window.
Save - Saves changes made to either project or template file currently open. If the file has not been
previously been saved you are prompted to name and designate where to save the file.
Cut - Cut highlighted text from fields.
Copy - Copy highlighted text within fields.
Paste - Paste cut and copied text into selected fields.
Delete - Delete selected text within fields.
Print - Prints the active generated code.
Help - Launches the RMS CodeCrafter help file.
FIG. 1 RMS CodeCrafter Wizard Toolbar
New
Open
Save
Cut
Copy
Paste
Delete
Print
Help

The RMS CodeCrafter Work Area
5
RMS CodeCrafter
Text Field Context Menu
Right click within any text field to access the text field context menu.
Undo - Undoes last text action.
Cut - Cuts selected text to the clipboard.
Copy - Copies selected text to the clipboard.
Paste - Pastes text from clipboard into text field.
Delete - Deletes selected text.
Select All - Selects all text within the field.

The RMS CodeCrafter Work Area
6RMS CodeCrafter

RMS CodeCrafter Device Template Pages
7
R
MS CodeCrafter
RMS CodeCrafter Device Template Pages
Device Templates
You can create persistent templates for monitored devices, where you provide the settings and
parameters. RMS CodeCrafter can then use the device templates for similar or the same devices in
other projects.
When you opt to use device templates RMS CodeCrafter pulls all available templates from the
template folder destination, which you can set in the Preferences window. You can create a new
template or open an existing template from within the File menu but either way you are brought to
the Device Template Main page to edit and set parameters.
Device Template Main Page
The Device Template Main page is the first page of the template creation process.
FIG. 2 Device Template Main Page

RMS CodeCrafter Device Template Pages
8RMS CodeCrafter
Template Name - This is the template name provided by you. This is not the file name but by
default it will be used as such when saving. Template name is displayed as a selection when you are
associating new monitored devices with an existing template.
Manufacturer - This is a text field where you can provide the manufacturer information for the
device.
Model - This is a text field where you can provide the model information for the device.\
Uses Communications Module? - Place a check in the box to enable the function. The template
will use a communication module.
Communication Timeout - Measured in 1/10ths of a second, where 0 is a valid value. If no
timeout is required, use -1.
Control Failure Detect - Placing a check in the box adds a call to RMSEnablePowerFailure() in
the generated code file.
Support Module - Click the radio button that best represents the device for the template.
 Projector
 Transport
 Basic
 Slide Projector
 None
Next - Progresses the wizard to the Device Template Parameters page.

RMS CodeCrafter Device Template Pages
9
R
MS CodeCrafter
Device Template Parameters Page
The Device Parameters page is a list of available parameters that can be included with the template.
There is a grid displaying all device parameters currently within the template. In the left-hand
column is a checkbox, when selected indicates the entry is to be deleted.
Add Parameter - Add a parameters entry.
Edit Parameter - Edit a selected parameters entry.
Next - Progresses the RMS CodeCrafter wizard to the Device Template Final page.
Previous - Regresses the RMS CodeCrafter wizard to the Device Template Main page.
FIG. 3 Device Template Parameters Page

RMS CodeCrafter Device Template Pages
10 RMS CodeCrafter
Add/Edit Device Template Parameters Window
The Add/Edit Device Template Parameters window allows you to add device parameters or edit
existing ones.
Name - A text field you can edit to name the parameter.
Type - Select one of the parameter types:
 Number
 Index
 String
 Enum
Status - select one from the scroll list:
 Not Assigned
 Room Communication
 Control System
 Network
 Security
 Help Request
 Maintenance
FIG. 4 Add/Edit Device Template Parameters Window

RMS CodeCrafter Device Template Pages
11
R
MS CodeCrafter
 Equipment Usage
Threshold Comparison Operator - select from the following:
 None
 Less Than
 Less Than or Equal To
 Greater Than
 Greater Than or Equal To
 Equal To
 Not Equal To
 Contains (String or Enum only)
 Does Not Contain (String or Enum only)
Threshold Value - A text field you can edit to set threshold value. 32-bit signed number for
Number, 16-bit unsigned number for Index and any string up to 100 characters for String and
Enum.
 Reset - Place a mark in the box to enable reset of threshold.
Reset Value - A text field you can edit to set reset value. 32-bit signed number for Number, 16-bit
unsigned number for Index and any string up to 100 characters for String and Enum.
Trigger - select one of the following:
 None
 Button
 Channel
 Level
Use Range (Number) - Sets the minimum and maximum for number; this value is optional.
Set Range (Enum or Index) - A drop down list of enumeration strings. You can elect to:
 Add - adds the sting to the parameter use.
 Remove - removes the string from parameter use.
 Move Up - moves the string up the list of parameter use.
 Move Down - moves the string down the list of parameter use.
OK - Closes the window and saves changes made.
Cancel - Closes window without implementing changes.

RMS CodeCrafter Device Template Pages
12 RMS CodeCrafter
Set Range for Index or Enum Parameter
Add string - adds the sting to the parameter use.
Remove - removes the string from parameter use.
Move Up - moves the string up the list of parameter use.
Move Down - moves the string down the list of parameter use.
OK - Closes the window and saves changes made.
Cancel - Closes window without implementing changes.
FIG. 5 Set Range for Index or Enum Parameter