AMX NETLINX STUDIO V2.4 Instruction Manual
  1. Manuals
  2. Brands
  3. AMX Manuals
  4. Software
  5. NETLINX STUDIO V2.4
  6. Instruction manual
AMX NETLINX STUDIO V2.4 Instruction Manual

AMX NETLINX STUDIO V2.4 Instruction Manual

Hide thumbs
Table of Contents

Advertisement

Quick Links

instruction manual
NetLinx Studio
v2.4 or higher
So f twa re

Advertisement

Table of Contents
loading

Related Manuals for AMX NETLINX STUDIO V2.4

Summary of Contents for AMX NETLINX STUDIO V2.4

  • Page 1 instruction manual NetLinx Studio v2.4 or higher So f twa re...
  • Page 2 TERMINATION. AMX RESERVES THE RIGHT, IN ITS SOLE DISCRETION, TO TERMINATE THIS LICENSE FOR ANY REASON AND UPON WRITTEN NOTICE TO LICENSEE. In the event that AMX terminates this License, then Licensee shall return all copies of the AMX Software to AMX and certify in writing that all copies have been destroyed.

  • Page 3: Table Of Contents

    Supported File Types ......................2 What's New Dialog ......................3 WebUpdate ........................3 Software History2 Application ................... 3 DIP Switch 2.0........................3 The NetLinx Studio v2.4 Work Area ................5 Overview ........................... 5 Title Bar ..........................5 Toolbars ..........................5 Menu Bar........................... 6 Status Bar..........................
  • Page 4 Table of Contents Using The Terminal Window ....................17 Terminal Window Context Menu .................... 18 Watch Window ........................ 18 Watch Window Context Menu....................19 Using NetLinx Studio ..................... 21 The Netlinx Studio Workspace Wizard................21 Using the Workspace Wizard....................21 Building the Workspace ......................
  • Page 5 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 ..................42 Removing A File From A System ..................42 Building (Compiling Systems) ..................
  • Page 6 IREDIT ........................... 67 Working With IREdit Database (*.IRN) Files ................67 Adding An IR File From the AMX IR Database ..............67 Adding An IR File From an IREDIT User Database (*IRN) File ..........68 IR File Folder Context Menu ....................69 IR File Context Menu ......................
  • Page 7 Table of Contents Programming ......................77 Overview ......................... 77 Source Code Editor Context Menu ..................77 Using The Code Wizard ....................78 Creating Events With the Code Wizard.................. 79 Creating Send_Commands With the Code Wizard..............79 Generating Constants From an IR File With the Code Wizard ..........79 Code Wizard - Advanced Users.....................
  • Page 8 Table of Contents Debugging Source Code Files ....................94 To enter debug mode:......................95 Using Single-step Mode ......................95 Master Controller Debug Options................... 96 Changing The Value Of A Watched Variable................. 96 Debug Mode Error Messages ....................96 Breakpoints ........................97 Using Breakpoints (NetLinx Only) ..................
  • Page 9 Table of Contents Compiling an Individual File ..................109 Compiler Errors and Warnings ..................110 Compiler Errors ......................110 Compiler Warnings......................113 Compiler Error Warnings Report Dialog................114 Disabling Compiler Warnings In Netlinx Code ..............114 Run-Time Errors......................114 Working With Online Devices ................115 NetLinx Network Setup....................
  • Page 10 Table of Contents Setting NetLinx Time and Date ..................136 Rebooting the Master....................137 Axcess/NetLinx Debugging ................... 137 Debugging Source Code Files ..................... 137 Notes on Using Current Length (when the Total Length option is disabled):....... 138 Master Controller Debug Options..................138 Changing The Value Of a Watched Variable ...............
  • Page 11 Virtual Netlinx Master USB Transfers .................. 160 Configuring the Touch Panel for Virtual NetLinx Master USB Transfers ......161 AMX USB Driver Information For USB Enabled G4 Panels..........161 Configuring NetLinx Studio for Virtual NetLinx Master Transfers......... 162 Transferring Files Using A Virtual Netlinx Master Usb Connection........162 Virtual NetLinx Master TCP/IP Transfers ................
  • Page 12 Table of Contents Preferences Dialog - Commands Tab................177 Adding/Removing Commands From The Toolbars.............. 177 Creating Custom Toolbars ....................178 Preferences Dialog - Toolbars Tab ................178 Preferences Dialog - Tools Tab ..................178 Adding/Removing Application Shortcuts In The Tools Menu ..........179 Preferences Dialog - Keyboard Tab................

  • Page 13: Netlinx Studio (V2.4 Or Higher)

    Use the Index and Search tabs to perform more detailed searches. Use the Browse Sequences to quickly browse related topics. Click the AMX.COM toolbar button to access the www.amx.com home page. Click the NetLinx Studio Online Help toolbar button to access an online version of this help file.

  • Page 14: Supported Operating Systems And Minimum Pc Requirements

    Block files *.AXB Lib Files *.LIB NetLinx Studio v1.2 *.PJS Project files The following file types are supported, but are edited using external AMX applications, as described below: Type Associated AMX Application Extension TPD file TPDesign3 *.TPD TP4 files TPDesign4 *.TP4...

  • Page 15: What's New Dialog

    The AMX WebUpdate program is a stand-alone application that communicates with the AMX website, allows a user to select from a list of available AMX Software programs to choose for updating, determines the latest version of the selected applications, returns a listing of available updates, allows a user to download the selected installation files, and upon request, launches the installation of those downloads.
  • Page 16 NetLinx Studio (v2.4 or higher) NetLinx Studio (v2.4 or higher)

  • Page 17: The Netlinx Studio V2.4 Work Area

    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.

  • Page 18: Menu Bar

    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.
  • Page 19 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 &...

  • Page 20: Workspace Window

    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.

  • Page 21: Workspace Folder

    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 *.*).

  • Page 22: System File Folders

    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.

  • Page 23: Workspace File Context Menu

    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.

  • Page 24: Workspace Window - Online Tree Tab

    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).

  • Page 25: Output Display Window Context Menu

    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 compila- tion of source code files, as well as port status information.

  • Page 26: File Transfer Tab Context Menu

    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.

  • Page 27: Source Code Editor Windows

    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.
  • Page 28 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.

  • Page 29: Terminal Window

    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.

  • Page 30: Terminal Window Context Menu

    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.

  • Page 31: Watch 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.
  • Page 32 The NetLinx Studio v2.4 Work Area NetLinx Studio (v2.4 or higher)

  • Page 33: Using Netlinx Studio

    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.
  • Page 34 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.

  • Page 35: Building The Workspace

    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.
  • Page 36 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.

  • Page 37: Working With Workspace Files

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

  • Page 38: Opening Workspace Files

    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.

  • Page 39: Copying And Pasting Projects

    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.

  • Page 40: Saving The Workspace

    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.

  • Page 41: Importing Exported ("To Go") Workspace Files

    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).

  • Page 42: Viewing And Editing Workspace Properties

    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.
  • Page 43 Working With Workspace Files Export Workspace Files Opens the Export Workspace File To Go dialog, where you can export To Go 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.
  • Page 44 Working With Workspace Files NetLinx Studio (v2.4 or higher)

  • Page 45: Working With Projects

    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.

  • Page 46: Building The Selected Project

    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.

  • Page 47: Converting Netlinx Studio V1.2 Project Files

    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.

  • Page 48: Project Folder Context Menu

    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.

  • Page 49: Working With Systems And System Files

    These files (.IRL or .IRV) are created in the IREdit Program, and con- tain infrared (IR) control functions for IR controlled devices. IR Database files These files (.IRN) contain links to either the AMX IR Database or to a user-defined IR database. Other files In many cases, it is helpful to save document and image files (for example, .TXT, .DOC, .BMP) with the other system files, even if they...

  • Page 50: Creating A New System

    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.

  • Page 51: Adding An Existing System To A Project

    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.

  • Page 52: System Status: Active Vs. Inactive

    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.

  • Page 53: Adding A File To A 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).

  • Page 54: Drag And Drop Files Into A System

    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.

  • Page 55: Building (Compiling Systems)

    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.

  • Page 56: Viewing And Editing System Properties

    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.

  • Page 57: System Files

    IR controlled devices. IR files are placed in the IR folder. IRN files IRN files provide links to the AMX IR Database and/or user-defined IR Database files. Other files In many cases, it is helpful to save document and image files (for example, .TXT, .DOC, .BMP) with the other system files, even if they are not directly...

  • Page 58: Creating New System Files

    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.

  • Page 59: Identifiers Vs. Disk Filenames

    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.

  • Page 60: Device Mapping

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

  • Page 61: Device:port:system (D:p:s)

    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.

  • Page 62: To Remove Device Mapping Information From A File

    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.

  • Page 63: Adding A New Source Code File To A 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.

  • Page 64: Removing A File From A System

    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.

  • Page 65: Saving The Active File

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

  • Page 66: Designating The System's Master Source Code File

    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).

  • Page 67: Utf-8 Encoding

    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.

  • Page 68: Zip File Extraction

    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).

  • Page 69: Source Code File Context Menu

    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 70: Adding A New Include File To A System

    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.

  • Page 71: Include File Context Menu

    NetLinx Studio v2.3 (or higher) 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. Refer to the Cafe Duet online help file for details on creating JAR module files.

  • Page 72: Minimum Support Requirements For Modules

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

  • Page 73: Source Code Entry

    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.

  • Page 74: Compiling Module Files

    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 <filename.AXS>...

  • Page 75: Working With User Interface Files

    Refer to the on-line help files for instructions on generating UI files in these applications. These software applications are available for transfer via the www.amx.com website (Dealers > Tech Center > Downloadable Files > 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 76: Configuring Netlinx Source Code For Kpd 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.

  • Page 77: Sample Netlinx Code

    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.

  • Page 78: User Interface File Folder Context Menu

    (in the Workspace tab of the Workspace Window). IRL files are standard IR library files. IRV files are IR files exported from the VPXpress application (for use with AMX ViewPoint wireless touch panels). NetLinx Studio v2.0 (or later) also supports IR Database (.IRN) files. IRN files are generated in the IREdit application, and consist of a database of IR files (either the read-only AMX IR Database or a user-defined database).

  • Page 79: Iredit

    The AMX IR Database is read-only. To add an IR file from the AMX IR Database to your Project: 1. Select Project > Add From AMX IR Database to open the Select IR From a Database dialog, with the AMX IR Database displayed.

  • Page 80: Adding An Ir File From An Iredit User Database (*Irn) File

    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.

  • Page 81: Ir File Folder Context Menu

    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.

  • Page 82: Working With "Other" Files

    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 83: Other File Folder Context Menu

    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.

  • Page 84: Search And Replace Within The Active Source Code File

    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.

  • Page 85: Searching Across Multiple Files

    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.

  • Page 86: Printing Files

    The status of this operation is indicated in the Status dialog. This only happens the first time a directory is searched. • AMX IRN Database - Use this option to search the AMX IRN Database. • User's IRN Database - Use this option to search for IR files within an existing User IR Database (*.IRN) file.

  • Page 87: Print Dialog

    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.
  • Page 88 Working With Systems and System Files NetLinx Studio (v2.4 or higher)

  • Page 89: Programming

    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.

  • Page 90: Using The Code Wizard

    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 clip- board, and Paste the contents of the clipboard to the active file, at the cur- sor position.

  • Page 91: Creating Events With The Code Wizard

    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.

  • Page 92: Code Wizard - Advanced Users

    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.

  • Page 93: Code Wizard Dialog - Channel Tab

    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.

  • Page 94: Code Wizard Dialog - Level Tab

    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"...

  • Page 95: Code Wizard Dialog - Data Tab

    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 automati- cally. A value of 0 (zero) in the From field will generate an "all level" LEVEL_EVENT handler.

  • Page 96: Code Wizard Dialog - Send Command Tab

    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. Generate @T variable text send command for touch panels. @BMF Generate @BMF variable text send command for touch panels.

  • Page 97: Syntax Highlighting

    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.

  • Page 98: Autocomplete And Autosuggest

    Programming Use chroma-coding to make your code easier to read and manage. For example, you could chroma- code all comments to yellow, all identifiers to red and strings to blue to make them more easily identifiable in your code file. The text elements that can be chroma-coded, and their default color assignments are listed below: Comments green...

  • Page 99: Call Tips

    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).

  • Page 100: Code Folding

    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.

  • Page 101: Unicode Characters

    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.

  • Page 102: Goto Section

    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.

  • Page 103: Case Inversion

    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.

  • Page 104: Find Matching Brace

    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.

  • Page 105: Supported Regular Expression Special Characters

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

  • Page 106: Undo/Redo

    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.

  • Page 107: To Enter Debug Mode

    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.

  • Page 108: Master Controller Debug Options

    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.

  • Page 109: Breakpoints

    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.

  • Page 110: Clearing Breakpoints

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

  • Page 111: Find Push Message Dialog

    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.

  • Page 112: Defining A Unicode String Literal

    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.

  • Page 113: Unicode - Character Case Mappings

    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.

  • Page 114: Unicode - Reading And Writing To Files

    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. The WC_FILE routines operate the same as the FILE routines with the exception of FILE_OPEN.

  • Page 115: Right-To-Left Unicode Strings

    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 right- most 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.

  • Page 116: Using The Terminal Window

    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.

  • Page 117: Ascii / Hex / Decimal Conversions Table

    Programming ASCII / HEX / DECIMAL CONVERSIONS TABLE " & < > NetLinx Studio (v2.4 or higher)
  • Page 118 Programming NetLinx Studio (v2.4 or higher)

  • Page 119: Compile Operations

    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.

  • Page 120: Building The Selected System

    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.

  • Page 121: Compiling An Individual File

    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).

  • Page 122: Compiler Errors And Warnings

    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.
  • Page 123 Compile Operations Device values must be In a range specification, the devices (or their defined identifi- equal ers) 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.
  • Page 124 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 fol- low the PROGRAM_NAME keyword. String constant never ends, A string literal is started but never ends. Add a closing single EOF encountered quotation mark (') to the end of the string.

  • Page 125: 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 126: Compiler Error Warnings Report 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).

  • Page 127: Working With Online Devices

    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.

  • Page 128: Working With The Online Device Tree

    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.

  • Page 129: Device Tree Elements

    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.

  • Page 130: Device States

    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.

  • Page 131: Device Tree Context Menu

    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 Sys- tem Number of the NetLinx Master it is "Found" by. If the device has been configured with a valid Device Number, it will com- municate with the NetLinx Master as that Device Number.

  • Page 132: Binding/Unbinding Devices

    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.

  • Page 133: Netlinx Diagnostics - Netlinx Device Notification

    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.

  • Page 134: Editing Device Notification Settings

    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. 7. Click Done to save the changes and exit the NetLinx Device Notifications Options dialog.

  • Page 135: Removing Devices From 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.
  • Page 136 Working With Online Devices message is obviously completely customizable - whatever is typed in will be SEND_STRING 0 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.
  • Page 137 Working With Online Devices is a header sent with each line - this is a good place to use STR1 DEV_TO_STRING is data. Data bytes < $20 (ASCII control codes) and > $7E (~) are formatted as hex STR2 and separated by commas. As of v2.01, a space ( ) is no longer added between STR1...
  • Page 138 Working With Online Devices is the line length. This may need to be changed if a terminal with a line length nLine other than the typical 80 characters is being used. If not, just leave it as 0 for the defaults. is 2, defaults to 80, else defaults to 67 to allow 13 characters for...

  • Page 139: Buffering Of The Notification And Diagnostic Tabs

    #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. Buffering of the Notification and Diagnostic Tabs The Notification and Diagnostic tabs are capable of handling a large number of messages without adversely affecting the system.
  • Page 140 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 <D:P:S> 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.

  • Page 141: Netlinx Diagnostics - Netlinx Device Control

    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).

  • Page 142: Viewing Push Results

    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"...

  • Page 143: Netlinx Diagnostics - Netlinx Device Addressing

    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.

  • Page 144: Restoring The Default Device And System Numbers On A Netlinx Device

    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.

  • Page 145: Netlinx Diagnostics - Url Lists

    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.

  • Page 146: Netlinx Diagnostics - Network Addressing

    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.

  • Page 147: Setting The Ip Address For A Netlinx Master

    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).

  • Page 148: Changing The Ip Address On A Netlinx Master (Specify Ip Address)

    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.

  • Page 149: Rebooting The Master

    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.

  • Page 150: Notes On Using Current Length (When The Total Length Option Is Disabled)

    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.

  • Page 151: Changing The Value Of A Watched Variable

    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 con- troller or execute one pass through the mainline code for an Axcess con-...
  • Page 152 Working With Online Devices NetLinx Studio (v2.4 or higher)

  • Page 153: Communications And File Transfers

    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.

  • Page 154: Configuring System-Level Communications Settings

    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.

  • Page 155: Configuring Terminal 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.

  • Page 156: Setting The Default Control Platform

    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.

  • Page 157: Connecting To A Netlinx Master Via Tcp/Ip

    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.

  • Page 158: Connecting To A Netlinx Master Via Serial Port

    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.

  • Page 159: Connecting To A Secured Netlinx Master

    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 Parity None Stop Bits Flow Control None Phone Number Enter the telephone number of the master. 7.

  • Page 160: If You Don't Connect

    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.

  • Page 161: File Transfer Operations

    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.

  • Page 162: File Transfers Edit Sub-Menu

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

  • Page 163: File Transfer Status Information

    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).

  • Page 164: Step 1: Adding Files To The Transfer Queue

    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.

  • Page 165: Adding Files To The Files To Send Queue

    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).

  • Page 166: Adding Individual System Files From The Open Workspace File

    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.

  • Page 167: Adding Files To The Files To Receive Queue

    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.

  • Page 168: Step 2: Communication Settings

    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.

  • Page 169: Configuring Serial Communication Settings

    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.

  • Page 170: Configuring Virtual Netlinx Master Communication Settings (Netlinx Only)

    Communications and File Transfers Stop Bits 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.

  • Page 171: Step 3: Device Mapping

    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. Step 3: Device Mapping Setting Device-File Mapping Information Every time you select a file (to send or receive) via the Select Files For File Transfer dialog (Other...

  • Page 172: Receiving Files Directly From A System Device (Serial Connections Only)

    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.

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

    2. Plug in the USB cable into the G4 panel. 3. You should see an USB icon show up in the System Tray. 4. Double click on the icon to bring up the list of USB devices (you should see the "AMX USB LAN LINK"" device in the list).

  • Page 174: Configuring Netlinx Studio For Virtual Netlinx Master Transfers

    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.

  • Page 175: Virtual Netlinx Master Tcp/Ip Transfers

    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.

  • Page 176: Configuring Netlinx Studio For Virtual Netlinx Master Tcp/Ip Transfers

    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.

  • Page 177: Firmware Transfers

    Controllers or System devices. NXI Master Controllers use Kit files for firmware upgrades. A Kit file (.KIT) is a package of several files, all of which are required to upgrade the firmware, and are available online via www.amx.com. The Online Device Tree (Online Tree tab of the Workspace Window) displays information about each online device, including the current firmware version.

  • Page 178: Sending Firmware To An Axcess Device (Tsk File)

    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.

  • Page 179: Netlinx Master Security

    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.

  • Page 180: Master Controller User Name And Password Dialog

    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.

  • Page 181: Connecting To A Secured Netlinx Master

    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. For example, if the target Master already has security enabled (via the Authentication Required option in the Communication Settings for that Master), the user will have to provide the correct User Name and Password set for that Master, even if the File also requires a User Name and Password to successfully transfer to/...

  • Page 182: If You Don't Connect

    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.

  • Page 183: Setting Program Preferences

    This is the background color setting for the selected window. Software History Application This option allows you to specify wether to automatically close the AMX Software History Application when you exit NetLinx Studio, or to leave it running (default = Close when NetLinx Studio Exits).
  • Page 184 • 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).

  • Page 185: Preferences Dialog - Netlinx Compiler Tab

    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.

  • Page 186: Preferences Dialog - Editor Tab

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

  • Page 189: Importing/Exporting Editor Preferences

    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.

  • Page 190: Creating Custom Toolbars

    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.

  • Page 191: Adding/Removing Application Shortcuts In The Tools Menu

    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.

  • Page 192: Creating Custom Shortcut Keys

    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.

  • Page 193: Customizing The Menus

    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.

  • Page 194: Preferences Dialog - Diagnostics Tab

    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.

  • Page 195: Preferences Dialog - Terminal Tab

    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.

  • Page 196: Preferences Dialog - Workspace Tab

    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.

  • Page 197: Troubleshooting

    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.

  • Page 198: Netlinx Master Error - Device_Id Error

    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.
  • Page 199 Index NetLinx Studio (v2.4 or higher)
  • Page 200 ATLANTA • BOSTON • CHICAGO • CLEVELAND • DALLAS • DENVER • INDIANAPOLIS • LOS ANGELES • MINNEAPOLIS • PHILADELPHIA • PHOENIX • PORTLAND • SPOKANE • TAMPA 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...

Table of Contents