manualshive.com logo in svg

AMX NetLinx Studio, Instruction Manual

Share
Download
AMX NetLinx Studio Instruction Manual Download Page 9

Table of Contents

vii

NetLinx Studio - Instruction Manual

Working with Online Devices  .........................................................................137

Working with the Online Tree............................................................................... 137

Online Tree Elements............................................................................................ 138

System.........................................................................................................................  138

Master Controller ........................................................................................................  138

Devices ........................................................................................................................  139

Device State Folders...............................................................................................................  139
Virtual/Dynamic Devices .........................................................................................................   140

Online Tree Context Menu ..........................................................................................  140

Setting Online Tree Preferences .................................................................................  140

Viewing Online Devices and Ports ........................................................................ 140

Checking Port Status ...................................................................................................  141

Online Tree Reports.............................................................................................. 141

Generating an Online Tree Report ..............................................................................  141

Example Online Tree Report - Text File Format ..........................................................  142

Example Online Tree Report - CSV File Format...........................................................  142

Binding/Unbinding Devices................................................................................... 143

Binding an Unbound Device ........................................................................................  143

Unbinding a Bound Device ..........................................................................................  143

Zero-Config Networking ....................................................................................... 144

Generating a List of Network Devices.........................................................................  144

Accessing a Device via Zero-Config Networking.........................................................  144

Configuring Devices via Zero-Config Networking .......................................................  145

Terminal and Telnet Sessions ................................................................................ 145

Terminal Window ........................................................................................................  145

Using the Terminal Window ........................................................................................  145

Terminal Window Context Menu.................................................................................  145

Telnet Window ............................................................................................................  146

Using the Telnet Window ............................................................................................  146

Setting Terminal and Telnet Window Preferences ......................................................  146

See Also ................................................................................................................ 147

File Transfer Operations  .................................................................................149

Overview .............................................................................................................. 149

USB Transfers ..............................................................................................................  149

Sending Files to the Master or System Devices .................................................... 149

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

Summary of Contents for NetLinx Studio

Page 1: ...Instruction Manual Development Tools NetLinx Studio NetLinx Design v3 3 or higher Last Revised 7 02 2013...

Page 2: ...arranted for a period of one 1 year from the Shipping Date b Disk drive mechanisms pan tilt heads and external power supplies are warranted for a period of one 1 year from the Shipping Date c AMX ligh...

Page 3: ...P Switch 2 0 3 NetLinx Studio Work Area 3 Title Bar 3 Menu Bar 4 Toolbars 4 Workspace Bar 4 Editor Windows 5 Output Bar 6 Watch Bar 6 Status Bar 7 Understanding Workspaces Projects and Systems 8 Works...

Page 4: ...ect 25 Copying and Pasting Projects 26 Importing a Project 26 Viewing and Editing Project Properties 27 Removing a Project from the Workspace 27 Adding Systems to a Project 27 Removing a System from a...

Page 5: ...ting a New Block File 49 Adding an Existing Block File to a System 50 Working with Module Files 51 Duet JAR Module Files 51 Minimum Support Requirements for Duet Modules 52 Creating a New Module File...

Page 6: ...rogramming 71 Editor Windows 71 Setting Editor Preferences 72 File Revisions 72 Edit Options 73 Undo Redo 73 Cut Copy and Paste 73 Find Find Next and Replace 73 Searching within the Active File 73 Sea...

Page 7: ...ng with WIDECHAR Arrays and Unicode Strings 99 Unicode Compatible Functions 100 Converting Between WIDECHAR and CHAR 100 Defining a Unicode String Literal 100 Storing a Unicode String 100 Character Ca...

Page 8: ...On a Breakpoint 115 NetLinx Master Error DEVICE_ID Error 115 Debug Option Disabled For Axcess Code File 115 Debugging NetLinx Code with Terminal or Telnet Messages 116 Communication Settings 119 Over...

Page 9: ...nding a Bound Device 143 Zero Config Networking 144 Generating a List of Network Devices 144 Accessing a Device via Zero Config Networking 144 Configuring Devices via Zero Config Networking 145 Termin...

Page 10: ...ation 162 Transfer Errors and Definitions 163 Firmware Transfers 163 Sending Firmware to a NetLinx Device KIT File 163 Sending Firmware to an Axcess Device TSK File 164 Diagnostics Menu Options 167 Ov...

Page 11: ...aster Controller s Date Time 187 File Extraction 188 SRC File Extraction 188 ZIP File Extraction 189 Find IRL IRV Files 189 Find In Files 190 File Compare Utility 191 Backup Workspace Files 192 Import...

Page 12: ...ommand 211 Removing Buttons from Existing Toolbars 212 Creating a New Custom Toolbar 212 Renaming Custom Toolbars 212 Deleting Custom Toolbars 212 Customize dialog Tools tab 213 Customize dialog Keybo...

Page 13: ...all of the files associated with an entire control system i e Master Source Code Source Code axs Include axi files Module axs or jar files IR irl irv files User Interface tpd tp4 kpd and Other any fi...

Page 14: ...cates with the AMX website With WebUpdate you can select from a list of available AMX Software programs to choose for updating WebUpdate determines the latest version of the selected applications retu...

Page 15: ...AMX devices and configure communications settings Click Tools DIP Switch to launch the application Refer to the DIP Switch 2 0 on line help file for details and instructions NetLinx Studio Work Area...

Page 16: ...splay a tooltip describing the button Choose View Toolbars to open the Toolbars sub menu to view or hide the toolbars You can customize the menus via options in the Customize dialog refer to the Custo...

Page 17: ...e See Working with IR Files on page 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 Editor Wi...

Page 18: ...190 Find IR Files tab Displays the results of a Tools Find IRL IRV search operation Double click on a listed file to open it for viewing editing in the IREdit utility program See Find IRL IRV Files on...

Page 19: ...fication messages OFF ON Note Click inside this area to toggle Diagnostics messages Last Push Message and History Displays the most recently received Push if Push is enabled via the Diagnostics Enable...

Page 20: ...es Since all System files are linked to the Workspace when you open a file for editing you are opening and editing the actual file not a local copy In the event that the file is linked to multiple Sys...

Page 21: ...ystems are represented by System folders in the Workspace tab FIG 13 Systems only exist within the context of a Project System Files A control system uses several different types of files including So...

Page 22: ...displayed when NetLinx Studio is launched and provides a read only text file describing features that are new to this release To prevent this dialog from appearing every time the program is launched...

Page 23: ...System files are linked to the Workspace when you open a file for editing you are opening and editing the actual file not a local copy In the event that the file is linked to multiple Systems any chan...

Page 24: ...in the Workspace File Description dialog FIG 19 Click OK to return to the Workspace Wizard 4 Click Next to proceed to the Workspace File Location dialog FIG 20 5 Specify the target location for the W...

Page 25: ...FIG 22 All fields in this dialog are optional Click OK to return to the Project Identifier dialog 7 Click Next to proceed to the System Type dialog FIG 23 8 Use the option buttons to select which type...

Page 26: ...IG 25 Click OK to return to the System Information dialog 10 Click Next to proceed to the Assign System ID dialog FIG 26 11 To associate a System ID to the new System enter the System ID in the text b...

Page 27: ...the Communication Settings dialog FIG 28 14 Click Next to proceed to the Master Source Code File Selection dialog FIG 29 FIG 27 System Communications dialog FIG 28 Communication Settings dialog These...

Page 28: ...cted type See Create an AXS File Using Templates on page 17 for details Add the Master Source Code File later This option allows you to exit the Workspace Wizard at this point and manually specify the...

Page 29: ...nd select the desired AXS file via the Open dialog 3 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...

Page 30: ...cation for the new file in the text box click the Browse button to locate and select a target directory via the Browse For Folder dialog 8 Click Next to complete the Wizard Creating a New Empty Worksp...

Page 31: ...e Close Workspace to close the active Workspace file The program will prompt you to save any unsaved changes before closing the file Adding a Project to the Workspace There are several ways to add a P...

Page 32: ...open Workspace 1 Click to select the Project that you want to remove in the Workspace tab of the Workspace Bar 2 Select Remove Project from the Project menu 3 When prompted click Yes to confirm that y...

Page 33: ...ting AXW file if desired Use the Browse button to navigate to a different folder 3 By default the name and target directory of the APW file to be created matches the name of the open Workspace file wi...

Page 34: ...s are mutually exclusive If you select one the other is disabled Select Include the Compiled TKN TOK File to include the compiled TKN TOK file in the exported APW file Select Include the Complied SRC...

Page 35: ...en Workspace FIG 41 To access this dialog select Workspace Properties from the Project menu You can edit the Identifier and Description fields but the File Name and Creation Date are read only Backing...

Page 36: ...ction Manual 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...

Page 37: ...ral ways to add a Project to the open Workspace Import an existing Project see Importing Projects into a Workspace section on page 19 Create a new Project and import it into the Workspace see below Pa...

Page 38: ...ct which you can then copy paste and modify as necessary within the active Workspace In cases where there are only minor variations from one Project to the next this can be a real timer saver 1 In the...

Page 39: ...Paste a System from another Project see the Copying and Pasting Systems section on page 32 Removing a System from a Project When you remove a System from a Project no System files are actually delete...

Page 40: ...Working with Projects 28 NetLinx Studio Instruction Manual...

Page 41: ...tion with the master controller i e diagnostics online tree etc will be done with the communications settings of the selected System The currently active System appears in bold in the Workspace tab of...

Page 42: ...a Transport Connection Option b Select a Transport Connection Option TCP IP or Serial TCP IP To specify network TCP IP settings NetLinx systems only select the TCP IP option button to enable the TCP I...

Page 43: ...ted System into in the Workspace tab of the Workspace Bar 2 Right click to access the Project folder context menu and select Import a System to open the Open Workspace dialog 3 Use the options in this...

Page 44: ...ways added to the selected highlighted System in the Workspace tab of the Workspace Bar and it is always automatically added to the appropriate System File folder based on file type 1 Select highlight...

Page 45: ...stem File folder based on the file type 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 remov...

Page 46: ...information in this dialog Building Compiling Systems See the Building the Selected System on page 105 See the Building the Active System on page 105 FIG 54 System Properties dialog Identifier Require...

Page 47: ...e See the Working with Block Files section on page 49 for details Module Files NetLinx Module files provide pre fabricated axs code or compiled TKO code to control a specific device on the bus Module...

Page 48: ...f 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 1 Select New from the Fil...

Page 49: ...the selected System Alternatively you can drag and drop files into a System in the Workspace Bar from Windows Explorer or from the Find In Files Find IR Files tabs of the Output Bar See the Drag and D...

Page 50: ...Browse button to navigate to the desired file Relative Path This read only field represents the location of the file relative to the Workspace file that is currently open All files are linked to the...

Page 51: ...ce Code file defines all of the devices in the System and sets any global parameters for the System Source Code files Axcess or NetLinx Source Code files that are sent to specific NetLinx or Axcess de...

Page 52: ...CE DEFINE_CONSTANT DEFINE_TYPE etc that differentiate the various sections contained in a typical Source Code file for the indicated system type If you select User Defined Template then enter the file...

Page 53: ...ab of the Workspace Bar and expand the view to show the System File folders Source Include Module User Interface IR and Other 2 Right click on the Source folder to access the Source File Folder contex...

Page 54: ...the sections and headings i e DEFINE_DEVICE DEFINE_CONSTANT DEFINE_TYPE etc that differentiate the various sections contained in a typical Source Code file for the indicated system type If you select...

Page 55: ...the new file should now appear in the Source folder under the selected System If Make this the Master File Source Code File was checked in step 5 then the file icon will feature the letter M in the Wo...

Page 56: ...can view edit general file information for the selected file s FIG 76 5 Edit the file information if necessary for each file being added to the System If this file is to be the Master Source Code fil...

Page 57: ...log FIG 78 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 Bar and selecting Set A...

Page 58: ...accessed This is the default NetLinx include file and it contains various standard NetLinx system structures and variables This file is called at every NetLinx compile operation and is included even w...

Page 59: ...the file name and the target location for the file and click OK Note that you can enter a path for a non existing folder in the text box and the program will create it for you Click the Browse button...

Page 60: ...menu and select Add Existing Include File FIG 86 3 In the Add Existing Include File dialog locate and select the Include axi file that you want to add to the selected System Use the Recent tab to qui...

Page 61: ...der and can be referenced in the main Source Code FIG 90 Creating a New Block File To create a new Block file that is not associated with a System 1 Select New from the File menu to open the New dialo...

Page 62: ...isting Block File to a System 1 Click to select highlight a System in the Workspace tab of the Workspace Bar 2 Right click on the Source folder to access the Source Code File Folder context menu and s...

Page 63: ...NetLinx module files JAR module files are similar to NetLinx module files except that are generated using the AMX Cafe Duet design application JAR module files are also stored in the Module folder in...

Page 64: ...open the File Template dialog FIG 98 3 Select Yes default or No and click Next to proceed If you select Yes click Next to proceed to the next File Template dialog see Step 4 If you select No click Ne...

Page 65: ...the Browse button to locate and select the file via the Open dialog 5 In this File Template dialog enter a file name for the new Module file and click Next to proceed FIG 100 6 In the New File Locati...

Page 66: ...le File Folder context menu and select Add New Module File to open the File Template dialog FIG 104 Alternatively you can also either select File New or click the New toolbar button and select Module...

Page 67: ...INE_DEVICE DEFINE_CONSTANT DEFINE_TYPE etc that differentiate the various sections contained in a typical Module file for the indicated system type If you select User Defined Template enter the file p...

Page 68: ...IG 110 Adding an Existing Module File to a System 1 Click to select highlight a System in the Workspace tab of the Workspace Bar 2 Right click on the Module folder to access the Module Folder context...

Page 69: ...r each file being added to the System 6 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 Ed...

Page 70: ...ICE NUMBER DEFINITIONS GO BELOW 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 avcnt1...

Page 71: ...NetLinx Studio compiled and then transferred to the NetLinx Master 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: ...UI files created in TPDesign3 tp4 Touch panel UI files created in TPDesign4 kpd Keypad UI files created in KPDesign 4 Click Open to access the File Properties dialog where you can view edit general f...

Page 73: ...o System This opens the Add Existing File dialog 5 Locate and select for the desired KPD file 6 Click OK to close the Add Existing File dialog The file is added to the project file in the UI system fo...

Page 74: ...ate and select the IR irl or irv file that you want to add to the selected System FIG 120 4 Click Open to access the File Properties dialog where you can view edit general file information for the sel...

Page 75: ...Database or a user defined IR database IRN file Adding an IR File from the AMX IR Database If you have installed the IREdit application the Add From AMX IR Database option is available in the Project...

Page 76: ...add the desired files to the Selected IR File s list To remove a file from the Selected IR File s list select a file and click Remove 7 Click OK to close the Select IRN User Database dialog and open...

Page 77: ...you can enter a path for a non existing folder in the text box and the program will create it for you Click the Browse button to locate and select the target directory in the Browse For Folder dialog...

Page 78: ...selected System The file should now appear in the Other folder under the selected System Search Operations Using the Edit and Search Functions The Edit and Search functions are accessible via the Edit...

Page 79: ...that device on the bus The Axcess language allows physical device numbers in the range 0 255 The NetLinx language allows numbers in the range 0 32767 Device 0 refers to the master numbers above 32767...

Page 80: ...these folders to view the System files 5 Select the file you want to map 6 In the Device View window select the target device for the selected file from the list of devices The device list is based o...

Page 81: ...mapping information is removed via the Remove option in the Device Mapping dialog or the Delete command in the System File Device Map context menu Removing Device Mapping Information 1 Select a device...

Page 82: ...67 for details 4 Click OK to save the D P S assignment and close the dialog Printing Files You can print the file in the active Editor window using the Print options in the File menu 1 Choose File Pri...

Page 83: ...w Window option in the Window menu to open the same code file in multiple Editor windows With this feature you to can and edit different locations in a large code file Right click anywhere within an E...

Page 84: ...comments associated with this revision that you would like to include FIG 134 To save a file revision of the active Source Code file 1 Select File Save File Revision to open the Save File Revision dia...

Page 85: ...action Cut Copy and Paste Select Edit Cut to cut the selected text to the clipboard Select Edit Copy to copy the selected text to the clipboard Select Edit Paste to Paste the contents of the clipboar...

Page 86: ...on Selection or Whole File 6 Click Find Next to perform the search The first instance of the search string is highlighted in the Editor window 7 Click Replace to replace the highlighted instance of th...

Page 87: ...e selected section in the open Editor window Goto Functions Subs With this option you can jump to a particular section in your code in the active Editor window 1 Select Edit Goto Functions Subs to acc...

Page 88: ...PUSH keyword is used to find out if a channel has had an input change from off to on such as when a button is pressed If the channel has been turned on the corresponding Push statement is activated Th...

Page 89: ...Selection With text selected in an Editor window select this option to re arrange the selected text to make all numbers in the code i e device numbers channel numbers etc fall into ascending sequentia...

Page 90: ...e Editor Display and Indentions tab of the Preferences dialog by default this option is disabled Advanced Edit Sub Menu Option Action Description Clipboard Buffers Select this option to access a listi...

Page 91: ...led Supported Regular Expressions Regular Expression Description Represents the beginning of a line For example x only matches an x that occurs at the beginning of a line Represents the end of a line...

Page 92: ...nguage Reserved Word If a partial word that is typed is recognized as a reserved word the editor will suggest its closest match Operator All of the following operators and the longer forms BOR AND XOR...

Page 93: ...scroll through the list if necessary and select the term or phrase that you want to insert at the cursor s position Double click or press the Tab key or Enter on your keyboard to insert the selection...

Page 94: ...ample NetLinx Studio displays a list of calls when the word SYSTEM_CALL is followed by a single quote as shown in FIG 145 The list of calls is in alphabetical order with the very first item highlighte...

Page 95: ...y the program or the tabbed dialog FIG 147 Code Wizard Creating Button Events 1 With I want to generate one or more BUTTON EVENT s selected click Next to proceed to the next dialog in the Wizard FIG 1...

Page 96: ...ly this event to all buttons Note that this option is unavailable if the Create Feedback Statements option is selected in the first dialog 6 Click Next to proceed to the last dialog in the Code Wizard...

Page 97: ...log FIG 153 4 Use this dialog to specify how many channels should be handled by this Channel Event By default I want to handle a single channel is selected With this option selected enter the channel...

Page 98: ...zard Creating Level Events 1 With I want to generate one or more LEVEL EVENT s selected click Next to proceed to the next dialog in the Wizard FIG 156 2 Use this dialog to specify how many levels shou...

Page 99: ...Wizard The generated code is added to the code file in the active Editor window Code Wizard Creating Data Events 1 With I want to generate a DATA EVENT selected click Next to proceed to the next dial...

Page 100: ...log in the Wizard FIG 159 2 Specify the type of SEND_COMMAND to create PAGE Make a new page visible on a touch panel PPN Make a new popup page visible on a touch panel If either of these options are s...

Page 101: ...an IR File 1 With I want to generate constants from an IR file selected click Next to proceed to the next dialog in the Wizard FIG 163 2 Specify the IR file to generate constants from use the Browse b...

Page 102: ...urce Code file in the DEFINE_CONSTANT section Code Wizard Advanced Users You can toggle the Code Wizard to show the individual dialogs containing detailed options for all the above functionality that...

Page 103: ...when Use DEVCHAN is selected GET_LAST is selected and disabled Use INTEGER Button ranges will be placed in an INTEGER array named Array Name using the button range defined as From through To in the D...

Page 104: ...DEVCHAN array named Array Name using the Device and channel range defined as From through To in the DEFINE_VARIABLE section A single CHANNEL_EVENT statement referencing Array Name will be generated No...

Page 105: ...ray named Array Name using the Device and button range defined as From through To in the DEFINE_VARIABLE section A single LEVEL_EVENT statement referencing Array Name will be generated If CREATE_LEVEL...

Page 106: ...el range on NetLinx this variable will be created as an array If generating code for a level range on Axcess this variable will be created as a series or variable starting with this name i e Variable...

Page 107: ...TXT or TXT variable text send command for touch panels BMF Generate BMF variable text send command for touch panels PPN Generate PPN popup on send command for touch panels PPF Generate PPF popup off s...

Page 108: ...IR Constant tab Code Wizard IR Constant Options Device The device name used during code generation This name is used to generate the Constant Prefix field IR File The IR file for which you would like...

Page 109: ...fore 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 Se...

Page 110: ...le By default this file is installed with NetLinx Studio to the following path C Program Files Common Files AMXShare AXIs UnicodeLib axi 3 Save your source file with the Encoding option in the Save As...

Page 111: ...o display the characters unicode send command value in the lower read only window 3 Press OK to insert the unicode send command value in the code at the cursor s position Working with WIDECHAR Arrays...

Page 112: ...nstant or variable and initialize it using a Unicode string literal use the following syntax WIDECHAR wcMyString _WC My String Character Case Mappings Converting between upper and lower case is accomp...

Page 113: ...C_CONCAT_STRING _WC First name _WC SurName If you attempt to concatenate Unicode strings or WIDECHAR arrays using NetLinx string expressions expect data loss Using FORMAT The NetLinx Unicode library d...

Page 114: ...le The following file functions support WIDECHAR arrays WC_FILE_OPEN WC_FILE_CLOSE WC_FILE_READ WC_FILE_READ_LINE WC_FILE_WRITE WC_FILE_WRITE_LINE Right to Left Unicode Strings Right to Left Unicode l...

Page 115: ...Files NSM 1 Select Edit Macros to access the Macros sub menu and select Save Macros 2 In the Save As dialog specify a target directory and filename for this macro file and click Save Macros Sub Menu...

Page 116: ...f several macros have been loaded select the macro you want to run via the Select a Macro dialog Select Edit Macros Select Macros to access this dialog FIG 177 Selecting Macros If more than one macro...

Page 117: ...in the open Workspace using the Build Project command When you compile a Project every Source Code Include and Module file contained in all of the Systems within the selected Project are compiled Ther...

Page 118: ...compiler The Compile as Axcess command compiles the selected file using the Axcess compiler 3 The status and results of the build are displayed in the Status tab of the Output Bar See the Compiling S...

Page 119: ...it up into smaller pieces Identifier expected The compiler is expecting an identifier after a DEFINE statement or after an integer declaration in the DEFINE_VARIABLE section Identifier is not an array...

Page 120: ...the PROGRAM_NAME string on the first line of the file This variable type not allowed This error occurs when an attempt is made to use an array variable with DEFINE_LATCHING DEFINE_TOGGLING or DEFINE_...

Page 121: ...this warning can be turned on or off in the Compiler Options tab of the Preferences dialog w Define_Call is not used This warning occurs at the end of program compilation for each DEFINE_CALL subrouti...

Page 122: ...es not act in the way it should If the program code is correct you should check for run time errors These errors occur in the Master Controller usually when it could not perform a particular operation...

Page 123: ...NetLinx code 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 If you attempt to edi...

Page 124: ...execution is suspended between each pass through mainline allowing you to test programs one line at a time Single step mode works differently in NetLinx than it does in Axcess In NetLinx systems it e...

Page 125: ...e 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 Missing files Using Current Length with Total...

Page 126: ...ow context menu and select Toggle Breakpoint or use the Toggle Breakpoint toolbar button 3 A red arrow appears in the Editor window to the left of the cursor position A green bar highlighting the line...

Page 127: ...or 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 us...

Page 128: ...oxes in Windows programs the SEND_STRING 0 code can reformat the data as a string of printable ASCII characters The debug axi file attached to Technote 461 contains 16 subroutines useful for this type...

Page 129: ...that a space 20 is not added between STR1 and STR2 nLine is the line length This may need to be changed if a terminal with a line length other than the typical 80 characters is being used If not just...

Page 130: ...be changed if a terminal with a line length other than the typical 80 characters is being used If not just leave it as 0 for the defaults If nMode is 2 nLine defaults to 80 else nLine defaults to 67 t...

Page 131: ...ious 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 via Network see...

Page 132: ...s configured to automatically ping the Master Controller to ensure availability True or False User ID This value indicates the User Name entered for this address Password This value indicates the Pass...

Page 133: ...ied connection If the connection is successful the connection information is indicated in the Status Bar FIG 186 If the connection fails the program will alert you and prompt you to revisit the curren...

Page 134: ...lick OK to close this dialog and return to the Communication Settings dialog The new Master s IP Address is indicated in the List of Addresses FIG 190 7 Select the new Master connection in the List of...

Page 135: ...mmunication Settings dialog click Listen to open the Listen For Masters dialog FIG 193 2 Click Start Listening to begin listening for blink UDP messages from NetLinx Masters on the same subnet As Mast...

Page 136: ...n the List of Active NetLinx Master Controllers click Stop Listening Note that this action enables the Select To Add button FIG 195 4 Select the IP Address of the target Master and click Select To Add...

Page 137: ...K to save changes close this dialog and return to the Communication Settings dialog The new Master s IP Address is now indicated in the List of Addresses 7 With the newly added Master selected click S...

Page 138: ...ialog which now indicates the newly selected configuration FIG 199 9 Click OK to close this dialog 10 Refresh the Online Tree select Refresh System Online Tree from the Online Tree context menu to con...

Page 139: ...Selection and TCP IP selected as the Transport Connection Option 1 Select an address in the List of Addresses and click Delete 2 The deleted address is removed from the List of Addresses Click Delete...

Page 140: ...port from the drop down list Default 38400 Data Bits Specify a data bit setting from the drop down list Default 8 Parity Specify a parity setting from the drop down list Default None Stop Bits Specif...

Page 141: ...Click Change to re visit the Master Communication Settings dialog to edit the current settings Click Cancel to close the dialog without establishing a connection Configuring a Virtual NetLinx Master...

Page 142: ...fault 1 Range 1 65535 Assuming that the actual NetLinx Master is set to 0 via the System Properties dialog System ID field this default setting will work However if you have designated any other numbe...

Page 143: ...og to edit the current settings Click Cancel to close the dialog without establishing a connection Note that if the connection fails the Status Bar indicates no active connection Connecting via Termin...

Page 144: ...can have its own dedicated communication settings Via the Master Communication Settings dialog 1 Select Settings Master Communication Settings to open the Master Communication Settings dialog 2 Click...

Page 145: ...ck OK to close the Master Communication Settings dialog Via the System Properties dialog Alternatively you can also access System level communications settings options via the System Properties dialog...

Page 146: ...so that as you create new NetLinx systems they will always require that User Name Password combination Connecting to a Secured NetLinx Master When connecting to a NetLinx Master that has security ena...

Page 147: ...ck Communication Settings to access the Communication Settings dialog 3 Select Axcess Master as the Platform selection FIG 211 4 Under Serial Connection Options select a COM port and specify the commu...

Page 148: ...Communication Settings 136 NetLinx Studio Instruction Manual...

Page 149: ...online Double click any online device in the list to display the ports and sub devices associated with the device Click the Display command button or right click anywhere within the Online Tree tab t...

Page 150: ...001 and A V Switcher Scaler port 5002 These are the specific device components within the Master each of which requires it s own firmware For example NetLinx Controllers use two firmware files Master...

Page 151: ...20 Device State Folders The remaining Device folders categorize NDP devices according to their device state FIG 217 Sub devices are indicated with red icons and give a description and firmware version...

Page 152: ...rties and device port properties in the Online Tree 1 In the Online Tree click the Display command button and select Refresh Network Online Tree 2 All devices currently connected to the Master are dis...

Page 153: ...Online Tree context menu to access the Online Tree Report dialog FIG 221 2 Select a format Text File Format or CSV File Format If you select Text File Format then you can select the Include Device Ma...

Page 154: ...ne Tree Report Text File Format The following is an example of an Online Tree Text File Report FIG 222 Example Online Tree Report CSV File Format FIG 223 provides an example of an Online Tree CSV File...

Page 155: ...evice to open the Bind Unbind Device dialog FIG 224 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...

Page 156: ...lect Refresh Zero Config List to generate an initial listing of all Zero Config devices detected Accessing a Device via Zero Config Networking Once you have generated a listing of devices of Zero Conf...

Page 157: ...is currently enabled on the device Also carriage return characters are not appended to the pasted text even if the clipboard text contains one You must press the return key to enter a pasted command...

Page 158: ...Tools Telnet Session This action invokes the Telnet Settings dialog FIG 227 2 In the Telnet Settings dialog specify the IP Address of the Master with which you want to establish a Telnet session Alte...

Page 159: ...Notification Options see page 167 Break On String Options see page 170 Enable NetLinx Device Notifications see page 171 Enable Push Message Status Bar Display see page 171 Enable NetLinx Internal Diag...

Page 160: ...Working with Online Devices 148 NetLinx Studio Instruction Manual...

Page 161: ...panel The File Transfer dialog Tools File Transfer provides an easy to understand approach to file transfer while still providing a high level of flexibility The Virtual NetLinx Master option allows y...

Page 162: ...nication settings transport and target Master that are associated with the System to which they belong To view edit the communications for files in the Send tab select a file and select Edit Communica...

Page 163: ...es via the Select Files for File Transfer dialog 1 In the File Transfer dialog Send tab click the Add command button to open the Select Files For Transfer dialog FIG 230 FIG 229 File Transfer dialog S...

Page 164: ...Transfer Operations Files cannot be added to the Files To Send list without device mapping information Source Code files cannot be sent until they have been successfully compiled While Touch Panel UI...

Page 165: ...or the file s mapping assignment FIG 233 FIG 232 Select Files For File Transfer dialog Other tab Select Files For File Transfer dialog Other tab file types Label Description extension IRL IRV Files IR...

Page 166: ...are now indicated in the file list at the bottom of the Other tab FIG 234 Click Add to add other non Workspace files to the file list via the Open dialog Click Remove to remove a selected file from t...

Page 167: ...file type s to include in a Quick Load The check box options in this dialog allow you to simplify the transfer operation by only sending only specific file types Note that there are additional option...

Page 168: ...in the selected ftl file are added to the File Transfer dialog Smart Transfer for TPDesign4 files Smart Transfer automatically optimizes the transfer by identifying the various components fonts bitmap...

Page 169: ...re specific to receiving files from the Master Controller FIG 228 2 To add the files to be included in this transfer operation click the Add command button to open the Select Files For File Transfer d...

Page 170: ...on in the Communication Settings dialog the Enter Device Number dialog is invoked rather than the Enter Device Mapping Information dialog shown above In this case enter the device number of the target...

Page 171: ...ton FIG 229 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 Fi...

Page 172: ...Protected Setup button to access the Protected Setup page 3 Use the on screen keyboard to enter the password the default password is 1988 4 Press the System Connection button to access the System Conn...

Page 173: ...m and log in as a Dealer 2 Go to the Tech Center via the link at the top of the main page 3 Click the Application Files link in the menu on the left side of the screen 4 Click the NetLinx Design Tools...

Page 174: ...er is indicated in the File Transfer Status tab of the Output Bar Canceling File Transfers 1 Right click on an item in the File Transfer Status tab of the Output Bar 2 Select Cancel Current Transfer f...

Page 175: ...ce dialog FIG 243 Transfer Errors and Definitions Error String Meaning Failure Generic unclassified failure Success Generic success File does not exist The file supplied on the cmdline doesn t exist F...

Page 176: ...eboot option if required by the target device see note below 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 NetLi...

Page 177: ...th a list of all Axcess devices currently online and capable of receiving the firmware 5 Select the target AxLink device from the list 6 Review the File Connection and Target Device information before...

Page 178: ...File Transfer Operations 166 NetLinx Studio Instruction Manual...

Page 179: ...the Add command button see Adding a Device to the Device Notification List section on page 167 If a notification type is enabled the word ON is displayed in the appropriate column See the Enable NetLi...

Page 180: ...ew target device specified has its own line in the notifications list The Device Port System values for example 1 0 0 identify the device in the Device column The selected notification option s are la...

Page 181: ...Notification tab of the Output Bar right click and select Clear in the Notification tab context menu Editing Device Notification Settings In order to edit add or remove devices or Notification types y...

Page 182: ...ction remains active but the program stops processing the appropriate message stream The options in this dialog allow you to enable or disable Break On String for asynchronous notification or diagnost...

Page 183: ...ons Select Disable NetLinx Device Notifications from the Diagnostics menu or use the toolbar button to disable NetLinx notifications This command is only available if NetLinx Device Notifications are...

Page 184: ...files 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 di...

Page 185: ...Command to specify the type of message you are sending b Click Send To Master to send the messages in the Message s to Send field to the master If none of the messages are selected highlighted all me...

Page 186: ...k Send to emulate the specified level and value The Level number range is 0 65535 The list below contains the valid level data types and their ranges 5 To send a String or Command enter a string or co...

Page 187: ...The Start Identify Mode button places the entire NetLinx system specified in the Destination System field in ID Mode Changing the Device System Address On a NetLinx Device Select Device Addressing fro...

Page 188: ...NetLinx Touch Panel or the ID button on NetLinx Masters The device that generates the first event is the device that gets identified Once a device has been identified it will be set or changed to the...

Page 189: ...refresh to represent the new device address URL Listing 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...

Page 190: ...the list select the URL and click Remove To clear all URLs from the list click Remove All Network Addresses Use the options in the Networking Addresses dialog to change the network settings for a spe...

Page 191: ...s as applicable 4 Edit the DNS Address assignments and or add new DNS address information as needed 5 Click Set DNS Information to set the new DNS address assignments 6 Click Reboot Master to reboot t...

Page 192: ...m fields Enter the desired Device and System numbers in these fields 4 To specify the Device Properties information for the selected device click in the Change Device Properties check box to enable th...

Page 193: ...eir device addressing information if necessary FIG 262 Refer to Valid Subnet Masks on page 181 for a listing of valid Subnet Masks and the maximum number of IP Hosts allowed for each Valid Subnet Mask...

Page 194: ...ush button a physical push button found on the network device 1 Select Diagnostics Network Device Addressing to access the Network Device Addressing dialog and open the Set Identification Mode tab 2 U...

Page 195: ...on the network device 1 Select Diagnostics Network Device Addressing to access the Network Device Addressing dialog and open the Set Identification Mode tab 2 Under Network Device Processing Options e...

Page 196: ...he program FIG 270 9 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 se...

Page 197: ...ster Controller dialog Use the options in this dialog to reboot a specified master controller FIG 271 The left side of this dialog lists the Projects and Systems that are included in the currently ope...

Page 198: ...AxLink devices and communication ports DIP Switch 2 0 helps you to quickly figure out how to set device and communications settings for AxLink and NetLinx devices and IR RF settings for TXC Transmitte...

Page 199: ...w next to the Date field to open the calendar window To change the system s date click to select the desired day Use the forward and back arrow buttons to change the month When you select a new date t...

Page 200: ...SRC File to open the Select SRC File for Extraction dialog 2 Locate and select the SRC file you want to extract and click Open 3 In the Extract NetLinx Source From a SRC File dialog the selected file...

Page 201: ...th is indicated in the ZIP File To Extract From field Select the Extract using original directory path s option to preserve the original directory paths of the files default disabled 4 In the Extract...

Page 202: ...rer of the IR device associated with the file you are searching for Hand Control Enter the model number for the hand held IR remote associated with the file you are searching for Model Enter the manuf...

Page 203: ...File Compare Utility to open the File Compare Utility dialog 2 In the File 1 to Compare text box enter the file path and name of the file that you want to compare the other file against 3 In the File...

Page 204: ...kup Workspace Files option in the Tools menu to access the Backup Workspace Files dialog where you can create a backup ZIP file of the open Workspace 1 Select Project Backup Workspace Files to access...

Page 205: ...e includes one or more user defined IR database irn files select the Include User IRN Database s option to include these files in the resulting ZIP file This option is disabled if the Workspace does n...

Page 206: ...you to import a previously exported program preferences configuration epx file Before you can select an EPX file the programs alerts you that the imported file will overwrite the current program prefe...

Page 207: ...elect Tools View ReadMe to open the ReadMe txt file associated with this version of NetLinx Studio FIG 283 This file contains version information as well as a listing of features that are new to this...

Page 208: ...Tools Menu Options 196 NetLinx Studio Instruction Manual...

Page 209: ...s assigned to a variable of a different type Examples Assigning a string literal string expression or array to a non array variable Assigning a non array variable to an entire array Assigning an integ...

Page 210: ...ferred to the master Build With Password Protection Select this option to apply a password to the Source file Once you retrieve the source code file from the master you will be prompted for a password...

Page 211: ...rd to unlock the file The last password you entered in this dialog will be used to open the locked file first If that fails then you will be prompted for a correct password Note When building with sou...

Page 212: ...he 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 disp...

Page 213: ...ws Note You must close and re open all files in order for this option to take effect Trim Blanks at End of Line Select to automatically trim off any blanks at the ends of the lines Enable Column Edge...

Page 214: ...and select the desired EPX file and click Open The Editor tab of the Preferences dialog should now reflect the preferences specified in the imported EPX file Preferences dialog Editor Highlighting an...

Page 215: ...be remembered as a device and syntax highlighted Additionally if the editor recognizes that you have partially typed the name of the above section variable for example dv it will auto suggest dvTP Th...

Page 216: ...Show Zero Config tab This option toggles the Zero Config tab of the Workspace bar default enabled Saving Enable Auto Save Toggles the timed auto saving of text files and the duration of time between...

Page 217: ...a File From the Workspace Close File Without Prompting Always Prompt Before Closing Files Do Not Prompt Or Close File FIG 290 Preferences dialog General tab General options Window Color Display Optio...

Page 218: ...do not already have them default disabled This is so that text copied from the terminal displays correctly in windows text editors Many editors do not recognize text that just has carriage returns at...

Page 219: ...sociated SRC default enabled Automatically choose Smart Transfer when sending a TP4 file default disabled By default select Send Bitmaps when sending a TPD file default enabled By default select Send...

Page 220: ...example the message STRING from CHANNEL 6 0F 1D has two control codes converted to hexadecimal Decimal values will display with a leading character STRING from CHANNEL 6 15 29 Buffer File Options Tot...

Page 221: ...fonts used within the Online Tree Use the Foreground Color drop down palette to set the text color Use the Background Color drop down palette to set the background Show Only Port Counts Click this opt...

Page 222: ...olbars Tools Contains options for adding external programs to the Tools menu as shortcuts Keyboard Contains options for customizing keyboard accelerators hotkeys Menu Contains options for customizing...

Page 223: ...tem to open the Command context menu FIG 296 Customize dialog Toolbars tab Customize dialog Toolbars tab options Toolbars This list box contains a list of all toolbars currently associated with NetLin...

Page 224: ...lick the New button This opens the Toolbar Name dialog 2 Enter a name for the new toolbar in the text box and click OK 3 The new toolbar name appears in the Toolbars list along with an empty new toolb...

Page 225: ...e Arguments field to access a list of supported arguments CurCol Places the column number of the active cursor location into the argument list CurLine Places the line number of the active cursor locat...

Page 226: ...en a list of all command categories These categories mirror the main Menu options File Edit Panel Page Button States Layout View Window and Help with one additional option All Commands this category i...

Page 227: ...menu you can associate an icon with the command 1 For toolbar buttons right click on the select the button that you want to associate an icon with For menu items right click on a menu item to open th...

Page 228: ...s tab Use the options in the Options tab of the Customize dialog to customize the general appearance of the toolbars FIG 300 FIG 300 Customize dialog Options tab Customize dialog Options tab options S...

Page 229: ...Setting Program Preferences 217 NetLinx Studio Instruction Manual...

Page 230: ...tion knowledge In the ever changing AV industry continual education is key to success AMX University is dedicated to ensuring that you have the opportunity to gather the information and experience you...

Reviews:

No comments

Brands by name

Popular brands

Load more brands