Page of 230

Amx NetLinx Studio Instruction Manual

Netlinx design v3.3 or higher.
I n s t r u c t i o n M a n u a l
NetLinx Studio
®
NetLinx Design
(v3.3 or higher)
D e v e l o p m e n t T o o l s
L a s t R e v is e d : 7 / 0 2 / 2 0 1 3

   Related Manuals for Amx NetLinx Studio

   Summary of Contents for Amx NetLinx Studio

  • Page 1

    I n s t r u c t i o n M a n u a l NetLinx Studio ® NetLinx Design (v3.3 or higher) D e v e l o p m e n t T o o l s...

  • Page 2

    6. LIMITED WARRANTY; RETURN, REPAIR AND REPLACEMENT 6.1 AMX warrants the Products to be free of material defects in materials and workmanship under normal use for three (3) years from the Shipping Date (or such other period as may be specified below), subject to the following limitations and exceptions (“Limited Warranty”).

  • Page 3: Table Of Contents

    Table of Contents Table of Contents NetLinx Studio (v3.3 or higher) ................1 Overview ........................1 Supported OSs and Minimum PC Requirements............1 Supported Operating Systems ..................1 Supported OS Languages ....................1 PC Requirements:......................2 Networking Requirements ....................2 Other PC Requirements ....................2 Supported File Types ......................

  • Page 4: Table Of Contents

    Removing a File from a System................33 Viewing and Editing System Properties..............34 Building (Compiling) Systems.................. 34 Working with System Files ................35 Overview ........................ 35 Identifiers vs. Disk Filenames .................. 35 Creating New System Files ..................36 NetLinx Studio - Instruction Manual...

  • Page 5: Table Of Contents

    Adding an Existing IR File to a System ................62 Working with IREdit Database (*.irn) Files..............63 Adding an IR File from the AMX IR Database ............... 63 Adding an IR File from a User Database (*IRN) File............64 Working with "Other" Files ..................65 Creating a Standard Text (.txt) File ................

  • Page 6: Table Of Contents

    Syntax Highlighting ....................80 Default Syntax Highlighting Colors ................81 AutoComplete and AutoSuggest................81 Call Tips ........................82 Using the Code Wizard ................... 83 Code Wizard - Creating Button Events................83 Code Wizard - Creating Channel Events................ 85 NetLinx Studio - Instruction Manual...

  • Page 7: Table Of Contents

    Right-to-Left Unicode Strings ..................102 Sending Strings to a User Interface................102 Working with Macros .................... 103 Recording a Macro ...................... 103 Saving NetLinx Studio Macro Files (*NSM)..............103 Playing a Macro ......................104 Selecting Macros ......................104 Building and Debugging Source Code ............105 Overview - Building (Compiling) Code ..............

  • Page 8: Table Of Contents

    Via the Master Communication Settings dialog ............132 Via the System Properties dialog ................133 NetLinx Master Security..................134 Connecting to a Secured NetLinx Master..............134 If You Don't Connect....................134 Connecting to an Axcess Master................135 NetLinx Studio - Instruction Manual...

  • Page 9: Table Of Contents

    Adding Workspace Files via the "Select Files for File Transfer" dialog....... 151 System Files - Prerequisites for Transfer Operations .............. 152 Adding Orphan Files ....................152 Adding Workspace Files via Quick Load ..............155 File Transfer List Files ....................156 Creating File Transfer List Files....................156 NetLinx Studio - Instruction Manual...

  • Page 10: Table Of Contents

    Connect the Panel to Your PC Via USB ................... 161 Configure the Panel for USB Virtual NetLinx Master Transfers..........161 AMX USB LAN Software for USB Enabled G4 Panels ............. 161 Installing the AMX USB LAN Application................161 MVP-5200i USB Driver ......................161 Transferring Files Using a Virtual NetLinx Master USB Connection......

  • Page 11: Table Of Contents

    Preferences dialog - Terminal - Telnet Windows tab ..........206 Preferences dialog - File Transfer tab ..............207 Preferences dialog - Diagnostics tab ..............208 Preferences dialog - Online Tree - Zero Config tab ..........209 NetLinx Studio - Instruction Manual...

  • Page 12: Table Of Contents

    Adding Commands to Existing Menus ................ 215 Associating an Icon with a New Command ................215 Adding a Command to a Context Menu ................. 215 Removing Commands from Existing Menus................216 Customize dialog - Options tab................... 216 NetLinx Studio - Instruction Manual...

  • Page 13: Netlinx Studio (v3.3 Or Higher), Overview, Supported Oss And Minimum Pc Requirements, Supported Operating Systems

    NetLinx Studio (v3.3 or higher) NetLinx Studio (v3.3 or higher) Overview NetLinx Studio is a 32-bit Windows® application for programming and maintaining entire control systems. NetLinx Studio supports both NetLinx and Axcess system programming. FIG. 1 NetLinx Studio v3.3 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.

  • Page 14: Pc Requirements, Networking Requirements, Other Pc Requirements, Supported File Types, Associated Amx Software, Webupdate

    The PC on which NetLinx Studio is installed must have internet connectivity for the purpose of application updates  The PC on which NetLinx Studio is installed must have either IP network connectivity or COM port (RS-232) connectivity to the target master for the purpose of transferring system files to the control systems. Other PC Requirements ...

  • Page 15: Amx-pi (product Information), Dip Switch 2.0, Netlinx Studio Work Area, Title Bar

    Refer to the DIP Switch 2.0 on-line help file for details and instructions. NetLinx Studio Work Area 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. 2).

  • Page 16: Menu Bar, Toolbars, Workspace Bar

    FIG. 4 Menu Bar If you are running NetLinx Studio in Windows 2000, NT or XP, you may have to press the ALT key to view the menu item hotkeys. The menus can be customized via options in the Customize dialog (refer to the Customize dialog - Menu tab section on page 214 for details).

  • Page 17: Editor Windows

    61.  Zero-Config tab - Displays a listing of all Masters on the LAN to which the PC running NetLinx Studio is connected. See Zero-Config Networking on page 144. Click View > Workspace to toggle (show/hide) the Workspace Bar.

  • Page 18: Output Bar, Watch Bar

    NetLinx Studio (v3.3 or higher) Output Bar There are 6 tabs contained in the dockable Output Bar (FIG. 8). FIG. 8 Output Bar  Status tab - Displays build information pertaining to the last compilation of source code files, as well as port status information.

  • Page 19: Status Bar

    NetLinx Studio (v3.3 or higher) The Watch Bar is a dockable window in which you can view and edit the contents of variables within a compiled program. Also, you can control the execution through each pass of the mainline of a compiled program. Once you select Start Debugging, additional options in the Debug menu become available (see Master Controller Debug Options section on page 111).

  • Page 20: Understanding Workspaces, Projects And Systems, Workspaces, Projects

    Workspace Bar - Workspace tab - Project Folder NetLinx Studio allows you to copy and paste Projects within the Workspace; in the case that you need to create several similar Projects you can quickly generate multiple Projects and modify each one as necessary.

  • Page 21: Systems, System Files

    A control system uses several different types of files, including Source, Include, Module, User-Interface, IR and Other files (FIG. 14). FIG. 14 Workspace Bar - Workspace tab - System Files The System file types recognized by NetLinx Studio are described in the Working with System Files section on page 35. NetLinx Studio - Instruction Manual...

  • Page 22: What's New Dialog

    NetLinx Studio (v3.3 or higher) What's New dialog This dialog (FIG. 15) is displayed when NetLinx Studio is launched, and provides a (read-only) text file describing features that are new to this release. FIG. 15 What's New dialog  To prevent this dialog from appearing every time the program is launched, select Don't Show Me Again.

  • Page 23: Working With Workspace Files, Overview, Creating A New Workspace File, Using The Workspace Wizard

    A Workspace contains one or more Projects. Each Project in turn can contain multiple Systems. Once created, you can re-open that Workspace file to recall the NetLinx Studio workspace exactly as it was when the Workspace file was created, including the Projects, Systems (and all related files) it contains.

  • Page 24

    Specify the target location for the Workspace file in the text box, or click the Browse (...) button (to the right of the text box) to locate and select a target directory via the Browse For Folder dialog. Click Next to proceed to the Project Identifier dialog (FIG. 21). NetLinx Studio - Instruction Manual...

  • Page 25

    Use the option buttons to select which type of System to add to the Project (NetLinx or Axcess). This dialog also includes the option to add the System later, in which case the Workspace Wizard is complete. Select either NetLinx or Axcess, and click Next to proceed to the System Information dialog (FIG. 24). NetLinx Studio - Instruction Manual...

  • Page 26

    To associate a System ID to the new System, enter the System ID in the text box. By default the ID is set to zero (0 = this System). Click Next to proceed to the System Communications dialog (FIG. 27). This dialog displays the current Master Communication Settings (read-only). NetLinx Studio - Instruction Manual...

  • Page 27

    FIG. 28 Communication Settings dialog These settings become the default communication settings for all new Workspace files until they are manually changed. Click Next to proceed to the Master Source Code File Selection dialog (FIG. 29). NetLinx Studio - Instruction Manual...

  • Page 28: Create An Empty Axs File

    Click Source Code File Description to enter a 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. Click Next to proceed to the New File Location dialog (FIG. 31). NetLinx Studio - Instruction Manual...

  • Page 29: Add An Existing Axs File To The System, Create An Axs File Using Templates

    Step 9. This option results in a Source Code file that is formatted with header/footer information and all of the main sections of a typical Source Code File of the selected type: Click Next to proceed to the File Template dialog (FIG. 33). NetLinx Studio - Instruction Manual...

  • Page 30: Creating A New (empty) Workspace

    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 (FIG. 34). FIG. 34 Workspace tab indicating an empty Workspace NetLinx Studio - Instruction Manual...

  • Page 31: Opening Workspace Files, Saving The Workspace (*.apw) File, Closing Workspace Files

    In the Open Workspace dialog, locate and select the Workspace (.APW) file which contains the Project you want to import. In the Import Components From a Workspace dialog, use the check boxes to select which Project(s) contained in the specified Workspace file you want to import (FIG. 36). NetLinx Studio - Instruction Manual...

  • Page 32: Removing A Project From The Workspace

    Click to select the Project that you want to remove (in the Workspace tab of the Workspace Bar). Select Remove Project from the Project menu. When prompted, click Yes to confirm that you want to remove the selected Project. NetLinx Studio - Instruction Manual...

  • Page 33: Exporting Workspace Files "to Go" (for Distribution)

    Select Include Module Files that are not part of the Workspace to include AXS (*.TKO) and Duet (*.jar) Module files that are needed for a successful NetLinx compile and link, but have not been added to the Workspace. NetLinx Studio - Instruction Manual...

  • Page 34: Importing From Exported Workspace Files

    Select Project > Import From Exported Workspace File to access the Select AXW File dialog. Locate and select the desired AXW file, and click Open. This invokes the Import From AXW File dialog (FIG. 40). FIG. 40 Import From AXW File dialog NetLinx Studio - Instruction Manual...

  • Page 35: Viewing And Editing Workspace Properties, Backing Up The Workspace, Building The Workspace

    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.

  • Page 36: Setting Workspace Preferences

    Use the options on the Workspace tab of the Preferences dialog to set various display and file preferences relating to the Workspace Bar See the Preferences dialog - Workspace tab section on page 204 for details. NetLinx Studio - Instruction Manual...

  • Page 37: Working With Projects, Overview, Opening Projects, Adding An Existing Project To The Workspace

    Working with Projects Working with Projects Overview A Project in NetLinx Studio contains one or more Systems. Projects are represented by Project folders in the Workspace tab (FIG. 42). FIG. 42 Workspace Bar - Workspace tab - Project Folder Note: You can copy and paste Projects within the Workspace to create several similar Projects, and modify each one as necessary.

  • Page 38: Copying And Pasting Projects, Importing A Project

    Fill in the other fields and click OK to save changes and close this dialog. The Project appears in the current Workspace, with the new Identifier. Importing a Project See Importing from Exported Workspace Files on page 22. NetLinx Studio - Instruction Manual...

  • Page 39: Viewing And Editing Project Properties, Removing A Project From The Workspace

    Click to select the System that you want to remove (in the Workspace tab of the Workspace Bar). Select Remove System from the Project menu. When prompted. click Yes to remove the System. Building the Project See Building the Selected Project on page 105. NetLinx Studio - Instruction Manual...

  • Page 40

    Working with Projects NetLinx Studio - Instruction Manual...

  • Page 41: Working With Systems, Overview, System Status: Active Vs. Inactive, Designating The Active System

    If there is an active connection to a master controller when you 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 active System’s communication settings. NetLinx Studio - Instruction Manual...

  • Page 42: Creating A New System

    Edit TCP/IP Setting dialog. See the Editing a TCP/IP Address section on page 127 for details. Serial - Select the Serial option button, and use the Serial Connection Options to select a COM port and specify the settings for serial port communications (FIG. 50). NetLinx Studio - Instruction Manual...

  • Page 43: Adding An Existing System To A Project, Importing Systems Into A Project

    Click Open to access the Import Components From a Workspace dialog (FIG. 51). FIG. 51 Import Components From a Workspace dialog Check each System that you want to import, and click OK to add the selected System(s) to the Project. NetLinx Studio - Instruction Manual...

  • Page 44: Copying And Pasting Systems, Adding A File To A System

    Copying and Pasting Systems NetLinx Studio allows you to easily copy and paste Systems (and all 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.

  • Page 45: Drag And Drop Files Into A System, Removing A File From A System

    Removing a File from a System Since all files are linked in NetLinx Studio, when you remove a file from a System, the file is not deleted from the disk, only removed from the System. If the same file is used in multiple Systems in the open Workspace, the Remove File from System option only removes the file from the selected System (as opposed to all instances of the file in the Workspace).

  • Page 46: Viewing And Editing System Properties, Building (compiling) Systems

    Displays the current communications settings for this System. To change these settings, click the Settings Communication Settings command button to open the Communication Settings dialog. Building (Compiling) Systems  See the Building the Selected System on page 105.  See the Building the Active System on page 105. NetLinx Studio - Instruction Manual...

  • Page 47: Working With System Files, Overview, Identifiers Vs. Disk Filenames

    IR controlled devices. See the Working with IR Files section on page 61 for details. IR Database files These files (.irn) contain links to either the AMX IR Database or to a user-defined IR database. See the Working with IR Files section on page 61 for details. Other files In many cases, it is helpful to save document and image files (for example, .txt, .DOC,...

  • Page 48: Creating New System Files, Saving The Active File, Saving All Open Files

    Click File > Save to save the active file in the Editor, using the current file name and identifier. Saving All Open Files Click File > Save All to save all open files, using their current file names and identifiers. NetLinx Studio - Instruction Manual...

  • Page 49: Adding A File To A System, Removing A File From A System

    Removing a File from a System Since all files are linked in NetLinx Studio, when you remove a file from a System, the file is not deleted from the disk, only removed from the System. If the same file is used in multiple Systems in the open Workspace, the Remove File from System option only removes the file from the selected System (as opposed to all instances of the file in the Workspace).

  • Page 50: Viewing And Editing System File Properties

    This option is only available for Source (AXS) files. This box allows you to compile a source code file to a platform (Axcess or NetLinx) different than the System's designated platform. This option is available if the Master File check box is deselected. Modified Date The date the file was last modified (read-only). NetLinx Studio - Instruction Manual...

  • Page 51: Working With Source Code Files, Creating A New Source Code File

    Working with Source Code Files You can create new Source Code files in NetLinx Studio, or add existing Source Code files to a System. Source Code files are created and/or edited in the Editor windows. Source Code files are stored in the Source folder in the Workspace tab of the Workspace Bar (FIG.

  • Page 52

    File Template dialog In the New File Location dialog, specify a target directory for the file.  By default, the target directory is the NetLinx Studio directory.  Use the Browse (...) button to navigate to another folder if necessary. (FIG. 65).

  • Page 53: Adding A New Source Code File To A System

    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 and add it to a specific System in the Workspace: Click to select (highlight) a System in the Workspace tab of the Workspace Bar and expand the view to show the System File folders (Source, Include, Module, User Interface, IR and Other).

  • Page 54

    If this file is to be the Master Source Code file for the System, then check the Make this the Master Source Code File check box.and click Next to proceed (FIG. 70). FIG. 70 File Template dialog NetLinx Studio - Instruction Manual...

  • Page 55: Adding An Existing Source Code File To A System

    Working with System Files In the New File Location dialog, specify a target directory for the file.  By default, the target directory is the NetLinx Studio directory.  Use the Browse (...) button to navigate to another folder if necessary. (FIG. 71).

  • Page 56

    Edit the file information (if necessary) for each file being added to the System. If this file is to be the Master Source Code file for the System, then check the Master File check box. Click OK to add the file to the selected System. NetLinx Studio - Instruction Manual...

  • Page 57: Designating The System's Master Source Code File, Compiling Source Code Files

    In the Build menu, select Compile <filename.axs>.  To specify the compiler to use (NetLinx or Axcess), double-click to open the file in an Editor window, and select Compile As NetLinx or Compile As Axcess from the Build menu. NetLinx Studio - Instruction Manual...

  • Page 58: Working With Include Files, Netlinx .axi" File, Creating A New Include File

    The NetLinx.axi file is updated in step with version changes of NetLinx Studio. 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.

  • Page 59: Adding A New Include File To A System

    Click OK to close the dialog and create the file. The new Source Code file is opened in an Editor window for editing. Also, the new file should now appear in the Source folder (FIG. 85). FIG. 85 Workspace tab - Include File Added NetLinx Studio - Instruction Manual...

  • Page 60: Adding An Existing Include File To A System

    System. Use the Recent tab to quickly access recently used files (FIG. 87). FIG. 87 Add Existing Include File dialog Click Open to access the File Properties dialog to view/edit general file information for the selected file(s) (FIG. 88). FIG. 88 File Properties dialog NetLinx Studio - Instruction Manual...

  • Page 61: Working With Block Files, Creating A New Block File

    Select New from the File menu to open the New dialog (FIG. 91). FIG. 91 New dialog - Block File selected Select Block File and click OK to open the New Block File dialog (FIG. 92). FIG. 92 New Block File dialog NetLinx Studio - Instruction Manual...

  • Page 62: Adding An Existing Block File To A System

    Locate and select the Block (.axb) file that you want to add to the selected System. Use the Recent tab to quickly access recently used files. Click Open to access the File Properties dialog, where you can view/edit general file information for the selected file(s) (FIG. 95). NetLinx Studio - Instruction Manual...

  • Page 63: Working With Module Files, Duet (jar) Module Files

    *.jar - Duet Module Files Duet (JAR) Module Files NetLinx Studio supports Duet (*.jar) module files in addition to NetLinx module files. JAR module files are similar to NetLinx module files except that are generated using the AMX Cafe Duet design application.

  • Page 64: Minimum Support Requirements For Duet Modules, Creating A New Module File

    If you select No, click Next to proceed to the New File Location dialog (see Step 6). In this dialog, select a module template to use to create the file (NetLinx Module Template or User-Defined Template), and click Next to proceed. (FIG. 99). NetLinx Studio - Instruction Manual...

  • Page 65

    File Template dialog In the New File Location dialog, specify a target directory for the file.  By default, the target directory is the NetLinx Studio directory.  Use the Browse (...) button to navigate to another folder if necessary. (FIG. 101).

  • Page 66: Adding A New Module File To A System

    The first File Template dialog prompts you to either use a template to create the new file or to create an empty AXS file not based on a template (FIG. 105). FIG. 105 File Template dialog NetLinx Studio - Instruction Manual...

  • Page 67

    File Template dialog In the New File Location dialog, specify a target directory for the file.  By default, the target directory is the NetLinx Studio directory.  Use the Browse (...) button to navigate to another folder if necessary. (FIG. 108).

  • Page 68: Adding An Existing Module File To A System

    Source Folder Context Menu In the Add Existing Module File dialog, locate and select the Module file that you want to add to the selected System. Use the Recent tab to quickly access recently used files (FIG. 112). NetLinx Studio - Instruction Manual...

  • Page 69

    Click OK to add the file to the selected System. The file should now appear in the Module folder under the selected System. Double-click to open the file in an Editor window (FIG. 114). FIG. 114 Module Folder - New JAR file NetLinx Studio - Instruction Manual...

  • Page 70: Including A Netlinx Module In Your Program, Sample Netlinx Code - Dms-ims Module

    DEFINE_DEVICE DvVIRT = 33001:1:0 DvDMS = 6020:1:0 (**********************************************) VARIABLE DEFINITIONS GO BELOW (**********************************************) DEFINE_VARIABLE CHAR strFileName[100] (**********************************************) STARTUP CODE GOES BELOW (**********************************************) DEFINE_START StrFileName = ‘avcnt11.kpd’ (**********************************************) VARIABLE DEFINITIONS GO BELOW (**********************************************) DEFINE_VARIABLE CHAR strVarTextArray[100][40] NetLinx Studio - Instruction Manual...

  • Page 71: Compiling Module Files, Working With User Interface Files

    These software applications are available for transfer via the www.amx.com website (Dealers > Tech Center > Application Files). NetLinx Studio allows you to associate UI files with each System and to map and transfer the files to their target panels or master.

  • Page 72

    Use the Recent tab to quickly access recently used files. Click Open to access the File Properties dialog where you can view/edit general file information for the selected file (FIG. 117). FIG. 117 File Properties dialog NetLinx Studio - Instruction Manual...

  • Page 73: Configuring Netlinx Source Code For Kpd Files, Working With Ir Files, Iredit

    Working with IR Files IR files (.irl and .irv) contain IR control data to operate IR-controlled system devices. NetLinx Studio allows you to link existing IR files into your Project/System. IR files are stored in the IR folder (in the Workspace tab of the Workspace Bar).

  • Page 74: Adding An Existing Ir File To A System

    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. Edit the file information (if necessary). NetLinx Studio - Instruction Manual...

  • Page 75: Working With Iredit Database (*.irn) Files, Adding An Ir File From The Amx Ir Database

    FIG. 121 IR System Folder context menu - Add From AMX IR Database Select Project > Add From AMX IR Database to open the Select IR From a Database dialog with the AMX IR Database displayed (FIG. 122). FIG. 122...

  • Page 76: Adding An Ir File From A User Database (*irn) File

    IR System File Folder (in the Workspace tab of the Workspace Bar). Refer to the Find IRL/IRV Files section on page 189 for information on using the Find IR Files tool to search IRN Databases for IR files. NetLinx Studio - Instruction Manual...

  • Page 77: Working With "other" Files, Creating A Standard Text (.txt) File

    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. should all be placed in a "_Docs" folder under the project directory on disk.

  • Page 78: Adding An Existing "other" File To A System, Search Operations

    Searching for IR Library (IRL/IRV) Files Use the Find IR Files dialog (Tools > Find IRL/IRV Files) to search for an IR file in a specific directory or IRN Database. See the Find IRL/IRV Files section on page 189. NetLinx Studio - Instruction Manual...

  • Page 79: Device Mapping, Device:port:system (d:p:s)

    // system device belongs to In Axcess, Master Source Code files are always mapped to the Master Controller (device = 0), and cannot be mapped to any other device. This does not apply to NetLinx Master Source Code files. NetLinx Studio - Instruction Manual...

  • Page 80: Creating Device Mapping Assignments

    This does not apply to NetLinx Master Source Code files.  To map to a device that is not specified in the Master Source Code file, select <Custom>, and enter the device's D:P:S assignment in the Enter DPS dialog (FIG. 129). NetLinx Studio - Instruction Manual...

  • Page 81: Removing Device Mapping Information

    File Device Map context menu. Workspace mappings are only updated when the source code file is saved. Removing Device Mapping Information Select a device-mapping icon in the File View window of the Device Mapping dialog. Click the Remove button. NetLinx Studio - Instruction Manual...

  • Page 82: Viewing Offline Device Mapping Information In The Online Tree, Editing Device Mapping Information, Printing Files

    Select Print from the File menu to access the Print dialog. Use the options in this dialog to set preferences for your printer, and send the file in the currently active Editor window to a specified printer. NetLinx Studio - Instruction Manual...

  • Page 83: Programming, Editor Windows

    Editor window.  NetLinx Studio features a Code Wizard that steps you through the process of generating several different types of code. See the Using the Code Wizard section on page 83. NetLinx Studio - Instruction Manual...

  • Page 84: Setting Editor Preferences, File Revisions

    (or other identifier), and add text comments to assist in managing multiple revisions of the same file. Additionally, NetLinx Studio automatically includes a date/time stamp in the revision information. The file revision information is added as a block of text to the top of the source code file when the revision is saved.

  • Page 85: Edit Options, Undo/redo, Cut, Copy And Paste, Find, Find Next And Replace

    NetLinx Studio inserts the file revision information specified here at the top of the source code file, before any other revision information that may already exists in the file. The example below shows file revision information ("REV 2"), as it appears in the source code file after two revisions have been saved: FIG.

  • Page 86: Search And Replace Within The Active File, Goto Line

    The total number of replaced instances is indicated in the Status bar (on the left-hand side). Goto Line Select this option to jump to a particular line number in your code. NetLinx Studio - Instruction Manual...

  • Page 87: Insert Section, Goto Section, Goto Functions/subs

    With this option, you can jump to a particular section in your code in the active Editor window. Select Edit > Goto Functions/Subs to access a list of functions contained within the active Source Code file. Select the function or subroutine that you want to jump to from the list. NetLinx Studio - Instruction Manual...

  • Page 88: Bookmarks, Push Messages

    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. NetLinx Studio displays the most recently received Push, or Push status (Push Enabled/Disabled) in the Status Bar (FIG. 140).

  • Page 89: Advanced

    NetLinx code segments. See Using the Code Wizard on page 83 for details. Unicode Edit Select this option to edit in Unicode. See Working with Unicode on page 97 for details. NetLinx Studio - Instruction Manual...

  • Page 90: Macros, Expand / Collapse All Fold Levels

    Select Edit > Macros to open the Macros sub-menu. Use the options in this menu to create and manage macros for use in Editor windows. Alternatively, use the toolbar buttons in the Macros toolbar to access these functions.  NetLinx Studio Macros Files use the file extension *.NSM.  See the Working with Macros section on page 103 for details.

  • Page 91: Regular Expression Support, Regular Expression Special Characters

    Regular Expression Support Regular expressions are notations used for describing patterns of text. They are a form of metacharacters, or characters that define other characters. The regular expressions supported by NetLinx Studio are described below: Supported Regular Expressions Regular...

  • Page 92: Syntax Highlighting

    When NetLinx Studio is started it loads two files: NetLinx.rw and Axcess.rw. These are the Words "reserved word" files. These files contain all of the words that NetLinx Studio will consider to be "Language Reserved Words". Language Reserved Words are syntax highlighted using the color specified in Preferences >...

  • Page 93: Default Syntax Highlighting Colors, Autocomplete And Autosuggest

    AutoComplete/AutoSuggest feature.  With AutoComplete/AutoSuggest enabled, the program will suggest a name that has been previously defined within the source code as you type in a variable name, device name or a reserved identifier, NetLinx Studio - Instruction Manual...

  • Page 94: Call Tips

    A single-quoted call name is followed by an open parenthesis.  A single-quoted system call name is followed by an open parenthesis. For example, NetLinx Studio displays a list of calls when the word "SYSTEM_CALL" is followed by a single quote as shown in FIG. 145: FIG. 145...

  • Page 95: Using The Code Wizard, Code Wizard - Creating Button Events

    Select Create Feedback Statements if desired (unchecked by default). Note that if you select this option, these Button Events cannot be set to handle all buttons. Click Next to proceed to the next dialog (FIG. 149). NetLinx Studio - Instruction Manual...

  • Page 96

    Button Event code in the Comment field if desired (default = Code Wizard Code). Click Finish to close the Code Wizard. The generated code is added to the code file in the active Editor window. NetLinx Studio - Instruction Manual...

  • Page 97: Code Wizard - Creating Channel Events

    Last) to associate with this event (FIG. 154). FIG. 154 Channel Event Code Wizard dialog 2 - Range of Channels  Select I want to handle all channels to apply this event to all channels. NetLinx Studio - Instruction Manual...

  • Page 98: Code Wizard - Creating Level Events

    With I want to handle a range of levels selected, indicate the range of levels to include (First and Last) to associate with this event (FIG. 157). FIG. 157 Channel Event Code Wizard dialog 2 - Range of Levels NetLinx Studio - Instruction Manual...

  • Page 99: Code Wizard - Creating Data Events

    Send a STRING, Send a COMMAND, and Generate an ERROR - all unchecked by default). Note that at least one option must be selected to enable the Next button. Click Next to proceed to the next dialog (FIG. 160). NetLinx Studio - Instruction Manual...

  • Page 100: Code Wizard - Creating Send_commands

    If this option is selected, specify the Variable Text Channel (for the target button), and enter the replacement Text for that button in the field provided. Click Next to proceed to the next dialog (FIG. 160). NetLinx Studio - Instruction Manual...

  • Page 101: Code Wizard - Generating Constants From An Ir File

    Specify a comment to add to the generated code segment containing the IR constants (optional), and specify a prefix to be added to each IR constant generated (also optional). Click Next to proceed to the next dialog (FIG. 164). NetLinx Studio - Instruction Manual...

  • Page 102: Code Wizard - Advanced Users

    Use Wizard Style check box (selected by default). FIG. 165 Code Wizard dialog (Advanced mode) When the Code Wizard generates a new code segment, it is inserted in the active Source Code file, in the appropriate section of the code. NetLinx Studio - Instruction Manual...

  • Page 103: Code Wizard Dialog - Button Tab

    Code Wizard dialog - Button tab Select Tools > Code Wizard to launch the NetLinx Studio Code Wizard. Uncheck the Use Wizard Style check box to access the individual tabs containing detailed options for each code type. The Button tab is shown in FIG. 166: FIG.

  • Page 104: Code Wizard Dialog - Channel Tab

    Device The device name used during code generation. This name may appear in a DEVCHAN definition or CHANNEL_EVENT statement depending on the platform and options selected. NetLinx Studio - Instruction Manual...

  • Page 105: Code Wizard Dialog - Level Tab

    This option will cause each level in the Array Name definition to be generated on it's own line with an empty comment at the end of the line. If this option is not selected, eight levels will be generated on each line with an empty comment above the line NetLinx Studio - Instruction Manual...

  • Page 106: Code Wizard Dialog - Data Tab

    If generating code for NetLinx, this code is placed in the STRING section of the DATA_EVENT. Device The device name used during code generation. This name may appear in a variable declaration, ONLINE/OFFLINE construct, DATA_EVENT or CREATE_BUFFER statements depending on the platform and options selected. NetLinx Studio - Instruction Manual...

  • Page 107: Code Wizard Dialog - Send Command Tab

    This value is used on the line before the SEND_COMMAND statement. Comments in NetLinx are always line-style comments (i.e. //). Insert Once you have made the relevant selections on this tab, click this button to insert the specified code into the file. NetLinx Studio - Instruction Manual...

  • Page 108: Code Wizard Dialog - Ir Constant Tab

    This value is used on the line before the constant declarations. Comments in NetLinx are always line- style comments (i.e. //). Insert Once you have made the relevant selections on this tab, click this button to insert the specified code into the file. NetLinx Studio - Instruction Manual...

  • Page 109: Enabling Utf-8 Encoding, Enabling Unicode Compiling, Working With Unicode

    Select Edit > Advanced > Unicode Edit to edit in Unicode. Enabling UTF-8 Encoding Before you begin to work with Unicode, you must enable the UTF-8 Unicode option in NetLinx Studio. This option will tell NetLinx Studio to store your file as UTF-8, which will support Unicode characters.

  • Page 110

    Preferences dialog - Editor - NetLinx Compiler tab Add an Include statement to your code to include the "UnicodeLib.axi" Include file: By default, this file is installed with NetLinx Studio to the following path: C:\Program Files\Common Files\AMXShare\AXIs\UnicodeLib.axi Save your source file with the Encoding option in the Save As dialog set to UTF-8 (FIG. 174).

  • Page 111: Including The Unicode Library, Unicode Characters, Working With Widechar Arrays And Unicode Strings

    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 counterpart do except they work on and return WIDECHAR arrays. NetLinx Studio - Instruction Manual...

  • Page 112: Unicode Compatible Functions, Converting Between Widechar And Char, Defining A Unicode String Literal

    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. For more information on Unicode character conversion, see the Unicode.org character conversion FAQ. NetLinx Studio - Instruction Manual...

  • Page 113: Unicode Related Compiler Errors, Concatenating String, Using Format, Reading And Writing To Files

    The NetLinx Unicode library supports three different file formats for compatibility with files created on a computer. Windows Notepad supports the same three file formats so files created in Notepad can be read using the WC_FILE routines and files created using the WC_FILE routines can be read with Notepad. NetLinx Studio - Instruction Manual...

  • Page 114: Right-to-left Unicode Strings, Sending Strings To A User Interface

    Sending a WIDECHAR array to a user interface is accomplished using WC_TP_ENCODE. WC_TP_ENCODE takes a WIDECHAR array and returns a CHAR array formatted for a user interface UNI or BAU command. cMyString = WC_TP_ENCODE(wcMyString) SEND_COMMAND dvTP,"'^UNI-1,0,',cMyString " NetLinx Studio - Instruction Manual...

  • Page 115: Recording A Macro, Saving Netlinx Studio Macro Files (*nsm), Working With Macros

    Select Edit > Macros to open the Macros sub-menu. Use the options in this menu to create and manage macros for use in Editor windows. Alternatively, use the toolbar buttons in the Macros toolbar to access these functions. NetLinx Studio Macros Files use the file extension *.NSM.

  • Page 116: Playing A Macro, Selecting Macros

    Select the macro that you want to run, and click Select. This closes the Select a Macro dialog, and the selected macro is now the current macro. Click Edit > Macros > Run '<macrofilename>', to run the selected macro. NetLinx Studio - Instruction Manual...

  • Page 117: Building The Workspace, Building The Selected Project, Building The Selected System, Building The Active System

    NetLinx Studio 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.

  • Page 118: Building An Individual File, Compiler Errors And Warnings, Compiler Error Types, Compiler Errors

    When the compiler finds an error during the compilation process, it informs the programmer. Most of the time these errors occur due to a typographical 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: NetLinx Studio - Instruction Manual...

  • Page 119

    A value or variable passed to a CALL as a parameter is of the wrong type as defined by the DEFINE_CALL statement. PROGRAM_NAME must be on Move the PROGRAM_NAME= statement to the first line of the program. line 1 NetLinx Studio - Instruction Manual...

  • Page 120

    Variables may not be assigned a value when they are defined in the here DEFINE_VARIABLE section. WAIT not found A statement references a WAIT by a name that does not exist. For example, CANCEL_WAIT 'CASS' will produce this error if there is no WAIT named CASS. NetLinx Studio - Instruction Manual...

  • Page 121: Compiler Warnings

    • Assigning the result of a function that returns a non-array type to a one- or two-dimensional array variable (for example, X = ATOI('AMX'), where X is a one- or two-dimensional array variable) This message is a warning and not an error, because X = ITOA(12) works correctly when X is a simple variable, since the result is a single value between Ø...

  • Page 122: Compiler Error Warnings Report Dialog, Disabling Compiler Warnings In Netlinx Code, Run-time Errors

    These errors occur if the SET_LENGTH_STRING keyword tries to set the length value of an array to a value greater than the array's storage capacity. Bad While This error occurs whenever a WHILE loop terminates due to the half-second timeout imposed on WHILE loops. NetLinx Studio - Instruction Manual...

  • Page 123: Debugging Source Code Files, Master Controller Debug Options

    Building and Debugging Source Code Debugging Source Code Files NetLinx Studio contains several useful options for debugging your Master Controller and Source Code files. The Debugging feature allows you to view variables declared within the scope of a Function and or Call procedure. However, stack and parameter values are not editable.

  • Page 124: Entering And Exiting Debug Mode, Using Single-step Mode, Changing The Value Of A Watched Variable

    Watch Bar: Select a watched variable in the Watch Bar. To change the variable's value, double-click on the desired variable's value to change the value to an edit field, which you can modify as desired. NetLinx Studio - Instruction Manual...

  • Page 125: Debug Mode Error Messages, Using Current Length With Total Length Disabled

    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. NetLinx Studio - Instruction Manual...

  • Page 126: Using Breakpoints (netlinx Only), Setting A Breakpoint, Clearing Breakpoints, Editing Breakpoints

    Editing Breakpoints Select Debug > Edit Breakpoints to access the Breakpoints dialog. Use the options in this dialog to toggle any breakpoints set in the active (NetLinx) Source Code file (FIG. 182). FIG. 182 Breakpoints dialog NetLinx Studio - Instruction Manual...

  • Page 127: Troubleshooting Debugging, Netlinx Debugger Not Stopping On A Breakpoint, Netlinx Master Error - Device_id Error

    Select File Properties to open the File Properties dialog. Change the Compile As selection to Axcess. Click OK to save the change and close the File Properties dialog. Recompile the file (as Axcess) and download. NetLinx Studio - Instruction Manual...

  • Page 128: Debugging Netlinx Code With Terminal Or Telnet Messages

    FUNCTION CHAR[17] DPS_TO_STRING (DEV dvDEV) This function takes a DEV and returns a string in the '<number>:<port>:<system>' format. Same as DEV_TO_STRING except it always returns the actual system number, not system 0, if the device is so defined. NetLinx Studio - Instruction Manual...

  • Page 129

    It could be the local master, a virtual device on the local system (see TN435), an IP device, serial device, etc.…  dvDEV is the device from which to get the info. NetLinx Studio - Instruction Manual...

  • Page 130

    #INCLUDE 'debug.axi' to the source code. "Debug.axi" and example code are attached to Tech Note #461. To access AMX Tech Notes, go to www.amx.com, log in as a dealer and go to Tech Center > Tech Notes. NetLinx Studio - Instruction Manual...

  • Page 131: Communication Settings, Overview, Connecting To A Master Controller

    Serial. When connected to a Master Controller, NetLinx Studio can be used for file transfers (including firmware upgrades) as well as various diagnostics tasks. Connecting to a Master Controller There are several ways that NetLinx Studio can connect to a Master Controller (refer to the following sections of this document). ...

  • Page 132

    Communication Settings dialog - TCP/IP Options List of Addresses: This table lists all TCP/IP Addresses that have been configured and saved in NetLinx Studio. This table presents the following information for each address in the list (as entered in the New TCP/IP Setting dialog when each address is defined.

  • Page 133

    Click Cancel to close the dialog without establishing a connection.  Note that if the connection fails, the Status Bar indicates no active connection (FIG. 188). FIG. 188 Status Bar indicating NO Network connection to a Master Controller NetLinx Studio - Instruction Manual...

  • Page 134: Manually Entering The Master's Ip Address Information

    List of Addresses (FIG. 190). FIG. 190 List of Addresses, indicating new Master Controller Select the new Master connection in the List of Addresses. This populates the Current Platform-Transport Selected field with the selected connection (FIG. 191). NetLinx Studio - Instruction Manual...

  • Page 135: Listening For Masters On The Network

    Listen For Masters dialog Click Start Listening to begin listening for "blink" (UDP) messages from NetLinx Masters on the same subnet. As Masters are discovered, they are added to the List of Active NetLinx Master Controllers (FIG. 194). NetLinx Studio - Instruction Manual...

  • Page 136

    Listening. Note that this action enables the Select To Add button (FIG. 195). FIG. 195 Listen For Masters dialog - Stop Listening Select the IP Address of the target Master and click Select To Add (FIG. 196). NetLinx Studio - Instruction Manual...

  • Page 137

    Address is now indicated in the List of Addresses. With the newly added Master selected, click Select. This updates the Current Platform-Transport Selected window to indicate that the newly added and selected Master is now the current communication configuration (FIG. 198). NetLinx Studio - Instruction Manual...

  • Page 138

    Master Communication Settings dialog (new Master indicated as current Configuration) Click OK to close this dialog. Refresh the Online Tree (select Refresh System Online Tree from the Online Tree context menu) to connect to the Master. NetLinx Studio - Instruction Manual...

  • Page 139: Editing A Tcp/ip Address, Deleting A Tcp/ip Address, Connecting To A Master Controller Via Serial

    Click Communication Settings to open the Communication Settings dialog. Select the Platform and the Transport Connection Option (Serial). This populates the dialog with options for configuring Serial communication settings with the target Master Controller (FIG. 202). NetLinx Studio - Instruction Manual...

  • Page 140

    Enter a User Name and Password if required by the target Master. Click OK to close this dialog and return to the Master Communication Settings dialog, now indicating Serial as the current connection configuration (FIG. 206). FIG. 203 Master Communication Settings dialog - Serial Configuration NetLinx Studio - Instruction Manual...

  • Page 141: Configuring A Virtual Netlinx Master

    Click Communication Settings to open the Communication Settings dialog. Select the Platform (NetLinx Master) and the Transport Connection Option (Virtual NetLinx Master.). This populates the dialog with options for configuring Virtual NetLinx Master communication settings (FIG. 205). NetLinx Studio - Instruction Manual...

  • Page 142

    Click Select - note that this updates the Current Platform Transport Selected field with the IP address of the selected virtual Master. Click OK to close the Communication Settings dialog and return to the Master Communication Settings dialog, now indicating the selected Virtual NetLinx Master as the current connection (FIG. 206). NetLinx Studio - Instruction Manual...

  • Page 143: Connecting Via Terminal Session

    Select Settings > Master Communication Settings to open the Master Communication Settings dialog. Select Terminal Settings from the Available System(s) list (FIG. 207). FIG. 207 Communication Settings dialog - Terminal Settings Click the Communication Settings button to access the Serial Settings dialog (FIG. 208). NetLinx Studio - Instruction Manual...

  • Page 144: Configuring System-level Communications Settings, Via The Master Communication Settings Dialog

    Click OK to close the Master Communication Settings dialog. Click Tools > Terminal Session to attempt to establish a terminal connection based on the configuration specified in the Serial Settings dialog. This action invokes a terminal window in NetLinx Studio. Configuring System-Level Communications Settings The Master Communication Settings dialog contains options that allow you to specify System-level communication settings.

  • Page 145: Via The System Properties Dialog

    Select (highlight) a System in the Workspace tab, and select System Properties from the Project menu to open the System Properties dialog (FIG. 210). FIG. 210 System Properties dialog Click Communication Settings to open the Communication Settings dialog. Follow the steps above to specify communication settings for the selected System. NetLinx Studio - Instruction Manual...

  • Page 146: Netlinx Master Security, Connecting To A Secured Netlinx Master, If You Don't Connect

    NetLinx Studio supports security for NetLinx Masters, via the Authentication Required option in the Communication Settings dialog. Before you can enable/disable 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.

  • Page 147: Connecting To An Axcess Master

    These instructions in these topics assume that the physical link between the PC running NetLinx Studio and the master is established. Select Settings > Master Communication Settings to open the Master Communication Settings dialog.

  • Page 148

    Communication Settings NetLinx Studio - Instruction Manual...

  • Page 149: Working With Online Devices, Working With The Online Tree

    Click the Display command button (or right-click anywhere within the Online Tree tab) to access the Online Tree Context Menu.  You can set preferences for the Online Tree via options in the Preferences dialog - Online Tree - Zero Config tab (see page 209). NetLinx Studio - Instruction Manual...

  • Page 150: Online Tree Elements, System, Master Controller

    Device Controller. Enova DVX All-In-One Presentation Switchers also utilize "Switcher Firmware" for the A/V Switcher component. Click on each of the Master’s device component folders to view the Ports contained in each (FIG. 215). FIG. 215 Master Controller Device Components - Device Ports NetLinx Studio - Instruction Manual...

  • Page 151: Devices, Device State Folders

    These devices have been bound to a Master in the past but is not currently communicating with Devices: the Master. After 10 minutes with no communication with the NetLinx Master, a "Searching" device is moved into the "Lost" state. NetLinx Studio - Instruction Manual...

  • Page 152: Virtual/dynamic Devices, Online Tree Context Menu, Setting Online Tree Preferences, Viewing Online Devices And Ports

    System, total number of devices online, and the total number of ports in the System are indicated in the (read-only) Master(s), Devices and Ports fields a the bottom of this tab (FIG. 219). FIG. 219 Online Tree - total Master(s), Devices and Ports in the System NetLinx Studio - Instruction Manual...

  • Page 153: Checking Port Status, Online Tree Reports, Generating An Online Tree Report

    Online tree associated with the current system that is opened within the workspace. The device mappings can be ordered by "Device Name" or by "Device Number". Click OK to generate the report and close this dialog. NetLinx Studio - Instruction Manual...

  • Page 154: Example Online Tree Report - Text File Format

    The following is an example of an Online Tree Text File Report (FIG. 222). FIG. 222 Online Tree Report dialog Example Online Tree Report - CSV File Format FIG. 223 provides an example of an Online Tree CSV File Report: FIG. 223 Online Tree CSV File Report NetLinx Studio - Instruction Manual...

  • Page 155: Binding/unbinding Devices, Binding An Unbound Device, Unbinding A Bound Device

    Select Unbind Device to open the Bind/Unbind Device dialog (FIG. 224). De-select the check box next to the Master that the device is currently bound to. Select Refresh System (in the Online Tree context menu). The device should now appear in the Unbound Devices folder. NetLinx Studio - Instruction Manual...

  • Page 156: Zero-config Networking, Generating A List Of Network Devices, Accessing A Device Via Zero-config Networking

    Zero-Config tab and Configuration Page for selected device By default, the selected device's Web Console (HTML) is displayed in your default browser. To force the Web Console pages to open in a window within NetLinx Studio instead: Open the Preferences dialog to the General tab.

  • Page 157: Configuring Devices Via Zero-config Networking, Terminal And Telnet Sessions, Terminal Window, Using The Terminal Window

    Terminal and Telnet Sessions Terminal Window NetLinx Studio provides a terminal interface to NetLinx and Axcess devices that support an interactive terminal mode. Select Tools > Terminal to invoke the Terminal Window. The Terminal window puts the Master Controller into dumb terminal mode.

  • Page 158: Telnet Window, Using The Telnet Window, Setting Terminal And Telnet Window Preferences

    Telnet Window NetLinx Studio provides a Telnet interface to NetLinx and Axcess devices. NetLinx Studio supports multiple simultaneous Telnet sessions. Select Tools > Telnet Session to invoke the Telnet window. Use the Telnet window to communicate directly with the Master Controller in situations where a Terminal session is not desirable.

  • Page 159: See Also

    Control A Device - see page 173  Device Addressing - see page 175  URL Listing - see page 177  Network Addresses - see page 178  Network Device Addressing - see page 180 NetLinx Studio - Instruction Manual...

  • Page 160

    Working with Online Devices NetLinx Studio - Instruction Manual...

  • Page 161: File Transfer Operations, Overview, Usb Transfers, Sending Files To The Master Or System Devices

    USB Transfers NetLinx Studio supports file transfers to several G4 touch panels via USB connection, for situations where the target panel is not connected to a NetLinx Master. In this situation, you will use a USB connector on your PC to connect directly to the panel, using your PC as a Virtual NetLinx Master.

  • Page 162

    To view/edit the device mapping information for files in the Send tab, select a file in the list and select Edit > Device Mapping (in the File Transfer dialog). With all of the files that are to be included in this transfer listed in the Send tab, click the Send command button (FIG. 229). NetLinx Studio - Instruction Manual...

  • Page 163: Adding Workspace Files Via The "select Files For File Transfer" Dialog

    Device Mapping section on page 67 for details. In the File Transfer dialog (Send tab), click the Add command button to open the Select Files For Transfer dialog (FIG. 230). FIG. 230 Select Files For File Transfer dialog (Current Workspace tab) NetLinx Studio - Instruction Manual...

  • Page 164: System Files - Prerequisites For Transfer Operations, Adding Orphan Files

    With a Workspace open, select Tools > File Transfer to open the File Transfer dialog (Send tab). Click the Add command button to open the Select Files For File Transfer dialog. Open the Other tab (FIG. 232). NetLinx Studio - Instruction Manual...

  • Page 165

    Locate and select the file that you want to add, and click OK to close the Open dialog. In the Enter Device Mapping Information dialog, enter the the proper D:P:S information for the file’s mapping assignment (FIG. 233). NetLinx Studio - Instruction Manual...

  • Page 166

    Click OK to close the Select Files for File Transfer dialog and return to the File Transfer dialog. The files added in the Select Files for File Transfer dialog are now indicated in the Send tab. NetLinx Studio - Instruction Manual...

  • Page 167: Adding Workspace Files Via Quick Load

    Select Remove Duplicates When Loading to prevent having any duplicate entries in the Send tab (default = enabled). Click OK to close the dialog and load the File Transfer dialog (Send tab) according to the selections made in the Quick Load dialog. NetLinx Studio - Instruction Manual...

  • Page 168: File Transfer List Files, Creating File Transfer List Files

    Note that Smart Transfer can also be enabled via the Smart Transfer option (under TP4 Files) in the Quick Load dialog. See the Adding Workspace Files via Quick Load section on page 155 for details on using Quick Load. NetLinx Studio - Instruction Manual...

  • Page 169: Receiving Files From The Master

    To add the files to be included in this transfer operation, click the Add command button to open the Select Files For File Transfer dialog - Other tab (FIG. 238). FIG. 238 Select Files For File Transfer dialog (Receiving files) This tab lists the different types of files that can be received from the Master: NetLinx Studio - Instruction Manual...

  • Page 170

    Enter Device Number dialog (Axcess only) Click OK to close the Enter Device Mapping Information dialog and return to the File Transfer dialog. Note that the selected files are now indicated in the Receive tab (FIG. 234). NetLinx Studio - Instruction Manual...

  • Page 171

    This initiates the transfer of every file listed in the Receive tab, in the order in which they are listed (top to bottom).  The progress and status of each file transfer is indicated in the File Transfer Status tab of the Output Bar. NetLinx Studio - Instruction Manual...

  • Page 172: Virtual Netlinx Master Transfers, Configuring The Touch Panel For Virtual Netlinx Master Tcp/ip Transfers

    Virtual NetLinx Master section on page 129. NetLinx Studio supports direct connection to G4 panels via TCP/IP and USB, for situations where the target panel is not connected to a NetLinx Master. In this situation, you can use your PC's Ethernet or USB connectors to connect directly to the panel, using your PC as a Virtual NetLinx Master.

  • Page 173: Configuring The Touch Panel For Virtual Netlinx Master Usb Transfers

    AMX USB LAN Software for USB Enabled G4 Panels The AMX USB LAN software (which includes the G4 Panel USB driver) is required to connect to USB-enabled G4 panels via USB. To download the latest version of the AMX USB LAN software: Go to www.amx.com and log in as a Dealer.

  • Page 174: Transferring Files Using A Virtual Netlinx Master Usb Connection, Canceling File Transfers

    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. NetLinx Studio - Instruction Manual...

  • Page 175: Transfer Errors And Definitions, Firmware Transfers, Sending Firmware To A Netlinx Device (kit File)

    Firmware Transfers NetLinx Studio provides the ability to transfer KIT and TSK firmware files to a NetLinx or Axcess master controller. To send firmware files, select Tools > Firmware Transfers, then select either Send to NetLinx Device, or Send to Axcess Device from the sub-menu.

  • Page 176: Sending Firmware To An Axcess Device (tsk File)

    Use the Firmware Transfers options in the Tools menu to update the firmware in Axcess Masters. Axcess Master Controllers use .TSK files for firmware upgrades. Choose Tools > Firmware Transfers > Send To Axcess Device to open the Send To Axcess Device dialog (FIG. 244). NetLinx Studio - Instruction Manual...

  • Page 177

    Click Yes to reboot, and the program initiates the reboot sequence. When the Master has rebooted, the Status LED on the front panel of the Master blinks once a second to indicate that it is functioning properly. Once it has rebooted, click OK. NetLinx Studio - Instruction Manual...

  • Page 178

    File Transfer Operations NetLinx Studio - Instruction Manual...

  • Page 179: Diagnostics Menu Options, Overview, Netlinx Device Notification Options

    NetLinx in the Communication Setting dialog. NetLinx Device Notification Options The NetLinx Device Notifications functionality in NetLinx Studio allows you to receive several types of auto-notification messages from one or more specified NetLinx devices. Use the NetLinx Device Notifications Options dialog to add and remove Devices from the notifications list, and specify which Notifications are enabled for each device (FIG.

  • Page 180

    These are low-level strings of raw data, used primarily for troubleshooting the NetLinx master. This option is intended for use in conjunction with AMX Technical Support. Click Done to save changes and close the dialog.

  • Page 181: Removing Devices From The Notifications List, Editing Device Notification Settings

    NetLinx Device Notifications Options dialog This open the NetLinx Notification Properties - (Edit) dialog (FIG. 249). FIG. 249 NetLinx Notifications Properties - [Edit] dialog Alternatively, you can double-click on a device in the Device list to access this dialog. NetLinx Studio - Instruction Manual...

  • Page 182: Break On String Options

    • Match Case - This option makes the string(s) indicated case-sensitive (by default, this option is unchecked). • Scan Line Number and time Stamp - This option causes the program to include the line number and time stamp as part of the matching process. NetLinx Studio - Instruction Manual...

  • Page 183: Enable Netlinx Device Notifications, Disable Netlinx Device Notifications, Enable Push Message Status Bar Display

    Select Diagnostics > Enable Push Message Status Bar Display to display Push messages in the Status Bar. The Push Message Status Bar Display indicates the status of Push messages sent to the Master (FIG. 252). FIG. 252 Push Message Status Bar Display See the Push Messages section on page 76 for more information. NetLinx Studio - Instruction Manual...

  • Page 184: Enable Netlinx Internal Diagnostics Messages, Buffering Of The Notification And Diagnostic Tabs, Emulate A Device

    Emulate a Device Emulating a device means that NetLinx Studio generates messages that appear to the master to have come from a specified <D:P:S> combination. The options in the Emulate a Device dialog allow you to specify the <D:P:S>...

  • Page 185: Control A Device

    Control a Device Controlling a device in NetLinx Studio means that it will appear to a specified System device that messages are being sent from the NetLinx Master. The options in the Control a Device dialog allow you to specify the <D:P:S> combination for the target device you want to control.

  • Page 186

    For example to send the "CALIBRATE" send command, simply type CALIBRATE (no quotes) rather than SEND_COMMAND <dev> "CALIBRATE". Hold down the Shift key to select a specific range of lines to send to the controller instead of all the lines within the edit control. NetLinx Studio - Instruction Manual...

  • Page 187: Device Addressing, Changing The Device/system Address On A Netlinx Device

    NetLinx device, using Identity (ID) Mode. The Start Identify Mode button places the entire NetLinx system (specified in the Destination System field) in ID Mode. If the target Master has security applied, NetLinx Studio will prompt you for a User Name and Password in order to change these settings.

  • Page 188: 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.

  • Page 189: Url Listing, Creating A Url List

    To add a device to the URL List, click Add. This opens the Add URL dialog (FIG. 258). FIG. 258 Add URL dialog Enter the web address (URL or IP Address) of the device in the URL field and click OK to return to the URL List dialog. NetLinx Studio - Instruction Manual...

  • Page 190: Network Addresses

    NXI masters are always set to Device = 0.  If the target Master has security applied, NetLinx Studio will prompt you for a User Name and Password in order to change these settings. See the NetLinx Master Security section on page 134 for details.

  • Page 191: Changing The System Number On A Netlinx Master

    Click Set IP Information to set the new IP Address assignment. A message will be displayed indicating that the Master has accepted the new settings. Click Reboot Master to reboot the Master and accept the new changes. Allow 20-30 seconds for the Master to reboot. NetLinx Studio - Instruction Manual...

  • Page 192: Network Device Addressing, Manually Specifying Device Addresses For Network Devices

    FIG. 261 Network Device Addressing dialog - Individual Device Settings tab Network Devices are devices that are not on the AMX bus; instead they connect to a NetLinx Master via the LAN. Select Diagnostics > Network Device Addressing to open the Network Device Addressing dialog (Individual Device Settings tab).

  • Page 193: Valid Subnet Masks, Set Identification Mode

    The options in the Set Identification Mode tab of the Network Device Addressing dialog allow you to use ID Mode to identify Network Devices that are located throughout a system, and change their device addressing information if necessary (FIG. 262). FIG. 262 Network Device Addressing dialog - Set Identification Mode tab NetLinx Studio - Instruction Manual...

  • Page 194: Identification Mode - Continuous Increment Mode (using Dhcp)

    Diagnostics Menu Options Network Devices are devices that are not on the AMX bus; instead they connect to a NetLinx Master via the LAN.  For a Single Network Device: To use ID Mode to identify and change values for a single device on the network, do not check the Continuous Increment Mode check box.

  • Page 195: Identification Mode - Continuous Increment Mode (specify Ip Addresses)

    Proceed to a network device and push the ID push-button on the device (for panels push a button) to ID the device. By pressing the ID push-button on the device, NetLinx Studio will set that device's network address information (Device Addressing and Device IP Addressing values) according to the settings in this dialog.

  • Page 196

    Proceed to a network device and push the ID push-button on the device (for panels push a button) to ID the device. By pressing the ID push-button on the device, NetLinx Studio will set that device's network address information (Device Addressing and Device IP Addressing values) according to the settings in this dialog.

  • Page 197: Tools Menu Options, Overview, Reboot The Master Controller

    All communications to the Master are stopped in order to activate a connection and initiate the reboot process.  Allow 20-30 seconds for the reboot.  You can reboot more than one Master before closing this dialog. Click Done to close this dialog. NetLinx Studio - Instruction Manual...

  • Page 198: Amx-pi, Dip Switch

    Tools Menu Options AMX-PI The AMX-PI application provides the ability to display detailed information on AMX hardware and software, including release notes and product revision history (FIG. 272). FIG. 272 AMX-PI  Click Tools > AMX-PI to launch the application.

  • Page 199: Set Master Controller's Date/time

    Alternatively, you can highlight the field in the Time display that you want to adjust and type the desired number in its place.  If no field is selected within the time display, the up/down arrows affect the hours setting. NetLinx Studio - Instruction Manual...

  • Page 200: File Extraction, Src File Extraction

    File Extraction SRC File Extraction NetLinx Studio can generate a compressed version of NetLinx program files anytime they are compiled or transferred. The compressed NetLinx files are called Source Files, and have the extension .src. To generate NetLinx Source Files at compile time, enable the Build With Source option in the NetLinx Compiler tab of the Preferences dialog (FIG.

  • Page 201: Zip File Extraction, Find Irl/irv Files

    ZIP File Extraction NetLinx Studio allows you to export an entire Workspace (including all contained Projects, Systems and System Files) as a .ZIP file. The Extract From ZIP File command allows you to extract these files: Select Tools >...

  • Page 202: Find In Files

    (...) button to select the directory to search in the Browse For Folder dialog. The first time you search within any given directory, NetLinx Studio generates an index file of all IR files in that directory. The status of this operation is indicated in the Status dialog. This only happens the first time a directory is searched.

  • Page 203: File Compare Utility

    Click Compare to begin the compare operation on the two selected files, using the Compare Options specified. This action invokes the File Compare dialog (FIG. 279). NetLinx Studio - Instruction Manual...

  • Page 204: Backup Workspace Files

    This option is intended for file backups only, as opposed to creating a self-contained Workspace file for distribution to remote sites. See Exporting Workspace Files "To Go" (for Distribution) on page 21. Select Project > Backup Workspace Files to access the Backup Workspace Files dialog (FIG. 280). NetLinx Studio - Instruction Manual...

  • Page 205

    The Progress bar indicates the progress of the backup operation. Once the export operation is done, detailed results of the operation are listed in the Backup Workspace Files Report dialog (FIG. 281). FIG. 281 Backup Workspace Files Report dialog NetLinx Studio - Instruction Manual...

  • Page 206: Import And Export Hotkeys, Import And Export Preferences

    The options in this dialog allow you to export the current Editor preferences (as defined in the Preferences dialog) as an *.epx file, which can later be imported back into NetLinx Studio (via the Tools > Import Editor Preferences option).

  • Page 207: View Readme

    Tools Menu Options View ReadMe Select Tools > View ReadMe to open the ReadMe.txt file associated with this version of NetLinx Studio (FIG. 283). FIG. 283 Example ReadMe.txt file This file contains version information as well as a listing of features that are new to this release, and any existing known issues.

  • Page 208

    Tools Menu Options NetLinx Studio - Instruction Manual...

  • Page 209: Setting Program Preferences, Overview, Preferences Dialog - Axcess Compiler Tab

    • Assigning the result of a function that returns a non-array type to a 1- or 2-dimensional array variable (for example, X = ATOI('AMX'), where X is a 1- or 2-dimensional array variable). This message is a warning and not an error, because X = ITOA(12) works correctly when X is a simple variable, since the result is a single value between Ø...

  • Page 210

    • Select Library Files to select or create the directory that the compiler will look for (IR) Library files in. Note: In some cases, when running NetLinx Studio on Windows Vista and Windows 7, the message "Need Administrator Rights" may be displayed in the Directories window (with tool- text that says "You need Administrator Rights to change the HKEY_LOCAL_MACHINE section...

  • Page 211: Preferences Dialog - Netlinx Compiler Tab

    Passwords must be at least 6 characters in length (maximum of 20 characters). Enable _WC Select this option if you are utilizing wide-string ("_WC...") Unicode sub-routines in your Preprocessor (Unicode) NetLinx code. See the Enabling Unicode Compiling section on page 97 for details. NetLinx Studio - Instruction Manual...

  • Page 212: Preferences Dialog - Editor - Display And Indentions Tab

    • Select Module Files to select or create the directory that the compiler will look for Duet Module files (*.jar) and AXS Module files (*.TKO). Note: In some cases, when running NetLinx Studio on Windows Vista and Windows 7, the message "Need Administrator Rights" may be displayed in the Directories window (with tool- text that says "You need Administrator Rights to change the HKEY_LOCAL_MACHINE...

  • Page 213: Importing/exporting Editor Preferences

    Use the Import Preferences and Export Preferences options in the Tools menu to import/export the current Editor preferences, as they are defined in the Editor tab of the Preferences dialog. Select Tools > Export Editor Preferences. This opens the Export Preferences dialog (FIG. 287). NetLinx Studio - Instruction Manual...

  • Page 214: Importing An Existing *.epx File, Preferences Dialog - Editor - Highlighting And Fonts Tab

    Preferences dialog - Editor - Highlighting and Fonts tab Editor - Highlighting and Fonts options Highlighting Document Type Select the type of document that you want to set highlighting options for (Axcess/NetLinx Source code files or Text Files). NetLinx Studio - Instruction Manual...

  • Page 215

    The Selection button opens the Font dialog, where you can select the font, font style (regular, italic, bold) and font size to be displayed in the Editor window. Check Only Fixed Pitch Fonts to limit the font selection list to include only fixed-pitch fonts (such as Courier or Terminal). NetLinx Studio - Instruction Manual...

  • Page 216: Preferences Dialog - Workspace Tab

    Editor window. If this option is not selected, the following tab-oriented options are disabled. Enable File Icons In Tabs This option toggles the file icons displayed in the Editor window tabs. Enable Window Close Button This option toggles the Window Close button. NetLinx Studio - Instruction Manual...

  • Page 217: Preferences Dialog - General Tab

    This is the background color setting for the selected window. General Recent File List Size This field allows you to change the size of the recent file list, displayed at the bottom of the File menu (range = 1-9). NetLinx Studio - Instruction Manual...

  • Page 218: Preferences Dialog - Terminal - Telnet Windows Tab

    Sets the Foreground and Background Colors for Terminal Windows in their active state. Inactive Window Sets the Foreground and Background Colors for Terminal Windows in their inactive state. Telnet Window Colors Sets the Foreground and Background Colors for Telnet Windows. NetLinx Studio - Instruction Manual...

  • Page 219: Preferences Dialog - File Transfer Tab

    Serial connections) Show "Load List" Summary (default = enabled) By default, select "Send Glyph" when sending a KPB file (default = disabled) By default, select "Send Font" when sending a KPB file (default = disabled) NetLinx Studio - Instruction Manual...

  • Page 220: Preferences Dialog - Diagnostics Tab

    Diagnostics and Notifications Output Displays Options Read X lines from the Use this field to adjust the number of lines that will be read from the buffer every quarter-second buffer every 1/4 (default = 4) second NetLinx Studio - Instruction Manual...

  • Page 221: Preferences Dialog - Online Tree - Zero Config Tab, Importing/exporting Editor Preferences

    • Use the Foreground Color drop-down palette to set the text color. • Use the Background Color drop-down palette to set the background. Default TELNET Program: This option allows you to specify a default Telnet program to use with NetLinx Studio other than telnet.exe.

  • Page 222: Customize Dialog - Commands Tab, Customizing The Work Area

    The Preferences dialog should now reflect the preferences specified in the imported *.EPX file. Customizing the Work Area The Customize dialog (Settings > Customize) includes options that allow you to customize the NetLinx Studio UI to best suit your preferences. The options in this dialog are organized into the following tabs: ...

  • Page 223: Customize Dialog - Toolbars Tab, Adding Buttons To Existing Toolbars

    Customize dialog - Toolbars tab options Toolbars: This list box contains a list of all toolbars currently associated with NetLinx Studio (including custom toolbars). Each listed toolbar has a check box. Select/de-select these check boxes to show/hide the named toolbar.

  • Page 224: Removing Buttons From Existing Toolbars, Creating A New Custom Toolbar, Renaming Custom Toolbars

    Enter the new name in the Toolbar Name text box and click OK to save the change. Deleting Custom Toolbars Click to select a custom toolbar. Click Delete to permanently delete the selected toolbar. The standard NetLinx Studio toolbars cannot be deleted. NetLinx Studio - Instruction Manual...

  • Page 225: Customize Dialog - Tools Tab

    • $(FileDir) - Places the directory of the active file into the argument list (e.g. "C:\Projects\Home System"). • $(CurDir) - Places the directory of where the NetLinx Studio program resides (e.g. NetLinx Studio (NSX.EXE) resides in C:\Program Files\AMX Control Disc\NetLinx Studio).

  • Page 226: Customize Dialog - Keyboard Tab, Customize Dialog - Menu Tab

    Customize dialog - Menu tab Use the options in the Menu tab of the Customize dialog to customize the contents of the menus (FIG. 299). FIG. 299 Customize dialog - Menu tab NetLinx Studio - Instruction Manual...

  • Page 227: Creating A New Custom Menu, Adding Commands To Existing Menus

    Release the mouse button to delete the item from the menu. Alternatively, as long as the Customize dialog is open, you can simply right-click on any menu item to open the Command context menu. Select Delete to delete the button. NetLinx Studio - Instruction Manual...

  • Page 228: Removing Commands From Existing Menus, Customize Dialog - Options Tab

    ScreenTips description. If Show ScreenTips on Toolbars is disabled, this option is not available (default = enabled). Large Icons: When this option is enabled (checked), the toolbar icons are displayed at approximately double their original size (default = disabled). NetLinx Studio - Instruction Manual...

  • Page 229

    Setting Program Preferences NetLinx Studio - Instruction Manual...

  • Page 230

    - Schedules and registration for any AMX University course - Travel and hotel information - Your individual certification requirements and progress 3000 RESEARCH DRIVE, RICHARDSON, TX 75082 USA • 800.222.0193 • 469.624.8000 • 469-624-7153 fax • 800.932.6993 technical support • www.amx.com...

Comments to this Manuals

Symbols: 0
Latest comments: