AMX RMS 3.0, Manual

Page 1: ...Software NetLinx Programmer s Guide RMS Resource Management Suite 3 0 ...

Page 2: ... 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 prod ucts 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 ...

Page 3: ...ceipt AMX DISCLAIMS ALL OTHER WARRAN TIES EITHER EXPRESS OR IMPLIED INCLUDING BUT NOT LIMITED TO IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE WITH REGARD TO THE AMX SOFT WARE 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 e...

Page 4: ......

Page 5: ...ges 12 Advise Messages 12 Upgrading from MeetingManager 1 0 15 Basic Changes 15 Lamp Hours 16 Communication Timeout 17 Custom Source Usage 18 Source Usage and Multiple Displays 19 Time Synchronization 21 Migrating from The Device Monitoring Worksheet to RMS CodeCrafter 22 Getting Started 23 Using RMS CodeCrafter 23 Interfacing with the RMS SDK 25 Service Mode 27 Device Parameter Persistence 27 Cus...

Page 6: ...rogramming 38 Control Failure 40 Device Information 40 Monitoring Source Usage 41 Source Select 41 Monitoring Many NetLinx connected Devices 43 RMSNLDeviceMod 43 Monitoring A Single NetLinx connected Device 45 Registering Devices 46 Registering Parameters 46 Setting Parameter Values 52 NetLinx Modules 55 Non RMS Modules 55 KeyboardMod 55 RMSEngineMod Module 55 Commands 56 Strings 60 Channels 62 Le...

Page 7: ...Mod Module 68 Commands 68 Module Definition 68 Touch Panel Pages 69 RMSNLDeviceMod Module 70 Commands 70 Module Definition 70 Touch Panel Pages 70 RMSProjectorMod Module 71 Commands 71 Strings 72 Channels 72 Module Definition 73 Touch Panel Pages 73 RMSTransportMod Module 74 Commands 74 Strings 75 Channels 76 Module Definition 76 Touch Panel Pages 77 RMSBasicDeviceMod Module 77 Commands 77 Strings...

Page 8: ...inition 80 Touch Panel Pages 80 RMSSrcUsageMod Module 81 Commands 81 Channels 81 Module Definition 82 Touch Panel Pages 82 i ConnectLinx 83 Using i ConnectLinx 84 Standard Actions 86 Action Arguments 88 Action Persistence and Distribution 89 International Issues Localization 90 Programming 91 Channels 91 Levels 91 Commands 92 Strings 94 Module 95 ...

Page 9: ...ult condition occurs routing such notifications to the appropriate personnel as determined by the notification configuration The RMS Software Development Kit SDK is composed of a series of modules that allow users to monitor equipment errors and usage view appointments display welcome images and messages and view current appointment details from any NetLinx compatible touch panel Users can create ...

Page 10: ...Overview 2 RMS NetLinx Programmer s Guide ...

Page 11: ...e RMS SDK is a set of NetLinx and TPDesign files that are included in your control system programs To utilize this SDK you will need the following applications installed NetLinx Studio 2 5 or later TPDesign 4 v2 6 or later for G4 panels TPDesign 3 v3 16 or later for G3 panels ...

Page 12: ...System Requirements 4 RMS NetLinx Programmer s Guide ...

Page 13: ...P address or a HostName for the server NetLinx supports DNS so if you are using a HostName the HostName must be registered with the DNS server that NetLinx has been configured to use The DNS server configuration will be picked up automatically through DHCP if the DNS servers are registered with the DHCP server For more information on configuring DNS servers in NetLinx see the NetLinx master s inst...

Page 14: ...a NetLinx system has been programmed with the RMS modules and the server s IP address or HostName the NetLinx system automatically connects to the RMS server Install Checklist Is the RMS server s host name registered with your DNS server Yes Configure each NetLinx system to point the correct DNS server and supply the HostName to the NetLinx programmer to use in the SERVER command The DNS server co...

Page 15: ...ted with a NetLinx connected device In the case of a video projector this device would be the IR card Serial Card or IP Socket used to communicate with the projector The RMS software is associated with the NetLinx master itself Each monitored device has one or more device parameters that represent monitored items For instance monitoring lamp hours of a video projector is accomplished through a Lam...

Page 16: ...Type This is the device type of the NetLinx connected device This might be NI 2000 or NXP TPI 4 Touch Panel This is available for Axcess and NetLinx devices This information is registered automatically by the RMS server Serial Number This is the serial number of the NetLinx connected Device This is only available for NetLinx devices This information is registered automatically by the RMS server Fi...

Page 17: ... 2 less than 10 Value and Units This is the current value of the parameter Units are appended to the value when displayed in the web console Threshold Value and Comparison Operator The threshold value is the value for which this parameter is considered to indicate a problem or fault The comparison operator is used to detect when the value changes from the un faulted to the faulted condition The co...

Page 18: ...echnician 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 Reset Flag and Reset Value These values determine if and how the parameter can be reset from the RMS server console If t...

Page 19: ... would include items that require a technician to visit the room Room Communication Error A loss of communication between the room and the RMS server Control System Error Any error that represents a control system error such as an offline device or loss of communication with a device Network Error Any network related error These would most commonly be associated with loss of communication with dev...

Page 20: ...rt template or the default template if a custom template has not been assigned Next the RMS server checks for any notifications in the Notification List matching the group room and status type for the parameter and dispatch any messages via SMTP or SNPP as needed using the appropriate text from the template assigned to the parameter Advise Messages When an Advise message occurs the RMS server firs...

Page 21: ...users registers for a notification matching the parameters group room and status type If the Lamp Hours changes from 1001 to 999 the RMS server triggers an Advise message If the parameter is configured to send Advise messages the message is sent to the log and to all users registered for a notification matching the parameters group room and status type ...

Page 22: ...Concepts 14 RMS NetLinx Programmer s Guide ...

Page 23: ... constants functions names including MM have been changed to RMS For instance MMNetLinxDeviceOnline is now RMSNetLinxDeviceOnline and MM_PARAM_SET is now RMS_PARAM_SET Many of the SDK changes can be handled by using RMS CodeCrafter it can import data from a MeetingManager 1 0 Device Monitoring Worksheet and generate an include file that uses the new RMS 2 0 SDK However changes to your code will be...

Page 24: ...anges required to take full advantage of the RMS 2 0 SDK so check the next sections to see if they apply to your program After making this change you will need to recompile and download your code Lamp Hours In order to take full advantage of the Lamp Hours reporting and Manage Lamp Hours view Projector Lamp Hours must be reported to the RMSProjectorMod support module If you created your own Lamp H...

Page 25: ... VCRs a new support module RMSBasicDeviceMod was added RMSBasicDeviceMod monitors a device for Power Communication Status Control Failure optional and IP Address This module simplifies monitoring device communications To use this new module make the following changes to your programming Remove the registration of the named device and the Device Communicating parameter Remove the calls to parameter...

Page 26: ...recompile and download If you have customized MeetingManagerSrcUsageMod with custom sources as indicated by a value of MM_MAX_CUSTOM_SOURCES greater than 0 in your customized version of MeetingManagerSrcUsageMod axs you will need to migrate these custom sources to the RMSSrcUsageMod axs file RMSSrcUsageMod supports custom sources in two ways The first way is the same as MeetingManagerSrcUsageMod w...

Page 27: ...racking of one or more sources at the same time since each MeetingManagerSrcUsageMod module could track one source While this method still works in RMS 2 0 RMSSrcUsageMod supports a new method for tracking multiple sources RMSSrcUsageMod supports a new command Multisource which tells RMSSrcUsageMod that it should track each source independently In this mode RMSSrcUsageMod times each source from th...

Page 28: ...is vdvCLActions 1011 CurrentSource VCR OR PreviewSource VCR vdvCLActions 1014 CurrentSource DVD OR PreviewSource DVD The code produced by RMS CodeCrafter is similar in concept to the code above and will work for either Single source or Multi source source usage tracking To take advantage of this new feature in RMS 2 0 when using RMS CodeCrafter simply check the Using multiple display devices check...

Page 29: ...ed to include i TimeManager in your program However there are ways to configure RMS to allow i TimeManager to handle time synchronization If the RMS SDK automatically detects that i TimeManager is present based on the device vdvTMEvents being defined then the RMS SDK will automatically defeat the RMS time synchronization You can manually disable the RMS time synchronization by calling this functio...

Page 30: ...are still necessary but it is easier to do with the assistance of RMS CodeCrafter To bring your worksheet into CodeCrafter for editing 1 Dowload RMS CodeCrafter from AMX com if you do not already have the application the application is included in the RMS 3 0 SDK installation for your convenience 2 Install and open RMS CodeCrafter 3 Select File Open Import Spreadsheet 4 Locate your MeetingManager ...

Page 31: ...odeCrafter project by opening the program from the AMX Resource Management Suite RMSCodeCrafter Program Folder For details on operating the program see the RMSCodeCrafter help file The RMS SDK consists of a series of modules to simplify device monitoring programming Device monitoring modules handle the registration of devices and parameters and keeping track of lamp hours and transport run time In...

Page 32: ...es Transport RMSTransportMod Device Online Offline Power Run Time Communication Status for Serial devices Control Failure Optional IP Address of Socket based devices Slide Projector RMSSldProjMod Device Online Offline Power Lamp Hours The following diagram is a visual description of the architecture of the RMSMain axi and the RMS support modules FIG 1 Architecture of The RMSMain axi And The RMS Su...

Page 33: ...les will automatically detect power status To notify RMS when the device power is ON call this function RMSSetDevicePower DeviceIdentifier TRUE Where DeviceIdentifier is the identifier for the real device such as dvProj To notify RMS when the device power is OFF call this function RMSSetDevicePower DeviceIdentifier FALSE Where DeviceIdentifier is the identifier for the real device such as dvProj F...

Page 34: ... State is the transport state Play 1 stop 2 Pause 3 FFwd 4 Rew 5 SrchFwd 6 SrchRev 7 Record 8 For serial devices including RS232 and IP controlled devices you need to add some polling commands to these device in order to allow the RMS support module to properly report the Device Communicating parameter The RMSBasicDeviceMod RMSProjectorMod and RMSTransportMod expect to receive a string from the de...

Page 35: ...ds may include A button on a protected touch panel page A button on a protected web based touch panel page A switched connected to an IO port on a NetLinx system accessible only by technicians A key activated switch connected to an IO port on a NetLinx system Device Parameter Persistence Monitored devices and parameters are registered with RMS the first time a NetLinx system connects to the RMS se...

Page 36: ...lete the room and then add the room back Deleting a room from RMS deletes all associated monitored devices and parameters from the RMS server Optionally you can delete a device or a parameter from the RMS console provided the device is not the System device and the parameter is not one of its parameters ...

Page 37: ...tom Device Monitoring Programming The RMS SDK is made up of a series of modules and include files The following diagram is a visual description of the architecture of the RMSMain axi and the RMS support modules FIG 2 Architecture of The RMSMain axi And The RMS Support Modules ...

Page 38: ...when it is time to register devices and parameters and when the administrator resets a parameter from the RMS console RMS sends these events to your program as a string from vdvRMSEngine The event processing section in this include file will process these strings parse the parameters and call a function in your program to notify you of the event These functions need to be defined in your program w...

Page 39: ...l automatically register four parameters for this device They are System Power Help Request Maintenance Request and Service Mode In addition the system will monitor room communication status for each room These parameters require no programming on your part for registration However you will need to add support for system power RMS registers and manages this parameter for you but you need to notify...

Page 40: ...for dvRelay RMSRegisterDeviceIndexParam dvRELAY Rack Power 1 RMS_COMP_LESS_THAN RMS_STAT_MAINTENANCE FALSE 0 RMS_PARAM_SET nRMSRackPowerRackPower OFF ON This function is called from CHANNEL_EVENT dvRELAY 0 Relay on or off DEFINE_FUNCTION RMSSetRackPowerRackPower INTEGER nValue LOCAL_VAR CHAR bInit IF nRMSRackPowerRackPower nValue bInit FALSE RMSChangeIndexParam dvRELAY Rack Power nValue nRMSRackPo...

Page 41: ...Device Monitoring Programming 33 RMS NetLinx Programmer s Guide ON SWITCH CHANNEL CHANNEL CASE 1 RMSSetRackPowerRackPower 1 break Channel Off OFF SWITCH CHANNEL CHANNEL CASE 1 RMSSetRackPowerRackPower 0 break ...

Page 42: ...or each device this module will register and monitor online offline status communication status control failure and power Communication status is registered only if the device is a two way device This includes serial devices and IP sockets Control failure is registered only if enabled via a SEND_COMMAND and is based on the ability to control power If the device is an IP based device the IP address...

Page 43: ...MAND and is based on the ability to control power If the device is an IP based device the IP address NetLinx is communicating with is also registered with RMS Lamp hours are determined by counting the time that the device s power is On However this module can also accept the value of lamp hours as a SEND_COMMAND when you have a projector that can provide lamp hours Since this module registers lamp...

Page 44: ... This includes serial devices and IP sockets Control failure is register only if enabled via a SEND_COMMAND and is based on the ability to control power If the device is an IP based device the IP address NetLinx is communicating with is also registered with RMS Run time is determined by counting the time that the device is in a transport state other than stop while the power is on The following di...

Page 45: ...s For each projector this module will register and monitor online offline status power and lamp hours Lamp hours are determined by counting the time that the device s power is On The following diagram is a visual description of the architecture of the RMSSldProjMod module FIG 6 Architecture of The RMSBasicDeviceMod Module ...

Page 46: ...vVCR 5001 2 0 dvSWT 5001 3 0 vdvVPROJ 33001 1 0 vdvVCR 33002 1 0 vdvSWT 33003 1 0 vdvRMSEngine 33003 1 0 Projector Monitoring Code DEFINE_MODULE RMSProjectorMod mdlProj1 vdvVPROJ dvVPROJ vdvRMSEngine DEFINE_MODULE COMM_XXXXX COMM dvVPROJ vdvVPROJ VCR Monitoring Code DEFINE_MODULE RMSTransportMod mdlVCR1 vdvVCR dvVCR vdvRMSEngine DEFINE_MODULE COMM_XXXXX COMM dvVCR vdvVCR If you are not using an AM...

Page 47: ...d be set to report on channel 255 of the real device In some cases this requires a SET IO LINK command to be sent to the real device In these cases simply pass the real device Notify Modules Turn Power On RMSSetDevicePower dvProj TRUE SEND_STRING vdvVPROJ POWER 1 PULSE vdvVPROJ 27 ON vdvVPROJ 255 Turn Power Off RMSSetDevicePower dvProj FALSE SEND_STRING vdvVPROJ POWER 0 PULSE vdvVPROJ 28 OFF vdvVP...

Page 48: ...bles an IO status to appear on channel 255 of the device These modules will watch for power attempts using channel 9 27 or 28 and report a control failure if the power of the device does not respond properly Additionally the module will monitor channel 254 used as a power fail channel when using the PON commands and report control failure conditions when this channel is on This functionality must ...

Page 49: ...Any standard source selected registered with i ConnectLinx will automatically register in RMS by RMSSrcUsageMod As your programming sets the selected source on the i ConnectLinx device RMSSrcUsageMod will track the usage of the source and report it to RMS To enable usage monitoring of a standard i ConnectLinx source simply register the source with i ConnectLinx and add programming for the source s...

Page 50: ...et the i ConnectLinx status for Power Off using the standard Power Off action PULSE vdvCLActions 1002 By default RMS monitors a single source at a time If a new source is selected the previous selected source s usage is tracked and the new source is selected However if you have more that one destination in your system such as two projectors this operation is not desirable RMS can monitor each sour...

Page 51: ... device definition for their name for example 128 1 0 and the manufacturer and model will be determined by the device This module is most useful for monitoring a large quantity of NetLinx devices where the logical name of the device is not important such as a bank of Input or Relay cards To use this module create a device array with the NetLinx connected devices you want monitored Then pass this d...

Page 52: ...RMS NetLinx Programmer s Guide DEFINE_MODULE RMSNLDeviceMod mdlNLD dvMonitoredDevices vdvRMSEngine The following diagram is a visual description of the architecture of the RMSNLDeviceMod module FIG 8 Architecture of The RMSNLDeviceMod Module ...

Page 53: ...nline This function will need to be called in two places Call RMSNetLinxDeviceOnline in the RMSDevMonRegisterCallback function to make sure it is registered when the RMS engine module connects to the RMS server Also call RMSNetLinxDeviceOnline when the NetLinx connected device reports online RMSNetLinxDeviceOffline updates the online offline parameter to offline It only needs to be called when the...

Page 54: ...hen the RMS engine module connects to the RMS server Also call RMSRegisterDevice when the NetLinx connected device reports online This function will automatically register the Online Offline parameter and set this value to Online The RMSRegisterDevice function and the corresponding RMS SEND_COMMAND that it generates will only work for devices that are currently online This is because RMS tracks in...

Page 55: ...be limited to a list The value NetLinx sends for an enumeration parameter needs to exist in the enumeration list However the administrator will only be allowed to pick a threshold or reset value from the enumeration list An example of an enum parameter is the currently selected source The character is used to separate values in the enumeration list Index Parameter Index parameters are parameters o...

Page 56: ...m dvDPS cName slThreshold nThresholdCompare nThresholdStatus bCanReset slResetValue nInitialOp slInitial slMin slMax RMSRegisterDeviceIndexParam dvDPS cName nThreshold nThresholdCompare nThresholdStatus bCanReset nResetValue nInitialOp nInitial cEnumList RMSRegisterDeviceStringParam dvDPS cName cThreshold nThresholdCompare nThresholdStatus bCanReset cResetValue nInitialOp cInitial ...

Page 57: ...monitoring voltage or if you are monitoring percentage Two additional registration functions allow for the units field and can be used in place of the above functions RMSRegisterDeviceEnumParam dvDPS cName cThreshold nThresholdCompare nThresholdStatus bCanReset cResetValue nInitialOp cInitial cEnumList RMSRegisterDeviceNumberParamWithUnits dvDPS cName cUnits slThreshold nThresholdCompare nThreshol...

Page 58: ...ter to register nThresholdCompare can be one of the following values RMS_COMP_NONE 0 RMS_COMP_LESS_THAN 1 RMS_COMP_LESS_THAN_EQ_TO 2 RMS_COMP_GREATER_THAN 3 RMS_COMP_GREATER_THAN_EQ_TO 4 RMS_COMP_EQUAL_TO 5 RMS_COMP_NOT_EQUAL_TO 6 RMS_COMP_CONTAINS 7 RMS_COMP_DOES_NOT_CONTAIN 8 This value along with slThreshold nThreshold or cThreshold will be used to test to see when the parameter indicates a fau...

Page 59: ...ignored nInitialOp and slInitial nInitial and cInitial are used to set the value of the parameter at the time it is registered nInitialOp can be one of the following values RMS_PARAM_SET 0 RMS_PARAM_INC 1 RMS_PARAM_DEC 2 RMS_PARAM_MULTIPLY 3 RMS_PARAM_DIVIDE 4 RMS_PARAM_UNCHANGED 6 This eliminates the need to send a separate set parameter messages after the parameter is registered These constants ...

Page 60: ...eIndexParam dvDPS cName nValue RMSChangeStringParam dvDPS cName nOp cValue RMSChangeEnumParam dvDPS cName cValue The dvDPS is the device number of the device with which this parameter is associated cName is the name of the parameter to set nOp can be one of the following values RMS_PARAM_SET 0 RMS_PARAM_INC 1 RMS_PARAM_DEC 2 RMS_PARAM_MULTIPLY 3 RMS_PARAM_DIVIDE 4 RMS_PARAM_RESET 5 These constants...

Page 61: ...parameters RMS_PARAM_INC 1 will append the string value to the current string and RMS_PARAM_DEC 2 will remove the string value from the current string The results of multiple and divide on a String parameter are undefined Note that values for slMin slMax and cEnumList supplied during parameter registration are not used to validate the value set using these functions If a Number parameter value fal...

Page 62: ...Custom Device Monitoring Programming 54 RMS NetLinx Programmer s Guide ...

Page 63: ... This is the keyboard module This module is required by any module requiring on screen text entry of data RMSUIMod and RMSHelpUIMod require this module For more information see KeyboardMod Readme txt in the RMS SDK directory RMSEngineMod Module Commands Strings Channels Levels Module Definition ...

Page 64: ...used to limit the portion of the i ConnectLinx tree avail able to users when configuring room pre sets This command is used when a single NetLinx master is running more than one instance of RMS ADD DEV DPS Name Man Model Set device info for monitored device DPS must be in string form ex 5001 1 0 Name Manufacturer and Model are optional ADD NPARAM DPS Name Threshold Status Reset Initial Value Min M...

Page 65: ...83647 to 2147483647 slMax must be greater than slMin Set slMax and slMin to zero or omit the values to not impose a range ADD SPARAM DPS Name Threshold Status Reset Initial Value Add a String parameter See above for description of all arguments ADD IPARAM DPS Name Threshold Status Reset Initial Value Enum List Add an Index parameter See above for description of all arguments Enum List is a list of...

Page 66: ...ts to append to the parameter value when displayed SET PARAM DPS Name Value Set a parameter value DPS must be in string form ex 5001 1 0 Value can be one of the following Value Set Value Value Increment by Value Value Decrement by Value Value Multiply by Value Value Divide by Value Value Divide by Value RESET reset the value NOCHANGE do not change the value HELP Help Message Send a help request MA...

Page 67: ...mation to master debug port master messaging SERVICE ON Turn on service mode While in service mode no errors will be reported SERVICE OFF Turn off service mode Default ANSWER QuestionID Flags Answer Provide an answer to a question QuestionID and Flags should be the values supplied from the QUESTION string The Answer is a text string IGNORE SERVER TIME UPDATE Normally NetLinx receives a time update...

Page 68: ...en the administrator manually resets a parameter from the RMS console ROOM NAME Name The name of the room as defined in the RMS server ROOM LOCATION Location The location of the room as defined in the RMS server ROOM OWNER Owner The owner of the room as defined in the RMS server WEB SERVER HostPort The host port of the web server where RMS is running WEB ROOT Directory The root directory of RMS on...

Page 69: ...e include file This binary data can be passed to the RMSDecodeAppointmentString function defined in the include file to convert the data to an appointment structure MESG Flags Message A message from the RMS console Flags are the message flag and Message is the text of the message Currently there are no Flags defined EXTEND No A message indicating the current appointment could not be extended due t...

Page 70: ... 5 First Appointment Index 6 Last Appointment Index 7 Number of Appointment Remaining today Module Definition DEFINE_MODULE RMSEngineMod mdlRMSEng vdvRMSEngine dvRMSSocket vdvCLActions Where mdlRMSEng is a unique module name vdvRMSEngine A virtual device for communicating to RMSEngineMod RMSEngineMod module dvRMSSocket A socket device for communicating to the RMS server vdvCLActions A i ConnectLin...

Page 71: ...nd Descriptions DFORMAT DAY MONTH Set Date format European format Day Month Year DFORMAT MONTH DAY Set Date format US format Month Day Year TFORMAT 12 HOUR Set Time format to 12 hour format 01 12 00 59 AM PM TFORMAT 24 HOUR Set Time format to 24 hour military format 00 23 00 59 DEBUG ON Turn on debug DEBUG OFF Turn off debug Default VERSION Send version information to master debug port master mess...

Page 72: ...uch panel devices implementing RMSUIMod If any of these panels are G3 panels make sure the first panel in this array is a G3 panel This will instruct the module to use G3 compatible SEND_COMMAND s dvTPWelcome An array of welcome touch panel devices implementing RMSUIMod If any of these panels are G3 panels make sure the first panel in this array is a G3 panel This will instruct the module to use G...

Page 73: ...ing touch panel pop up pages for dvTp Touch Panel Pop up Pages Popup Page Popup Group mtgmMeetingEndWarning N A mtgmMeetingExtendWarning N A mtgmHelpResponse N A mtgmAppointmentDetails N A mtgmViewSchedule1 mtgmViewSchedule mtgmViewSchedule3 mtgmViewSchedule mtgmMonthSelect mtgmMonthYear mtgmYearSelect mtgmMonthYear mtgmHelpMessage KBClients mtgmMaintenanceMessage KBClients KBShift N A mtgmHelpQue...

Page 74: ...ls N A mtgmViewSchedule1 mtgmViewSchedule mtgmViewSchedule3 mtgmViewSchedule The RMS Welcome Screen 320x240 tpd file implements the welcome functionality in multiple pages without popups See this file for more details Commands and Descriptions DFORMAT DAY MONTH Set Date format European format Day Month Year DFORMAT MONTH DAY Set Date format US format Month Day Year TFORMAT 12 HOUR Set Time format ...

Page 75: ...AND s All channel and variable text numbers are defined inside the module If you need to change them edit the module and re compile the module and your program Touch Panel Pages RMSWelcomeOnlyUIMod requires the following touch panel pages for dvTPWelcome mtgmWelcomePage RMSWelcomeOnlyUIMod requires the following touch panel pop up pages for dvTp Touch Panel Pop up Pages Popup Page Popup Group mtgm...

Page 76: ...es implementing RMSHelpUIMod dvTP An array of main touch panel devices implementing RMSHelpUIMod If any panels are G3 panels make sure the first panel in this array is a G3 panel This will instruct the module to use G3 compatible SEND_COMMAND s Commands and Descriptions DFORMAT DAY MONTH Set Date format European format Day Month Year DFORMAT MONTH DAY Set Date format US format Month Day Year TFORM...

Page 77: ... compile the module and your program Touch Panel Pages RMSHelpUIMod requires the following touch panel pages for dvTP mtgmMain KBKeyboard RMSHelpUIMod requires the following touch panel pop up pages for dvTp Touch Panel Pop up Pages Popup Page Popup Group mtgmHelpResponse N A mtgmHelpQuestion N A mtgmHelpMessage KBClients mtgmMaintenanceMessage KBClients KBShift N A ...

Page 78: ...finition DEFINE_MODULE RMSNLDeviceMod mdlNLD dvMonitoredDevices vdvRMSEngine Where mdlNLD is a unique module name dvMonitoredDevices An array of NetLinx connected devices to monitor vdvRMSEngine A virtual device for communicating to RMSEngineMod module Touch Panel Pages This module requires no pages Commands and Descriptions VERSION Send version information to master debug port master messaging ...

Page 79: ...t Set the device communication timeout to Timeout Timeout is in 1 10 second increments Sending a value of zero will disable the device communication timeout and the registration of the device communicating parameter DEV PWR DPS State Set the device power state DPS must be in string form ex 5001 1 0 State must be 1 or 0 LAMP HOURS DPS Value Set the projector lamp hours DPS must be in string form ex...

Page 80: ... that the device is communicating See the communication timeout command for more details Channels The module watches for these channels on the vdvProjModule device 9 toggle System Power State 27 Set system power to ON 28 Set system power to OFF 254 Power failure 255 Power Status Strings and Descriptions POWER Power State Set the system power state PowerState should be 0 for off and 1 for on Exampl...

Page 81: ...g to RMSProjectorMod This can be the same virtual device used to communicate with an InConcert module or a physical projector If controlling the projector or display using an IR device pass the physical device to this parameter dvProj A physical projector or socket device to which the projector is connected vdvRMSEngine A virtual device for communicating to RMSEngineMod module Touch Panel Pages Th...

Page 82: ...unication timeout to Timeout Timeout is in 1 10 second increments Sending a value of zero will disable the device communication timeout and the registration of the device communicating parameter DEV PWR DPS State Set the device power state DPS must be in string form ex 5001 1 0 State must be 1 or 0 XPORT STATE DPS State Set the transport state DPS must be in string form ex 5001 1 0 State should be...

Page 83: ...mmand the module will notify RMS that the device is communicating See the communication timeout command for more details Strings and Descriptions POWER Power State Set the system power state PowerState should be 0 for off and 1 for on Example POWER 1 TRANSPORT Transport State Set the system power state Transport State can be 2 for Stop or any other value for a non stopped condition Any value other...

Page 84: ...to rewind 246 Set transport state to search forward 247 Set transport state to search reverse 248 Set transport state to record Module Definition DEFINE_MODULE RMSTransportMod mdlVCR1 vdvVCRModule dvVCR vdvRMSEngine Where mdlVCR1is a unique module name vdvVCRModule A virtual device for communicating to RMSTransportMod This can be the same virtual device used to communicate with an InConcert module...

Page 85: ...ce monitoring DPS must be in string form ex 5001 1 0 COMM TO DPS Timeout Set the device communication timeout to Timeout Timeout is in 1 10 second increments Sending a value of zero will disable the device communication timeout and the registration of the device communicating parameter DEV PWR DPS State Set the device power state DPS must be in string form ex 5001 1 0 State must be 1 or 0 POWER FA...

Page 86: ...command the module will notify RMS that the device is communicating See the communication timeout command for more details Channels The module watches for these channels on the vdvModule device 9 toggle System Power State 27 Set system power to ON 28 Set system power to OFF 254 Power failure 255 Power Status Strings and Descriptions POWER Power State Set the system power state PowerState should be...

Page 87: ...vice A physical device or socket device to which the virtual device is connected vdvRMSEngine A virtual device for communicating to RMSEngineMod module Touch Panel Pages This module requires no pages RMSSldProjMod Module Commands Channels Module Definition Commands RMSSldProjMod listens for the following commands from the vdvRMSEngine device Commands and Descriptions DEV INFO DPS Name Man Model Se...

Page 88: ...rojector Power State Module Definition DEFINE_MODULE RMSSldProjMod mdlSldProj1 dvSldProj vdvRMSEngine Where mdlSldProj1is a unique module name dvSldProj A physical device to which the slide projector is connected vdvRMSEngine A virtual device for communicating to RMSEngineMod module Touch Panel Pages This module requires no pages ...

Page 89: ... On 1002 Power Off 1011 VCR Select 1012 HI 8 VCR Select 1013 Umatic VCR Select 1014 DVD Select 1015 Laser Disc Select 1016 TV DVD Cable Select 1017 Video Conference Select 1018 Document Camera Select 1019 Room Camera Select 1020 Whiteboard Select 1021 Rack Computer Select 1022 Aux PC Select Commands and Descriptions MULTISOURCE State Set the multi source tracking state State can be ON or OFF The d...

Page 90: ...name that starts with Select is assumed to be a custom source RMSSrcUsageMod will register this source name with the RMS server and treat the associated channel as a source select channel For more information on i ConnectLinx programming refer to the i ConnectLinx help file installed with i ConnectLinx as part of the RMS SDK Module Definition DEFINE_MODULE RMSSrcUsageMod mdlSrcUsage vdvRMSEngine v...

Page 91: ...ontrol System Once a process outside the NetLinx Control System has obtained the action list the process can then make a request to i ConnectLinx to execute that action i ConnectLinx handles this request and makes this request available to the NetLinx program for execution i ConnectLinxEngineMod is the main i ConnectLinx module that handles exposing and executing action requests see the Module sec...

Page 92: ...ons you want executed remotely using this virtual device Think of the virtual device vdvCLActions as a touch panel Normally you write your NetLinx program to respond to certain push channels from a touch panel i ConnectLinx is exactly the same Let s say you want to provide the user with the ability to play and stop a VCR Imagine you have two touch panel buttons that do these functions write code t...

Page 93: ...virtual device describing the name of a given channel code To specify the names of the actions in the above example you would add some code like this DATA_EVENT vdvCLActions ONLINE Setup actions VCR Play SEND_COMMAND vdvCLActions ADD ACTION 1 VCR Play VCR Stop SEND_COMMAND vdvCLActions ADD ACTION 2 VCR Stop Once i ConnectLinx receives these commands it stores this information in an XML file that c...

Page 94: ... Standard actions are actions defined by AMX and supported natively by i ConnectLinx When adding actions to i ConnectLinx it is best to use the standard action if it is available That way the action can be executed regardless of which system the i ConnectLinx compatible technology was programmed to control The list of standard actions are listed in the i ConnectLinxStdFunctionList xls file The sta...

Page 95: ...Also if the VCR exists in the system then there is likely a way to select the VCR as the active source Therefore the vcr macro includes the VCR source select and the standard transports To load a set of actions by macro simply send a command to i ConnectLinx with the macro you want added For example DATA_EVENT vdvCLActions ONLINE Setup actions VCR Select and Play Record SEND_COMMAND vdvCLActions A...

Page 96: ... arguments Each action can support zero or more arguments Each argument can be one of the following types Number A single number from 32767 to 32767 You can define the minimum value maximum value desired step and a default value The user is presented with a text box in which to enter this number Level Similar to a Number argument only the user is presented with a slider to enter the level String A...

Page 97: ...t may not always be practical to keep all the i ConnectLinx action list files on the NetLinx Master For instance in a corporate environment with 20 NetLinx Masters in various conference rooms a user outside the company needs to have direct access to each NetLinx Master through the firewall in order to download the files Additionally each NetLinx Master needs it s own DNS entry so users do not have...

Page 98: ...ex file contains the list of rooms in that building and points to the actual action list for each room International Issues Localization Localization is the process by which an application is adapted to a locale and describes a user s environment or geographical location i ConnectLinx provides the standard action name help string and folder names for all the standard actions This information is bu...

Page 99: ...he doc user connectlinx directory When i ConnectLinx starts up the text is read from this file and used for all standard actions Programming i ConnectLinx appears on the NetLinx bus as a NetLinx device This device has 1 port with channels levels commands and strings like most other devices Channels i ConnectLinx supports the following channels Levels i ConnectLinx supports the following levels i C...

Page 100: ...ds one or more standard actions by ID The is used for AND and is used for THROUGH ADD FOLDER Folder Name Parent Adds a folder to the action list The parent specifies which parent folder the new folder is added to If parent is not supplied this folder is added to the root of the action list ADD ACTION ID Action Help String Folder Adds an action The ID and Action are required The Help String appears...

Page 101: ...ired The Default value defines the initial value this argument is set to when the user edits this argument Enum1 Enum2 define the available choices for the argument GET NODE Name Start End Get the node description for Name including children from Start to End Returns a PARENT string and multiple CHILD strings GET ACTION Name Get the action description for Name Returns ACTION string and multiple ar...

Page 102: ...argument to Action LARG Action Arg Name Min Max Step Default Describes a level argument to Action SARG Action Arg Name Min Max Default Describes a string argument to Action EARG Action Arg Name Default Enum1 Enum2 Describes an enum argument to Action UUID UUID Provides the UUID for this i ConnectLinx This ID can be used to identify this instance of i ConnectLinx from all other instances of i Conne...

Page 103: ...ConnectLinxEngineMod Module definition code is displayed below DEFINE_MODULE i ConnectLinxEngineMod mdlCL vdvCLActions Where mdlCL is a unique module name i ConnectLinxEngineMod Module Parameter vdvCLActions A virtual device number for programming NetLinx actions ...

Page 104: ... USA 800 222 0193 469 624 8000 469 624 7153 fax 800 932 6993 technical support www amx com 10 06 2006 AMX All rights reserved AMX and the AMX logo are registered trademarks of AMX AMX reserves the right to alter specifications without notice at any time 93 3002 04 REV J ...