instruction manual RMS CodeCrafter So ftw are
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.
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.
Table of Contents Table of Contents Welcome to RMS CodeCrafter .................................................................................1 System Requirements ....................................................................................................... 1 Other PC requirements: ........................................................................................................... 1 The RMS CodeCrafter Work Area ...........................................................................
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...............................................................................
Table of Contents Opening An Existing Project............................................................................................ 69 Closing A Project Or Template File ................................................................................. 69 Importing RMS SDK Spreadsheets................................................................................. 69 SERVERINFO.TXT Window ...........................................................................................
Table of Contents Named Devices...................................................................................................................... 80 Monitored Devices ................................................................................................................. 81 Device Parameters................................................................................................................. 81 i!-ConnectLinx ..........................................................................
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.
Welcome to RMS CodeCrafter 2 RMS CodeCrafter
The RMS CodeCrafter Work Area 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.
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. Visual Style - A list of visual appearances for the wizard.
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. 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 6 RMS CodeCrafter
RMS CodeCrafter Device Template Pages 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.
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. 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.
RMS CodeCrafter Device Template Pages 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. FIG. 3 Device Template Parameters Page Add Parameter - Add a parameters entry. Edit Parameter - Edit a selected parameters entry.
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.
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. 32-bit signed number for Number, 16-bit unsigned number for Index and any string up to 100 characters for String and Enum.
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. 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 Device Template Wizard Finished Page The Device Template Wizard Finished page is the last step in making a device template. FIG. 6 Device Template Final Page Save Template to - A text field where you can either type or click the Browse button to designate where RMS CodeCrafter wizard is to save the template file (.CGT). Previous - Regresses the RMS CodeCrafter wizard to the Device Template Parameters Page.
RMS CodeCrafter Device Template Pages 14 RMS CodeCrafter
RMS CodeCrafter MeetingManager Project Pages RMS CodeCrafter MeetingManager Project Pages Introductory Page The Introductory page is the initial page displayed upon launching the RMS CodeCrafter wizard. 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.
RMS CodeCrafter MeetingManager Project Pages 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. Default R.M.S. Server Address - A text field where you can edit the server address for the R.M.S. server.
RMS CodeCrafter MeetingManager Project Pages Code Generation Wizard - Start Page The Code Generation Wizard - Start page is the first page you see when you open a new or existing project file. FIG. 9 Project Start Page Select the appropriate RMS application - This is the RMS application code you want generated. Click the radio button to select. Your choices are: MeetingManager (default) AssetManager Enter the NetLinx code file (.AXS) or NetLinx Studio workspace file (.
RMS CodeCrafter MeetingManager Project Pages Code File Selection Page You will see the Code File Selection page if you selected a NetLinx Studio workspace file (.APW) in the Project Start page. A list of all available NetLinx code files within the .APW file is displayed. Previous - Returns the wizard back to the Project Start page. Next - Progresses the RMS CodeCrafter wizard to the Room Information/Options page.
RMS CodeCrafter MeetingManager Project Pages Using multiple display devices? - This option is only available when Monitor source usage? has been selected. Placing a check in this box determines if a call to RMSSetMultiSource(TRUE) is included in the DEFINE_EVENT section of the generated code. Room Name - A text field, you provide the name of the room. (This field is required) Location - A text field, you provide the name of the location for the room.
RMS CodeCrafter MeetingManager Project Pages RMS Server Address Page The RMS Server Address page allows you the opportunity to specify the IP address of the R.M.S. server. This is optional and if left unchanged, the default specified in the Preferences window is used. FIG. 11 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.
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. The device, port and socket location of the virtual device, RMS Engine. dvRMSSocket - A text field you can edit and specify to meet your needs.
RMS CodeCrafter MeetingManager Project Pages vdvRMSEngine - 33001:1:0 dvRMSSocket - 0:3:0 vdvCLActions - 33002:1:0 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. Scheduling: Main Panels Page The Main Panels page allows you to add, edit and delete main panels used to display scheduling.
RMS CodeCrafter MeetingManager Project Pages The main 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 RMS Virtual and Socket Device Definitions page. Next - Progresses the RMS CodeCrafter wizard to the Scheduling: Welcome Panels page. Add/Edit Main Panel Window FIG.
RMS CodeCrafter MeetingManager Project Pages 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. OK - Accepts changes and closes window. Cancel - Closes window and does not keep changes. Scheduling: Welcome Panels Page The Welcome Panels page allows you to add, edit and delete welcome panels used to display scheduling.
RMS CodeCrafter MeetingManager Project Pages Add/Edit Welcome Panel Window FIG. 16 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. Description - A text field you can edit to describe the panel. MeetingManager Pages - Drop down lists of devices available.
RMS CodeCrafter MeetingManager Project Pages Named NetLinx Devices Page The Named NetLinx Devices page allows you to add, edit and delete devices monitored as Named Devices. A named device is a NetLinx device that supports a logical name, i.e., a touch panel. FIG. 17 Named Devices Page Add Device - Launches the Add/Edit Named Device window. Adds a named device to the project. Edit Device - Launches the Add/Edit Named Device window. When a named device is selected you can edit its properties.
RMS CodeCrafter MeetingManager Project Pages Add/Edit Named Devices Window FIG. 18 Add/Edit Named Devices Window The Add/Edit Named 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. You can select an existing device, enter a new device, or enter a D:P:S address.
RMS CodeCrafter MeetingManager Project Pages Monitored Third-Party Devices Page The Monitored Third-Party Devices page allows you to add, edit and delete devices intended to be monitored as Monitored Devices. A Monitored Device is a device that supports a logical name, manufacturer, and model, i.e., a projector. FIG. 19 Monitored Devices Page Add Device - Launches the Add/Edit Monitored Device window. Adds a monitored device to the project. Edit Device - Launches the Add/Edit Monitored Device 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. You can select an existing device, enter a new device, or enter a D:P:S address.
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. Module Virtual Device - Drop down lists of devices available. This field is populated by devices extracted from the integrated NetLinx file.
RMS CodeCrafter MeetingManager Project Pages Logical Name - A text field where you can type the logical name of the device. OK - Accepts the changes and closes the window. Cancel - Closes the window without keeping changes. Device Parameters Page The Device Parameters page allows you to add, edit and delete Device Parameters. The Device Parameters page is only available if your project has Named NetLinx, Monitored devices or both. FIG.
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. Name - A text field you can edit to name the parameter.
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. 32-bit signed number for Number, 16-bit unsigned number for Index and any string up to 100 characters for String and Enum.
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. 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 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.
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. Remove - Removes the device currently selected in the device list. Previous - Regresses the RMS CodeCrafter wizard to the Device Parameters Page.
RMS CodeCrafter MeetingManager Project Pages Generate NetLinx Code File Page The Generate NetLinx Code File page prompts RMS CodeCrafter to generate the NetLinx include code file. FIG. 27 Generate Code 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 .
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. FIG. 28 Wizard Complete Page Finish - Clicking this button returns you to the Introductory page. If you selected Save Project on Finish? in User Preferences you are prompted to save your project now.
RMS CodeCrafter AssetManager Project Pages RMS CodeCrafter AssetManager Project Pages Introductory Page The Introductory page is the initial page displayed upon launching the RMS CodeCrafter wizard. 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.
RMS CodeCrafter AssetManager Project Pages 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. Default R.M.S. Server Address - A text field where you can edit the server address for the R.M.S. server.
RMS CodeCrafter AssetManager Project Pages Code Generation Wizard - Start Page The Code Generation Wizard - Start page is the first page you see when you open a new or existing project file. FIG. 31 Project Start Page Select the appropriate RMS application - This is the RMS application code you want generated. Click the radio button to select. Your choices are: MeetingManager (default) AssetManager Enter the NetLinx code file (.AXS) or NetLinx Studio workspace file (.
RMS CodeCrafter AssetManager Project Pages Code File Selection Page You will see the Code File Selection page if you selected a NetLinx Studio workspace file (.APW) in the Project Start page. A list of all available NetLinx code files within the .APW file is displayed. Previous - Returns the wizard back to the Project Start page. Next - Progresses the RMS CodeCrafter wizard to the Room Information/Options page.
RMS CodeCrafter AssetManager Project Pages RMSSetMultiSource(TRUE) is included in the DEFINE_EVENT section of the generated code. Room Name - A text field, you provide the name of the room. (This field is required) Location - A text field, you provide the name of the location for the room. (This field is required) Owner - A text field, you provide the name of the person that owns the room.
RMS CodeCrafter AssetManager Project Pages RMS Server Address Page The RMS Server Address page allows you the opportunity to specify the IP address of the R.M.S. server. This is optional and if left unchanged, the default specified in the Preferences window is used. FIG. 33 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.
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. The device, port and socket location of the virtual device, RMS Engine. dvRMSSocket - A text field you can edit and specify to meet your needs.
RMS CodeCrafter AssetManager Project Pages vdvRMSEngine - 33001:1:0 dvRMSSocket - 0:3:0 vdvCLActions - 33002:1:0 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 Help Desk: Display Panels page.
RMS CodeCrafter AssetManager Project Pages Edit Panel - Launches the Add/Edit Help Desk Panel window. When a Help Desk panel is selected you can edit its properties. The Help Desk 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 RMS Virtual and Socket Device Definitions 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. OK - Accepts changes and closes window. Cancel - Closes window and does not keep changes.
RMS CodeCrafter AssetManager Project Pages 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. Add/Edit Named Devices Window FIG.
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. All devices found are compiled into a list and appear in the Add All Welcome and Main Panels window. Within this window you can select any, all or none for your use.
RMS CodeCrafter AssetManager Project Pages Add Device - Launches the Add/Edit Monitored Device window. Adds a monitored device to the project. Edit Device - Launches the Add/Edit Monitored Device window. When a monitored device is selected you can edit its properties. Add Device from Template - Launches the Add Device from Template window. Adds a device using a device template. The monitored device grid lists all devices available for the project.
RMS CodeCrafter AssetManager Project Pages Logical Name - A text field you can edit to name the device. 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. Support Module - Click the radio button that best represents the device for the template.
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. Virtual Device - A list where you can either select the communications module virtual device or type it in manually.
RMS CodeCrafter AssetManager Project Pages Device Parameters Page The Device Parameters page allows you to add, edit and delete Device Parameters. FIG. 42 Device Parameters Page Add Parameter - Launches the Add/Edit Device Parameters window. Adds a device parameter to the project. Edit Parameter - Launches the Add/Edit Device Parameters window. When a device parameter is selected you can edit its properties. The device parameters grid lists all devices available for the project.
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. Name - A text field you can edit to name the parameter.
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. 32-bit signed number for Number, 16-bit unsigned number for Index and any string up to 100 characters for String and Enum.
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. 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 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. The i!-ConnectLinx functions grid list displays all i!ConnectLinx functions, with touch panel button mappings, currently available in the project.
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. Remove - Removes the device currently selected in the device list. Previous - Regresses the RMS CodeCrafter wizard to the Device Parameters page.
RMS CodeCrafter AssetManager Project Pages Generate NetLinx Code File Page The Generate NetLinx Code File page prompts RMS CodeCrafter to generate the NetLinx include code file. FIG. 47 Generate Code 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 .
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. FIG. 48 Wizard Complete Page Finish - Clicking this button returns you to the Introductory page. If you selected Save Project on Finish? in User Preferences you are prompted to save your project now.
RMS CodeCrafter AssetManager Project Pages 62 RMS CodeCrafter
Basic Operations 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. 2. The RMS CodeCrafter wizard opens to the Device Template Main page. 3. Type the name of your Template in the field Template Name. 4.
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. 3. Either type or click Browse to select the location of your integrated file. While it is not necessary to have either an .AXS or .
Basic Operations the Named Devices list, click Add all Welcome and Main Panels to launch the Add All Welcome and Main Panels Window. 14. Once you have included all of your named devices for your project, click Next. The next page is Monitored Third-Party Devices page. 15. To add a device, click Add Device and open the Add/Edit Monitored Device window. To edit a device, select the device from the list and click Edit Device to open the Add/Edit Monitored Device window.
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. 3. Either type or click Browse to select the location of your integrated file. While it is not necessary to have either an .AXS or .
Basic Operations 15. To add a panel, click Add Panel and open the Add/Edit Welcome Panel window. To edit a panel, select the panel from the list and click Edit Panel to open the Add/Edit Welcome Panel window. 16. Once you have added all of your main panels, click Next. The next page is Named NetLinx Devices. No scheduling display selected: 17. To add a device, click Add Device and open the Add/Edit Named Device window.
Basic Operations Saving A Device Template File Once you have created a Device Template it is necessary to save it order to keep changes made. 1. With the Device Template open, select File > Save. 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. 1. With the project file open, select File > Save. 2. Select the target location to save the file. 3.
Basic Operations Opening An Existing Project If you have already created a project (.CGP) and would like to use it as a starting point, follow these steps: 1. With the RMS CodeCrafter wizard open to the Introductory page, click Open Project. 2. In the Open RMS CodeCrafter Project window, navigate to your project and click Open. You can now begin working from your saved project.
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. Server Address (or Hostname) - A text field for entering either the IP address or hostname of the RMS server. System Master Address - A text field for entering either the IP address or hostname of the master controller for the room.
Basic Operations Exiting RMS CodeCrafter You've created a device template, implemented said template into a project file and then used RMS CodeCrafter to generate the inclusion file code. Now you would like to close the project file and exit RMS CodeCrafter. Select File > Exit. If you have not already saved you are prompted to do so at this time.
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. With RMS CodeCrafter open to the Introductory page, click Edit Preferences to open the Preferences window. 2. Type the IP address of the RMS server in the field, Default R.M.S. Server Address. 3. Click OK.
Code Generation Code Generation RMS CodeCrafter will output a single, all-inclusive NetLinx include (.axi) file, with the following features: File Header RMS CodeCrafter should include a header including an AMX copyright notice, an RMS SDK version, and information about the RMS CodeCrafter program such as name and version. (***************************************************************************) (* AMX Corporation *) (* Copyright (c) 2004 AMX Corporation. All rights reserved.
Code Generation DEFINE_CONSTANT Section Server Address Definition RMS CodeCrafter will create a definition for the server address, using the value provided in the RMS Server Address Page. // RMS Server IP CHAR RMS_SERVER_IP[100] = '192.168.222.51' Maximum String/Enum Param Length RMS CodeCrafter will create a definition for RMS_MAX_PARAM_LEN constant, with a value of 100. // Max String/Enum Param Length RMS_MAX_PARAM_LEN = 100 RMSCommon.
Code Generation // If a G4 panel appears first in this list, then G4 commands will be used (looks better). VOLATILE DEV dvRMSTPWelcome[] = { dvTP2a } 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).
Code Generation { 1002 // Power Off // i!-ConnectLinx Touch Panel Buttons VOLATILE INTEGER nchCLPanelButtons[] = { 1 // 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– String (CHAR Array), length is RMS_MAX_PARAM_LEN Each variable name will contain one of the following Hungarian prefixes, based on type: Signed
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 *) (* Note: Caller must define this *) (***************************************) DEFINE_FUNCTION RMSDevMonRegisterCallback() { } Each monitored device
Code Generation RMS Device Parameters A custom function will be generated for each parameter to set the value of the parameter and report it to the RMS server.
Code Generation RMSWelcomeOnlyUIMod This module definition is generated if the user selects Welcome Panels Only in the Scheduling Options. // RMSWelcomeOnlyUIMod - The RMS/MeetingManager Welcome Panel User Interface.
Code Generation Event Definitions RMS CodeCrafter generates the following DATA_EVENT blocks the DEFINE_EVENT section. RMS Engine Device RMS CodeCrafter generates a DATA_EVENT block for the RMS Engine device.
Code Generation Monitored Devices RMS CodeCrafter generates a DATA_EVENT block for each Monitored Device not using a support module.
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.
Code Generation SEND_COMMAND DATA.DEVICE,'ADD // Blinds // Blinds Open (1095) // Blinds Close (1096) SEND_COMMAND DATA.DEVICE,'ADD // VCR - VHS // VCR Play (1131) // VCR Stop (1132) // VCR Pause (1133) // VCR Fast Forward (1134) // VCR Rewind (1135) // VCR Search Fwd (1136) // VCR Search Rev (1137) SEND_COMMAND DATA.
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.
RMS Concepts RMS Concepts Device Monitoring Framework RMS provides device monitoring through a user extensible framework. This framework allows you to customize what devices are monitored, the conditions that indicate a problem or fault and what type of problem or fault this condition represents. RMS generates notifications when a fault condition occurs, as determined by the notification configuration. Each room has one or more monitored devices.
RMS Concepts Device Values (Cont.) Address and Address Type This is the physical address and address type for the Netlinx-connected device. This information describes how the device is connected to the NetLinx master. A device connected via ICSNet will display "ICSNet" for the address type and the hardware's network address for the address. A device connected via IP will display "TCP/IP" for the address type and the IP address for the address. Axcess devices will display "AXLink" for both values.
RMS Concepts Parameter Values (Cont.) Reset Flag and Reset Value These values determine if and how the parameter can be reset from the RMS server console. If the Reset Flag is set, then the administrator can reset the value remotely. When the administrator selects "Reset" from the console, the Reset Value is copied to the Value and the faulted condition is cleared. These values are useful for parameters such as VCR "Run Time" which would be manually reset when the VCR is cleaned.
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.
i!-ConnectLinx i!-ConnectLinx i!-ConnectLinx™ is an application that allows you to expose NetLinx™ actions to the outside world. i!-ConnectLinx allows a programmer to define and program actions that can be utilized by other user interfaces or processes outside the NetLinx Control System.
i!-ConnectLinx BUTTON_EVENT[vdvCLActions,1] { PUSH: { PULSE[VCR,1] } } BUTTON_EVENT[vdvCLActions,2] { PUSH: { PULSE{VCR,2] } } (* VCR Play *) (* VCR Stop *) When the i!-ConnectLinx engine gets a request to play the VCR, i!-ConnectLinx will "push" the button of the virtual device just like a user pushes a button on a touch panel. There is now only one thing left to do: Tell the user which actions are which.
Code Generation RMS CodeCrafter 91
ARGENTINA • AUSTRALIA • BELGIUM • BRAZIL • CANADA • CHINA • ENGLAND • FRANCE • GERMANY • GREECE • HONG KONG • INDIA • INDONESIA • ITALY • JAPAN LEBANON • MALAYSIA • MEXICO • NETHERLANDS • NEW ZEALAND • PHILIPPINES • PORTUGAL • RUSSIA • SINGAPORE • SPAIN • SWITZERLAND • THAILAND • TURKEY • USA ATLANTA • BOSTON • CHICAGO • CLEVELAND • DALLAS • DENVER • INDIANAPOLIS • LOS ANGELES • MINNEAPOLIS • PHILADELPHIA • PHOENIX • PORTLAND • SPOKANE • TAMPA 3000 RESEARCH DRIVE, RICHARDSON, TX 75082 USA • 800.222.
