AMX NETLINX STUDIO V2.4 Instruction Manual Download Page 21

Page: 21 / 200

The NetLinx Studio v2.4 Work Area

NetLinx Studio (v2.4 or higher)

The fourth level contains all of the actual files that make up the System (.AXS, .AXI,

.TPD, .TKO, .TP4 .IRL/.IRV, and *.*).

The fifth and final level indicates the file mapping information for each file, as applicable.

Click on the "+" folder flags to expand the folders to expose any subfolders; click the "-" folder

flags to collapse the folders.

The hierarchical file structure of the Workspace tab is described below:

Workspace Folder

You can have one Workspace open at a time. A Workspace contains at least one Project,

and each Project contains at least one System.

Right-mouse click anywhere within the workspace tab to open the Workspace context

menu.

Project Folders

Right-mouse click on any Project folder to open the Project Folder context menu.

Expand any Project folder to display the System folder(s) contained in that Project.

System Folders

Each System has it's own platform (Axcess or NetLinx) setting along with the

communication information (i.e. IP address or COM port setting with the appropriate

baud rate, etc.).

Right-mouse click on any System folder to open the System Folder context menu.

The 'Module' folder only appears if NetLinx is designated as the system platform (via
the Communication Settings dialog).

FIG. 5

Workspace Window - Workspace Tab

Summary of Contents for NETLINX STUDIO V2.4

Page 1: ...instruction manual Software NetLinx Studio v2 4 or higher ...

Page 2: ...HER WARRANTIES EITHER EXPRESS OR IMPLIED INCLUD ING BUT NOT LIMITED TO IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE WITH REGARD TO THE AMX SOFTWARE THIS LIMITED WARRANTY GIVES YOU SPECIFIC LEGAL RIGHTS Any supplements or updates to the AMX SOFTWARE including without limitation any if any service packs or hot fixes provided to you after the expi ration of the ninety 90...

Page 3: ...oolbars 5 Menu Bar 6 Status Bar 6 Workspace Window 8 Workspace Window Workspace Tab 8 Workspace Folder 9 Project Folders 9 System Folders 9 System File Folders 10 System Files 10 File Mapping Information 10 Other key functions and features of the Workspace tab include 10 Workspace File Context Menu 11 Workspace Window Online Tree Tab 12 Output Display Window 12 Output Display Window Context Menu 1...

Page 4: ...o A Workspace 27 Saving The Workspace 28 Exporting Workspace Files For Distribution 28 Importing Exported To Go Workspace Files 29 Viewing and Editing Workspace Properties 30 Workspace File Context Menu 30 Working With Projects 33 Overview 33 Opening Projects in NetLinx Studio v2 0 or higher 33 Creating A New Project 33 Building the Selected Project 34 Viewing And Editing Project Properties 34 Con...

Page 5: ...ing Dialog 48 DEVICE PORT SYSTEM D P S 49 To Remove Device Mapping Information from a File 50 System File Device Map Context Menu 50 Working With System Source Code Files 50 Adding A New Source Code File To A System 51 Adding An Existing Source Code File To A System 51 Removing A File From A System 52 Creating A Source Code File 52 Saving The Active File 53 Saving All Open Files 53 File Revisions ...

Page 6: ...de 65 User Interface File Folder Context Menu 66 User Interface File Context Menu 66 Working With IR Files 66 Adding An Existing Ir File To A System 66 IREDIT 67 Working With IREdit Database IRN Files 67 Adding An IR File From the AMX IR Database 67 Adding An IR File From an IREDIT User Database IRN File 68 IR File Folder Context Menu 69 IR File Context Menu 69 Working With Other Files 70 Creating...

Page 7: ...mand Tab 84 Code Wizard Dialog IR Constant Tab 84 Syntax Highlighting 85 Default Syntax Highlighting Colors 85 AutoComplete and AutoSuggest 86 Call Tips 87 Code Folding 88 Unicode Characters 89 UTF 8 Encoding 89 Insert Section 89 Goto Section 90 Goto Line 90 Goto Function Or Subroutine 90 Block Comment Uncomment 90 Case Inversion 91 Clipboard Text Buffer 91 Using The Clipboard Text Buffer 91 Find ...

Page 8: ...piling 99 Including the Unicode Library 99 Defining a Unicode String Literal 100 Storing a Unicode String 100 Working With Widechar Arrays and Unicode Strings 100 Unicode Character Case Mappings 101 Unicode Concatenating String 101 Unicode Converting Between WIDECHAR and CHAR 101 Unicode Using FORMAT 101 Unicode Reading and Writing To Files 102 Unicode Send Strings To A User Interface 102 Right to...

Page 9: ... Diagnostics Messages 123 Debugging NetLinx Programs with Terminal or Telnet messages 123 Buffering of the Notification and Diagnostic Tabs 127 NetLinx Diagnostics NetLinx Device Emulation 127 NetLinx Diagnostics NetLinx Device Control 129 Viewing Push Results 130 NetLinx Diagnostics Netlinx Device Addressing 131 Changing The Device System Address On A Netlinx Device 131 Restoring The Default Devi...

Page 10: ...Via TCP IP 145 Connecting To a NetLinx Master Via Serial Port 146 Connecting To A NetLinx Master Via Modem 146 Connecting To A Secured Netlinx Master 147 If you don t connect 148 Connecting To an Axcess Master 148 Connecting To An Axcess Master Via Serial Port 148 Connecting To An Axcess Master Via Modem 148 File Transfer Operations 149 File Transfers Edit Sub Menu 150 File Transfer Status Informa...

Page 11: ...4 Panels 161 Configuring NetLinx Studio for Virtual NetLinx Master Transfers 162 Transferring Files Using A Virtual Netlinx Master Usb Connection 162 Virtual NetLinx Master TCP IP Transfers 163 Configuring The Touch Panel For Virtual Netlinx Master Tcp ip Transfers 163 Configuring Netlinx Studio For Virtual Netlinx Master Tcp ip Transfers 164 Transferring Files Using A Virtual Netlinx Master Tcp i...

Page 12: ...s Dialog Keyboard Tab 179 Creating Custom Shortcut Keys 180 Preferences Dialog Menu Tab 180 Customizing The Menus 181 Preferences Dialog Diagnostics Tab 182 Preferences Dialog Terminal Tab 183 Preferences Dialog File Transfer Tab 183 Preferences Dialog Workspace Tab 184 Troubleshooting 185 NetLinx Debugger Not Stopping On A Breakpoint 185 Symptoms 185 Cause 185 Resolution 185 NetLinx Master Error ...

Page 13: ...rtup or select Help What s New to open The on line help program is designed to offer key information to help to learn about and use the NetLinx Studio program Use the Table Of Contents on the left side of the help window to navigate to a particular help topic or press the F1 key while any dialog is open to open the help topic associated with the active dialog The Help menu also contains shortcuts ...

Page 14: ...ouse or other pointing device Supported File Types NetLinx Studio supports the following file types for editing with the Source Code Editor The following file types are supported but are edited using external AMX applications as described below You must have Administrator rights to install and run all required System files If the mouse wheel on your Microsoft IntelliMouse doesn t work with NetLinx...

Page 15: ...hose downloads Select Help Web Update to launch this application Refer to the WebUpdate on line help for details and instructions Software History2 Application The AMX Software History2 application provides the ability to display detailed information on AMX hardware and software Click Tools Software History to launch the application Refer to the AMX Software History 2 Application on line help file...

Page 16: ...NetLinx Studio v2 4 or higher 4 NetLinx Studio v2 4 or higher ...

Page 17: ...he main user interface elements Title Bar Displays the name of the application and the name of the currently active file An asterisk after the file name indicates that it contains unsaved changes Toolbars There are eight toolbars in NetLinx Studio Hover the mouse cursor over any toolbar button for about one second to display a tooltip describing the button Choose View Toolbars to open the Toolbars...

Page 18: ...he toolbar button to toggle hide show the Status Bar The Status Bar displays general information including communication status a brief description of any option in the program cursor location last Push received COM port currently being used network IP address NetLinx systems only and current PC keyboard settings The elements of the Status Bar are described below from left to right FIG 2 Toolbars ...

Page 19: ...aster Controller Connection Information Displays the name and status of the active communications port If a TCP IP connection exists the current IP address is displayed If Virtual NetLinx Master is selected then the Virtual NetLinx Master is displayed with its System number Master Security Status Indicates the current security status for the Master locked Authentication Enabled unlocked Authentica...

Page 20: ...ere you can select to hide or display the NetLinx Studio toolbars Workspace Window Workspace Tab The Workspace tab contains a tree structure of all the available Projects and Systems contained within a Workspace file You may create multiple Projects within a Workspace Within a Project you can create multiple Systems The Workspace view can be expanded to show all of the various elements within each...

Page 21: ...st one Project and each Project contains at least one System Right mouse click anywhere within the workspace tab to open the Workspace context menu Project Folders Right mouse click on any Project folder to open the Project Folder context menu Expand any Project folder to display the System folder s contained in that Project System Folders Each System has it s own platform Axcess or NetLinx settin...

Page 22: ... Project Add File To System the file is automatically placed as a link in the appropriate System File folder based on it s file type You cannot have the same file referenced more than once within a system i e cannot add the same file name to the Source folder and the Other folder within the same System File Mapping Information Any file that has device file mapping information associated with it is...

Page 23: ...he Workspace for distribution as an AXW file AXW files preserve all relative file path information for the Projects Systems and System files contained in the Workspace making them ideal for distribution to remote sites Import From Exported Workspace File Opens the Select AXW File dialog where you can select a previously exported To Go AXW file to import into the program New Project Opens the New P...

Page 24: ...tected to be currently online by the Master Controller and the firmware version for each The Device Tree also provides port status information for each device Refer to the Working With the Online Device Tree section on page 116 for more information Output Display Window Select View Output or click the toolbar button to toggle show hide the Output Display window FIG 7 FIG 6 Workspace Window Online ...

Page 25: ... the open Work space select a file or Ctrl click to select multiple files then drag and drop the file s into the System folder of the System that you want to add the file s to This invokes the File Properties dialog where you can change the Identifier File Name and Description for each file that you are adding to the System Double click on a listed file to open it for viewing editing in the IREdit...

Page 26: ...the Compiler Error Warnings Report dialog which allows you to specify wether you want to include compiler Errors Warnings or both in the report By default Errors and Warnings are both selected Find Notifications and Diagnostics tabs only Search for text within the tab via the Find dialog You may search up or down the tab based on the current cursor loca tion within the tab The search can be case s...

Page 27: ...e Editor Window Features Source Code Editor window features include FIG 8 Source Code Editor Window NetLinx Studio features a Code Wizard that steps you through the process of generating several different types of code Do not attempt to open LIB or SYC files for editing in the Source Code Editor Doing so could cause program failure Unicode Characters Select Unicode Edit from the Edit menu or the S...

Page 28: ... Drag and drop Support Drag and drop any supported file type from Explorer into the Source Code Editor to open that file in a new Source Code Editor window Drag and drop selected text to another Editor window at the cursor location or to another location within the same Editor window Floating Window Source Code Editor windows are moveable and resizeable Use the options in the Window menu to arrang...

Page 29: ...al window puts the Master Controller into dumb terminal mode Anything that is typed on the screen exits through the Master communications port and anything coming in from the communications port is displayed in the Terminal window Use the Terminal window to communicate directly with the Master Controller and to debug RS 232 controlled devices You cannot use the Terminal window while a communicatio...

Page 30: ...ee separate sets lists of specified variables The Watch window consists of a table with four columns Right click inside the Watch Window to access the Watch Window context menu Display Click to open the Display sub menu which contains view options for the Termi nal Window The options are ASCII HEX hexadecimal and DEC decimal Clear Clears the contents of the Terminal Window Save To File Opens the S...

Page 31: ...a compiled NetLinx source code file Delete Variable Deletes the selected variable from the Watch Window Delete All Variables Deletes all variables from the Watch Window Total Length Sets the viewing mode for arrays to show the total length of the array in the Length column of the Watch Window All of the locations of the array are displayed regardless of the Current Length value of the array By def...

Page 32: ...The NetLinx Studio v2 4 Work Area 20 NetLinx Studio v2 4 or higher ...

Page 33: ...click the Browse button to the right of the text field to locate and select a target directory via the Browse For Folder dialog 6 Click Next to proceed to the Project Identifier dialog 7 Enter an identifier name for the new Project in the text field To enter additional information for the new Project click the Project Information button and fill in the Project Information up to 128 characters and ...

Page 34: ...an existing AXS File to the System This option adds an existing AXS file to the System as the Master Source Code File a Click Next to proceed to the Existing Master Source File Location dialog b Enter a path and filename of the desired Master Source Code File or click the Browse button to locate and select the desired AXS file via the Open dialog c Click Source Code File Description to enter an op...

Page 35: ...udio v2 0 or later is that you can choose to build compile the entire Workspace That is every Source Code Include and Module file contained within the open Workspace can be compiled with a single command Build Workspace There are several ways to access the Build Workspace command via the Build menu the Workspace context menu in the Workspace tab of the Workspace Window or via the toolbar button To...

Page 36: ...display individual dialogs for all the above functionality for use by advanced users When the Wizard generates a new code segment it is automatically inserted in the active Source Code file in the appropriate section of the code Refer to Using The Code Wizard section on page 78 for details ...

Page 37: ...ou can quickly generate multiple Projects and modify each one as necessary Workspace files also allow you to build compile multiple Projects Systems The Build Workspace command compiles every file contained in the Workspace It is important to note that in NetLinx Studio v2 0 and later there is no concept of Projects outside the context of a Workspace A Project can only be opened by adding it to a ...

Page 38: ... Workspace context menu and select New Workspace Before the new Workspace is created the program will prompt you to save any changes made to the currently open Workspace if applicable A new Workspace file is created As indicated in the Workspace tab this Workspace contains no Projects Systems All Projects Systems and associated files must be added manually Import an Existing Project You can import...

Page 39: ...Project From The Workspace When you delete a Project from the open Workspace no System files are actually deleted from the hard drive the Project is simply removed from the open Workspace To delete a Project from the Workspace 1 Click to select the Project that you want to remove in the Workspace tab of the Workspace Window 2 Select Delete Project from the Project menu the Project Folder context m...

Page 40: ...d when exporting your Workspace files All files will reside in the same directory as the APW file upon extraction of the AXW file No directory path information is required for the To Go APW File Name You may enter non existing folders and the program will create them for you 1 Select Export Workspace Files To Go from the Project menu the Workspace context menu or click the toolbar button to open t...

Page 41: ...le files from the resulting AXW file Excluding AXS AXI files will result in device mappings of the exported AXW file to be set to Custom Since no source files will be part of the exported AXW all device mappings will need to be resolved in the newly created APW file Naturally the previous two options are mutually exclusive If you select one the other is disabled Select the Include the Compiled TKN...

Page 42: ...space Identifier can have a maximum of 128 characters File Name The File Name cannot be changed and is only for display Description The Description text is optional and can have a maximum of 2 000 characters Creation Date This read only field indicates the creation date of the open Workspace Conversion Date If a NetLinx Studio v2 0 or higher workspace file was converted from a NetLinx Studio v1 2 ...

Page 43: ...ponents From a Workspace dialog Use the dialog to select a specific Project con tained in the Workspace Paste Project You can copy and paste Projects by selecting Copy Project from the Project Folder context menu and selecting the Paste Project com mand Collapse Tree Collapses the Project System File tree to show only the Workspace and its Project s Expand To System Level Expands the Project Syste...

Page 44: ...Working With Workspace Files 32 NetLinx Studio v2 4 or higher ...

Page 45: ... in the Workspace you should make a copy of the original file under a different name make your changes then remove the original file from the System and link the new file to the System Opening Projects in NetLinx Studio v2 0 or higher In NetLinx Studio version 2 0 or later Projects are always contained within a Workspace and there is no concept of a Project outside of a Workspace So rather than op...

Page 46: ...o compile in the Workspace tab of the Workspace Window 2 Select Build Build Project Name Project Any errors detected by the program before the build operation starts are listed in the Pre Build Errors dialog This dialog gives you the option of ignoring the errors and continuing with the build 3 The status and results of the build are displayed in the Status tab of the Output Display Window Viewing...

Page 47: ... communication settings for each System individually Click Yes to change the System Level Communications Settings for each System contained in the converted Project via the Master Communications Settings dialog or click No to leave the communication settings alone for this Project System The converted file now exists as a APW file in the same folder that contained the original PJS file under the s...

Page 48: ...m communication settings for the new system Once created the new system is added to the Project Import a System Opens the Open Workspace dialog where you can locate and select the Workspace APW file that contains the System you want to import into the Project Once you select an APW file the Import Com ponents From a Workspace dialog is invoked Use this dialog to select specific Systems contained i...

Page 49: ... So if you intend to make changes to a System file and you want those changes to be specific to only one System in the Workspace you should Source Code Files These include the Master Source Code File and all other source code AXS files associated with the System Include files These are Axcess or NetLinx code files AXI that are referenced in any source code file by the Include statement Module File...

Page 50: ...radio buttons to select either Axcess or NetLinx as the system platform Select a Transport Connection Option TCP IP Serial or Modem TCP IP To specify network TCP IP settings NetLinx systems only select the TCP IP radio button and click Settings to open the TCP IP Settings dialog where you can enter the System s IP Address assignment Serial Select the Serial radio button and click Settings to open ...

Page 51: ...l associated System Files within a Workspace This allows you to develop a set of core Systems which you can then copy paste and modify as necessary In cases where there are only minor variations from one System to the next this can be a real timer saver To copy and paste a System within a Workspace 1 Open a Workspace in the Workspace tab of the Workspace Window and click to select highlight a Syst...

Page 52: ...ou select a System to be active the program will prompt you to see if you want to stop the current connection and continue with the selected Active System communication settings To designate the active System select highlight a System in the Workspace tab of the Workspace Window then select Set as Active System from either the Project menu or the System Folder context menu or click the toolbar but...

Page 53: ...gs area at the bottom of the dialog click Communication Settings to open the Communication Settings dialog 3 Follow steps 4 through 8 above to specify communication settings for the selected System Adding A File To A System When a file is added to a System the file is always added to the selected highlighted System in the Workspace tab of the Workspace Window and it is always automatically added t...

Page 54: ...dialog is invoked Use the options in this dialog to rename the selected file browse for a different file and or enter a description for the file if desired Click OK to add the file to the System Note that the file is placed in the appropriate System File folder based on the file type Removing A File From A System Since all files are linked in NetLinx Studio v2 0 or later when you remove a file fro...

Page 55: ...rrors dialog This dialog gives you the option of ignoring the errors and continuing with the build 3 The status and results of the build are displayed in the Status tab of the Output Display Window Building The Active System You can select to build compile only the System currently designated as the Active System using the Build Active System command When you compile a System every Source Code Inc...

Page 56: ...mmunication Settings Delete System Deletes the selected System from the selected Project This option does not delete the System or its associated files from the disk Build System Builds compiles the active System including all contained System files The progress and results of the build can be viewed in the Status tab of the Output Display window Copy Selected System Copies the selected System to ...

Page 57: ...ed TKO code to control a specific device on the bus NetLinx Studio v2 3 or higher supports Duet JAR Module files Module files cannot be designated as master files When the System is being compiled these Module files are compiled first then copied to the directory where the designated Master Source code file resides Module files are placed in the Module file folder User Interface UI files These are...

Page 58: ...le as needed in the Source Code Editor window and select File Save or click the toolbar button 5 Specify a name and target location for the new file in the Save As dialog File Types And Extensions Use the Project Add File To System command to add the file to a System The Workspace Wizard option launches the Workspace Wizard which steps you through the process of creating a new Workspace with a Pro...

Page 59: ...e file s associated TOK file still reflects the disk file name Viewing And Editing System File Properties Use the File Properties option in the System File context menus to open the File Properties dialog which allows you to view general properties for the selected file The fields in the File Properties dialog include Identifier The File Identifier can have a maximum of 128 characters and must be ...

Page 60: ...e is also a Custom listing which allows you to specify a D P S assignment other than what is specified within the Master Source Code file With a file selected in the File View window select a target device for the file in the Device View window and click the Map button to map that file to the selected device If you select Custom the Enter DPS dialog will prompt you to enter the D P S assignment of...

Page 61: ... mapping information is saved with the Workspace file and this association is maintained until the mapping information is removed via the Remove option in the Device Mapping dialog or the Delete command in the System File Device Map context menu DEVICE PORT SYSTEM D P S A device is any hardware component that can be connected to the NetLinx bus Each device must be assigned a unique number to locat...

Page 62: ...o a System Source Code files are created and or edited in the Source Code Editor windows Source Code files are stored in the Source folder in the Workspace tab of the Workspace Window NetLinx Studio distinguishes between two types of Source Code files the Master Source Code file and System Source Code files Master Source Code file The Source Code that is sent to an Axcess or NetLinx Master Control...

Page 63: ...am notifies you that the file was created Click Finish to close the File Template dialog The new file should appear in the Source folder under the selected System Adding An Existing Source Code File To A System To add an existing Source Code file to a specific System in the Workspace 1 Click to select highlight a System in the Workspace tab of the Workspace Window 2 Right click on the Source folde...

Page 64: ... button 3 The program prompts you to verify this action 4 Click Yes to remove the file from the System Creating A Source Code File To create a Source Code file 1 Select New from the File menu or click the toolbar button to open the New dialog 2 Select Source File and click OK 3 In the File Template dialog select whether to use an existing template to create the file If you click Yes you will be pr...

Page 65: ...ptions in the Save File Revision dialog File Save File Revision to view edit the PROGRAM_NAME revision number or identifier file name and add any comments associated with this revision that you would like to include To save a file revision of the active Source Code file 1 Select File Save File Revision to open the Save File Revision dialog 2 Enter edit the information in this dialog as desired 3 C...

Page 66: ...Source at the time that it is added to the System via the Master File option in the File Properties dialog Alternatively you can designate any Source Code file in the System as the Master Source by right clicking on a Source Code file in the Workspace tab of the Workspace Window and selecting Set As Master from the Source Code File context menu Compiling Source Code Files There are several ways to...

Page 67: ...nd select the SRC file you want to extract and click Open 3 In the Extract NetLinx Source From a SRC File dialog the selected file with full directory path is indicated in the SRC File To Extract From field 4 In the Extract To field specify the target directory for the extracted NetLinx Source files and click Extract to extract the files When extracted the program will always replicate the directo...

Page 68: ... password assigned to the file via the Build With Password option and the NetLinx password entered in the NetLinx Compiler tab of the Preferences dialog Password field If you receive this error message click OK in the error message dialog to access the Enter Password dialog and re enter the password exactly as it was entered when the file was compiled While this feature exists primarily to allow y...

Page 69: ...dio If there are ever any interim updates to the NetLinx AXI file you will be notified via the AMX newsletter and the update will be posted to the Software Center on the AMX com website Creating An Include File To create an Include file 1 Select New from the File menu or click the toolbar button to open the New dialog 2 Select Include File and click OK 3 An empty Include file is created in a new S...

Page 70: ...ng Include File 3 In the Add Existing Include File dialog locate and select the Include AXI file that you want to add to the selected System 4 Click Open to access the File Properties dialog where you can view edit general file information for the selected file 5 Edit the file information if necessary 6 Click OK to add the file to the selected System 7 The file should now appear in the Include fol...

Page 71: ...space Window and the same basic rules apply to JAR module files that were true for NetLinx modules Module files cannot be designated as Master Source Code files When the System is being compiled first the Module files are compiled and then the Master Source Code AXS file is compiled NetLinx Studio v2 3 or higher constructs a composite TKN file when Duet module s are included in the Workspace and a...

Page 72: ...plate NetLinx or Axcess You can select to create a module file using the module standard template NetLinx Module axs The module standard template file is located in the same directory as the NetLinx Studio application EXE file If you click No you will proceed directly to the New File Location dialog 4 In the New File Location dialog enter a File Name and specify a target directory for the module f...

Page 73: ...nx module for a DMS keypad would look like DEFINE_MODULE DMS IMSMod mdlDMS dvDMS dvDMS_R strFILE_NAME StrVartextArray Where Use the Recent tab to quickly access recently used files If you select multiple files to add to the System the program will prompt you to edit the file properties for each file before adding them Module_Name DMS IMSMod tko Virtual_Dev A virtual device you define Real_Dev The ...

Page 74: ...t menu described below Add New Module File Adds a new Module AXS file to the selected not necessarily the active System via the new file wizard The options in the new file wizard dialogs allow you to assign a File Template File Name and Location to the new Module file Add Existing Module File Opens the Add Existing Module File dialog where you can add an existing Module file to the System containi...

Page 75: ...NetLinx Studio allows you to associate UI files with each System and to map and transfer the files to their target panels or master If the TPDesign3 TPDesign4 and or KPDesign applications are installed on your PC you can double click on any UI file in the Workspace tab to launch the associated editor program TPDesign3 TPDesign4 or KPDesign You can add external programs to the Tools menu via the Ad...

Page 76: ... In the REALS section of the program re write the dvDMS_R to equal the value of the new Device number set in the Device Addressing Tab of the Tools NetLinx Diagnostics dialog box An example is if the Changed Device number value is set to 6001 the dvDMS_R value would now read 6001 1 0 Each consecutive keypad device would become dvDMS_R 6002 6003 6004 3 In the STARTING CODE GOES HERE CREATE FILE sec...

Page 77: ...CODE GOES BELOW DEFINE_START StrFileName avcnt11 kpd VARIABLE DEFINITIONS GO BELOW DEFINE_VARIABLE CHAR strVarTextArray 100 40 Where DVVirt an arbitrary Virtual Device number you define range for keypad panels 32768 36863 DvDMS the real device number of the DMS or IMS panel StrFileName a string variable CHAR array containing the file name of the KPD file to transfer or run StrVarTextArray a two di...

Page 78: ...isting IR File dialog locate and select the IR IRL or IRV file that you want to add to the selected System Add Existing User Interface File Opens the Add Existing User Interface File dialog where you can add an existing User Interface file to the System contain ing the selected User Interface folder Docking View Changes the Workspace Window to a dockable window that can be resized and moved to any...

Page 79: ...ol Model To launch the IREdit program double click on an IR file in the Workspace tab of the Workspace Window or double click on an IR file in the Find IR Files tab of the Output Display Window results of a search For detailed instructions on using IREdit refer to the IREdit online help file The options in the Select IR From a Database dialog allow you to locate and select IR file s from within ei...

Page 80: ... and select the IRN file that contains the IR file s that you want to add to the selected System 3 Click Open to open the selected IRN file in the Select IR From a Database dialog 4 In the Select IR From a Database dialog select the Manufacturer Product Category Model Hand Control Model and then select the IR file to add to the System 5 With the desired IR file selected click Add to add the file t...

Page 81: ... the bus Export to IRL File This option is only available if the IR file you selected was extracted from an IR Database IRN file IR Database files come from the IREdit application and represent either the AMX IR Database included with the IREdit application or a user defined IR Database file Once you have added an IR file from an IR Database file via the Add From AMX IR Database or Add From User I...

Page 82: ...elect highlight a System in the Workspace tab of the Workspace Window 2 Right click on the Other folder to access the Other File Folder context menu and select Add Existing Other File 3 In the Add Existing Other File dialog locate and select the file that you want to add to the selected System The Add Other dialog is set to look for TXT files by default change the Files of Type option to All Files...

Page 83: ...oss multiple files Searching Within the Active Source Code File Use the Find and Find Next options in the Edit menu to search within the active Source Code file 1 Choose Edit Find or click the Find toolbar button to open the Find dialog 2 Enter a search string in the Find What text box If you select multiple files to add to the System the program will prompt you to edit the file properties for eac...

Page 84: ... search for yell only finds the word yell as opposed to any instance of the search string i e yellow Match case Searches only for instances that match the case UPPERCASE or low ercase of the characters in the search string Loop Start the search at the cursor s position and automatically loop the cursor to either the top or bottom of the file depending on the Direction setting to finish searching t...

Page 85: ...s 6 Click Find to perform the search The first instance of the search string is highlighted in the Find In Files tab of the Output Display window 7 The results of the Find In Files operation are displayed in the Find In Files tab of the Output Display window along with the total number of instances of the search string that were found in the specified directory 8 Double click on any file listed in...

Page 86: ... Preview window Otherwise the active file will appear for preview Hand Control Model Enter the model number for the hand held IR remote associated with the file you are searching for Device Model Enter the manufacturer s model number for the IR device associated with the file you are searching for Where To Search Use the radio buttons to select one of three ways to specify where to search for IR f...

Page 87: ... Out Zooms out from the page view Close Closes the Print Preview window If you don t have a printer installed on your PC the Print and Print Preview options invoke a message alerting you to install a printer Name Click the down arrow to display a list of available printers Select the target printer from this list Properties Click to open the Printer Setup dialog to set options specific to the sele...

Page 88: ...Working With Systems and System Files 76 NetLinx Studio v2 4 or higher ...

Page 89: ...Source Code Editor Window Refer to the Source Code Editor Window Features section on page 15 for a list of supported features Build Active System Compiles all Source Code files and any associated Include and Module files in the active System Compile active Source Code File Compiles the active file using the compile type associated with the file the compile type can be changed via the File Properti...

Page 90: ...he beginning of that section in the active file If a section that does not exist within the active code file is chosen nothing happens Goto Line Opens the Goto Line dialog where you can specify the line of code to which you want to move the cursor in the active file If a line number is entered that is beyond the max number of lines in the file the cursor is moved to the last line in the file Bookm...

Page 91: ... SEND_COMMAND to create select either to Make a New Page PAGE or to Make a New Popup Page PPN and specify the name of the new page or popup page This dialog also contains the option to change the text on a specified button on a touch panel in which case you must specify the Variable Text Channel and the replacement Text for that button Click Next to proceed 3 Specify the Device for which you want ...

Page 92: ...To in the DEFINE_VARIABLE section A single BUTTON_EVENT statement referencing Array Name will be generated Note that when Use DEVCHAN is selected GET_LAST is selected and grayed out This option is not available if generating code for Axcess Use INTEGER Button ranges will be placed in an INTEGER array named Array Name using the button range defined as From through To in the DEFINE_VARIABLE section ...

Page 93: ...ray Name using the Device and channel range defined as From through To in the DEFINE_VARIABLE section A single CHANNEL_EVENT statement referencing Array Name will be gen erated Note that when Use DEVCHAN is selected GET_LAST is selected and grayed out This option is not available if generating code for Axcess Use INTEGER Channel ranges will be placed in an INTEGER array named Array Name using the ...

Page 94: ...ed If CREATE_LEVEL and or SEND_LEVEL statements will be generated each construct will refer ence this array for the level number for NetLinx only Note that when Use DEVCHAN is selected GET_LAST is selected and grayed out This option is not available if generating code for Axcess Use INTEGER Level ranges will be placed in an INTEGER array named Array Name using the button range defined as From thro...

Page 95: ...le comments i e Insert Once you have made the relevant selections on this tab click this com mand button to insert the specified code into the file Online Generate ONLINE statements In Axcess a construct for detecting device online status is generated Offline Generate OFFLINE statements In Axcess a construct for detecting device offline status is generated OnError Generate ONERROR Statements not s...

Page 96: ...ustom Generate a custom send command Device The device name used during code generation This name will appear in the SEND_COMMAND statement Sub Command The command parameter used in the SEND_COMMAND Depending on options this may be the Page Name Text to Send BMF sub command popup page name or custom command Comment This value is used on the line before the SEND_COMMAND statement Com ments in NetLi...

Page 97: ...OR NOT BAND BNOT BXOR OR are syntax highlighted using the color specified in Preferences Editor Operator Floating Point Numbers A number is considered a floating point number if it contains a decimal point Floating point numbers are syntax highlighted using the color speci fied in Preferences Editor Floating Point Number Number A number is any series of digits that does not include a decimal point...

Page 98: ...f the word that has been typed to the right of the cursor when a suggestion is selected Use the scroll bar to scroll through the list if necessary and click to select the desired term or phrase that you want to insert at the cursor s position Double click or press the Tab key or Enter on your keyboard to insert the selection In the example below FIG 12 the user has typed the character D and is sel...

Page 99: ... are within the scope of the CALL FUNCTION or EVENT that they were declared in Call Tips Call tips are similar to the AutoComplete and AutoSuggest functions except that Call Tips assist you with adding declared functions by displaying a list of parameters that are valid for the particular function you are adding Call Tips are shown for declared functions when A function name is followed by an open...

Page 100: ...s header row Fold levels that are expanded are indicated by a red minus sign to the left of the line containing that section s header row In FIG 15 all fold levels are collapsed except DEFINE_CONSTANT in this example there are no data type definitions In order to use fold levels you must first enable the option in the Editor tab of the Preferences dialog by default this option is disabled Once the...

Page 101: ...better with other editors You can also select the Enable UTF 8 Encoding option in the Editor tab of the Preferences dialog Insert Section The Insert Section option allows you to insert a particular section heading in your code at the cursor s position This option is available via the Edit menu the Source Code Editor context menu or the Edit toolbar 1 Select Edit Insert Section to access the Insert...

Page 102: ...r section in your code in the active Source Code Editor window 1 Click the Goto Function or Subroutine toolbar button to access a list of functions contained within the active Source Code file 2 Select the function or subroutine that you want to jump to from the list 3 The cursor jumps to the top of the selected section in the Source Code Editor window Block Comment Uncomment Select Edit Block Com...

Page 103: ...board Buffers or click the toolbar button This displays a list of all items currently stored in clipboard memory Any text that has been cut or copied to clipboard memory is shown in the list starting with the most recent entry 4 Click on the item in the list that you want to insert into the active code file The selected clipboard item is inserted into the active file at the cursor s position Using...

Page 104: ...w End Of Line Select Edit Show End Of Line or click the toolbar button to toggle the display of the end of each line of code indicated by CRLF as black text on a red background as opposed to the default view which indicates the end of each line with a red bar By default this option is disabled Rescan Current Source File Select Edit Rescan Current Source File or click the toolbar button to rescan t...

Page 105: ...gn hotkeys use the Keyboard tab of the Preferences dialog select Advanced Editor from the Category drop down list Special Character Description Matches on any character This marks the start of a region for tagging a match This marks the end of a tagged region n Where n is 1 through 9 refers to the first through ninth tagged region when replacing For example if the search string was Fred 1 9 XXX an...

Page 106: ... window Debugging Debugging Source Code Files NetLinx Studio contains several useful options for debugging your Master Controller and Source Code files In order to begin debugging your computer must be connected to a Master Controller and you must have a compiled Source Code file active To use debugging the Build With Source option must be selected in the Axcess Compiler and or NetLinx Compiler ta...

Page 107: ...o exit Debug mode close the Watch window Using Single step Mode In Single step mode program execution is suspended between each pass through mainline allowing you to test programs one line at a time Single step mode works differently in NetLinx than it does in Axcess In NetLinx systems it executes a single instruction in the source file In Axcess systems it executes a single line of code in the Ma...

Page 108: ...re getting weird behavior recompile with Compile with Debug Info enabled in the NetLinx Compiler tab of the Preference dialog You will always need debug symbols for breakpoint debugging Start Stop Debugging Ability to toggle the debug state of the application There is no limitation on then number of NetLinx variables that can be watched in the Debug Watch windows A maximum of 10 watch variables ar...

Page 109: ... PUSH dvLocalTP3 2 fTestLevel fTestLevel 1 SEND_LEVEL dvLocalTP3 1 fTestLevel Note that semicolons are used in the example to terminate each line in a breakpoint The only time that the semicolon is absolutely necessary is when a breakpoint is set at the last line of code To keep things simple consider terminating each breakpoint with a semicolon Setting A Breakpoint 1 Place the cursor on a line of...

Page 110: ...gnostics Enable Push Message Status Bar Display or click the toolbar button to display Push message status Enabled Disabled Insert Push Message Dialog Select Insert Push Message from the Edit menu to open the Insert Push Message dialog This dialog displays a list of recent Push messages that were sent to the Master Click to select a Push from the list and click OK to insert the code for that Push ...

Page 111: ...udio to store your file as UTF 8 which will support Unicode characters Enabling UTF 8 1 Choose Settings Preferences to open the Preferences dialog 2 Select the Editor tab 3 Under Display check the Enable UTF 8 format checkbox 4 Close the Preferences dialog Enabling Unicode Compiling 1 Choose Settings Preferences to open the Preferences dialog 2 Select the NetLinx Compiler tab 3 Under Options check...

Page 112: ...or WIDECHAR array for use in Unicode programming These functions allow you to operate on strings similar to the way you would with CHAR array For instance to remove the first 3 characters from a WIDECHAR array and return those characters as a WIDECHAR array use WC_GET_BUFFER_STRING wcRemoved WC_GET_BUFFER_STRING wcMyString 3 You will find that most other function work exactly as their CHAR counter...

Page 113: ...expressions expect data loss Unicode Converting Between WIDECHAR and CHAR On occasion you may need to convert a CHAR array to a WIDECHAR array or a WIDECHAR array to a CHAR array The CH_TO_WC and WC_TO_CH functions can be used to accomplish these conversions For example wcMyString CH_TO_WC Any ASCII string wcMyString CH_TO_WC cMyString cMyString WC_TO_CH _WC Any Unicode string cMyString WC_TO_CH w...

Page 114: ...tion will set the variable to the file format that was detected When writing files the file format parameter will determine how data is written to the file The following constants can be used for specifying or checking the file format WC_FORMAT_UNICODE WC_FORMAT_UNICODE_BE WC_FORMAT_UTF8 The Unicode file format specified by the constant WC_FORMAT_UNICODE is the fastest to encode and decode You sho...

Page 115: ...the string regardless of the language s orientation Unicode Compiler Errors The most common type of compiler errors you will encounter while programming for Unicode are caused by not wrapping Unicode string literals in _WC passing a WIDECHAR to a function that take a CHAR array or passing a CHAR array to a function that takes a WIDECHAR array If you forget to wrap a Unicode string in _WC expect to...

Page 116: ...ces You cannot use the Terminal window while a communication port is in use for a file transfer or debug operation Type ECHO ON in the Terminal window to display messages If the Terminal window becomes unresponsive close and re open the window To leave the Terminal Emulator window active for a long session click the Terminal Locks the Port option in the General tab of the Preferences dialog Use th...

Page 117: ...0B 11 2C 44 L 4C 76 l 6C 108 ff 0C 12 2D 45 M 4D 77 m 6D 109 cr 0D 13 2E 46 N 4E 78 n 6E 110 so 0E 14 2F 47 O 4F 79 o 6F 111 si 0F 15 0 30 48 P 50 80 p 70 112 dle 10 16 1 31 49 Q 51 81 q 71 113 dc1 11 17 2 32 50 R 52 82 r 72 114 dc2 12 18 3 33 51 S 53 83 s 73 115 dc3 13 19 4 34 52 T 54 84 t 74 116 dc4 14 20 5 35 53 U 55 85 u 75 117 nak 15 21 6 36 54 V 56 86 v 76 118 syn 16 22 7 37 55 W 57 87 w 77 ...

Page 118: ...Programming 106 NetLinx Studio v2 4 or higher ...

Page 119: ... or via the toolbar button To compile the open Workspace 1 Select Build Build Workspace Any errors detected by the program before the build operation starts are listed in the Pre Build Errors dialog This dialog gives you the option of ignoring the errors and continuing with the build 2 The status and results of the build are displayed in the Status tab of the Output Display Window Building the Sel...

Page 120: ... Display Window Building the Active System You can select to build compile only the System currently designated as the Active System using the Build Active System command When you compile a System every Source Code Include and Module file contained in the selected System is compiled To compile the Active System 1 Select Build Active System from the Build menu or click the toolbar button Any errors...

Page 121: ...nd There are several ways to access the Compile commands via the Build menu the System File context menus in the Workspace tab of the Workspace Window the Source Code Editor context window or via the toolbar buttons If you create a new non Project related file without a Workspace file open the Compile command compiles the file using the compiler NetLinx or Axcess associated with the file when it w...

Page 122: ...phical error or incorrect syntax of a particular command Unlike warnings errors must be corrected before your program can be executed Compilation errors are described below A symbol was expected The compiler is expecting a certain symbol at this particular place Active keyword expected An ACTIVE keyword is not present after a SELECT keyword Allowed only in DEFINE_START A keyword that is only allow...

Page 123: ...uestion must be an integer This error occurs when the third parameter of CREATE_LEVEL is an array or array element NetLinx Compiler failed RT 2147417851 ST 1 This error means that the compiler cannot find the line num ber to even check what type of error has occurred so it gives no details on the cause If you get this non descriptive error when compiling and the code contains modules check to make...

Page 124: ...thin DEFINE_START To not allowed within MAINLINE To not allowed within RELEASE To not allowed within WAIT These errors occur if the TO keyword is found in an erroneous location The TO keyword can only be associated directly with a PUSH statement Too few parameters in CALL There are not enough parameters being passed to the sub routine Too many Include files A program may only contain up to 20 Incl...

Page 125: ...n be turned on or off in the Compiler Options tab of the Preference dialog w Define_Call is not used This warning occurs at the end of program compilation for each DEFINE_CALL subroutine that was declared but never used The genera tion of this warning can be turned on or off in the Compiler Options tab of the Preference dialog w Integer applies to arrays only This warning appears when the keyword ...

Page 126: ...e but the System does not act in the way it should If the program code is correct you should check for run time errors These errors occur in the Master Controller usually when it could not perform a particular operation in the program Run Time errors are errors that occur during program execution and are described below Bad assign 2dim These errors occur if an attempt is made to assign a two dimen...

Page 127: ...ols Master Comm Settings Menu item Select NetLinx for the platform and then select either a COM port if the networking is not already configured or an IP address if it is currently on the network Select OK when complete Select the Tools NetLinx Diagnostics Menu item Select the Networking tab from the tabs along the top Enter 0 for both System and Device Then press Get IP Info Then press Get DNS In...

Page 128: ... use the new network settings You are now finished with your NetLinx Network Setup Working With the Online Device Tree The Online Tree tab of the Workspace Window FIG 20 displays an Online Device Tree for either the NetLinx or Axcess Master Controller The Online Device Tree displays a list of devices detected to be currently online by the Master Controller and the firmware version for each The Dev...

Page 129: ... IP address and MAC address FIG 21 Master Controller The next element down from the System is the Master Controller element This element indicates the Master Controller s device number device name and indicates the Master firmware version currently loaded FIG 22 Click the plus sign to expand the view to show sub devices and ports on the Master Sub devices are indicated with red icons and give a de...

Page 130: ...t and select Check Port Status from the context menu The results of this status check are indicated in the Status tab of the Output Window FIG 24 Device States There are several possible states for devices listed in the online device tree FIG 23 Online Device Tree Device element Unbound Device An Unbound or Orphan device is one that has not been bound to a NetLinx Master It may or may not have bee...

Page 131: ... with the NetLinx Master Refresh System Click to refresh the Online Device Tree for the local system the system containing the Master Controller that your PC is connected to For NetLinx systems it is the Master Controller identified in the Network field of the Communication Settings dialog The Connection Status to the Master Controller dialog may appear if communication to the master has not alrea...

Page 132: ...t menu A Bound device is one which has established communication with a specific Master To Bind an Unbound Device 1 Right click on a device contained in the Unbound Devices folder of the Device Tree to access the Device Tree context menu 2 Select Bind Device to open the Bind Unbind Device dialog FIG 25 FIG 24 Example result of Check Port Status displayed in the Status tab of the Output window FIG ...

Page 133: ...tions dialog Diagnostics NetLinx Device Notification Options to set auto notification preferences for one or more NetLinx devices Select Enable NetLinx Device Notifications from the Diagnostics menu or use the toolbar button to enable the specified NetLinx notifications The resulting notification messages are displayed in the Notifications tab of the Output Display window The Notifications tab con...

Page 134: ... Editing Device Notification Settings In order to edit add or remove devices from the list you must be connected to a NetLinx master controller 1 Select Diagnostics NetLinx Device Notification Options to open the NetLinx Device Notifications dialog 2 Select a device in the Device list and click the Edit button to open the NetLinx Notification Properties Edit dialog Alternatively you can double cli...

Page 135: ... the local system will show up in a terminal or Telnet session once the programmer has typed in MSG ON enter at the prompt For example if this line is in your code SEND_STRING 0 some message your terminal will display something like 0100636312 some message when the code executes The 13 characters to the left of the message are called the time stamp or tic time Also by default the master will appen...

Page 136: ...stem format 2 FUNCTION CHAR 25 DEVCHAN_TO_STRING DEVCHAN dcDC This function returns a DEVCHAN as a string with brackets in the format number port system chan 3 FUNCTION CHAR 25 DEV_CHAN_TO_STRING DEV dvDEV INTEGER nChannel Same as DEVCHAN_TO_STRING but takes a separate DEV and INTEGER as parameters Returns number port system chan 4 FUNCTION CHAR 25 DEVLEV_TO_STRING DEVLEV dlDL This function return...

Page 137: ...1 a space 20 is no longer added between STR1 and STR2 nLine is the line length This may need to be changed if a terminal with a line length other than the typical 80 characters is being used If not just leave it as 0 for the defaults If nMode is 2 nLine defaults to 80 else nLine defaults to 67 to allow 13 characters for the tic time nMode is the mode if MSG ON 2 mode is being used to set it to 2 o...

Page 138: ...need to be changed if a terminal with a line length other than the typical 80 characters is being used If not just leave it as 0 for the defaults If nMode is 2 nLine defaults to 80 else nLine defaults to 67 to allow 13 characters for the tic time nMode is the mode if MSG ON 2 mode is being used to set it to 2 otherwise use 0 for the defaults 14 CALL SEND INTEGER TO DEBUG dvDEBUG STR1 STR2 nLine nM...

Page 139: ...large number of messages being sent from the master controller As the buffer files are filling with messages from the master controller the program will read in a message and display it into the appropriate list view every quarter of a second This will allow you to view the messages at a reasonable rate versus what is being loading into the buffer files NetLinx Diagnostics NetLinx Device Emulation...

Page 140: ...turn key within the text box to enter a new line for the next message When entering a send command in the context of this dialog do not include the send c or send_command in the statement only type what would normally occur within the quotes but don t include the quotes either For example to send the CALIBRATE send command simply type CALIBRATE no quotes rather than SEND_COMMAND dev CALIBRATE a Cl...

Page 141: ...nnel text box The Channel number range is 0 65535 Select the Push button to emulate a push release on the channel specified You may click and hold down the Push button to see how the master controller responds to the push message Select the On or Off buttons to emulate Channel ON CHON and Channel OFF CHOFF messages for the specified D P S 4 To emulate a level enter the desired Level number Value a...

Page 142: ...iewing Push Results The PUSH keyword is used to find out if a channel has had an input change from off to on such as when a button is pressed If the channel has been turned on the corresponding Push statement is activated The operation or operations following this Push statement are only executed once after the channel is turned on To view Push results select Diagnostics Enable Push Message Status...

Page 143: ...o access the Device Addressing dialog which allows you to change the Device and or System Address for a NetLinx system device 1 Enter the target device s current Device number in the Device to Change Device text box 2 Click the Change Device checkbox and enter the new Device number in the New Device text box 3 Enter the target device s current System number in the System to Change System text box ...

Page 144: ...and System ID numbers for a NetLinx device 1 Enter the Device and System numbers that you want to assign to the device in the Change to Device Device and System text boxes 2 Enter the Device and System numbers that you want to assign to the device in the Change to Device Device and System text boxes 3 Click the Start Identify Mode button to place the named System in ID Mode The text box below this...

Page 145: ...P Address of the device in the URL text box and click OK to return to the URL List dialog 5 Initially the connection status reads Looking up URL Once found the new device appears in the URL List with its IP Port assignment 1319 6 Click Get URL List to refresh the URL List after adding a device 7 Repeat steps 1 5 for as many additional devices as are required To retrieve a list of all URL s in the ...

Page 146: ...etwork Addresses dialog 2 At the top of the dialog enter the specified device s System and Device numbers in the text boxes The range is 0 65535 3 Click the Get IP Information button to populate the IP Address fields with the current Host Name and Gateway assignments 4 Click the Use DHCP radio button and enter a new Host Name in the text box if necessary 5 Click the Set IP Information button to se...

Page 147: ... Master to reboot the master and accept the new changes Allow 20 30 seconds for the master to reboot Changing the IP Address On a Netlinx Master Use DHCP Use the options in the Network Addresses dialog to change the IP Address for a specified NetLinx device using DHCP 1 Select Diagnostics Network Addresses or click the toolbar button to access the Network Addresses dialog 2 At the top of the dialo...

Page 148: ...cified NetLinx Master 1 In the Master Controller ID text box enter edit the target System number if necessary 2 To retrieve the current Time Date settings for the specified target Master click Get Time Date The Master s current Time Date settings are displayed in the read only text field 3 To change the target Master s date setting click the down arrow next to the Date field to open the calendar w...

Page 149: ...our computer must be connected to a Master Controller and you must have a compiled Source Code file active To use debugging the Build With Source option must be selected in the Axcess Compiler and or NetLinx Compiler tabs of the Preferences dialog before the file is compiled For NetLinx code select You cannot compile send receive files or change port settings while the program is in debug mode Avo...

Page 150: ...n in the DEFINE_START section of your code you added cat 1 C cat 2 A cat 3 T in debug Total Length 3 and Current Length 0 because setting values using array indexing does not set the current length Master Controller Debug Options The Watch window is displayed when Start Debugging is selected from the Debug menu or the Debug Watch toolbar The Watch window is a dockable window that allows you to vie...

Page 151: ...st invoke the Step command again Single Step Execute one line of a source code file at a time for a NetLinx master con troller or execute one pass through the mainline code for an Axcess con troller The following options are only needed for debugging code on a NetLinx master Run To continue execution after a Single Step operation or from a toggled break point Run To Cursor Execute the program and ...

Page 152: ...Working With Online Devices 140 NetLinx Studio v2 4 or higher ...

Page 153: ... settings for the selected connection option For TCP IP connections Set the TCP IP address TCP IP Settings dialog For Serial connections Specify the COM port and set baud rate data bits parity stop bits and flow control Serial Settings dialog For Modem connections Specify the COM port and set baud rate data bits parity stop bits flow control and target phone number Modem Settings dialog For Virtua...

Page 154: ...port Connection Option TCP IP Serial Modem or Virtual NetLinx Master 6 Click Edit Settings to specify the communication settings for the selected connection option For TCP IP connections Set the TCP IP address TCP IP Settings dialog For Serial connections Specify the COM port and set baud rate data bits parity stop bits and flow control Serial Settings dialog For Modem connections Specify the COM ...

Page 155: ...ings for the Terminal window 1 Select Settings Master Communication Settings to open the Master Communication Settings dialog 2 Click to select the second item in the Available System s list labeled Terminal Settings 3 Click the Communication Settings button to access the Communication Settings dialog 4 Select the default Platform NetLinx or Axcess 5 Select a Transport Connection Option Serial or ...

Page 156: ...ent Projects The currently active System is highlighted in this list 2 Click to select a System from the Available System s list 3 Click the Communication Settings button to access the Communication Settings dialog 4 Select the default platform NetLinx or Axcess Note that if you select NetLinx a Module System file folder is included in the Workspace tab of the Workspace Window Connecting To A Netl...

Page 157: ...latform Selection 4 Select TCP IP as the Transport Connection Option 5 Click Edit Settings to open the TCP IP Settings dialog 6 Enter the TCP IP Address of the master 7 Click OK to return to the Communication Settings dialog 8 Select Authentication Required to enable NetLinx Master Security for this connection This enables the User Name and Password button Click it to enter the user name and passw...

Page 158: ... Password button Click it to enter the user name and password assigned to the Master case sensitive 9 Click OK to return to the Master Communication Settings dialog 10 Click OK to close the Master Communications dialog 11 In the online tree displayed in the Online Tree tab of the Workspace window click Display to open the Online Tree sub menu and select Refresh Network to refresh the online tree d...

Page 159: ...at has security enabled you will be required to enter a User Name and Password before you can connect To establish a connection to a secured master 1 Select Settings Communication Settings to open the Communication Settings dialog and select NetLinx as the platform and select a Transport Type 2 Click Edit Settings to configure the selected transport type 3 Click OK to save the TCP IP Serial or Mod...

Page 160: ...nx Studio and the AXCESS master is established 1 Select Settings Master Communication Settings to open the Master Communication Settings dialog 2 Click Communication Settings to access the Communication Settings dialog 3 Select Axcess Master as the Platform Selection 4 Select Serial as the Transport Connection Option 5 Click Edit Settings to open the Serial Settings dialog 6 Select a COM port and ...

Page 161: ...work to refresh the online tree display 11 Double click the System icon to expand the tree to show the Axcess master File Transfer Operations NetLinx Studio supports asynchronous communications send and receive to and from the bus on all available communications ports simultaneously You can send and receive both Axcess and NetLinx Source Code files to and from the Master Controller or bus device A...

Page 162: ...zes the transfer by identifying the various components fonts bitmaps sound files even pages and popup pages of the selected panel file and comparing them to the elements already present on the target panel Any shared components are not sent resulting in a much faster transfer assuming that there are shared components Communication Settings Opens the Communication Settings dialog where you can edit...

Page 163: ...h of the file being transferred Bytes Transferred The number of bytes transferred and the total number of bytes left to transfer Error An error message if an error has occurred Last Transfer The time and date of the last transfer Canceling during a file transfer may leave the target device in an unstable state Error String Meaning Failure Generic unclassified failure Success Generic success File d...

Page 164: ...enu option With at least one Workspace file open the options in the Quick Load dialog allow you to specify which of the files contained in the Workspace file s to add to the Files To Send queue 1 Selection Options menu Click the down arrow to access the following load options Active System Loads only the files from the active System Entire Workspace Loads all files from the Workspace Select System...

Page 165: ...e keypad module and sent it to the Master Adding All Files Contained In An APW Or AXW File In the Send tab 1 Select File Open Workspace AXW FTL File or click the Load Workspace command button to open the Open File dialog 2 Select either NetLinx Studio Files apw or Export To Go Files axw from the File of Type drop down menu depending on which type of file contains the system files that you want to ...

Page 166: ... use the Add command button in the Send tab to select individual System files to add to the Files To Send queue 1 Click the Add command button to open the Select Files For File Transfer dialog 2 Open the Current Workspace tab This tab consists of a display of the compiled Source Code AXS Token TKN User Interface TPD TP4 and IR IRL files contained in the currently open Workspace Use the options in ...

Page 167: ...em numbers for the source device and click OK to close the dialog and add the to the File list at the bottom of the Select Files To Transfer dialog 6 Click Settings in the Communication Settings section at the bottom of the dialog to open the Communication Settings dialog and specify the communication settings for the source device Note that in the Select Files For File Transfer dialog communicati...

Page 168: ...for each file in the Files To Send and Files To Receive queues 1 Select a file Send or Receive tabs 2 Click the Edit command button and select Communication Settings from the Edit menu to open the Communication Settings dialog a Select a Platform for this transfer Axcess or NetLinx b Select a Transport Connection Option TCP IP Serial Modem or Virtual NetLinx Master c Click Edit Settings to specify...

Page 169: ... specify the communication settings for serial port communications The default settings are 6 Click OK to return to the Communication Settings dialog 7 Click OK to save the new Serial communication settings with the selected file Configuring Modem Communication Settings With a Transfer selected in the Transfer List 1 Click the Edit command button and select Communication Settings to open the Commu...

Page 170: ...e new VNM communication settings with the selected file Configuring the Panel For Virtual Netlinx Master TCP IP Transfers If it is not already powered up and connected apply power to the G4 panel and verify that it is connected to the LAN via the TCP IP connector on the rear or side of the panel 1 Press and hold the grey Front Setup Access button below the touch screen for 3 seconds to access the ...

Page 171: ...g Step 4 Transferring the Files Sending Files To System Devices Once you have 1 Added the desired file s to the File To Send Queue 2 Configured the communication settings for the files in the list and 3 Specified the device file mapping information for the files in the list you are ready to begin transferring the file s to devices in the system Click the Send command button This initiates the tran...

Page 172: ...are KIT files or IR Files directly to G4 touch panels G4 touch panels that support USB connection include the MVP 8400 MVP 7500 and NXD T CV7 USB direct transfers require that you configure the Master Connection setting on the panel itself to USB prior to attempting the transfer TCP IP direct transfers require that you configure the Master Connection setting on the panel itself to TCP IP prior to ...

Page 173: ...om the G4 device AMX USB Driver Information For USB Enabled G4 Panels The AMX USB driver required to connect to USB enabled G4 panels via USB is included with the NetLinx Studio as well as TPDesign4 installation programs Once you have installed the latest version of either NetLinx Studio v2 4 or higher or TPD4 v2 4 or higher you should have the required USB driver After having installed NetLinx St...

Page 174: ...The System Number field is set to 1 by default Assuming that the actual NetLinx Master is set to 0 via the System Properties dialog System ID field this default setting will work However if you have designated any other number as the System ID be sure to set this System Number to a different number than the System ID to avoid a conflict with the actual NetLinx Master range 1 65535 Transferring Fil...

Page 175: ...ps to Virtual NetLinx Master TCP IP file transfers Configuring the Touch Panel for Virtual NetLinx Master TCP IP Transfers Configuring NetLinx Studio for Virtual NetLinx Master TCP IP Transfers Transferring Files Using a Virtual NetLinx Master TCP IP Connection Configuring The Touch Panel For Virtual Netlinx Master Tcp ip Transfers If it is not already powered up and connected apply power to the G...

Page 176: ...5 6 Click OK to close the Virtual NetLinx Master Settings dialog 7 Click OK to close the Communication Settings dialog Transferring Files Using A Virtual Netlinx Master Tcp ip Connection To use Virtual NetLinx Master to transfer TPDesign4 panel TP4 files NetLinx Firmware KIT files or IR files directly to a MVP 7500 MVP 8400 or NXD T CV7 panel via TCP IP 1 Select Tools File Transfer to open the Fil...

Page 177: ...must have the appropriate Kit file for your NetLinx Master To update NetLinx firmware 1 Choose Tools Firmware Transfers Send to NetLinx Device to open the Send To NetLinx Device dialog 2 Click the Browse button to navigate to the target directory in the Browse For Folder dialog The selected directory path is displayed in the Location text box Assuming that the specified target directory contains o...

Page 178: ...ion date and time 3 Select the desired TSK file from the list 4 Click the Query command button to populate the Devices list with a list of all Axcess devices currently online and capable of receiving the firmware 5 Select the target AXlink device from the list 6 Review the File Connection and Target Device information before you send Click the Send button to send the selected TSK file to the speci...

Page 179: ...ly a default User Name and Password to the No active System Default Settings option so that as you create new NetLinx systems they will always require that User Name Password combination Enabling Security On Netlinx Masters Before you can enable disable security on a NetLinx Master through NetLinx Studio you must Have loaded firmware in the target Master that supports security This means that the ...

Page 180: ...is locked FIG 29 Master Controller User Name and Password Dialog Click the User Name and Password command button in the Communication Settings dialog to access the Master Controller User Name and Password dialog Use this dialog to specify a User Name and a Password for the secured NetLinx Master this option is only enabled if the Authentication Required option is enabled The User Name and Password...

Page 181: ...Name and Password combination that the program will require in order to start this file transfer Once security is applied if the correct User Name and Password are not entered when prompted NetLinx Studio will display an Authentication Failure message in the Error column of the File Transfer Status window and the transfer will not complete Connecting To a Secured Netlinx Master When connecting to ...

Page 182: ...am can get the modem to call another modem and establish communications A Answer means that the FileTransfer program can get the modem to answer inbound calls and establish communications with the master controller X Not supported Less 100 reliable Internal Modems Windows Operating System Manufacturer Model Internal 95 98 ME NT 2000 XP Diamond Supra 336i SP ASVD C Diamond Supra 56i SP C Lucent 56K...

Page 183: ...s when a variable or value of one type is assigned to a variable of a different type Here are some examples Output Bar Status Status tab of the Output Display window Output Bar Find in Files Find in Files tab of the Output Display window Output Bar Find IR Files Find IR Files tab of the Output Display window Output Bar File Transfer Status File Transfer Status tab of the Output Display window Outp...

Page 184: ...rce Options Click these checkboxes to enable the following build compile options Build with Source Check to compile the source code with the executable code so that you may later retrieve the source code from the device you send the compiled code to If Build with Source is disabled only the executable code is sent when the file is transferred to the master Build With Password Protection Select thi...

Page 185: ... directories listed here in reverse order that is from the bottom up Select Module Files to select or create the directory that the compiler will look for Duet Module files JAR and AXS Module files TKO Compile With Debug Info Select this option to include variable symbol information in the compiled file This allows the debugger to identify and validate variable symbols in the code You must compile...

Page 186: ...st depend on the Document Type selection Select an item from this list to customize Text Files Axcess NetLinx Source code files Default Text Space Selected Text Comment Caret Reserved Word Window Background String Margin Operator Number Float Floating Point Number Device Constant Variable Type Default Text Selected Text Caret Function Names Stack Param Variables Code Fold Margin Code Fold Plus Cod...

Page 187: ...te background Print Color on White Print all text using the same colors displayed in the Source Code Editor window on a white background Print Color on White but Invert Light Colors This is the same as Print Color on White except that light colors are automatically be inverted for better readability on a white background Display options These options offer more display oriented options for the Sou...

Page 188: ...sets to be displayed in the Source Code Editor windows You must close and re open all files in order for this option to take effect Tabs and Indentation Preferences This set of options allows you to specify the following indentation preferences Set tab stops every X characters Use this option to specify the size in number of characters of the tab stops in the Source Code Editor window default 4 Ea...

Page 189: ...e the options on the Commands tab of the Preferences dialog to add remove commands from the toolbars The items on this tab include Categories This is a list of command categories Each command category in this list contains several commands displayed in the Commands list Commands This is a list of the commands included in the selected Command Category Description This read only field displays a bri...

Page 190: ...l System toolbars to their default set of command buttons New Click to create a new custom toolbar via the Toolbar Name dialog Rename Select a custom toolbar and click Rename to rename the selected toolbar via the Toolbar Name dialog You cannot rename or delete system toolbars Delete Select a custom toolbar and click Delete to delete the selected toolbar You cannot rename or delete system toolbars...

Page 191: ...r select Browse to specify an initial directory via the Browse For Folder dialog 7 Click Close to close the Preferences dialog 8 The new shortcut should appear at the bottom of the Tools menu Preferences Dialog Keyboard Tab Use the options on the Keyboard tab of the Preferences dialog to set custom keyboard accelerators shortcut keys key combinations for often used commands The items on this tab i...

Page 192: ...and enter the desired shortcut key or key combination If the new shortcut key is already assigned to another command it is indicated directly below the Press New Shortcut Key text box and the Assign button will be disabled to prevent duplicate assignments 5 Click Assign to assign the new shortcut key to the selected command Preferences Dialog Menu Tab Use the options on the Menu tab of the Prefere...

Page 193: ...en the Preferences dialog 2 Open the Commands tab 3 Open a menu in the main Menu bar To add a command Select a command category and a select the command you want to add to the menu Click and drag the command out of the Commands list and into the desired position in the open menu To remove a command Select a command from the open menu and click and drag it outside of the menu 4 Click Close to close...

Page 194: ...e numbers in system diagnostics displays default enabled Display Time Stamp Toggles the display of time stamps in system diagnostics displays in one second increments default enabled When enabled the Display Milliseconds option causes diagnostics time stamps to be displayed in milliseconds default disabled Display Control Codes as Converts unprintable characters i e Control Codes into either Hexad...

Page 195: ...ion toggles the transmission of control characters to the terminal s port default disabled Colors These options allow to customize the colors for both states Active Connected and Inactive Disconnected of the terminal window To change the colors on the terminal window select Active Connected then click the down arrows to access the Foreground text and Background color palettes Select the desired co...

Page 196: ...ore Compile Toggles auto saving of code files before a compile Automatically Stamp File with Creation and Last Modified Date This option automatically stamps all Workspace files with Creation and Last Modified dates when the file is closed default enabled Enable Window Tabs This option toggles the display of the window tabs that appear by default along the lower edge of the Source Code Editor wind...

Page 197: ...that sends a command string or level because of a device declared as an integer instead of a DEVICE PORT SYSTEM D P S structure Example DEFINE_DEVICE VCR 2 TP 128 DEFINE_EVENT BUTTON_EVENT TP 101 PUSH SEND_COMMAND VCR SP 9 The debugger will not stop if you put a breakpoint here Resolution Declare devices using the full D P S structure In fact you should always do this in Netlinx Example DEFINE_DEV...

Page 198: ...L or DEFINE_FUNCTION and a parameter is passed to the DEVICE_ID function make sure that parameter is of type DEV Debug Option Disabled For Axcess Code File Symptom After compiling and downloading an Axcess code file the Start Debugging option in the Debug menu is disabled Cause The code was created as an Axcess file but was compiled as a NetLinx file Resolution 1 Select the file in the Project Nav...

Page 199: ...Index 187 NetLinx Studio v2 4 or higher ...

Page 200: ...A 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 22...

Search results

Summary of Contents for NETLINX STUDIO V2.4

Reviews:

Related manuals for NETLINX STUDIO V2.4

Brands by name

Popular brands

AMX NETLINX STUDIO V2.4, Instruction Manual

Search results

Summary of Contents for NETLINX STUDIO V2.4

Reviews:

Related manuals for NETLINX STUDIO V2.4

Brands by name

Popular brands