AMX RMS CODECRAFTER Instruction Manual
  1. Manuals
  2. Brands
  3. AMX Manuals
  4. Software
  5. RMS CODECRAFTER
  6. Instruction manual
AMX RMS CODECRAFTER Instruction Manual

AMX RMS CODECRAFTER Instruction Manual

Hide thumbs Also See for RMS CODECRAFTER:
Table of Contents

Advertisement

Quick Links

Download this manual
instruction manual
RMS CodeCrafter
So f twa re

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the RMS CODECRAFTER and is the answer not in the manual?

Questions and answers

Related Manuals for AMX RMS CODECRAFTER

Summary of Contents for AMX RMS CODECRAFTER

  • Page 1 RMS CodeCrafter So f twa re...
  • Page 2 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.
  • Page 3 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.

  • Page 5: Table Of Contents

    Table of Contents 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..........................
  • Page 6 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....................
  • Page 7 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..................
  • Page 8 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 RMS CodeCrafter...

  • Page 9: Welcome To Rms Codecrafter

    Welcome to 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.
  • Page 10 Welcome to RMS CodeCrafter RMS CodeCrafter...

  • Page 11: The Rms Codecrafter Work Area

    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.

  • Page 12: View Menu

    The RMS CodeCrafter Work Area 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.

  • Page 13: Text Field Context Menu

    The RMS CodeCrafter Work Area 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.
  • Page 14 The RMS CodeCrafter Work Area RMS CodeCrafter...

  • Page 15: 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.
  • Page 16 RMS CodeCrafter Device Template Pages 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.

  • Page 17: Device Template Parameters Page

    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.

  • Page 18: Add/Edit Device Template Parameters Window

    RMS CodeCrafter Device Template Pages Add/Edit Device Template Parameters Window The Add/Edit Device Template Parameters window allows you to add device parameters or edit existing ones. FIG. 4 Add/Edit Device Template Parameters Window Name - A text field you can edit to name the parameter.
  • Page 19 RMS CodeCrafter Device Template Pages 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.

  • Page 20: Set Range For Index Or Enum Parameter

    RMS CodeCrafter Device Template Pages Set Range for Index or Enum Parameter FIG. 5 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.

  • Page 21: Device Template Final Page

    RMS CodeCrafter wizard is to save the template file (.CGT). Previous - Regresses the RMS CodeCrafter wizard to the Device Template Parameters Page. Finish - Generates the template file and stores in the directory specified by the Save Template to field.
  • Page 22 RMS CodeCrafter Device Template Pages RMS CodeCrafter...

  • Page 23: Rms Codecrafter Meetingmanager Project

    FIG. 7 Introductory Page The button you select will determine what file is generated. The buttons are as follows: New Project - Opens a new RMS CodeCrafter project file (.CGP) and progresses to the Project Start Page. 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.

  • Page 24: Preferences Window

    Additionally, you can set default features of the wizard with: Edit Preferences - Launches the Preferences window. Preferences Window RMS CodeCrafter allows you to set user preferences. FIG. 8 Preferences Window Template Folder - A text field where you can either type or click Browse to designate the default template folder destination.

  • Page 25: Code Generation Wizard - Start Page

    - Either type or click the Browse button for the location of the file to be integrated into the project. The file can be either a NetLinx code (.AXS) or NetLinx Studio workspace (.APW) file. The incorporation of either file into a RMS CodeCrafter project is optional. Next - Progresses RMS CodeCrafter to the next page.

  • Page 26: Code File Selection Page

    Previous - Returns the wizard back to the Project Start page. Next - Progresses the RMS CodeCrafter wizard to the Room Information/Options page. Room Information/Options Page RMS CodeCrafter supports the ability to add scheduling and i!-ConnectLinx options to a project file. FIG. 10 Room Information/Options Page...
  • Page 27 No scheduling display - If selected, no scheduling mods are included in the generated code. Previous - Regresses the RMS CodeCrafter wizard to the Code File Selection page. Next - Progresses the RMS CodeCrafter wizard to the RMS Server Address page.

  • Page 28: Rms Server Address Page

    R.M.S. Server Address - A text field where you can type the IP address of the R.M.S. server if necessary. Previous - Regresses the RMS CodeCrafter wizard to the Room Information/Options page. Next - Progresses the RMS CodeCrafter wizard to the RMS Virtual and Socket Device Definitions page. RMS CodeCrafter...

  • Page 29: Rms Virtual And Socket Device Definitions Page

    RMS CodeCrafter MeetingManager Project Pages RMS Virtual and Socket Device Definitions Page RMS Virtual and Socket Device Definitions page allows you to determine options related to i!- ConnectLinx and Scheduling on the Scheduling And i!-ConnectLinx Options page. FIG. 12 RMS Devices Page vdvRMSEngine - A text field you can edit and specify to meet your needs.

  • Page 30: Scheduling: Main Panels Page

    Device definitions are added to the generated code file; otherwise, a warning statement is added in the generated code file. Previous - Regresses the RMS CodeCrafter wizard to the Server Address page. Next - Progresses the RMS CodeCrafter wizard to the Main Panels page.

  • Page 31: Add/Edit Main Panel Window

    The Add/Edit Main Panel window is available to add and edit panel information. The fields you can edit are as follows: Panel Size - A list of supported panel sizes supported by RMS CodeCrafter, click on your desired panel size to select.

  • Page 32: Scheduling: Welcome Panels Page

    The welcome panel grid lists all panels available for the project. Any entry not selected with a check will be removed from the project upon closing the project. Previous - Regresses the RMS CodeCrafter wizard to the Scheduling: Main Panels page. Next - Progresses the RMS CodeCrafter wizard to the Named NetLinx Devices page.

  • Page 33: Add/Edit Welcome Panel Window

    The Add/Edit Welcome Panel window is available to add and edit panel information. The fields you can edit are as follows: Panel Size - A list of supported panel sizes supported by RMS CodeCrafter, click on your desired panel size to select.

  • Page 34: Named Netlinx Devices Page

    The named device grid lists all devices available for the project. Any entry not selected with a check will be removed from the project upon closing the project. Previous - Regresses the RMS CodeCrafter wizard to the Scheduling: Welcome Panels page. Next - Progresses the RMS CodeCrafter wizard to the Monitored Third-Party Devices page.

  • Page 35: Add/Edit Named Devices Window

    Cancel - Closes window and does not keep changes. Add All Welcome and Main Panels Window When you click Add all Welcome and Main Panels RMS CodeCrafter searches the existing Main and Welcome panels for MeetingManager devices that are not already listed on the Named Devices list.

  • Page 36: Monitored Third-Party Devices Page

    The monitored device grid lists all devices available for the project. Any entry not selected with a check will be removed from the project upon closing the project. Previous - Regresses the RMS CodeCrafter wizard to the Named NetLinx Devices page. Next - Progresses the RMS CodeCrafter wizard to the Device Parameters page.

  • Page 37: Add/Edit Monitored Devices Window

    RMS CodeCrafter MeetingManager Project Pages Add/Edit Monitored Devices Window FIG. 20 Add/Edit Monitored Devices Window The Add/Edit Monitored Devices window is available to add and edit named devices. The fields you can edit are as follows: Device - Drop down lists of devices available. This field is populated by devices extracted from the integrated NetLinx file.

  • Page 38: Add Device From Template Window

    RMS CodeCrafter MeetingManager Project Pages Using communications (COMM) module? - When selected, RMS CodeCrafter includes code for a communications module. Communications Module Virtual Deivce - A combo list either populated by virtual communication devices or you can type your own virtual device in the field.

  • Page 39: Device Parameters Page

    The device parameters grid lists all devices available for the project. Any entry not selected with a check will be removed from the project upon closing the project. Previous - Regresses the RMS CodeCrafter wizard to the Monitored Third-Party Devices page. Next - Progresses the RMS CodeCrafter wizard to the i!-ConnectLinx Touch Panel Button Mappings page.

  • Page 40: Add/Edit Device Parameters Window

    RMS CodeCrafter MeetingManager Project Pages Add/Edit Device Parameters Window The Add/Edit Device Parameters window allows you to add device parameters or edit existing ones. FIG. 23 Add/Edit Device Parameters Window Device - A list of devices available in this project. This field is populated by devices extracted from the integrated NetLinx file or user defined devices within the project.
  • Page 41 RMS CodeCrafter MeetingManager Project Pages Help Request Maintenance Equipment Usage Threshold Hold - 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) Value - A text field you can edit to set threshold value.

  • Page 42: Set Range For Index Or Enum Parameter

    RMS CodeCrafter MeetingManager Project Pages Set Range for Index or Enum Parameter FIG. 24 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.

  • Page 43: I!-Connectlinx Touch Panel Button Mappings Page

    RMS CodeCrafter MeetingManager Project Pages i!-ConnectLinx Touch Panel Button Mappings Page The i!-ConnectLinx Touch Panel Button Mappings page is available if you selected Support pre-meeting presets? or Monitor source usage? on the Room Information/Options page. You can map touch panel buttons to i!-ConnectLinx. Otherwise, only power on/off and source selects are available.

  • Page 44: Edit Touch Panel Button-Mappings

    RMS CodeCrafter MeetingManager Project Pages button fields are populated, RMS CodeCrafter will attempt to add the mapping without offering the dialog. In the event the mapping already exists, the mapping will fail and you receive a notification. To re-map, the original must be removed from the device list.

  • Page 45: Generate Netlinx Code File Page

    Generated NetLinx Code File - This is a text field you can either type the path or click Browse and specify the file name and target to generate. Copy RMS Module Files? - When the box is checked, RMS CodeCrafter will copy all corresponding .TKO files from the SDK install location and paste them in the location you designated in the Generated NetLinx Code File path.

  • Page 46: Code Generation Wizard - Finished Page

    RMS CodeCrafter MeetingManager Project Pages Code Generation Wizard - Finished Page The Code Generation Wizard - Finished page is the final step in the process of creating your own RMS code. The results of the code generation operation and confirmation of the target location is listed.

  • Page 47: Rms Codecrafter Assetmanager Project

    FIG. 29 Introductory Page The button you select will determine what file is generated. The buttons are as follows: New Project - Opens a new RMS CodeCrafter project file (.CGP) and progresses to the Project Start Page. 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.

  • Page 48: Preferences Window

    Additionally, you can set default features of the wizard with: Edit Preferences - Launches the Preferences window. Preferences Window RMS CodeCrafter allows you to set user preferences. FIG. 30 Preferences Window Template Folder - A text field where you can either type or click Browse to designate the default template folder destination.

  • Page 49: Code Generation Wizard - Start Page

    - Either type or click the Browse button for the location of the file to be integrated into the project. The file can be either a NetLinx code (.AXS) or NetLinx Studio workspace (.APW) file. The incorporation of either file into a RMS CodeCrafter project is optional. Next - Progresses RMS CodeCrafter to the next page.

  • Page 50: Code File Selection Page

    Previous - Returns the wizard back to the Project Start page. Next - Progresses the RMS CodeCrafter wizard to the Room Information/Options page. Room Information/Options Page RMS CodeCrafter supports the ability to add scheduling and i!-ConnectLinx options to a project file. FIG. 32 Room Information/Options Page...
  • Page 51 Owner - A text field, you provide the name of the person that owns the room. (This field is required) AssetManager Options: Include Help Desk Code - If selected, RMS CodeCrafter will define RMSHelpUIMod in the generated code. This option is only available if you selected AssetManager on the Project Start Page.

  • Page 52: Rms Server Address Page

    R.M.S. Server Address - A text field where you can type the IP address of the R.M.S. server if necessary. Previous - Regresses the RMS CodeCrafter wizard to the Room Information/Options page. Next - Progresses the RMS CodeCrafter wizard to the RMS Virtual and Socket Device Definitions page. RMS CodeCrafter...

  • Page 53: Rms Virtual And Socket Device Definitions Page

    RMS CodeCrafter AssetManager Project Pages RMS Virtual and Socket Device Definitions Page RMS Virtual and Socket Device Definitions page allows you to determine options related to i!- ConnectLinx and Scheduling on the Scheduling And i!-ConnectLinx Options page. FIG. 34 RMS Devices Page vdvRMSEngine - A text field you can edit and specify to meet your needs.

  • Page 54: Help Desk: Display Panels Page

    Previous - Regresses the RMS CodeCrafter wizard to the Server Address page. Next - Progresses the RMS CodeCrafter wizard to the Help Desk: Display Panels page. Help Desk: Display Panels Page The Help Desk: Display Panels page allows you to add, edit and delete Help Desk functions used in conjunction with AssetManager.

  • Page 55: Add/Edit Help Desk Panel Window

    The Add/Edit Help Desk Panel window is available to add and edit panel information. The fields you can edit are as follows: Panel Size - A list of supported panel sizes supported by RMS CodeCrafter, click on your desired panel size to select.

  • Page 56: Named Netlinx Devices Page

    RMS CodeCrafter AssetManager Project Pages Keyboard Device - Drop down lists of devices available. This field is populated by devices extracted from the integrated NetLinx file. You can select an existing device, enter a new device, or enter a D:P:S address. If you select an existing device or enter a new device, a warning for the device is added to the generated code file.

  • Page 57: Add/Edit Named Devices Window

    The named device grid lists all devices available for the project. Any entry not selected with a check will be removed from the project upon closing the project. Previous - Regresses the RMS CodeCrafter wizard to the Help Desk: Display Panels page. Next - Progresses the RMS CodeCrafter wizard to the Monitored Third-Party Devices page.

  • Page 58: Add All Welcome And Main Panels Window

    RMS CodeCrafter AssetManager Project Pages Add All Welcome and Main Panels Window When you click Add all Welcome and Main Panels RMS CodeCrafter searches the existing Main and Welcome panels for MeetingManager devices that are not already listed on the Named Devices list.

  • Page 59: Add/Edit Monitored Devices Window

    The monitored device grid lists all devices available for the project. Any entry not selected with a check will be removed from the project upon closing the project. Previous - Regresses the RMS CodeCrafter wizard to the Named NetLinx Devices Page. Next - Progresses the RMS CodeCrafter wizard to the Device Parameters Page.
  • Page 60 Basic Slide Projector None Using communications (COMM) module? - When selected, RMS CodeCrafter includes code for a communications module. Communications Module Virtual Deivce - A combo list either populated by virtual communication devices or you can type your own virtual device in the field.

  • Page 61: Add Device From Template Window

    RMS CodeCrafter AssetManager Project Pages Add Device from Template Window If you select Add Device from Template, this window gives you the selection of all templates found in the default folder and populates them into the grid. FIG. 41 Add Device from Template Window Device - A list where you can either select the device or type it in manually.

  • Page 62: Device Parameters Page

    The device parameters grid lists all devices available for the project. Any entry not selected with a check will be removed from the project upon closing the project. Previous - Regresses the RMS CodeCrafter wizard to the Monitored Third-Party Devices page. Next - Progresses the RMS CodeCrafter wizard to the i!-ConnectLinx Touch Panel Button Mappings page.

  • Page 63: Add/Edit Device Parameters Window

    RMS CodeCrafter AssetManager Project Pages Add/Edit Device Parameters Window The Add/Edit Device Parameters window allows you to add device parameters or edit existing ones. FIG. 43 Add/Edit Device Parameters Window Device - A list of devices available in this project. This field is populated by devices extracted from the integrated NetLinx file or user defined devices within the project.
  • Page 64 RMS CodeCrafter AssetManager Project Pages Help Request Maintenance Equipment Usage Threshold Hold - 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) Value - A text field you can edit to set threshold value.

  • Page 65: Set Range For Index Or Enum Parameter

    RMS CodeCrafter AssetManager Project Pages Set Range for Index or Enum Parameter FIG. 44 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.

  • Page 66: I!-Connectlinx Touch Panel Button Mappings Page

    RMS CodeCrafter AssetManager Project Pages i!-ConnectLinx Touch Panel Button Mappings Page The i!-ConnectLinx Touch Panel Button Mappings page is available if you selected Monitor source usage? on the Room Information/Options page. You can map touch panel buttons to i!- ConnectLinx. Otherwise, only power on/off and source selects are available.

  • Page 67: Edit Touch Panel Button-Mappings

    RMS CodeCrafter AssetManager Project Pages button fields are populated, RMS CodeCrafter will attempt to add the mapping without offering the dialog. In the event the mapping already exists, the mapping will fail and you receive a notification. To re-map, the original must be removed from the device list.

  • Page 68: Generate Netlinx Code File Page

    Generated NetLinx Code File - This is a text field you can either type the path or click Browse and specify the file name and target to generate. Copy RMS Module Files? - When the box is checked, RMS CodeCrafter will copy all corresponding .TKO files from the SDK install location and paste them in the location you designated in the Generated NetLinx Code File path.

  • Page 69: Code Generation Wizard - Finished Page

    RMS CodeCrafter AssetManager Project Pages Code Generation Wizard - Finished Page The Code Generation Wizard - Finished page is the final step in the process of creating your own RMS code. The results of the code generation operation and confirmation of the target location is listed.
  • Page 70 RMS CodeCrafter AssetManager Project Pages RMS CodeCrafter...

  • Page 71: Basic Operations

    Creating A New Device Template 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. 1. With the RMS CodeCrafter wizard open to the Introductory page, click New Device Template.

  • Page 72: Creating A New Assetmanager Project

    Basic Operations Creating A New AssetManager Project The RMS CodeCrafter wizard creates project files that it uses in generating the NetLinx code you need. To create a .CGP file: 1. From the Introductory page click New Project. 2. The next page is the Project Start page. Select your desired RMS application, AssetManager.
  • Page 73 22. The next and final page is Code Generation Wizard - Finished. You will see this page if the NetLinx include file was successfully created. Displayed within the page is the file name and target destination. 23. Click Finish. RMS CodeCrafter...

  • Page 74: Creating A New Meetingmanager Project

    Basic Operations Creating A New MeetingManager Project The RMS CodeCrafter wizard creates project files that it uses in generating the NetLinx code you need. To create a .CGP file: 1. From the Introductory page click New Project. 2. The next page is the Project Start page. Select your desired RMS application, AssetManager.
  • Page 75 26. The next and final page is Code Generation Wizard - Finished. You will see this page if the NetLinx include file was successfully created. Displayed within the page is the file name and target destination. 27. Click Finish. RMS CodeCrafter...

  • Page 76: Saving A Device Template File

    2. Select the target location for the file and click Save. Saving A Project File Once you have created a RMS CodeCrafter file, it is necessary to save the file. You can then return to the file at a later date.

  • Page 77: Opening An Existing Project

    You can now begin working from your saved project. Closing A Project Or Template File Once you are done with a project or template file, but would like to keep RMS CodeCrafter open, you can close the file. To close a file: Select File >...

  • Page 78: Serverinfo.txt Window

    Basic Operations SERVERINFO.TXT Window RMS CodeCrafter allows you to generate a text file, SERVERINFO.TXT, that contains the IP address of the RMS server, and then transfer the file to the RMS directory on the system master for the room. FIG. 49 SERVERINFO.TXT Window R.M.S.

  • Page 79: Exiting Rms Codecrafter

    Office 2003® Web Update Newer versions of RMS CodeCrafter can now be acquired via the internet. The Web Update utility accesses the AMX web site with the application ID and version number and searches for updates. 1. Go to Help > Web Update to check for updates.

  • Page 80: Setting Default R.m.s. Server Address

    Basic Operations Setting Default R.M.S. Server Address As part of the code generated by RMS CodeCrafter, the IP address of the RMS server can be included. The IP address is necessary when using Scheduling and i!-ConnectLinx options. To set the location RMS CodeCrafter uses: 1.

  • Page 81: Code Generation

    (***************************************************************************) AMX Resource Management Suite (2.0.13) (***************************************************************************) RMS CodeCrafter obtains the RMS SDK version by reading a registry key set by the SDK installer, HKEY_LOCAL_MACHINE\SOFTWARE\AMX Corp.\RMS SDK\Version. DEFINE_DEVICES Section Device definitions RMS CodeCrafter will generate device definitions for the following devices in the...

  • Page 82: Define_Constant Section

    Device Arrays Main Panels RMS CodeCrafter creates a device array for all Main Panels. This array is used as a parameter to the RMSUIMod and RMSHelpUIMod modules. This array is created only if the user selects Main and Welcome Panels under Scheduling Options, or selects the Include Help Desk Code option (AssetManager only).

  • Page 83: I!-Connectlinx Variables

    Keyboard Panels RMS CodeCrafter should create a device array for all Main Panels Base (string) devices. This array is used as a parameter to the RMSUIMod, RMSHelpUIMod, and KeyboardMod modules. This array is created only if the user selects Main and Welcome Panels under Scheduling Options, or selects the Include Help Desk Code option (AssetManager only).
  • Page 84 VOLATILE INTEGER nchCLPanelButtons[] = // Power Off Device Parameters RMS CodeCrafter creates a variable for each device parameter specified, of the following types: Number – Signed Long (SLONG) Index – Integer (INTEGER)s String – String (CHAR Array), length is RMS_MAX_PARAM_LEN Enum–...

  • Page 85: Function Definitions

    Code Generation Function Definitions RMSCommon Callbacks RMS CodeCrafter creates definitions for the following callback functions: RMSDevMonRegisterCallBack This function has the following signature: (***************************************) (* Call Name: RMSDevMonRegisterCallback*) (* Function: time to register devices *) (* Param: None (* Return: None...

  • Page 86: Rms Device Parameters

    RMS CodeCrafter generates the following module definitions in the DEFINE_START section. Monitored Device/Support Modules RMS CodeCrafter generates a module definition for each Monitored device that uses a Support Module. Each module declaration is created using the Module name, the monitored devices virtual and actual device names, and the RMS Engine’s virtual device name (vdvRMSEngine).

  • Page 87: Rmswelcomeonlyuimod

    This module definition is generated if the user selects AssetManager as the RMS application, and enabled the Include Help Desk Code option. // RMSHelpUIMod - The RMS/AssetManager Help Desk Interface. Requires KeyboardMod. DEFINE_MODULE 'RMSHelpUIMod' mdlRMSHelpUI(vdvRMSEngine, vdvKB, dvRMSKeyboard, dvRMSTP) RMS CodeCrafter...

  • Page 88: Event Definitions

    RMS CodeCrafter generates a DATA_EVENT block for the RMS Engine device. This block will always be generated, boilerplate, with these exceptions: If the Use Multiple Displays option is selected, RMS CodeCrafter will generate a call to RMSSetMultiSource(TRUE) A call to RMSSetDeviceInfo() will be generated for each monitored device using an RMS Support Module;...

  • Page 89: Monitored Devices

    OFFLINE: RMSNetLinxDeviceOffline(dvLProj) Device Parameters RMS CodeCrafter generates an event handler for each device parameter of BUTTON. LEVEL, or CHANNEL type. See the RMS CodeCrafter Requirements specification for an example. i!-ConnectLinx RMS CodeCrafter generates an DATA_EVENT block for the i!-ConnectLinx virtual device. If Pre- Meeting Presets is selected, a LEVEL_EVENT block will also be created.

  • Page 90: Data_Event Block

    Code Generation DATA_EVENT Block RMS CodeCrafter generates a DATA_EVENT block for the vdvCLActions virtual device. This block will create the following: A fixed format STRING parsing block A SEND_COMMAND statement to register the room name, owner, and location. Registration commands for each function-touch panel button mapping. These registration commands can be combined using the AND and THROUGH syntax.

  • Page 91: Button_Event Block

    CD Search Rev (1737) SEND_COMMAND DATA.DEVICE,'ADD STD-1731-1737' BUTTON_EVENT Block RMS CodeCrafter generates a BUTTON_EVENT block for each device with button mappings. It does not make use of the i!-ConnectLinx variables defined in the variables section. An example block is provided below.

  • Page 92: Channel_Event Block

    Code Generation CHANNEL_EVENT Block RMS CodeCrafter generates a CHANNEL_EVENT block for each device with button mappings. It does not make use of the i!-ConnectLinx variables defined in the variables section. An example block is provided below. (*******************************************) (* CHANNEL: i!-ConnectLinx Feedback...

  • Page 93: Rms Concepts

    NetLinx devices. This information is registered automatically by the RMS server. Firmware Version This is the firmware version of the NetLinx-connected device. This is only available for NetLinx devices. This information is registered automatically be the RMS server. RMS CodeCrafter...

  • Page 94: Parameter Values

    Request" status that requires an AV technician to repair the equipment. If the "Device Online" parameter changes from "Online" to "Offline", this change could represent a "Security" or "Control System Error" status. These value are supplied during registration but can be modified by the administrator from the RMS server console. RMS CodeCrafter...

  • Page 95: Status Types

    Request", "Room Communication Error", "Control System Error", "Network Error", "Security" and "Equipment Usage." While there are no firm rules for what these status types mean and how they are used, AMX provides the following description of each status type and recommends that your usage is consistent with these descriptions.

  • Page 96: Rms Sdk And Rms Codecrafter

    RMS Concepts RMS SDK And RMS CodeCrafter The RMS SDK consists of a series of modules to simplify device monitoring programming. Device monitoring module handles the registration of devices and parameters and keeping track of lamp hours and transport run time. In most cases, adding device monitoring is achieved by selecting the appropriate device monitoring module and adding code to inform the module of important device changes.

  • Page 97: I!-Connectlinx

    BUTTON_EVENT[TP,1] (* VCR Play *) PUSH: PULSE[VCR,1] BUTTON_EVENT[TP,2] (* VCR Stop *) PUSH: PULSE{VCR,2] To expose these actions using i!-ConnectLinx, write the same code substituting the touch panel device for your i!-ConnectLinx virtual device: RMS CodeCrafter...
  • Page 98 In addition to specifying the name of an action, you can also supply a help string and a folder name. The help string helps a user understand the intent of the action more clearly. The folder name allows you to organize the actions in a tree view so that actions are more easily browsed. RMS CodeCrafter...
  • Page 99 Code Generation RMS CodeCrafter...
  • Page 100 ATLANTA • BOSTON • CHICAGO • CLEVELAND • DALLAS • DENVER • INDIANAPOLIS • LOS ANGELES • MINNEAPOLIS • PHILADELPHIA • PHOENIX • PORTLAND • SPOKANE • TAMPA 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...

Table of Contents