manualshive.com logo in svg

AMX RMS CODECRAFTER, Operation/Reference Manual

Share
Download
AMX RMS CODECRAFTER Operation/Reference Manual Download Page 71

10

/1

0 

 ©

2

0

1

0

 AM

X.

 Al

l 

ri

ghts 

reserved.

 AM

X

 a

n

d 

the AM

X 

log

o

 a

re 

regi

ster

ed trade

m

a

rk

s 

of AMX. AMX 

reserv

es the 

right

 to al

ter speci

fica

tio

n

s 

wi

thout no

tic

e

 a

t a

n

y 

ti

me.

It’s Your World - Take Control™

3000 RESEARCH DRIVE, RICHARDSON, TX 75082 USA •  800.222.0193  •  469.624.8000  •  469-624-7153 fax  • 800.932.6993 technical support  •  www.amx.com

Summary of Contents for RMS CODECRAFTER

Page 1: ...Operation Reference Guide Enterprise Applications RMS CodeCrafter v3 2 or higher Last Revised 9 22 2010...

Page 2: ...PLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE WITH REGARD TO THE AMX SOFTWARE THIS LIM ITED WARRANTY GIVES LICENSEE SPECIFIC LEGAL RIGHTS Any supplements or updates to the A...

Page 3: ...0 Set Range for Enum Parameter 11 Device Template Wizard Finished Page 12 RMS CodeCrafter Project Pages 13 Introductory Page 13 Edit User Preferences Window 14 Code Generation Wizard Start Page 15 Int...

Page 4: ...ew Device Template 41 Creating A New RMS Project 42 Saving A Device Template File 44 Saving A Project File 44 Opening An Existing Device Template 44 Opening An Existing Project 45 Closing A Project Or...

Page 5: ...54 Event Definitions 55 RMS Engine Device 55 Named Devices 55 Monitored Devices 56 Device Parameters 56 i ConnectLinx 56 LEVEL_EVENT Block 56 DATA_EVENT Block 57 BUTTON_EVENT Block 59 CHANNEL_EVENT B...

Page 6: ...iv RMS CodeCrafter Table of Contents i ConnectLinx 67 Using i ConnectLinx 67...

Page 7: ...device template files for frequently used devices Ability to import an existing RMS Device Monitoring Worksheet into a new RMS CodeCrafter project Ability to transfer a SERVERINFO TXT file containing...

Page 8: ...f RMS SDK utilized an Excel spreadsheet that RMS CodeCrafter now replaces Selecting this option opens the Import spreadsheet window Close Closes the project or template file currently open If the file...

Page 9: ...n previously been saved you are prompted to name and designate where to save the file Cut Cut highlighted text from fields Copy Copy highlighted text within fields Paste Paste cut and copied text into...

Page 10: ...Welcome to RMS CodeCrafter 4 RMS CodeCrafter...

Page 11: ...re brought to the Device Template Main page to edit and set parameters Device Template Main Page The Device Template Main page is the first page of the template creation process FIG 1 Device Template...

Page 12: ...the function Measured in 1 10ths of a second where 0 is a valid value Default is 300 Control Failure Detect Placing a check in the box adds a call to RMSEnablePowerFailure in the generated code file S...

Page 13: ...Status select one from the scroll list Not Assigned Room Communication Control System Network Security Help Request Maintenance Equipment Usage Threshold Comparison Operator select from the following...

Page 14: ...value is optional Set Range Enum or Index A drop down list of enumeration strings You can elect to Add adds the sting to the parameter use Remove removes the string from parameter use Move Up moves t...

Page 15: ...Enumeration List dialog 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 do...

Page 16: ...te Wizard Finished Page Edit Enumeration List dialog 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 templat...

Page 17: ...t Start Page Open Project After selecting the desired file in the open dialog window opens an existing RMS CodeCrafter project file CGP and progresses to the Project Start Page New Device Template Ope...

Page 18: ...the default template folder destination Default RMS Server Address A text field where you can edit the server address for the RMS server The default value is 0 0 0 0 Generate Device Variable Warnings...

Page 19: ...ge Code Generation Wizard Start Page Enter the NetLinx code file AXS or NetLinx Studio workspace file APW to be integrated into this project Either type or click the Browse button for the location of...

Page 20: ...elected 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 FIG 4 Integrated NetLinx Code Files Page Integrated Ne...

Page 21: ...if Monitor source usage has been selected Room Name Enter the name of the room in this text field required Location Enter the name of the room s location in this text field required Owner Enter the na...

Page 22: ...rated code Additionally the array of Welcome Panels is defined Help desk panels only If selected only the RMSHelpUIMod is defined in the generated code No scheduling display If selected no scheduling...

Page 23: ...ext field Previous Regresses to the Room Information Options page Next Progresses to the RMS Virtual and Socket Device Definitions page FIG 7 RMS Virtual and Socket Device Definitions Page RMS Virtual...

Page 24: ...onnectLinx Virtual Device vdvCLActions Enter the device port and system information of the virtual device and ConnectLinx in these text fields If this device is defined in the integrated file the fiel...

Page 25: ...ed by CodeCrafter click on your desired panel size to select Description A text field you can edit to describe the panel Base Device Drop down lists of devices available This field is populated by dev...

Page 26: ...ng Welcome Panels Page Scheduling Welcome Panels Page Add Panel Launches the Add Edit Welcome Panel dialog to add a welcome panel to the project Edit Panel Launches the Add Edit Welcome Panel dialog W...

Page 27: ...list of 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 warnin...

Page 28: ...add a named device to the project Edit Device Launches the Add Edit Named Device dialog When a named device is selected you can edit its properties Add all Welcome and Main Panels Launches the Add Al...

Page 29: ...ny entry not selected with a check is not included in the project The Device column is the device name and the Logical Name column is the associated name for that device CodeCrafter uses the panel des...

Page 30: ...Device Launches the Add Edit Monitored Device window to add a monitored device to the project Edit Device Launches the Add Edit Monitored Device window When a monitored device is selected you can edi...

Page 31: ...field Manufacturer Enter the manufacturer name for the device in this text field Model This is a text field where you can provide the model information for the device Support Module Click the radio bu...

Page 32: ...Accepts changes and closes this dialog Cancel Closes this dialog and does not keep changes FIG 16 Select Device Template dialog Select Device Template dialog Device Select a device from a drop down li...

Page 33: ...unches the Add Edit Device Parameters dialog to add a device parameter to the project Edit Parameter Launches the Add Edit Device Parameters dialog When a device parameter is selected you can edit its...

Page 34: ...the scroll list Not Assigned Room Communication Control System Network Security Help Request Maintenance Equipment Usage Threshold Comparison Operator Select from the following None Less Than Less Th...

Page 35: ...ional Set Range Enum or Index A drop down list of enumeration strings You can elect to Add adds the sting to the parameter use Remove removes the string from parameter use Move Up moves the string up...

Page 36: ...Parameter List dialog 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...

Page 37: ...in this list Functions A list of i ConnectLinx functions for the selected category Named Devices A list of devices populated by what is defined in the Add Edit Named Devices dialog section on page 25...

Page 38: ...e RMS CodeCrafter wizard to the Device Parameters Page Next Progresses the RMS CodeCrafter wizard to the Generate NetLinx Code File Page FIG 22 Add Function dialog Add Function dialog Device A list of...

Page 39: ...oom Information Options page Use this page to specify a device address D P S for the Anterus Duet Module Virtual Device If device addresses specified here have been previously defined in the integrate...

Page 40: ...Add RFID Reader This option invokes the Add Anterus RFID Reader dialog to add an RFID Reader to the list The Add Anterus RFID Reader dialog provides a drop down menu to select the RFID Reader device a...

Page 41: ...e as those in the Add Anterus RFID Reader dialog see above FIG 25 Add Anterus RFID Reader dialog Add Anterus RFID Reader dialog Anterus RFID Reader Device A list of RFID Readers available This field i...

Page 42: ...xt 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 CodeCrafter will copy all corresponding TKO files f...

Page 43: ...the process of creating your own RMS code The results of the code generation operation and confirmation of the target location is listed Finish Clicking this button returns you to the Introductory pa...

Page 44: ...RMS CodeCrafter Project Pages 40 RMS CodeCrafter...

Page 45: ...to launch the Add Edit Device Template Parameters window 11 Type the name of the parameter in the field provided 12 Click the radio button for the Type of parameter and select the Status in the menu...

Page 46: ...in and Welcome Panels or Welcome panels only in step 6 the next page is the Scheduling Welcome Panels page Otherwise it is the Named NetLinx Devices page 13 To add a panel click Add Panel and open the...

Page 47: ...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...

Page 48: ...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 w...

Page 49: ...erver System Master Address A text field for entering either the IP address or hostname of the master controller for the room Username A text field for entering the FTP username on the master controll...

Page 50: ...e 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 RMS CodeC...

Page 51: ...47 RMS CodeCrafter 1 With RMS CodeCrafter open to Introductory page click Edit Preferences to open the Preferences window 2 Click the checkbox next to Generate Device Variable Warnings to remove the...

Page 52: ...X Software is owned by AMX and is protected by United States copyright laws patent laws international treaty provisions and or state of Texas trade secret laws Portions of this AMX Software may from t...

Page 53: ...vice has not been defined Below is one such warning dvTP3a IF_NOT_DEFINED dvTP3a WARN RMS This Device Needs to be Defined in your Main Program dvTP3a END_IF An option is provided to enable disable the...

Page 54: ...ons page i ConnectLinx parameter storage VOLATILE SLONG asnNumberLevelArgValues 3 VOLATILE CHAR acStringEnumArgValues 3 50 Channel Arrays CodeCrafter creates two channel arrays for i ConnectLinx if i...

Page 55: ...function A comment containing the devices logical name A call to RMSRegisterDevice A call to RMSRegisterDeviceNumberParam RMSDevMonSetParamCallBack This function has the following signature Call Name...

Page 56: ...vice name vdvRMSEngine Each module definition is preceded by a comment containing the device name of the monitored device Source Usage This module definition is generated if the user selects Monitor S...

Page 57: ...CodeCrafter will generate a call to RMSSetMultiSource TRUE A call to RMSSetDeviceInfo is generated for each monitored device using an RMS Support Module If the device has a non negative timeout value...

Page 58: ...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...

Page 59: ...ook for arguments IF LEFT_STRING DATA TEXT 3 ARG Get arg ID cTemp DATA Text cTrash REMOVE_STRING cTemp ARG 1 nId ATOI cTemp cTrash REMOVE_STRING cTemp 1 Store it if we have room IF MAX_LENGTH_ARRAY ac...

Page 60: ...EVICE ADD STD 1131 1137 DVD DVD Play 1221 DVD Stop 1222 DVD Pause 1223 DVD Skip Forward 1224 DVD Skip Back 1225 DVD Search Fwd 1226 DVD Search Rev 1227 SEND_COMMAND DATA DEVICE ADD STD 1221 1227 CD Pl...

Page 61: ...e and the i ConnectLinx virtual device Anterus RFID Readers Device Array If support is enabled in the CodeCrafter project for Anterus then the code generator will need generate a DEVICE ARRAY that inc...

Page 62: ...etLinxDeviceOnline dvAnterusReader1 RFID Reader Front OFFLINE RMSNetLinxDeviceOffline dvAnterusReader1 DATA RFID Reader Back DATA_EVENT dvAnterusReader2 ONLINE RMSNetLinxDeviceOnline dvAnterusReader2...

Page 63: ...odule We need to identify additional Anterus RFID reader devices to the Anterus RFID Duet module We do this by sending the PROPERTY Identifiers command to the Anterus Duet module virtual device with a...

Page 64: ...evice as defined in the NetLinx program Devices are tracked by Device ID so this value must be unique within the devices of a given room For instance you can have multiple 1 1 0 devices as long as the...

Page 65: ...meter changes from a value that is not greater than 1000 to a value that is greater than 1000 the fault status is set When the value changes from a value greater than 1000 to a value not greater than...

Page 66: ...he RMS support modules register and monitor the following parameters Basic Device RMSBasicDeviceMod Device Online Offline Power Communication Status for Serial devices Control Failure Optional IP Addr...

Page 67: ...RMS Concepts 66 RMS CodeCrafter...

Page 68: ...simply include this module in your program define your actions and write programming to support those actions The i ConnectLinxEngineMod module makes the list of actions available to other processes...

Page 69: ...tell i ConnectLinx what that action is To specify the name of an action send a command to the i ConnectLinx virtual device describing the name of a given channel code To specify the names of the acti...

Page 70: ...i ConnectLinx 69 RMS CodeCrafter...

Page 71: ...egistered trademarks of AMX AMX reserves the right to alter specifications without notice at any time It s Your World Take Control 3000 RESEARCH DRIVE RICHARDSON TX 75082 USA 800 222 0193 469 624 8000...

Reviews:

No comments

Brands by name

Popular brands

Load more brands