instruction manual NetLinx Studio v2.
Software License and Warranty Agreement LICENSE GRANT. AMX grants to Licensee the non-exclusive right to use the AMX Software in the manner described in this License. The AMX Software is licensed, not sold. The AMX Software consists of generally available programming and development software, product documentation, sample applications, tools and utilities, and miscellaneous technical information. Please refer to the README.
Table of Contents Table of Contents NetLinx Studio (v2.4 or higher) ...............................................................................1 Overview ........................................................................................................................... 1 Supported Operating Systems and Minimum PC Requirements ...................................... 2 Supported operating systems: .................................................................................................
Table of Contents Using The Terminal Window .................................................................................................. 17 Terminal Window Context Menu ............................................................................................ 18 Watch Window ................................................................................................................ 18 Watch Window Context Menu.....................................................................................
Table of Contents Designating The Active System ............................................................................................. 40 Configuring System-Level Communications Settings ..................................................... 40 Adding A File To A System ............................................................................................. 41 Drag And Drop Files Into A System .......................................................................................
Table of Contents Include File Folder Context Menu .......................................................................................... 58 Include File Context Menu ..................................................................................................... 59 Working With Module Files ............................................................................................. 59 Duet (JAR) Module Files .......................................................................................
Table of Contents Programming ..........................................................................................................77 Overview ......................................................................................................................... 77 Source Code Editor Context Menu ........................................................................................ 77 Using The Code Wizard ...........................................................................................
Table of Contents Debugging Source Code Files ............................................................................................... 94 To enter debug mode:............................................................................................................ 95 Using Single-step Mode ......................................................................................................... 95 Master Controller Debug Options.......................................................................
Table of Contents Compiling an Individual File .......................................................................................... 109 Compiler Errors and Warnings ...................................................................................... 110 Compiler Errors ............................................................................................................. 110 Compiler Warnings......................................................................................................
Table of Contents Setting NetLinx Time and Date ..................................................................................... 136 Rebooting the Master.................................................................................................... 137 Axcess/NetLinx Debugging ........................................................................................... 137 Debugging Source Code Files .............................................................................................
Table of Contents Configuring TCP/IP Communication Settings (Netlinx Only) ............................................... 156 Configuring Serial Communication Settings......................................................................... 157 Configuring Modem Communication Settings...................................................................... 157 Configuring Virtual Netlinx Master Communication Settings (Netlinx Only).........................
Table of Contents Preferences Dialog - Commands Tab........................................................................... 177 Adding/Removing Commands From The Toolbars.............................................................. 177 Creating Custom Toolbars ................................................................................................... 178 Preferences Dialog - Toolbars Tab ...............................................................................
NetLinx Studio (v2.4 or higher) NetLinx Studio (v2.4 or higher) Overview NetLinx Studio v2 is a 32-bit Windows® application that allows you to program and maintain entire control systems. NetLinx Studio fully supports both NetLinx and Axcess system programming. Beyond creating, editing and compiling source code in two programming languages (Axcess and NetLinx), NetLinx Studio makes it easy to manage all of the files associated with an entire control system (i.e. Master Source Code/Source Code (.
NetLinx Studio (v2.4 or higher) Supported Operating Systems and Minimum PC Requirements Supported operating systems: Windows XP® Professional (service pack 1 or greater) Windows 2000® (service pack 3 or greater) You must have Administrator rights to install and run all required System files. PC Requirements: Pentium 233 MHZ processor (minimum requirement); 300 MHZ or faster recommended. 75 MB of free disk space (minimum requirement); 150 MB recommended. 128 MB of installed memory (RAM).
NetLinx Studio (v2.4 or higher) NetLinx Studio will attempt to open all other file types (*.*) using the application already associated with that file type in Windows. What's New Dialog The "What's New" dialog is displayed when NetLinx Studio is launched. This dialog provides a (read-only) text file describing the features that are new to this release. To prevent this dialog from being displayed every time the program is launched, select the Don't Show Me Again option at the bottom of the dialog.
NetLinx Studio (v2.4 or higher) 4 NetLinx Studio (v2.
The NetLinx Studio v2.4 Work Area The NetLinx Studio v2.4 Work Area Overview The NetLinx Studio work area contains the elements of the NetLinx Studio user interface. Before jumping into a project, take a few moments to familiarize yourself with the main user interface elements. FIG. 1 The NetLinx Studio v2.4 Work Area 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.
The NetLinx Studio v2.4 Work Area Build toolbar Debug Watch toolbar Diagnostics toolbar Edit toolbar Project toolbar Standard toolbar Terminal toolbar Window Mgmt toolbar FIG. 2 Toolbars See Also... The Adding/Removing Commands From The Toolbars section on page 177. The Creating Custom Toolbars section on page 178. Menu Bar The Menu Bar is located along the top of the application window, between the title bar and the toolbars. Click on any of the main menu items to open the associated drop-down menu.
The NetLinx Studio v2.4 Work Area Program Status/Quick descriptions of program options - The far-left side of the status bar displays quick descriptions of program options anytime you position the mouse cursor over a toolbar button or menu item. This field also displays the total number of replaced instances resulting from a search & replace operation. Notifications Messages Status - Displays the status of NetLinx notification messages (OFF/ON).
The NetLinx Studio v2.4 Work Area Workspace Window Use the Workspace Window (FIG. 4) to manage Project files, System files and online devices. The Workspace Window contains two tabs (Workspace and Online Tree), which display all open Workspace files (containing Projects and their associated System files), and all devices currently on-line, in a tree structure. FIG.
The NetLinx Studio v2.4 Work Area The 'Module' folder only appears if NetLinx is designated as the system platform (via the Communication Settings dialog). 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. FIG.
The NetLinx Studio v2.4 Work Area Expand any System folder to display the six System File folders contained in that System (Source, Include, Module, User Interface, IR and Other). System File Folders Expand any System File folder to display the System File(s) contained in that folder. Right-click on any System File folder to open the System File Folder context menu associated with that folder type.
The NetLinx Studio v2.4 Work Area Right-click on any open area inside the Workspace tab to open the Workspace Window Context Menu. Workspace File Context Menu Right-click on the Workspace file (in the Workspace tab of the Workspace Window) to open the Workspace File context menu.
The NetLinx Studio v2.4 Work Area Workspace Window - Online Tree Tab The Online Tree tab of the Workspace Window (FIG. 6) displays an Online Device tree for either the NetLinx or Axcess Master Controller. This tab displays a list of devices detected 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. FIG.
The NetLinx Studio v2.4 Work Area There are 6 tabs contained in the dockable Output Display window: Status Tab The Status tab displays build information pertaining to the last compilation of source code files, as well as port status information. Double click on a line containing an compiler error message to open the file in a Source Code Editor window, with the cursor positioned at the beginning of the line containing the indicated error.
The NetLinx Studio v2.4 Work Area Save All Items Saves all items to a user-defined file. You will be prompted for a file name to save the contents of the tab. Save Selected Items Saves only the selected items to a user-defined file. You will be prompted for a file name to save the contents of the tab. Compiler Error /Warning Report This option scans the contents of the Status tab, and then lists each compiler error and warning (one per line) in the Status tab.
The NetLinx Studio v2.4 Work Area Source Code Editor Windows Use Source Code Editor windows (FIG. 8) to display, view and edit Axcess and NetLinx source code files. You can have multiple files open at any time. Each code file is opened in a separate Source Code Editor window. FIG. 8 Source Code Editor Window Use the Source Code Editor windows to generate and edit Axcess and/or NetLinx code files.
The NetLinx Studio v2.4 Work Area Code folding Fold levels can be used to simplify the view in the Source Code Editor windows by allowing you to "fold" each major section of the code (DEFINE_DEVICE, DEFINE_CONSTANT, DEFINE_TYPE, etc.) so that only the header row is visible. This way, you only see the section(s) that you are actually working in. 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).
The NetLinx Studio v2.4 Work Area Indentation To indent a block of text, select text and press the Tab key. Use Shift + Tab to remove the indentation. Other Features include: • Multiple clip-board buffer capabilities. • Ability to print an entire file. • Mouse wheel support. Terminal Window NetLinx Studio provides a terminal interface to NetLinx and Axcess devices that support an interactive terminal mode. Select Tools > Terminal (or click the toolbar button) to invoke the Terminal Window.
The NetLinx Studio v2.4 Work Area Use the Terminal Options tab of the Preferences dialog to modify the behavior and change the appearance of the Terminal window. To use the Terminal window with NetLinx systems, you must be connected to the Master via the PROGRAM port. Otherwise, you can use Windows TelNet for terminal control of NetLinx systems. Terminal Window Context Menu Several of the key functions of the Terminal Window are accessible via the Terminal Window context menu.
The NetLinx Studio v2.4 Work Area Watch Window Context Menu Right-click inside the Watch Window to access the Watch Window context menu, described below: Refresh List Refreshes the contents of the Watch Window. Add Variable Opens a text field in the Name column, to allow you to add a variable to the Watch Window.
The NetLinx Studio v2.4 Work Area 20 NetLinx Studio (v2.
Using NetLinx Studio Using NetLinx Studio The Netlinx Studio Workspace Wizard A key feature of NetLinx Studio (v2.x) is the Workspace Wizard. The Workspace Wizard quickly steps you through the process of creating a new Workspace, with a Project and a System. Using the Workspace Wizard The NetLinx Studio Workspace Wizard provides an quick and easy way to create a new Workspace (.APW) file with one Project and one System.
Using NetLinx Studio 13. Click Next to proceed to the System Communications dialog. This dialog displays the current Master Communication Settings in a read-only text box. 14. Click Communication Settings to set the communication settings for this System, in the Communication Settings dialog. These settings become the default communication settings for all new Workspace files, until they are manually changed. 15. Click Next to proceed to the Master Source Code File Selection dialog. 16.
Using NetLinx Studio e. Click Source Code File Description to enter an optional description (up to 2,000 characters) in the Source Code File Description dialog, and click OK to return to the Master Source Code File Name dialog. f. Click Next to proceed to the New File Location dialog. g. Specify the target location for the new file in the text field (click the Browse button to locate and select a target directory via the Browse For Folder dialog). h. Click Next to complete the Wizard.
Using NetLinx Studio The Code Wizard can be toggled to 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. 24 NetLinx Studio (v2.
Working With Workspace Files Working With Workspace Files Overview NetLinx Studio utilizes a new concept for working with multiple projects/files simultaneously: the Workspace file. A Workspace represents at least one Project (containing at least one System), however a Workspace can contain multiple Projects. Each Project in turn can contain multiple Systems. At any time, you can create a Workspace file (via the File > Save Workspace option).
Working With Workspace Files Other features of the Workspace file include: You can import other Project or Systems folders from previously saved Workspace files. You can copy and paste existing Projects and Systems within a Workspace. You can edit the identifier that is used to display the workspace name in the tree display along with the description for the Workspace file via the Workspace Properties dialog. You can export all the files associated with the Workspace (including the Workspace file) into a .
Working With Workspace Files 3. In the Import Components From a Workspace dialog, use the check boxes to select which Project(s) contained in the specified Workspace file to import. 4. Click OK. If the selected Project(s) contain any identifiers that are already being used by the target Workspace, the program prompts you to change them. In this case, use the Import Name Change dialog to specify a new identifier for the imported Project. 5.
Working With Workspace Files The same Project can be included in more than one Workspace file. 3. In the Import Components From a Workspace dialog, use the check boxes to select which Project(s) contained in the specified Workspace file to import. 4. Click OK. If the selected Project(s) contain any identifiers that are already being used by the target Workspace, the program prompts you to change them. In this case, use the Import Name Change dialog to specify a new identifier for the imported Project. 5.
Working With Workspace Files Workspace Filename To Create text field to change the name and target directory for the resulting AXW file, if necessary. 4. Use the radio buttons in the Export Options area of the dialog to specify exporting the Full Workspace (all Projects and Systems included), or only the currently active Project (Only Active Project) or the currently active System (Only Active System). By default, the program is configured to export the entire Workspace file. 5.
Working With Workspace Files 5. Click Extract to extract the selected Workspace file to the specified directory. If a file of the same name already exists in the target directory, the NetLinx Studio Extraction Overwrite dialog prompts you to either overwrite the existing file (Yes or Yes To All), to preserve the existing file (No), or to cancel the operation. 6. Once the file is extracted, the Workspace file is automatically loaded, and is represented in the Workspace tab of the Workspace Window.
Working With Workspace Files Export Workspace Files To Go Opens the Export Workspace File To Go dialog, where you can export the 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.
Working With Workspace Files 32 NetLinx Studio (v2.
Working With Projects Working With Projects Overview A Project in NetLinx Studio contains one or more Systems (a System represents a control system (an Axcess or NetLinx Master, one or more user-interface devices and various types of controlled devices on the bus). Projects are represented by Project folders in the Workspace tab of the Workspace Window. A Workspace can contain several Projects (which in turn can contain multiple Systems). In NetLinx Studio (v2.
Working With Projects 3. Enter Dealer, Designer, Sales Order, Purchase Order info (maximum of 128 characters each), and a Description for the Project (maximum of 2,000 characters). These fields are all optional. 4. Click OK to add the new Project to the active Workspace. Building the Selected Project You can select to compile a single Project within the open Workspace, using the Build Project command.
Working With Projects Converting NetLinx Studio v1.2 Project Files NetLinx Studio v2.0 (and higher) supports Project (.PJS) files created in NetLinx Studio v1.2, via the File > Open or File > Open Workspace commands. The program converts the .PJS file into an .APW Workspace file that can be used by NetLinx Studio. The original NetLinx Studio v1.2 file is not altered during this conversion process. To convert NetLinx Studio v1.2 Project Files for use with NetLinx Studio v2.0: 1.
Working With Projects Project Folder Context Menu Right-click on any Project folder (in the Workspace tab of the Workspace Window) to open the Project Folder context menu. This context menu contains various Project -level commands and options, including: New Project Opens the New Project Properties dialog. The options in this dialog allow you to specify information for the new Project, including Project Identifier, Dealer, Sales Order, Designer, Purchase Order and Description.
Working With Systems and System Files Working With Systems and System Files Working With Systems A System in NetLinx Studio represents an Axcess or NetLinx-based control system. Each System has its own Master Controller (and associated Master Source Code file) and set of devices on the bus (and their associated files). Systems are represented by System Folders in the Workspace tab of the Workspace Window. Any Project can contain multiple Systems, and Systems only exist within the context of a Project.
Working With Systems and System Files 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. Creating A New System When you create a new System, it is automatically added to the Project that is currently selected (highlighted) in the Workspace tab. To create a new System: 1. Select the Project that you want to add the new System to in the Workspace Window (Workspace tab). 2.
Working With Systems and System Files Adding An Existing System To a Project Importing Systems Into A Project Its easy to import one or more existing Systems into a Project in the open Workspace. You just need to know which Workspace file contains the System(s) that you want to add to your Project: 1. Select (highlight) the Project that you want to add the imported System into (in the Workspace tab of the Workspace Window). 2.
Working With Systems and System Files System Status: Active Vs. Inactive You may have multiple systems within a Project, but only one is designated as the "Active System", meaning that all communication with the master controller (i.e. diagnostics, online tree, etc.) will be done with the communications settings of the selected System.
Working With Systems and System Files 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 Virtual NetLinx Master connections: Specify the System number for the Virtual Master (Virtual NetLinx Master Settings dialog; default = 1).
Working With Systems and System Files Use the Recent tab to quickly locate and select recently used files. 4. Click Open to access the File Properties dialog, where you can view/edit general file information for the selected file. 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. 5. Edit the file information (if necessary). 6.
Working With Systems and System Files 3. The program prompts you to verify this action. 4. Click Yes to remove the file from the System. Alternatively, you can simply select a System file and press the Delete key for the same results. Building (Compiling Systems) Building The Selected System You can select to build (compile) any System in the Workspace, using the Build System command. When you build a System, every Source Code, Include, and Module file contained in the selected System is compiled.
Working With Systems and System Files Viewing And Editing System Properties Use the System Properties dialog to view and/or edit the information for the selected System entered in the New System dialog when the System was created. To access this dialog, select System Properties from the Project menu, the System Folder context menu, or click the toolbar button. You can edit all of the information in this dialog: Identifier Required, and can have a maximum of 128 characters.
Working With Systems and System Files System Files System Files represent the actual files that are needed to operate a particular controlled device in the named System. System files include Source Code, Include files, NetLinx Module files, IRLib files, User-Interface (UI) files and any other (*.*) files that you might want to include. System files are placed in the appropriate System file folder (in the Workspace tab of the Workspace Window) as links only.
Working With Systems and System Files Creating New System Files Use the File > New command (or toolbar button) to create all types of System files, including Source Code, Include, Block and Text files. This command creates a new file, but does not automatically associate the new file with any Project or System. Use the Project > Add File To System command to add the file to a System. To create new System file: 1. Select New from the File menu, or click the toolbar button to open the New dialog. 2.
Working With Systems and System Files Identifiers vs. Disk Filenames Workspace and System files (displayed in the Workspace tab of the Workspace Window) are represented by the name assigned in the Identifier field in the Workspace Properties, Project Properties, System Properties, and File Properties dialogs. The disk file name is the full file name (plus it's extension) as it appears in Windows Explorer.
Working With Systems and System Files Device Mapping The Device Mapping dialog allows you to map files to System devices for file transfers. To access the Device Mapping dialog, select a System (in the Workspace tab of the Workspace Window) and select Project > Device Mapping. Alternatively, you can access the Device Mapping command via the Device Mapping command in the Source File, User Interface, and IR File context menus, or use the toolbar button.
Working With Systems and System Files 3. Select Device Mapping from the Project menu (or use the toolbar button) to open the Device Mapping dialog. You can also access the Device Mapping command via the Source File, User Interface, and IR File context menus. The Device Mapping option is only available if you have selected a Source Code file that is not designated as the Master Source Code file. 4.
Working With Systems and System Files where: Device: 16-bit integer representing the device number Port: 16-bit integer representing the port number (in the range 1 through the number of ports on the device) System: 16-bit integer representing the system number (0 = this system) that the device belongs to. For example, 128:1:0 represents the first port on device 128 on this system.
Working With Systems and System Files Adding A New Source Code File To A System NetLinx Studio provides a set of dialogs that step you through the process of creating a new Source Code (*.AXS) file. To create new Source Code file, and automatically add it to a specific System in the Workspace: 1. Click to select (highlight) a System (in the Workspace tab of the Workspace Window). 2.
Working With Systems and System Files 5. Edit the file information (if necessary). 6. If the file you are adding is to be used as the Master Source Code file for the System, check the Master File option. 7. Click OK to add the file to the selected System. 8. The file should now appear in the Source folder under the selected System, as the Master Source Code file (indicated by the letter "M" on the file icon in the Workspace tab).
Working With Systems and System Files 6. Develop the file as needed in the Source Code Editor window, and select File > Save (or click the toolbar button). 7. Specify a name and target location for the new file in the Save As dialog. Existing Source Code files can be added to Systems via the Project > Add File To System command. Saving The Active File Click File > Save (or click the toolbar button) to save the active file in the Source Code Editor, using the current file name and identifier.
Working With Systems and System Files The file that was replaced with the new file revision will not be deleted from your hard drive. The program will insert the file revision information specified here at the top of the source code file, before any other revision information that already exists in the file (if any exists).
Working With Systems and System Files To specify the compiler to use (NetLinx or Axcess), double-click to open the file in a Source Code Editor window, and select Compile as NetLinx or Compile As Axcess from the Build menu. The status and results of the build are displayed in the Status tab of the Output Display Window. UTF-8 Encoding In the Save As dialog, select UTF-8 from the Encoding menu to enable UTF-8 support for new files, to help NetLinx Studio files to work better with other editors.
Working With Systems and System Files The error "Dynazip Unzip Error: Bad or missing decryption key (Problem extracting file(s))" indicates a mismatch between the 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).
Working With Systems and System Files Source Code File Context Menu Right-click on any Source Code File (in the Workspace tab of the Workspace Window) to access the context menu described below: Set As Master Sets the selected Source Code file as the Master Source file for the system it belongs to. Compile Compiles the selected file, using the compiler (Axcess or NetLinx) associated with the file. The status and results of the build are displayed in the Status tab of the Output Display Window.
Working With Systems and System Files Existing Include files can be added to Systems via the Project > Add File To System command. Adding A New Include File To A System To create new Include file, and automatically add it 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 Include folder to access the Include File Folder context menu, and select Add New Include File. 3.
Working With Systems and System Files Add Existing Include File Opens the Add Existing Include File dialog, where you can add an existing Include file to the System containing the selected Include folder. The new file will be added to the selected Include folder. Docking View Changes the Workspace Window to a dockable window that can be resized and moved to anywhere within the NetLinx Studio work area. Hide Hides the Workspace Window.
Working With Systems and System Files is a DynaZip file containing the compiled TKN file as well as the JAR modules that need to be transferred to the NetLinx master in order for the TKN file to execute properly. Minimum Support Requirements For Modules Minimum support requirements for the KPDesign module: PLK-DMS Keypad, v5.1 PLK-IMS Keypad, v5.0 NetLinx Studio v1.2 NetLinx Master v2.0, build 94 Minimum support requirements for Duet modules (*.JAR): NetLinx Studio v2.
Working With Systems and System Files 2. Right-click on the Module folder to access the Module File Folder context menu, and select Add Existing Module File (or click the toolbar button). 3. In the Add Existing Module File dialog, locate and select the Module (.AXS, .TKO or .JAR) file that you want to add to the selected System. Use the Recent tab to quickly access recently used files. 4.
Working With Systems and System Files Compiling Module Files There are several ways to compile individual Module files: Right-click on a Module file (in the Workspace tab of the Workspace Window), and select Compile from the Module File context menu. Double-click to open the Module file in a Source Code Editor window and select Compile from the Build Menu.
Working With Systems and System Files Working With User Interface Files User-Interface (UI) files are sent to either touch panels or keypads, and provide the user-interface that allows the end user to control the system. User Interface files are placed (as links) in the User Interface folder (in the Workspace tab of the Workspace Window). There are two basic types of user-files: Touch Panel and Keypad. Touch Panel UI files are created in either TPDesign3 (.TPD) or TPDesign4 (.TP4), and Keypad UI files (.
Working With Systems and System Files Use the Recent tab to quickly access recently used files. 4. Click Open to access the File Properties dialog, where you can view/edit general file information for the selected file. 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. 5. Edit the file information (if necessary). 6. Click OK to add the file to the selected System. 7.
Working With Systems and System Files Sample Netlinx Code To send a KPD file to a NetLinx Master, you must use the NetLinx DMS-IMS module, with the following DEFINE_MODULE entry in the Master Source Code: DEFINE_MODULE 'DMS-IMSMod' Module_Name(Virtual_Dev, Real_Dev, strFileName, strVarTextArray) Where: Module_Name is a unique name.
Working With Systems and System Files User Interface File Folder Context Menu Right-click on any User Interface folder (in the Workspace tab of the Workspace Window) to access the context menu described below: 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 containing the selected User Interface folder.
Working With Systems and System Files Use the Recent tab to quickly access recently used files. 4. Click Open to access the File Properties dialog, where you can view/edit general file information for the selected file. 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. 5. Edit the file information (if necessary). 6. Click OK to add the file to the selected System.
Working With Systems and System Files 2. In the IR Database Navigator Window (on the left side of this dialog), start by picking the Manufacturer of the device associated with the desired IR file, and drill down through the subfolders (Product Category, Product Model Number and Hand Control Model Number) to locate and select the desired IR file (FIG. 10). FIG. 10 IR Database Navigator Window 3.
Working With Systems and System Files IR File Folder Context Menu Right-click on any IR folder (in the Workspace tab of the Workspace Window) to access the context menu described below: Add Existing IR File Opens the Add Existing IR File dialog, which allows you to locate and select an IR file (*.IRL, *.IRV) to add to the System. Add From AMX IR Database Opens the Select IR From a Database dialog, which allows you to locate and select a hand control record from within the 'AMX IR' database.
Working With Systems and System Files Working With "Other" Files The Other file folder (in the Workspace tab of the Workspace Window) contains all other (nonAxcess/NetLinx specific) file types that you want to include with your Project. These files are not compiled, but are saved with the Project. Use this folder to store standard text files, image files, etc. AMX recommends that documents such as AXwires, button-by-button, system drawings, etc.
Working With Systems and System 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. 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 Other folder under the selected System.
Working With Systems and System Files 3. Click one or more of the checkboxes to set any additional search criteria, as desired. Match whole word only Searches for instances of the search string that exist as whole words only. For example, a 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 lowercase) of the characters in the search string.
Working With Systems and System Files The total number of replaced instances is indicated in the Status bar (on the left-hand side). Searching Across Multiple Files To perform a Search operation across multiple files: 1. Choose Tools > Find In Files (or click the toolbar button) to open the Find In Files dialog. 2. Enter a search string (up to 255 characters) in the Find What text box.
Working With Systems and System Files 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 files: • IR Files in Folder - Use this option to specify a target directory to search.
Working With Systems and System Files The options in the Print Preview window toolbar include: Print Prints the current page view Next Page Displays the next page of the selected file Prev Page Displays the previous page of the selected file One Page/Two Page Toggles the page view to one or two pages. This option is enabled only if the active file is longer than one page.
Working With Systems and System Files 76 NetLinx Studio (v2.
Programming Programming Overview Use Source Code Editor windows (FIG. 11) to display, view and edit Axcess and NetLinx source code files. You can have multiple files open at any time. Each code file is opened in a separate Source Code Editor window. FIG. 11 Source Code Editor Window Refer to the Source Code Editor Window - Features section on page 15 for a list of supported features.
Programming Undo, Redo Undo and Redo the last text editing action. Cut, Copy, Paste Cut the selected text to the clipboard, Copy the selected text to the clipboard, and Paste the contents of the clipboard to the active file, at the cursor position. Delete Deletes the selected (highlighted) text in the active Source Code Editor window. Select All Selects all of the code in the active file.
Programming Creating Events With the Code Wizard 1. In the first Code Wizard dialog, select the appropriate radio button for the type of event you want to create (BUTTON_EVENTs, CHANNEL_EVENTs, LEVEL_EVENTs or DATA_EVENTs). 2. Click Next to proceed to the next Wizard dialog. The options in the Wizard dialogs are different for each event type. The Next button is enabled in each dialog as the required information is supplied. 3.
Programming Code Wizard - Advanced Users The Code Wizard can be toggled to show the individual dialogs (containing detailed options) for all the above functionality that can be used by advanced users. To view the advanced options in every dialog, de-select the Wizard Style checkbox (on by default). When the Wizard generates a new code segment, it is inserted in the active Source Code file, in the appropriate section of the code.
Programming Device The device name used during code generation. This name may appear in a DEVCHAN definition, BUTTON_EVENT, PUSH, RELEASE or feedback assignment statements depending on the platform and options selected. From, To, Total The button range used during code generation. The range is 1 1000. You may change any of these values; the others will adjust automatically. A value of 0 (zero) in the From field will generate an "all button" handler.
Programming From, To, Total The channel range used during code generation. The range is 1 1000. You may change any of these values; the others will adjust automatically. A value of 0 (zero) in the From field will generate an "all channel" handler. In this case, code generation cannot support arrays. Array Name The array name used for generating DEVCHAN or INTEGER array for channel ranges.
Programming From, To, Total The level range used during code generation. The range is 1 - 1000. You may change any of these values; the others will adjust automatically. A value of 0 (zero) in the From field will generate an "all level" LEVEL_EVENT handler. In this case, code generation cannot support arrays. Note: The range setting (1-1000) affects the load placed on the CPU at compile time. Higher range settings may result in slower compile operations.
Programming Code Wizard Dialog - Send Command Tab The advanced options available for Send_Commands (in the Send Command tab of the Code Wizard dialog) are described below: Page Generate PAGE- page flip send command for touch panels. @T Generate @T variable text send command for touch panels. @BMF Generate @BMF variable text send command for touch panels. @PPN Generate @PPN- popup on send command for touch panels. @PPF Generate @PPF- popup off send command for touch panels.
Programming Syntax Highlighting When a source file is loaded in the editor, it is read line by line. Each line is broken up into its constituent words. Technically the line is broken into tokens, but the concept of a word is more familiar to most people. Different words and groups of words are handled differently. Here is a breakdown of the mechanism used: Comments Any portion of the line that initiates or falls within a comment is considered to be one comment (essentially it's treated as one big word).
Programming Use chroma-coding to make your code easier to read and manage. For example, you could chromacode all comments to yellow, all identifiers to red and strings to blue to make them more easily identifiable in your code file.
Programming With AutoComplete/AutoSuggest enabled, as you type in a variable name, device name or a reserved identifier, the program will suggest a name that has been previously defined within the source code. When the editor makes a suggestion, you may choose to accept the suggestion by hitting the TAB key (or a different keystroke as defined in the Keyboard tab of the Preferences dialog). However, if the suggestion is not what you intended, you may choose to have the editor display it's next suggestion.
Programming FIG. 14 Call Tips The Call Tip displays a list of parameters that are valid for the particular function you are adding (separated by commas), with the current parameter being entered in bold (DEV DECK in the example above). You may enable or disable this feature by toggling the Enable Call Tips checkbox in the Editor tab of the Preferences dialog.
Programming If the Enable Code Folding option has not been enabled, these two options are unavailable. Also note that the application will remember your last code folding settings when the file is closed, so they will still be in place the next you open the file (v2.4 or later). Unicode Characters To insert unicode characters into the active Source Code file, at the cursor's position: 1. Select Unicode Edit from the Edit Menu or the Source Code Editor Context Menu to access the Enter Text... dialog. 2.
Programming DEFINE_MODULE DEFINE_EVENT DEFINE_PROGRAM DEFINE_PROGRAM 4. The section heading is added at the cursor's position. Goto Section The Goto Section option allows you to jump to a particular section in your code. This option is available via the Edit Menu, the Source Code Editor context menu or the Edit toolbar. 1. Select Edit > Goto Section to access the Goto Section sub-menu. 2. Select the section that you want to jump to from the sub-menu.
Programming Case Inversion Use the case inversion tools in the Edit menu (or the Edit toolbar) to quickly switch selected characters in the Source Code Editor window: Make Selection Uppercase - Changes all selected characters in the file to uppercase. Make Selection Lowercase - Changes all selected characters in the file to lowercase. Invert Case - With text selected in the Source Code Editor window, click this option to invert the case of the selected text.
Programming 6. Click the Clipboard Text Buffer toolbar button to access a list of items in the Clipboard Text Buffer. 7. Click an item in the list to paste it into the active Source Code Editor window, at the cursor location. Find Matching Brace Select Edit > Find Matching Brace (or click the toolbar button) to quickly locate the second (matching) brace in a set.
Programming Delete Word deletes the current word at the cursor Delete Word Left deletes from the cursor to the start of the word Delete Word Right deletes from the cursor to the end of the word Delete Line deletes the current line at the cursor Delete Line Left deletes from the cursor to the beginning of the line Delete Line Right deletes from the cursor to the end of the line None of these commands have default keyboard hotkeys assigned.
Programming Undo/redo NetLinx Studio supports Undo and Redo functionality in the Source Code Editor: Click Edit > Undo (or click the toolbar button) to undo the last action. Click Edit > Redo (or click the toolbar button) to redo (repeat) the last action. Working With Bookmarks NetLinx Studio allows you to place bookmarks in your program files for quick navigation to key points in the code. Use the bookmarks commands in the Edit menu to create, jump to and clear bookmarks.
Programming To enter debug mode: 1. Open and compile a Source Code file (that contains at least one variable), if you have not already done so. The file must be successfully compiled before you can enter debug mode. 2. Choose Build > Debug (or click the toolbar button) to open the Watch window. If this option is disabled, make sure your Master Communications Port settings are set to connect to your Master Controller. 3. Right-click inside the Watch window to open the Watch Window context menu. 4.
Programming 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 view and edit the contents of variables within a compiled Axcess or NetLinx program. Also, you can control the execution through each pass of the mainline of a compiled Axcess or NetLinx program.
Programming FIG. 17 No Debug Symbols 2. File no longer matches: FIG. 18 File no longer matches If you've made any changes to the source file, including a re-save, you'll get a message similar to the one above. It can often be safely ignored, but select No if you've done any significant editing. 3.
Programming To execute the next line of code, right-click and choose Step Into. You'll see the execution pointer advance one line. If you no longer need to single step, right-click and choose Run. If you are not currently debugging, you won't see execution break until you start debugging (Debug > Start Debugging).
Programming Find Push Message Dialog Select Find Push Message from the Edit menu to open the Find Push Message dialog. This dialog displays a list of recent Push messages that were sent to the Master. Select a Push from the list, and click OK to locate the selected Push message code in the active file. Working With Unicode NetLinx Studio (v2.4 or higher) supports 16-bit Unicode characters.
Programming Defining a Unicode String Literal To enter Unicode characters into your program, enclose the characters in single quotes, like you would any other string, and wrap the string literal in the Unicode macro _WC. Example: _WC('Your string goes here') All Unicode string literals must be wrapped in the _WC macro. Failing to wrap a Unicode string in the _WC macro will result in a compiler error.
Programming Unicode - Character Case Mappings Converting between upper and lower case is accomplished by using the Unicode.org character database to determine the mapping between upper case and lower case characters. Not all Unicode characters have an upper or lower case equivalent; these characters will not be affected by WC_UPPER_STRING and WC_LOWER_STRING. Only the characters defined by Unicode.org as having an upper or lower case mapping are affected by these functions.
Programming fTemperature = 98.652 cMyString = FORMAT('The current temperature is %3.2f',fTemperature) -----------------------------------------------------------------------fTemperature = 98.652 cTempString = FORMAT('%3.2f',fTemperature) wcMyString = _WC('The current temperature is ') wcMyString = WC_CONCAT_STRING(wcMyString,CH_TO_WC(cTempString)) Unicode - Reading and Writing To Files The NetLinx Unicode library supports reading and writing of WIDECHAR arrays.
Programming Right-to-Left Unicode Strings Right-to-Left Unicode languages are stored in memory the same way left-to-right language are. The first memory position of an array contains the first logical character. You can access the rightmost character of a Right-to-Left Unicode string using this notation: wchChar = wcString[1] Right-to-left languages are not stored differently than left-to-right languages, they are simply rendered differently than right to left languages.
Programming Using the Terminal Window Select Tools > Terminal (or click the toolbar button) to open the Terminal window. The Terminal 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.
Programming ASCII / HEX / DECIMAL CONVERSIONS TABLE CHR NetLinx Studio (v2.
Programming 106 NetLinx Studio (v2.
Compile Operations Compile Operations Overview The options in the Build menu allow you to compile source code into executable code that the Axcess or NetLinx control system can understand. NetLinx Studio v2 has the ability to compile and link all the source code (.AXS and .AXI) files at the Workspace, Project, System or File level, plus the ability to compile a single file as either an Axcess or NetLinx type source code file.
Compile Operations 3. The status and results of the build are displayed in the Status tab of the Output Display Window. Building the Selected System You can select to build (compile) any System in the Workspace, using the Build System command. When you build a System, every Source Code, Include, and Module file contained in the selected System is compiled. The Build System command always works on the selected System, regardless of whether it is currently designated as the active system or not.
Compile Operations 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 an Individual File You can select to compile a single Source Code, Include, or Module file, using the Compile, Compile As NetLinx and Compile as Axcess commands (or toolbar buttons). To compile an individual file: 1.
Compile Operations Compiler Errors and Warnings These help topics contain information on the various types of errors and bugs common to programming, and some techniques for solving these problems. Note that Warnings will not automatically preclude a successful compile operation. By contrast, Errors must be corrected before your program can be compiled. Compiler Error Types There are three general types of programming errors: Compilation errors - Errors that occur at compile time.
Compile Operations Device values must be equal In a range specification, the devices (or their defined identifiers) must be equal. For example, ([1,1]..[1,5]) is valid; ([1,1]..[2,5]) is not. Duplicate symbol Duplicate definitions of variables or constants are found. All variables and constants must have unique identifiers. Evaluation stack overflow The expression is too complicated. Try breaking it up into smaller pieces.
Compile Operations String constant expected A string is required for the particular operation. This error occurs if a string literal enclosed in single quotes does not follow the PROGRAM_NAME keyword. String constant never ends, EOF encountered A string literal is started but never ends. Add a closing single quotation mark (') to the end of the string. String literal expected A string is required for the particular operation.
Compile Operations Compiler Warnings Sometimes the compiler generates a warning message instead of an error message; these warning messages always start with w. A warning about a particular statement means that the statement is not technically an error, but you should be careful doing it. Warnings, unlike errors, do not stop the program from compiling. Some types of warnings can be disabled in the Compiler Options tab of the Preference dialog.
Compile Operations Compiler Error Warnings Report Dialog This dialog is invoked via the Compiler Errors/Warning Report option in the Output Display Window Context Menu. Use the options in this dialog to specify what you want to include in the report (Errors, Warnings or both). By default, both Errors and Warning are included. Note that Warnings will not automatically preclude a successful compile operation. By contrast, Errors must be corrected before your program can be compiled.
Working With Online Devices Working With Online Devices NetLinx Network Setup In order for the NetLinx system to run on a network, the network settings must be configured for the target network. You will need to have detailed information about your network on hand before starting. In order for the NetLinx master to operate correctly, it must have the IP address, subnet mask, gateway address, domain name and name server addresses according to the Network Administrator-supplied values.
Working With Online Devices Enter your Gateway. This value determines a path to computers not on your network. If you did not receive a value for this, enter your IP address. Do not leave this blank. Enter your Domain Suffix. If you did not receive a value for this, leave it blank. Enter up to 3 DNS IP. This values help your master find other network resources. If you did not receive a value for these, leave them blank. Press Set IP Info, followed by Set DNS Info and then press Reboot.
Working With Online Devices The online devices are organized according to the System they belong to. Double-click any System folder to display a list of System devices (and their firmware version) that are currently online. Double-click any online device in the list to display the ports and sub-devices associated with the device. Sub-devices are hardware components contained within a parent device, which may require their own firmware.
Working With Online Devices results of this status check are indicated in the Status tab of the Output Window (see FIG. 24 on page 120). Devices: The elements below the Master Controller in the device tree represent devices in the system. These elements indicate the device number, device name and the device firmware version currently loaded (FIG. 23): FIG. 23 Online Device Tree - Device element Click the plus sign to expand the view to show sub-devices and ports on the Master.
Working With Online Devices • Found: A device is "Found" if the device has been bound to a NetLinx Master and is communicating with that NetLinx Master. Found devices inherit the System Number of the NetLinx Master it is "Found" by. If the device has been configured with a valid Device Number, it will communicate with the NetLinx Master as that Device Number.
Working With Online Devices Device:Port:System information for the selected device FIG. 24 Example result of Check Port Status (displayed in the Status tab of the Output window) Binding/Unbinding Devices The Unbound Devices folder in the device tree (FIG. 20) indicates all devices in the system that are not currently bound to a Master. These are "orphan" devices, until they are assigned to communicate to a specific Master.
Working With Online Devices 3. By default, the selected device is displayed in the Device to Bind/Unbind window at the top of the dialog. If there is more than one Unbound device in the system, click the down arrow to select which device you want to bind. 4. Check the checkbox next to the Master that you want to bind the device to. If there is more than one Master in the system, check the specific Master that you want to bind the device to. 5. Select Refresh System (in the Device Tree context menu).
Working With Online Devices To set the selected set of notifications as the default notifications for this device, click the Set As Defaults button. Once you set the default notifications, you can use the Use Defaults button to recall the default set. 5. Click OK to close the NetLinx Notification Properties (Add) dialog and return to the NetLinx Device Notifications Options dialog. The new target device specified has its own line in the notifications list.
Working With Online Devices Removing Devices From The Notifications List 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 from the list and click the Remove command button. The program will not allow you to remove the All Devices (0:0:0) listing.
Working With Online Devices The SEND_STRING 0 message is obviously completely customizable - whatever is typed in will be what you are going to get. This can be used as a way to see the value of variables at specific points in the code, by sending that information from that point, instead of stopping execution with a breakpoint.
Working With Online Devices STR1 is a header sent with each line - this is a good place to use DEV_TO_STRING. STR2 is data. Data bytes < $20 (ASCII control codes) and > $7E (~) are formatted as hex and separated by commas. As of v2.01, 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.
Working With Online Devices 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; otherwise, use 0 for the defaults. 12.
Working With Online Devices STR1 is a header sent with each line - this is a good place to use DEV_TO_STRING. STR2 is data. All data bytes are formatted as hex and separated by commas. As of v2.01, a space ($20) is no longer added between STR1 and STR2. 16. CALL 'STRING TO DEV' (Txt[], dvDEV) Takes ASCII string Txt[] of the form '' or '::' and stores this as a DEV. The dev data in Txt[] can be embedded in other non-numeric characters.
Working With Online Devices 3. To emulate a channel (push/release), enter a valid Channel number to emulate Channel messages (i.e., Push/Release, CHON, and CHOFF) for the specified in the Channel 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.
Working With Online Devices It is recommended that you enable NetLinx Notifications to view the results in the Notifications tab of the Output Display window. For example, in order to view a string sent to a device (via the Emulate Device dialog), you must first enable the Strings to Device notification (in the NetLinx Device Notifications Options dialog). Additionally, to view any strings returned from the device, you must enable the Strings From Device notification.
Working With Online Devices 5. To emulate sending a String or Command, type a String or Command in the Message(s) To Send text box. Use the Return 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.
Working With Online Devices NetLinx Diagnostics - Netlinx Device Addressing Use the Device Addressing dialog to change the Device and System assignments for a specified NetLinx device, or to change a NetLinx Master's System number. Select Device Addressing from the Diagnostics menu, the Online Device context menu, or click the toolbar button to access this dialog.
Working With Online Devices Restoring The Default Device and System Numbers On A Netlinx Device Use the Device Addressing dialog to restore the default Device and System numbers on a NetLinx device: If the target Master has security applied, NetLinx Studio will prompt you for a User Name and Password in order to change these settings. 1. Select the target device/system in the Online Device Tree. 2. Right-click to access the Online Tree context menu. 3. Select Set Device/System to Factory Default.
Working With Online Devices NetLinx Diagnostics - URL Lists Use the URL Listing dialog to create a URL List for the specified master. The URL List identifies all NetLinx devices present in the same System as the Master that you are connected to. You must enter a URL for each device in the System before you can use ID Mode on other devices. Only devices defined in the URL list will appear in the On-line device tree (with the exception of the Master that you are connected to). Creating a URL List 1.
Working With Online Devices NetLinx Diagnostics - Network Addressing Use the options in the Networking Addresses dialog to change the network settings for a specified NetLinx master. If the target Master has security applied, NetLinx Studio will prompt you for a User Name and Password in order to change these settings. Changing the System Number On a Netlinx Master Use the System field in the Network Addresses dialog to change the System number for the connected Master: 1.
Working With Online Devices NXI masters are always set to Device = 0. 3. Click Get DNS Information to populate the DNS Address fields with the current Domain Suffix, DNS IP Address #1, DNS IP Address #2 and DNS IP Address #3 assignments (as applicable). 4. Edit the DNS Address assignments and/or add new DNS address information as needed. 5. Click Set DNS Information to set the new DNS address assignments. Setting the IP Address For a NetLinx Master 1.
Working With Online Devices Changing the IP Address On a Netlinx Master (Specify IP Address) 1. Select Diagnostics > Network Addresses (or click the toolbar button) to access the Network Addresses dialog. 2. Enter the specified master's System number in the System text box at the top of the dialog. The range is 0-65535. 3. Click the Get IP Information button to populate the IP Address fields with the current Host Name, IP Address, Subnet Mask and Gateway assignments. 4.
Working With Online Devices Rebooting the Master Select to access the Reboot the Master Controller dialog. Use the options in the Reboot the Master Controller dialog to reboot a specified master controller: 1. The left side of this dialog lists the Projects and Systems that are included in the currently open workspace. By default, the currently active System is highlighted, as shown below. The Master specified in the active (highlighted) System is the one that will be rebooted. 2.
Working With Online Devices 3. Right-click inside the Watch window to open the Watch Window context menu. 4. Click Add to insert a new variable in the Watch window. A box appears in the window, with a cursor blinking in the Name column. 5. Type the syntax of the variable exactly as it is defined in the code and press the Enter key. The value of the specified variable appears next to the variable (in the Value column). 6.
Working With Online Devices Step Mode Enable/Disable Step mode causes the Interpreter to break after each execution of the mainline. Watch variables are always updated after each pass through mainline. To continue program execution while in Step mode, you must invoke the "Step" command again. Single Step Execute one line of a source code file at a time for a NetLinx master controller or execute one pass through the mainline code for an Axcess controller.
Working With Online Devices 140 NetLinx Studio (v2.
Communications and File Transfers Communications and File Transfers Configuring Default Communications Settings The Master Communication Settings dialog contains options that allow you to specify the default communication settings for NetLinx Studio. The default settings will be used when there is not a Workspace file open, or when the open Workspace does not have an active System. To set the default communication settings: 1.
Communications and File Transfers Alternatively, you can access these option via the Set Default Communication Settings with the IP option in the Network Addresses dialog. Configuring System-Level Communications Settings The Master Communication Settings dialog contains options that allow you to specify System-level communication settings. Each System can have its own dedicated communication settings. These System-level settings override the default communications settings.
Communications and File Transfers Some combinations of settings may result in truncation in the Settings display text field (indicated by an ellipsis). If this is the case, simply hover the mouse cursor over the Settings display text field to view the full description. 7. Click OK to close the Communication Settings dialog. 8. Click OK to close the Master Communication Settings dialog.
Communications and File Transfers Setting the Default Control Platform You can set the default control platform and communication settings via the Configuration settings in the Master Communication Settings dialog: 1. Select Settings > Master Communication Settings to open the Master Communication Settings dialog. 2. Select in the Available System(s) list.
Communications and File Transfers 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). As indicated in the Virtual NetLinx Master dialog, changes made to the system number field will not take effect until all communications are stopped and restarted. 5. Click OK to return to the Communication Settings dialog. 6. Click OK to save the new VNM communication settings with the selected file.
Communications and File Transfers Connecting To a NetLinx Master Via Serial Port To connect to a NetLinx master, use the options in the Master Communication Settings and Communication Settings dialogs to specify the serial port settings. These instructions in these topics assume that the physical link between the PC running NetLinx Studio and the NetLinx master is established. 1. Select Settings > Master Communication Settings to open the Master Communication Settings dialog. 2.
Communications and File Transfers 6. Select a COM port and specify the communication settings for modem communications. The default settings are: Comm Port COM1 Baud Rate 38400 Data Bits 8 Parity None Stop Bits 1 Flow Control None Phone Number Enter the telephone number 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.
Communications and File Transfers If you don't connect: Verify that the master is set for ICSP Connectivity, with Require Encryption enabled (via the Master's built-in interface). Refer to the Master's documentation for details on enabling/disabling security. Connecting To an Axcess Master To connect to an AXCESS master, use the options in the Master Communication Settings and Communication Settings dialogs to specify the serial port or modem settings, depending on the transport connection type specified.
Communications and File Transfers transport connection type specified. These instructions in these topics assume that the physical link between the PC running NetLinx Studio and the NetLinx 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 Modem as the Transport Connection Option. 5.
Communications and File Transfers IR library files (.IRL/.IRV) are sent to IR-controlled devices on the bus, or directly to a System device (i.e. Touch Panels). The Virtual NetLinx Master option allows you to transfer files directly to G4 devices, without the need for an intermediate NetLinx Master. The File Transfer dialog (Tools > File Transfer) provides an easy to understand approach to file transfer while still providing a high level of flexibility.
Communications and File Transfers File Transfer Status Information Once you have started a file transfer operation, the following types of status information are displayed in the File Transfer Status tab of the Output Display window: Type The type of transfer (sending or receiving). Status The current state of the transfer (Pending, Transferring, Complete or Failed). Connection The communications settings used to establish communication with the target device.
Communications and File Transfers Step 1: Adding Files To The Transfer Queue Before files can be sent to or received from system devices, they must first be added to the Transfer Queue in either the Send or Receive tab. Using The Quick Load Dialog Use the options in the Quick Load dialog to specify which file types (of the files included in a selected Workspace file) to add to the Files To Send queue. The Quick Load dialog is not used for receiving files.
Communications and File Transfers Adding Files To The Files To Send Queue There are several possible approaches to adding files to the Files To Send List (Send tab). Add some or all of the files contained in a Workspace file or a Workspace-To-Go file. Add individual systems (see Supported File Types list). Notes: The file types that are available for selection depend on the selected Platform (Axcess or NetLinx), Send/Receive selection and Communication settings.
Communications and File Transfers This dialog contains two tabs: Existing and Recent. Use the Existing tab to locate and select the desired file, with the ability to navigate through all available local and network drives. The Recent tab contains a listing of the most recently used files (of all types). 3. Locate and select the Workspace file that contains the Project/System with the file(s) you want to add, and click Open. This opens the Quick Load dialog. 4.
Communications and File Transfers 3. Select the type of file that you want to add to the Transfer List. 4. Click the Add button. This invokes the Open dialog, with the Files of Type selection already set to the selected file type. 5. In the Open dialog, locate and select the file that you want to add. 6. Click Open to add the selected file to the Files To Send queue. Adding Files To The Files To Receive Queue IR files cannot be received from Axcess Master controllers.
Communications and File Transfers Step 2: Communication Settings Use the options in the Master Communication Settings dialog to set the communication settings for connecting to a NetLinx or Axcess master controller. A connection can be made to a NetLinx master controller via TCP/IP, Serial-RS232, Modem. A connection can be made to a Axcess master controller via Serial-RS232 or a Modem.
Communications and File Transfers c. By default, the program is set to automatically ping the master controller to ensure availability. De-select this option if desired. The Port should always be set to 1319 (default setting). Do not change the Port assignment. d. Click OK to return to the Communication Settings dialog. 6. Click OK to save the new TCP/IP communication settings with the selected file. Configuring Serial Communication Settings With a Transfer selected in the Transfer List: 1.
Communications and File Transfers Stop Bits 1 Flow Control None Phone Number Enter the telephone number of the master. 6. Click OK to return to the Communication Settings dialog. 7. Click OK to save the new Modem communication settings with the selected file. Configuring Virtual Netlinx Master Communication Settings (Netlinx Only) 1. Click the Edit command button, and select Communication Settings to open the Communication Settings dialog. 2. Select NetLinx Master as the Platform Selection. 3.
Communications and File Transfers 9. After several seconds, the panel should appear in the online device tree, listed as Virtual NetLinx Master. Once you can see the device online, you may transfer panel files directly to and from the G4 device.
Communications and File Transfers Receiving Files Directly From A System Device (Serial Connections Only) To receive files directly from a system device (Serial connections only): 1. In the Receive tab, click to select a file in the Files to Receive queue. 2. Click Edit to open the Edit menu and select Device Mapping. This opens the Enter DPS dialog. 3. Enter the Device:Port:System (D:P:S) information for the selected file. 4. Check the Connect directly to the device - No Master... option. 5. Click OK.
Communications and File Transfers Configuring the Touch Panel for Virtual NetLinx Master USB Transfers Connect the Panel to Your PC Via USB: 1. Apply power to the panel by plugging in the power supply. 2. Wait for the splash screen to disappear, then use a (Type A) USB cable to connect the panel to an available USB port on your PC. Plug the USB cable into the panel first, then connect to the PC. Configure the Panel for USB Virtual NetLinx Master Transfers: 1.
Communications and File Transfers b. Click the Communication Settings button to access the Communication Settings dialog. c. Select Virtual NetLinx Master as the Transport Connection Option. d. Click OK to close this dialog. e. Click OK to close the Master Communication Settings dialog. Configuring NetLinx Studio for Virtual NetLinx Master Transfers 1. Select Settings > Master Communications to open the Master Communication Settings dialog. 2.
Communications and File Transfers 5. Select the desired file and click OK to close this dialog and invoke the Enter Device Mapping Information dialog. 6. Review the mapping information, and click OK to return to the Select Files for File Transfer dialog. 7. Click OK to return to the File Transfer dialog, where the new file should appear in the Files to Send list. 8. Click inside the checkbox to the left of the file you just added.
Communications and File Transfers 9. After several seconds, the panel should appear in the online device tree, listed as Virtual NetLinx Master. Once you can see the device online, you may transfer panel files directly to and from the G4 device. Configuring Netlinx Studio For Virtual Netlinx Master Tcp/ip Transfers 1. Select Settings > Master Communication Settings to open the Master Communication Settings dialog. 2.
Communications and File Transfers 8. Click inside the checkbox to the left of the file you just added. Keep in mind that any files with a checkmark will be included in this transfer. Note that the Connection column indicates that the file you just added is using Virtual NetLinx Master. 9. Click the Send button to begin the transfer. Firmware Transfers NetLinx Studio provides the ability to transfer KIT and TSK firmware files to a NetLinx or Axcess master controller.
Communications and File Transfers Click the Send button to send the selected KIT file to the specified device. You can watch the progress of the transfer in the "Send to NetLinx Device" dialog. When the transfer is finished, and the reboot is complete, press the Close button. If the device is a NetLinx Master or NXI, then the Reboot option is valid. Other NetLinx devices need to be given the command to reboot (if they support it). Allow 20-30 seconds for NetLinx Masters to reboot.
Communications and File Transfers Netlinx Master Security NetLinx Studio (v2.3 or higher) supports security for NetLinx Masters, via the Authentication Required option in the Communication Settings dialog. Before you can enable/disable NetLinx security on a Master through NetLinx Studio, you must verify the following: The target Master has been loaded with firmware that supports security. This means that the Master must have Master Firmware version 304 (or higher) to support this functionality.
Communications and File Transfers 2. Verify that you have connected to the desired Master by checking the information in displayed in the Configuration window. 3. Click the Communication Settings command button to access the Communication Settings dialog. 4. Click to select the Authentication Required option. This enables the User Name and Password command button. 5. Click the User Name and Password button to access the Master Controller User Name and Password dialog. 6.
Communications and File Transfers When you apply security to an individual file transfer operation (as described below), the individual file's security settings will be overridden by the security set for the target Master.
Communications and File Transfers 5. Click on User Name and Password to enter the User Name and Password that are set for this NetLinx Master (in the Master Controller User Name and Password dialog). These are case sensitive. 6. Click OK to close the Master Controller User Name and Password dialog. 7. Click OK to close the Communication Settings dialog. 8. Click OK to close the Master Communication Settings dialog. At this point you should be able to connect to the Master.
Setting Program Preferences Setting Program Preferences Overview Select Settings > Preferences to open the Preferences dialog, where you can set various application-level preferences. Preferences Dialog - General Tab Use the options on the General tab of the Preferences dialog to set general program defaults.
Setting Program Preferences • Assigning a two-dimensional array to a one-dimensional array, or vice versa. • Assigning the result of a function that returns an array type to a non-array variable or to a two-dimensional array variable (for example, X = ITOA(12), where X is a nonarray variable or two-dimensional array variable).
Setting Program Preferences populated with the directories of that type that have been mapped. There are a maximum of 100 directories that can be entered for each type. Select Include Files to select or create the directory that the compiler will look for Include files in. Select Library Files to select or create the directory that the compiler will look for (IR) Library files in.
Setting Program Preferences Preferences Dialog - Editor Tab Use the options on the Editor Options tab of the Preferences dialog to set default preferences for the Source Code Editor windows. The items in this tab include: Syntax Highlighting - These options allow you to customize syntax highlighting within the Source Code Editor windows.
Setting Program Preferences Background Color - This is the background color setting for the selected Item. Click the down arrow to select a different color from a palette. Click the More Colors button on the color palette to access the advanced color selection palette. Apply to All - Use this option to apply the selected background color to all items in the Selections list. Text Color - This is the text color setting for the selected Item. Click the down arrow to select a different color from a palette.
Setting Program Preferences Enable Indentation Guides - This option causes the program to draw vertical lines indicating the tab stops in the Source Code Editor window (default = enabled). Note that indentation guides only appear if there are tabs present in the code. Enable Call Tips - This option enables the Call Tips function. Call Tips assist you with adding declared functions by displaying a list of parameters that are valid for the particular function you are adding.
Setting Program Preferences Importing/Exporting Editor Preferences Use the Import Editor Preferences and Export Editor Preferences options in the Tools menu to import/export the current Source Code Editor preferences, as they are defined in the Editor tab of the Preferences dialog: To export the current Editor Preferences, as a *.EPX file: 1. Select Tools > Export Editor Preferences. 2. In the Save As dialog, specify a name and target directory for the resulting *.EPX file, and click OK.
Setting Program Preferences Creating Custom Toolbars Use the options on the Commands tab of the Preferences dialog to create custom toolbars: 1. Select Settings > Preferences to open the Preferences dialog. 2. In the Toolbars tab, click New. 3. Enter a name in the Toolbar Name dialog, and click OK. 4. The new toolbar appears in the Toolbars list, and the new (empty) toolbar appears within the Toolbars list area of this tab. 5. Click and drag the new toolbar into the work area. 6.
Setting Program Preferences arrow button (to the right of the Arguments text box) to access a list of arguments supported by the specified application. To use arguments, you need to be familiar with the capabilities of the application you are adding. Consult the program's manufacturer for details on argument support. Initial Directory - This option allows you to specify the initial directory for the specified application to open by default when the program is launched.
Setting Program Preferences Assign - Click to assign the newly specified keyboard shortcut to the selected command. This button is only enabled if a command is selected, and new shortcut keys have been entered in the Press New Shortcut Key text box. Remove - With a command selected (in the Commands list), click Remove to remove the associated keyboard shortcut. Reset All - Click to reset all keyboard shortcuts to the defaults.
Setting Program Preferences Source View Text View FIG. 30 Context menu options Customizing The Menus Use the options on the Commands tab of the Preferences dialog to customize menus, and reset the menus to their original default state. To customize a menu: 1. Select Settings > Preferences to open 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.
Setting Program Preferences Preferences Dialog - Diagnostics Tab Use the options on the Diagnostics tab of the Preferences dialog to set default diagnostics preferences. The items in this dialog include: Notification View - Use this set of options to set default display preferences for the Notification tab of the Output Display Window. Display Line Numbers - Toggles the display of line numbers in asynchronous notification displays (default = enabled).
Setting Program Preferences disk. Your TEMP or TMP environment variables are used to determined the drive used for the two buffer files. Available Disc Space on drive c - this read-only field indicates the current amount of free disc space available on your local hard disc (c:). Use this number as reference if you are increasing the buffer file size. Preferences Dialog - Terminal Tab Use the options on the Terminal Options tab of the Preferences dialog to set default Terminal window preferences.
Setting Program Preferences Preferences Dialog - Workspace Tab Use the options on the Workspace tab of the Preferences dialog to set various display and file preferences relating to the Workspace Window. The items on this tab include: Restore Workspace On Startup - This option (on by default) automatically restores the workspace file upon startup of the application.
Troubleshooting Troubleshooting NetLinx Debugger Not Stopping On A Breakpoint Symptoms A breakpoint is set on a line of code, but the code does not stop execution on this line. The line of code in question contains a SEND_COMMAND, SEND_STRING, or SEND_LEVEL. Cause The debugger will not stop on a line of code 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.
Troubleshooting NetLinx Master Error - Device_ID Error When calling DEVICE_ID, this run time error can occur: CIpLibrary::Device_ID - Error 1 This error is cause by passing a parameter that is not of type DEV to the DEVICE_ID keyword. This usually occurs when converting AXCESS code to Netlinx. To fix this error, try the following: Look for all references to the DEVICE_ID function Make sure the value passed to the function is of type DEV.
Index NetLinx Studio (v2.
ARGENTINA • AUSTRALIA • BELGIUM • BRAZIL • CANADA • CHINA • ENGLAND • FRANCE • GERMANY • GREECE • HONG KONG • INDIA • INDONESIA • ITALY • JAPAN LEBANON • MALAYSIA • MEXICO • NETHERLANDS • NEW ZEALAND • PHILIPPINES • PORTUGAL • RUSSIA • SINGAPORE • SPAIN • SWITZERLAND • THAILAND • TURKEY • USA ATLANTA • BOSTON • CHICAGO • CLEVELAND • DALLAS • DENVER • INDIANAPOLIS • LOS ANGELES • MINNEAPOLIS • PHILADELPHIA • PHOENIX • PORTLAND • SPOKANE • TAMPA 3000 RESEARCH DRIVE, RICHARDSON, TX 75082 USA • 800.222.
