Net Linx Manual
Net Linx Manual
NetLinx Studio
v 2.2
So ftw are
Software License and Warranty Agreement
LICENSE GRANT.
AMX grants to Licensee the non-exclusive right to use the AMX Software in the manner described in this License. The AMX Software
is licensed, not sold. The AMX Software consists of generally available programming and development software, product documenta-
tion, sample applications, tools and utilities, and miscellaneous technical information. Please refer to the README.TXT file on the
compact disc or download for further information regarding the
components of the AMX Software. The AMX Software is subject to restrictions on distribution described in this License Agreement.
YOU MAY NOT LICENSE, RENT, OR LEASE THE AMX SOFTWARE. You may not reverse engineer, decompile, or disassemble the
AMX Software.
INTELLECTUAL PROPERTY.
The AMX Software is owned by AMX and is protected by United States copyright laws, patent laws, international treaty provisions,
and/or state of Texas trade secret laws. Licensee may make copies of the AMX Software solely for backup or archival purposes. Lic-
ensee may not copy the written materials accompanying the AMX Software.
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.
PRE-RELEASE CODE.
Portions of the AMX Software may, from time to time, as identified in the AMX Software, include PRE-RELEASE CODE and such
code may not be at the level of performance, compatibility and functionality of the final code. The PRE-RELEASE CODE may not
operate correctly and may be substantially modified prior to final release or certain features may not be generally released. AMX is
not obligated to make or support any PRE-RELEASE CODE. ALL PRE-RELEASE CODE IS PROVIDED "AS IS" WITH NO WAR-
RANTIES.
LIMITED WARRANTY.
AMX warrants that the AMX Software will perform substantially in accordance with the accompanying written materials for a period of
ninety (90) days from the date of receipt. AMX DISCLAIMS ALL OTHER WARRANTIES, EITHER EXPRESS OR IMPLIED, INCLUD-
ING, BUT NOT LIMITED TO IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE,
WITH REGARD TO THE AMX SOFTWARE. THIS LIMITED WARRANTY GIVES YOU SPECIFIC LEGAL RIGHTS. Any supplements
or updates to the AMX SOFTWARE, including without limitation, any (if any) service packs or hot fixes provided to you after the expi-
ration of the ninety (90) day Limited Warranty period are not covered by any warranty or condition, express, implied or statutory.
LICENSEE REMEDIES.
AMX's entire liability and your exclusive remedy shall be repair or replacement of the AMX Software that does not meet AMX's Lim-
ited Warranty and which is returned to AMX. This Limited Warranty is void if failure of the AMX Software has resulted from accident,
abuse, or misapplication. Any replacement AMX Software will be warranted for the remainder of the original warranty period or thirty
(30) days, whichever is longer. Outside the United States, these remedies may not available.
NO LIABILITY FOR CONSEQUENTIAL DAMAGES. IN NO EVENT SHALL AMX BE LIABLE FOR ANY DAMAGES WHATSOEVER
(INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF
BUSINESS INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR INABILITY TO USE THIS
AMX SOFTWARE, EVEN IF AMX HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. BECAUSE SOME STATES/
COUNTRIES DO NOT ALLOW THE EXCLUSION OR LIMITATION OF LIABILITY FOR CONSEQUENTIAL OR INCIDENTAL DAM-
AGES, THE ABOVE LIMITATION MAY NOT APPLY TO YOU.
U.S. GOVERNMENT RESTRICTED RIGHTS. The AMX Software is provided with RESTRICTED RIGHTS. Use, duplication, or dis-
closure by the Government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of The Rights in Technical Data and Com-
puter Software clause at DFARS 252.227-7013 or subparagraphs (c)(1) and (2) of the Commercial Computer Software Restricted
Rights at 48 CFR 52.227-19, as applicable.
This Agreement replaces and supercedes all previous AMX Software License Agreements and is governed by the laws
of the State of Texas, and all disputes will be resolved in the courts in Collin County, Texas, USA. Should you have any
questions concerning this Agreement, or if you desire to contact AMX for any reason, please write: AMX Corporation,
3000 Research Drive, Richardson, TX 75082.
Table of Contents
Table of Contents
Introduction ...............................................................................................................1
Supported Operating Systems and Minimum PC Requirements ...................................... 2
Supported operating systems: ................................................................................................. 2
PC Requirements:.................................................................................................................... 2
Other PC requirements: ........................................................................................................... 2
What’s New Dialog ............................................................................................................ 2
WebUpdate ....................................................................................................................... 3
Software History 2 Application .......................................................................................... 3
DIP Switch 2.0................................................................................................................... 3
The NetLinx Studio Workspace Wizard............................................................................. 3
The NetLinx Studio Code Wizard ...................................................................................... 3
Workspace, Projects and Systems.................................................................................... 4
Converting NetLinx Studio v1.2 Project Files .................................................................... 5
NetLinx Studio v2.x Work Area ......................................................................................... 6
Title Bar.................................................................................................................................... 7
Status Bar ................................................................................................................................ 7
Menu Bar.................................................................................................................................. 8
Toolbars ................................................................................................................................... 8
Workspace Window........................................................................................................... 9
Workspace Window - Workspace tab ...................................................................................... 9
Workspace Folder .................................................................................................................. 10
Workspace Context Menu...................................................................................................... 10
Project Folders ....................................................................................................................... 11
Project Folder Context Menu ................................................................................................. 11
System Folders ...................................................................................................................... 12
System Folder Context Menu................................................................................................. 12
System File Folders ............................................................................................................... 13
Workspace Window - Online Tree tab ................................................................................... 14
Online Tree Context Menu ..................................................................................................... 15
Output Display Window ................................................................................................... 15
Output Display Window - Diagnostics tab .............................................................................. 15
Output Display Window - File Transfer Status tab ................................................................. 15
Output Display Window - Find In Files tab ............................................................................. 16
Output Display Window - Find IR Files tab ............................................................................ 16
Output Display Window - Notifications tab ............................................................................. 16
Buffering of the Notification and Diagnostic Tabs .................................................................. 16
Using ID Mode to Change the Device Address on a NetLinx Device .................................. 119
Network Addressing ...................................................................................................... 119
Changing the System Number on a NetLinx Master............................................................ 119
Changing the IP Address on a NetLinx Device Using DHCP............................................... 120
Setting the DNS Address for a NetLinx Master.................................................................... 120
Setting the IP Address for a NetLinx Master ........................................................................ 120
Changing the IP Address on a NetLinx Master (Use DHCP) ............................................... 121
Changing the IP Address on a NetLinx Master (Specify IP Address) .................................. 121
Setting NetLinx Time and Date ..................................................................................... 122
Checking the Port Status On an Online Device ............................................................ 122
Device Mapping ....................................................................................................123
To Remove Device Mapping Information from a File........................................................... 124
Device Mapping dialog......................................................................................................... 124
System File Device Map context menu................................................................................ 125
Device:Port:System (D:P:S) .......................................................................................... 125
Communication Settings .....................................................................................127
Communication Settings ............................................................................................... 127
Configuring the Default Communications Settings............................................................... 127
Configuring System-Level Communications Settings .......................................................... 128
Configuring Terminal Communications Settings .................................................................. 129
Tested Modems List............................................................................................................. 130
File Transfer Operations ......................................................................................131
Sending Workspace Files to the Master Controller or System Device.......................... 131
Sending Other Files to the Master Controller or System Device................................... 134
Receiving Files from the Master Controller or System Device ...................................... 135
File Transfer Status Information .................................................................................... 136
Removing Inactive File Transfer Requests ................................................................... 137
Canceling Transfers ...................................................................................................... 137
Exiting NetLinx Studio During a File Transfer Operation............................................... 137
Rebooting the Master Controller ................................................................................... 137
Quick Load dialog.......................................................................................................... 137
Firmware Transfers ..............................................................................................139
Sending Firmware to a NetLinx Device (KIT file) .......................................................... 139
Sending Firmware to an Axcess Device (TSK file)........................................................ 140
Setting Program Preferences ..............................................................................141
Setting the Default Control Platform.............................................................................. 141
Setting the Default Communication Settings................................................................. 141
Preferences Dialog........................................................................................................ 142
Introduction
NetLinx Studio v2.0 (and higher) is a 32-bit Windows® application that allows you to program and
maintain entire control systems. NetLinx Studio fully supports both NetLinx and Axcess system
programming.
Beyond creating, editing and compiling source code in two programming languages (Axcess and
NetLinx), NetLinx Studio makes it easy to manage all of the files associated with an entire control
system (i.e. Master Source Code/Source Code (.AXS), Include (*.AXI) files, Module (.AXS) files,
IR (*.IRL/*.IRV) files, User Interface (.TPD, .TP4, .KPD), and Other (any file type) files) into one
centralized location, as a System. To maintain multiple systems, one or more Systems can be
organized within a larger Project. A Project can contain as many Systems as are required for a job.
The Workspace Window organizes and displays all of these Project and System files in a logical
hierarchical tree structure.
NetLinx Studio v2.x features many functional improvements and a refined user-interface. A few
key differences between v1.2 and v2.x are described below:
One important difference in functionality relative to version 1.2 is the concept of the
Workspace. A Workspace represents a set of Projects and Systems and associated System
files. Projects, Systems and System files are all linked to the Workspace to afford a high
degree of flexibility while helping you manage large numbers of files. Since all files are
linked to the Workspace, you can easily re-use System files without creating copies.
NetLinx Studio v2.x also allows you to copy and paste Projects within the Workspace; in
the case that you need to create several similar Projects you can quickly generate multiple
Projects and modify each one as necessary.
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. It is important to
understand that in the event that the file is linked to multiple Systems, any changes
made to the file will be reflected in every instance that the file is used (not just the
System that you were in when the changes were made).
Even if you don't have multiple links to the same file, and instead have only a single
link, you still need to be careful about altering the file. If you are linking to a file that
other people might use, they will be affected by the changes you make to the file. So,
if you intend to make changes to a System file, and you want those changes to be
specific to only one System in the Workspace, you should 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.
Another key difference is the ability to support NetLinx Module files (.AXS),
TPDesign4-generated UI (.TP4) files and G4 touch panels.
NetLinx Studio v2.x uses Wizards to help simplify the process of setting up your
Workspace, and to quickly generate programming code.
Windows XP® Professional (service pack 1 or greater, running on a Pentium 233 MHZ
processor (minimum requirement); 300 MHZ or faster recommended.
If you are installing NetLinx Studio on a Windows XP, 2000 or NT machine, you must
have Administrator rights to install and run all required System files.
PC Requirements:
Pentium 233 MHZ processor (minimum requirement); 300 MHZ or faster recommended.
Other PC requirements:
If the mouse wheel on your Microsoft® IntelliMouse® doesn’t work with NetLinx
Studio, try downloading the latest IntelliMouse drivers from Microsoft.
To prevent this dialog from being displayed every time the program is launched, select
the Don't Show Me Again option at the bottom of the dialog.
This dialog can always be accessed via the Help > What's New option.
WebUpdate
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.
Refer to the AMX Software History Application on-line help file for details and
instructions.
Refer to the DIP Switch 2.0 on-line help file for details and instructions.
Button Events
Channel Events
Level Events
Data Events
Send Commands
IR Constants
The wizard can be toggled to display individual dialogs for all the above functionality for use by
advanced programmers.
When the Wizard generates a new code segment, it is inserted in the active Source Code file, in the
appropriate section of the code.
See Using the Code Wizard section on page 73 for details.
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. A Workspace file represents not only the files currently open in the NetLinx
Studio workspace, but the window and template settings as well. Once you create, save
and then close a Workspace file, you can re-open that Workspace file to recall the
NetLinx Studio workspace, exactly as it was when the Workspace file was created. All
Workspace information is saved in an XML formatted file with the .APW file extension.
A Project represents at least one System (entire set of files needed to operate a Master
Controller, and the controlled devices on an AXlink or NetLinx bus). You can have
multiple Projects contained within a Workspace file, and each Project is represented by a
Project folder in the Workspace. Any Project may contain multiple Systems.
A System represents a set of files associated with a complete control system, comprised
of an Axcess or NetLinx Master Controller, one or more user-interface devices (i.e.
Touch Panels), and various types of controlled devices on the bus. Each System is
represented by a System folder contained within a Project in the Workspace.
Each System contains several System File folders; one for each of the file types used in
the System. System files include Source Code files, Include files, Module files, User
Interface files, IR files, and Other files that you want to include as part of a control
system.
The following table describes the file types represented in the Workspace tab of the Workspace
Window:
The original NetLinx Studio v. 1.2 file is not altered during this conversion process.
To convert NetLinx Studio v1.2 Project Files for use with NetLinx Studio v2.x:
1. Select File > Open Workspace (or use the toolbar button) to open the Open Workspace dialog.
2. Change the Files of type option (at the bottom of the dialog) to NetLinx Studio V1.2 PJS File
(*.pjs) files.
3. Locate and select the desired NetLinx Studio v1.2 Project file (*.PJS).
4. The program prompts you to proceed with the conversion process. Click Yes to continue to the
PJS to APW Project File Conversion dialog.
5. Click Convert to start the process.
6. The program prompts you when the conversion is complete (click OK in the Conversion
Succeeded dialog).
7. Once the file has been successfully converted, the program prompts you to change the
Communication Settings for the converted file. For Projects with multiple systems, the
program prompts you to change the communication settings for each System individually.
Click Yes to change the System-Level Communications Settings for each System contained in
the converted Project (via the Master Communications Settings dialog), or click No to leave
the communication settings alone for this Project/System.
The converted file now exists as a .APW file, in the same folder that contained the
original .PJS file under the same name, but with the .APW file extension.
The new Workspace file is automatically opened in the Workspace Window - Workspace
tab.
At this time, any open Workspace files are automatically closed. If there have been any
unsaved changes made to the open Workspace, the program prompts you to save your
changes before the Workspace is closed.
The converted file now appears as a Workspace with one Project, and one System, and
can be treated like any other NetLinx Studio v2.x Workspace file.
When converting NetLinx Studio v1.2 Projects that contain Module Files, all Module
files will appear in NetLinx Studio v.2's Source folder, as opposed to the Module
folder. Any TKO files resulting from compiling those files will be placed in the Module
file folder. This is only true for converted files, and doesn't apply to Module files added
to a new Workspace file created in NetLinx Studio v.2.
Title Bar
Displays the name of the application, and the name of the currently active file. An asterisk (*) after
the file name indicates that it contains unsaved changes.
Status Bar
The Status Bar (FIG. 3) displays general information, including communication status, a brief
description of any option in the program, cursor location, last Push received, COM port currently
being used, network IP address (NetLinx systems only) and current PC keyboard settings.
The elements of the Status Bar are described below, from left to right:
• Communication Status/quick The far-left side of the status bar displays quick descriptions of
descriptions of program program options anytime you position the mouse cursor over a
options: toolbar button or menu item.
• Notifications Messages Status: Displays the status of NetLinx notification messages (OFF/ON).
• Diagnostics Messages Status: Displays the status of asynchronous diagnostics messages
(OFF/ON).
• Last Push Message and Displays the most recently received Push (if Push is enabled via
History: the Diagnostics > Enable Push Message Status Bar Display
command), or Push status (Push Enabled/Disabled). Left-
mouse click on the push message displayed to view a history of
push messages. Then, right-mouse click within the list box to
view the available options.
• Master Controller Connection: Displays the name and status of the active communications
Information port. If a TCP/IP connection exists, the current IP address is
displayed. If Virtual NetLinx Master is selected, that the Virtual
NetLinx Master is displayed with its System number.
• Cursor Location: Displays the cursor's location in the active Source Code Editor
window (line and column numbers).
• Keyboard Settings: When a file is open (in a Source Code Editor window), the three
boxes on the far-right side of the status bar indicate the status
of the following keyboard settings:
OVR Overwrite/Insert (OVR indicates that the keyboard is
currently in overwrite mode - new characters will
replace or overwrite existing characters in the Source
Code Editor).
CAP Caps Lock (CAPS indicates that the keyboard is cur-
rently in Caps Lock mode - all letters typed will appear
in upper case.
NUM Number Lock (NUM indicates that the 10-key number/
arrow keypad is set to type numbers - arrow functions
are disabled).
Menu Bar
The Menu Bar is located along the top of the application window, between the title bar and the
toolbars. Click on any of the main menu items (File, Edit, View, Project, Build, Diagnostics, Debug,
Tools, Settings, Window or Help) to open the associated drop-down menu.
The main menu bar contains the following menus:
• File: Contains typical File menu options (Save, Save As, Print, Exit), plus several
options relating to file conversion and file transfer.
• Edit: Contains typical Edit menu options (Undo/Redo, Cut/Copy/Paste, Delete), plus
Selection tool options, and access to the Program Preferences dialog.
• View: Contains options for configuring the workspace (i.e. show/hide toolbars and win-
dows).
• Project: Contains various Project-level options (New Project, Add/Remove System, etc).
• Build: Contains options relating to compile operations (Build Workspace, Build System,
Compile As NetLinx/Axcess, etc).
• Diagnostics: Contains options relating to diagnostics operations, including Device Notifications,
Device Emulation/Control, Device Addressing, etc).
• Debug: Contains commands associated with variable watching (Start/Stop Debugging,
Step Mode, Break, etc).
• Tools: Contains options relating to file transfer (send/receive) operations, communica-
tions settings, and links to external programs. The bottom of the Tools menu is a
list of external programs loaded in the Tools list.
• Settings: Contains options for communications settings and program preferences.
• Window: Contains options for window control (stack/cascade/put most recent on top).
• Help: Contains options to access this on-line help program and the About NetLinx Studio
splash-screen.
·Refer to the NetLinx Studio online help for detailed descriptions of each menu item.
Refer to the Setting Menu Preferences (Menu tab) section on page 149 for information on
customizing the menus.
If you are running NetLinx Studio in Windows 2000, NT or XP, you may have to press
the ALT key to view the menu item hotkeys.
Toolbars
There are eight toolbars in NetLinx Studio (FIG. 4)
Choose View > Toolbars to open the Toolbars sub-menu to view or hide the toolbars.
Refer to Setting Toolbars Preferences (Toolbars tab) section on page 147 for information
on customizing the toolbars.
Refer to the NetLinx Studio online help for detailed descriptions of each toolbar button.
Hover the mouse cursor over any toolbar button (for about one second) to display a
tooltip describing the button.
Standard toolbar
Debug Watch toolbar
Edit toolbar
Diagnostics toolbar
Project toolbar
Terminal toolbar
Build toolbar
Workspace Window
Use the Workspace Window (FIG. 2) to manage Workspace files and associated 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.
Use the Workspace Window to view the Workspace file. Workspace files contain Project(s) and
their component System files and devices. The Workspace Window is visible when enabled via the
View menu.
Right-click inside the title bar to display the View Control context menu, where you can
select to hide or display the NetLinx Studio toolbars.
The first level within the open Workspace is the Project folder level.
The next level is the System(s) contained within the Project, each represented by a
System folder.
The third level contains the System File folders (Source, Include, Module, User Interface,
IR and Other).
The fourth level contains all of the actual files that make up the System (.AXS, .AXI,
.TPD, .TKO, .TP4 .IRL/.IRV, and *.*).
The hierarchical file structure of the Workspace tab is described in the following sub-sections:
Workspace Folder
You can have one Workspace open at a time. A Workspace contains at least one Project, and each
Project contains at least one System.
• New Workspace Closes the currently open Workspace, and starts a new (empty) work-
space (no Project/System associated until you add them manually).
• Workspace Wizard Launches the Workspace Wizard, which steps you through the pro-
cess of creating a new Workspace with a Project/System.
• Open Workspace Opens the Open Workspace dialog, where you can locate and select
an existing Workspace (.APW) file. You can have only one Workspace
open at any time, so in the event that you have a Workspace open, it
will be replaced by the one you open.
• Close Workspace Closes the Workspace file. The program prompts you to close the
files associated with the Workspace before closing them.
• Save Workspace Saves the Workspace file, under its current name and location.
• Save Workspace As Opens the Save Workspace As dialog, where you can specify a new
name and/or location for the saved Workspace file.
• Build Workspace Builds (compiles) the Workspace (including all contained Projects).
The progress and results of the build can be viewed in the Status tab
of the Output Display window.
• Export Workspace Files Opens the Export Workspace dialog, which allows you to export the
Workspace file as a ZIP file. The options in this dialog allow you to
specify the name of the resulting ZIP file, the target folder for the ZIP
file, and whether to include the full directory paths within the ZIP file.
• Import From Exported Opens the Select AXW File dialog, where you can select a previously
Workspace File exported "To Go" (AXW) file to import into the program.
• New Project Opens the New Project Properties dialog, which allows you to assign
an Identifier and general properties for a new Project. Once created,
the new project is added to the Workspace.
• Import a Project Opens the Open Workspace dialog, where you can locate and select
a Workspace (.APW) file. This invokes the Import Components From
a Workspace dialog. Use the dialog to select a specific Project con-
tained in the Workspace.
• Paste Project You can copy and paste Projects by selecting Copy Project from the
Project Folder context menu, and selecting the Paste Project com-
mand.
• Collapse Tree Collapses the Project/System/File tree to show only the Workspace
and its Project(s).
• Expand To System Level Expands the Project/System/File tree to show the Workspace,
Project(s) and System(s).
• Docking view Changes the Workspace Window to a dockable window that can be
resized and moved to anywhere within the NetLinx Studio work area.
• Hide Hides the Workspace Window
• Quick Load Workspace This option allows you to access the File Transfer dialog, already con-
figured to send all files in the Workspace (active Project/System only)
to the Master associated with the active System.
• Workspace Properties Opens the Workspace Properties dialog, where you can view the
basic properties of the Workspace. The options in this dialog also
allow you to edit the Workspace Identifier and Description.
Project Folders
Double-click any Project folder to display the System folder(s) contained in that Project.
• New Project Opens the New Project Properties dialog. The options in this dialog
allow you to specify information for the new Project, including Project
Identifier, Dealer, Sales Order, Designer, Purchase Order and
Description.
• Remove Project Removes the selected Project from the Workspace. This option does
not delete the Project or its associated files from the disk.
• Build Project Builds (compiles) the Project (including all contained Systems and
System files). The progress and results of the build can be viewed in
the Status tab of the Output Display window.
• Copy Selected Project Copies the selected Project to clipboard memory, so it can be pasted
(within the same Workspace only), via the Paste Project command in
the Workspace context menu.
• New System Opens the System Properties dialog, which allows you to assign an
Identifier, System ID, and Description for a new System. The System
Properties dialog also contains options that allow you to set custom
communication settings for the new system. Once created, the new
system is added to the Project.
• Import a System Opens the Open Workspace dialog, where you can locate and select
the Workspace (.APW) file that contains the System you want to
import into the Project. Once you select an APW file, the Import Com-
ponents From a Workspace dialog is invoked. Use this dialog to select
specific Systems contained in the selected Workspace.
• Paste System You can copy and paste Systems (within a single Workspace) by
selecting Copy Selected System from the System context menu, then
opening the target Project, and selecting the Paste System com-
mand.
• Collapse Tree Collapses the Project/System/File tree to show only the Workspace
and its Project(s).
• Expand To System Level Expands the Project/System/File tree to show the Workspace,
Project(s) and System(s).
• Docking View Changes the Workspace Window to a dockable window that can be
resized and moved to anywhere within the NetLinx Studio work area.
• Hide Hides the Workspace Window.
• Quick Load Project This option allows you to access the File Transfer dialog, already con-
figured to send all files in the active Project to the Master associated
with the active System.
• Project Properties Opens the Project Properties dialog, where you can view and edit the
basic properties of the Project (Project Identifier, Dealer, Sales Order,
Designer, Purchase Order and Description).
System Folders
Each System has it's own platform (Axcess or NetLinx) setting along with the
communication information (i.e. IP address or COM port setting with the appropriate
baud rate, etc.).
Double-click any System folder to display the six System File folders contained in that
System (Source, Include, Module, User Interface, IR and Other).
• Set as Active System Sets the currently selected System as the Active System.
• New System Opens the New System dialog. The options in this dialog allow you to
specify information for the new System, including System Identifier, Sys-
tem ID, Description and Communication Settings.
• Remove System Removes the selected System from the selected Project. This option does
not delete the System or its associated files from the disk.
• Build System Builds (compiles) the active System (including all contained System files).
The progress and results of the build can be viewed in the Status tab of
the Output Display window.
• Copy Selected Copies the selected System to clipboard memory, so it can pasted into
System another Project (via the Paste System command in the Project Folder
context menu).
• Add File To System Opens the Add Existing File dialog, which allows you locate and select an
individual file to be added to the active System. The selected file will auto-
matically be added to the appropriate System File folder, based on file
type.
• Collapse Tree Collapses the System/File tree to hide all System files.
• Expand System Tree Expands the System/File tree to show all System files contained in the
System File folders.
• Docking View Changes the Workspace Window to a dockable window that can be
resized and moved to anywhere within the NetLinx Studio work area.
• Hide Hides the Workspace Window.
• Quick Load System This option allows you to access the File Transfer dialog, already config-
ured to send all files in the active System to the Master associated with
the active System.
• System Properties Opens the System Properties dialog, where you can view and edit the
basic properties of the active System (System Identifier, System ID,
Description and Communication settings).
Double-click on any System File folder to display the System File(s) contained in that
folder.
Right-mouse click on any System File to open the System File context menu associated
with that file type.
Double-click any code file (Master Source Code, Source Code, Module or Include) to
open that file for viewing and/or editing in a Source Code Editor window.
Double-click any TPD file to open the TPDesign3 program (if it is installed).
Double-click any TP4 file to open the TPDesign4 program (if it is installed).
Double-click any KPD file to open the KPDesign program (if it is installed).
When you add a file to a System (Project > Add File To System), the file is automatically
placed (as a link) in the appropriate System File folder, based on it's file type.
You cannot have the same file referenced more than once within a system (i.e. cannot add
the same file name to the Source folder and the Other folder within the same System).
Other key functions and features of the Workspace tab include:
You can drag and drop files from Explorer into the appropriate sub-folders within a
System.
All files are linked files associated with a system, not copies of files from one location to
another.
For TPD/4, IR files and other source code files, you have the ability to map multiple
devices to the selected file.
The Master Source Code file will always be mapped automatically to device address
0:1:0 for NetLinx masters or 0 for Axcess masters.
You have the ability to copy a selected System folder to paste into another or the same
Project folder.
You have the ability to designate a single source code file as the Master Source Code file.
The Online Device tree is only a snap shot and is not updated in real time as devices
come on/off line. Select Refresh System or Refresh Network from the Online Tree
Context Menu (described below) to update the Online Device Tree.
The online devices are organized according to the System they belong to.
Double-click any System folder to display a list of System devices (and their firmware
version) that are currently online.
Double-click any online device in the list to display the ports and sub-devices associated
with the device.
Sub-devices are hardware components contained within a parent device, which may
require their own firmware. For example, and NXI Master Controller contains three
components, each of which require firmware.
• Refresh System Click to refresh the Online Device Tree for the local system (the system
containing the Master Controller that your PC is connected to). For
NetLinx systems, it is the Master Controller identified in the Network
field of the Communication Settings dialog. The Connection Status to
the Master Controller dialog may appear, if communication to the mas-
ter has not already been established.
• Refresh Network Click to refresh the entire online tree.
• Device Addressing Click to access the Device Addressing dialog, where you can view/edit
the Device/System addressing information for the selected device.
• Check Port Status This item is enabled only if a Port item is selected in the Online Device
Tree. The status of the selected port is displayed in the Status tab of
the Output Display window.
• Expand Tree Click to expand all of the folders in the Online Device Tree to show all
devices, ports and components.
• Expand to Device Level Click to expand the Online Device Tree to show all devices in the Sys-
tem.
• Collapse Tree Click to collapse the Online Device Tree to the top-level System
Devices folder.
The buffer files that are used by the Notification and Diagnostic tabs can become full.
When this happens, the program will disable the appropriate option. You will need to
clear the appropriate list before you can start the option again. You may copy the text
from the list view or save the content of the list view to a file.
Double click on a line containing an compiler error message to open the file in a Source
Code Editor window, with the cursor positioned at the beginning of the line containing
the indicated error.
The version number of the compiler (NetLinx or Axcess) is displayed in the Status tab,
whenever source code is being compiled.
As indicated, some of the options below are not relevant to all tabs.
• Enable/Disable Asynchronous (Notifications tab only): Stops or starts the asynchronous notifi-
Notifications cations messages that are sent by the NetLinx master controller
without visiting the menu bar.
• Enable/Disable Diagnostics (Diagnostics tab only): Stops or starts the internal system diag-
Messages nostics messages that are sent by the NetLinx master controller
without visiting the menu bar.
• Copy All Items Copies all items in the list to the clipboard.
• Copy Selected Items Copies only the selected items in the list to the clipboard.
• 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.
• Find (Notifications and Diagnostics tabs only): Search for text within
the tab, via the Find dialog. You may search up or down the tab
based on the current cursor location within the tab. The search
can be case sensitive. When the text is found in the tab, the pro-
gram highlights the row and scrolls the row into view.
• Clear Clears all the items within the list.
You must stop the appropriate process (either the Asynchronous Notification or
Diagnostic messages) with the master controller before you can select the Save As or
Copy menu options.
NetLinx Studio features a Code Wizard that steps you through the process of
generating several different types of code. See The NetLinx Studio Code
Wizard section on page 3 for details.
Do not attempt to open .LIB or .SYC files for editing in the Source Code Editor. Doing
so could cause program failure.
The text in the Editor windows is syntax highlighted for increased readability with a
default set of colors. Use the options in the Editor Options tab of the Preferences dialog
to customize various aspects of the Source Code editor windows (i.e. syntax highlighting,
auto-indent, show/hide line numbers and clipboard text buffer settings).
Syntax highlighting assigns different colors to different types of data in your Source
Code file. Use syntax highlighting to make your code easier to read and manage. For
example, you could syntax highlight all comments to yellow, all identifiers to red and
strings to blue to make them more easily identifiable in your code file.
Drag and drop any supported file type from Explorer into the Source Code Editor to open
that file in a new Source Code Editor window.
Drag and drop selected text to another Editor window (at the cursor location), or to
another location within the same Editor window.
Source Code Editor windows are moveable and resizeable. Use the options in the
Window menu to arrange (cascade or tile) multiple windows.
Use the New Window option in the Window menu to open the same code file in multiple
Editor windows. This feature allows you to view and edit different locations in a large
code file.
Right-click anywhere within a Source Code Editor window to open the Source Code
Editor context menu.
Hold down the Alt key and select text with the left mouse button for columnar Cut, Copy,
and Paste operations.
Use the Edit > Insert Section option to insert a (empty) section of code at the cursor
position.
Use the Edit > Goto Section option to move the cursor to the beginning of a selected
section of code in the active Editor window.
The Edit > Undo and Redo commands allow unlimited Undo/Redo operations.
Use the Edit > Make Selection Uppercase and Make Selection Lowercase commands to
automatically change the case on a selection of text.
Use the Edit > Sequentially Renumber Selection command to sequentially renumber
selected number text in the active Editor window.
The Edit > Block Comment-Uncomment option allows you to block comment-
uncomment selected text in the active Editor window.
To indent a block of text, select text and press the Tab key. Use Shift + Tab to remove the
indentation.
Action Description
Select None removes any selection.
Delete Selection deletes whatever is selected. Equivalent to hitting the delete key when you
have a selection.
Delete All deletes everything. Clears the document.
Select Word selects the nearest word to the cursor.
Select Word Left selects from the cursor to the start of the word.
Select Word Right selects from the cursor to the end of the word
Select Line selects the current line at the cursor
Select Line Left selects from the cursor to the beginning of the line
Select Line Right selects from the cursor to the end of the line
Delete Word deletes the current word at the cursor
Delete Word Left deletes from the cursor to the start of the word
Delete Word Right deletes from the cursor to the end of the word
Delete Line deletes the current line at the cursor
Delete Line Left deletes from the cursor to the beginning of the line
Delete Line Right deletes from the cursor to the end of the line
Syntax Highlighting
When a source file is loaded in the editor, it is read line by line. Each line is broken up into its
constituent words. Technically the line is broken into tokens, but the concept of a word is more
familiar to most people. Different words and groups of words are handled differently. Here is a
breakdown of the mechanism used:
Comments: Any portion of the line that initiates or falls within a comment is considered
to be one comment (essentially it’s treated as one big word). The comment is then syntax
highlighted using the color specified in Preferences > Editor > Comment.
Language Reserved Words: When NetLinx Studio is started it loads two files:
NetLinx.rw and Axcess.rw. These are the “reserved word” files. These files contain all of
the words that NetLinx Studio will consider to be “Language Reserved Words”.
Language Reserved Words are syntax highlighted using the color specified in
Preferences > Editor > Language Reserved Word.
If a partial word that is typed is recognized as a reserved word, the editor will suggest its
closest match.
are syntax highlighted using the color specified in Preferences > Editor > Operator.
Number: A number is any series of digits that does not include a decimal point. A
number may have the optional prefix “$” for hex or the optional postfix “b” for binary. If
the number is a hexadecimal number then it may contain the letters A-F or a-f. Numbers
are syntax highlighted using the color specified in Preferences > Editor > Number.
String: Strings are any series of characters and digits that occur within two single quotes.
Strings are syntax highlighted using the color specified in Preferences > Editor >
String.
Constants, Devices, Type, Variable: Since NetLinx code may be divided into the
following sections DEFINE_CONSTANT, DEFINE_DEVICE, DEFINE_TYPE,
DEFINE_VARIABLE, anytime a word is encountered that falls within one of these
sections it is parsed, remembered and then syntax highlighted according to the section in
which it occurred. So if a DEFINE_DEVICE section contains a line that reads
“dvTP = 128” the word dvTP will be remembered as a device and syntax highlighted
using the color specified in Preferences > Editor > Device. Additionally, if the editor
recognizes that you have partially typed the name of the above section variable (say
“dv”), it will autosuggest “dvTP”. It does this for all of the items it encountered in any of
the above DEFINE_ sections.
Default Text: Any word that is not recognized as any of the above is syntax highlighted
using the color specified in Preferences > Editor > Default Text.
Use the Edit > Rescan Current Source File option to rescan the active file, in order to
rebuild the symbol information utilized by the AutoComplete/AutoSuggest feature.
Build Active System Compiles all Source Code files (and any associated Include and
Module files) in the active System.
Compile Compiles the active file, using the compile type associated with the
<active Source Code File> file (the compile type can be changed via the File Properties dialog).
Compile as NetLinx Click to compile the active file using the NetLinx compiler, regardless
of it's Compile As property.
Compile as Axcess Click to compile the active file using the Axcess compiler, regardless
of it's Compile As property.
Undo, Redo Undo and Redo the last text editing action.
Cut, Copy, Paste Cut the selected text to the clipboard, Copy the selected text to the
clipboard, and Paste the contents of the clipboard to the active file, at
the cursor position.
Delete Deletes the selected (highlighted) text in the active Source Code Edi-
tor window.
Select All Selects all of the code in the active file.
Goto Section Click to open the Goto Section sub-menu, which contains a listing of
code sections in a Source Code File. Select a section from this list to
jump to the beginning of that section in the active file. If a section that
does not exist within the active code file is chosen, nothing happens.
Goto Line Opens the Goto Line dialog, where you can specify the line of code
to which you want to move the cursor in the active file. If a line num-
ber is entered that is beyond the max number of lines in the file, the
cursor is moved to the last line in the file.
Bookmark Inserts a bookmark at the line containing the cursor in the active file.
Bookmarks are indicated by a blue box in the left margin of the
Source Code Editor window. You can have as many bookmarks as
number of lines in the source code.
Toggle Breakpoint Places a breakpoint in the active file, at the cursor position (NetLinx
files only). Once a breakpoint has been inserted in the file, place the
cursor in the line with the breakpoint and select Toggle Breakpoint
again to remove the breakpoint.
Clear Breakpoints Removes all NetLinx breakpoints.
Terminal Window
NetLinx Studio provides a terminal interface to NetLinx and Axcess devices that support an
interactive terminal mode. The Terminal toolbar is enabled when the Terminal window is opened,
with connect/disconnect commands and the (ASCII, Hex, and Decimal) display commands.
Key features of the Terminal window (accessible through the Terminal window context menu) are
described below:
Paste Operations
Text data contained in the clipboard can be pasted into the terminal window. However, text can only
be pasted when the Terminal window is connected (online), and only the first line of text in the
clipboard will be pasted.
All characters pasted in the Terminal window are not pasted into the window directly,
regardless of the current position of the caret. Rather, they are sent out the port to the
device just as if they had been typed directly from the keyboard. This means that you
will not necessarily see the text that was pasted unless echoing is currently enabled
on the device. Also, carriage-return characters are not appended to the pasted text
(even if the clipboard text contains one). Your must press the return key to enter a
pasted command.
For serial ports, specify the COM port, and set baud, data bits, parity, stop bits and flow
control.
For modems, specify the COM port, and set baud, data bits, parity, stop bits, flow control
and target phone number.
The default settings for Serial and Modem ports are:
You cannot use the Terminal window while a communication port is in use for a file
transfer or debug operation.
If the Terminal window becomes unresponsive, close and re-open the window.
To leave the Terminal window active for a long session, click the Terminal Locks the
Port option in the General tab of the Preferences dialog.
Use the Format tab of the Preferences dialog to change the appearance of the elements of
the Terminal window.
To use the Terminal window with NetLinx systems, you must be connected to the Master
via the PROGRAM port. Otherwise, you can use Windows TelNet for terminal control of
NetLinx systems.
The Terminal Window does not support:
Cut operations.
Editing operations within the window, other than to input characters at the cursor. (The
text in the terminal window actually reflects what has been received from the device. Text
that is typed in the window will not appear unless echoing is currently enabled on the
device).
• Add line feed character This option toggles the display of a line feed character in the termi-
nal window (default = disabled).
• Send Ctrl characters to port This option toggles the transmission of control characters to the
terminal's port (default = disabled).
• Colors These options allow to customize the colors for both states (Active
(Connected) and Inactive (Disconnected)) of the terminal window.
To change the colors on the terminal window, select Active (Con-
nected), then click the down arrows to access the Foreground
(text) and Background color palettes. Select the desired colors,
and repeat for the Inactive (Disconnected) state.
• Terminal buffer size Use the slider to increase or decrease the size of the terminal
buffer. The range is 16 - 64K (default = 32K).
• Display Click to open the Display sub-menu, which contains view options for the Ter-
minal Window. The options are ASCII, HEX (hexadecimal) and DEC (deci-
mal).
• Clear Clears the contents of the Terminal Window.
• Save To File Opens the Save As dialog, which allows you to save the contents of the Termi-
nal Window as a text file (.txt).
• Disconnect Disconnects the Terminal. The terminal window background turns a light
shade of gray, to indicate that it is disconnected.
• Last commands At the bottom of this menu is a list of the last commands entered.
Watch Window
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 specified variables within a compiled Axcess or NetLinx program. Also, you can
control the execution of the mainline of a compiled Axcess or NetLinx program. The Watch
window contains three tabs (Watch1-Watch3), which allow you to watch up to three separate sets/
lists of specified variables.
The Watch window consists of a table with several columns:
You can also drag and drop a variable from the Source Code Editor window into the
debug window.
You cannot compile, send/receive files, or change port settings while the program is
in debug mode.
To use debugging, the Build With Source option must be selected in the Preferences
dialog (Axcess Compiler Options tab), before the file is compiled.
1. Open and compile an Axcess 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 to open the Watch window. If this option is disabled, make sure your
Master Communications Port settings are set to connect to your Master Controller.
3. Right-click inside the Watch window to open the Watch Window context menu.
4. Click Add to insert a new variable in the Watch window. A box appears in the window, with a
cursor blinking in the Name column.
5. Type the syntax of the variable exactly as it is defined in the code and press the Enter key. The
value of the specified variable appears next to the variable (in the Value column).
6. You can select different view formats for the Value by right-clicking on the line containing the
variable/value, and clicking on Display in the Watch window context menu. This opens the
Display sub-menu, containing the following view options:
• ASCII Display displays the value of the watched variable in ASCII format.
• Decimal Display displays the value of the watched variable in decimal format.
• Hexadecimal Display displays the value of the watched variable in hexadecimal format.
• Octal Display displays the value of the watched variable in octal format.
• Binary Display displays the value of the watched variable in binary format.
• Add Variable From List: Opens the List of Watched Variables dialog, where you can select a
variable to add to the Watch Window from a list of all variables located
in the TKN file of a compiled NetLinx source code file.
• Delete Variable: Deletes the selected variable from the Watch Window.
• Delete All Variables: Deletes all variables from the Watch Window.
• Total Length: Sets the viewing mode for arrays to show the total length of the array in
the Length column of the Watch Window. All of the locations of the
array are displayed, regardless of the current length value of the array.
• Step Mode: Toggles the step mode between Run and Single Step mode.
• Single Step: In NetLinx systems, this command executes a single instruction in the
source file; in Axcess systems, it executes a single line of code in the
Mainline.
Notes on using Current Length (when the Total Length option is disabled):
The way you initialize variables in your source code affects the use of Current Length. For
example, if you have a variable declared as:
CHAR cat[3]
in debug, Total Length = 3 and Current Length = 0.
If you modified the code as:
CHAR cat[3] = 'CAT'
in debug Total Length = 3 and Current Length = 3.
If you modified the code like this:
CHAR cat[3]
and then in the DEFINE_START section of your code you added:
cat[1] = 'C'
cat[2] = 'A'
cat[3] = 'T'
in debug Total Length = 3 and Current Length = 0, because setting values using array indexing does
not set the current length.
Dockable Windows
Dockable windows can be re-arranged within the application window. They automatically snap to
the top, bottom, right or left side of the application window. The windows you can dock and resize
are the Workspace Window, Output Display window and Watch window.
Double click in the title bar of any of the dockable windows to dock/undock the window.
To move the windows, click on the title bar and drag and drop the window.
To dock the windows, drag the window to reposition it next to any border or window
frame and the window will automatically snap to the nearest border.
To stretch/resize the windows, click on any border and drag the border either vertically or
horizontally.
The File > Save Workspace command only saves the Workspace (APW) file itself,
and does not save changes made to the System files contained in the Workspace.
Use the File > Save All command to save the Workspace file and all of the System
files it contains.
One advantage of the Workspace file is that it serves as a time-saver: Once you have saved a
Workspace file, (containing a particular set of Projects, Systems and System Files), the next time
you open the application, you can simply open the single Workspace file (File > Open Workspace)
to load the Projects/Systems it contains. This way you bypass the need to open each Project,
System and System File individually.
All Projects and associated Systems and System files are linked to the Workspace, so that you can
add and remove Projects and Systems without having to make copies of the files. NetLinx Studio
v2.x also allows you to copy and paste Projects within the Workspace; in the case that you need to
create several similar Projects you can quickly generate multiple Projects and modify each one as
necessary.
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. It is important to
understand that in the event that the file is linked to multiple Systems, any changes
made to the file will be reflected in every instance that the file is used (not just the
System that you were in when the changes were made).
Even if you don't have multiple links to the same file, you should still be careful about
altering the file. If you are linking to a file that other people might use, they will be
affected by the changes you make to the file. So, if you intend to make changes to a
System file, and you want those changes to be specific to only one System in the
Workspace, you should 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.
Workspace files also allow you to build (compile) multiple Projects/Systems. The Build Workspace
command compiles every file contained in the Workspace.
It is important to note that in NetLinx Studio v2.x, there is no concept of Projects outside the
context of a Workspace. A Project can only be opened by adding it to a Workspace. This is to
support the file linking aspect of the program.
Other features of the Workspace file include:
You can import other Project or Systems folders from previously saved Workspace files.
You can copy and paste existing Projects and Systems within a Workspace.
You can edit the identifier that is used to display the workspace name in the tree display
along with the description for the Workspace file via the Workspace Properties dialog.
You can export all the files associated with the Workspace (including the Workspace file)
into a .ZIP file.
13. Click Next to proceed to the System Communications dialog. This dialog displays the current
Master Communication Settings in a read-only text box.
14. Click Communication Settings to set the communication settings for this System, in the
Communication Settings dialog.
These settings become the default communication settings for all new Workspace
files, until they are manually changed.
15. Click Next to proceed to the Master Source Code File Selection dialog.
16. Use the radio buttons to select the type of Master Source Code file to create for this System:
Create an empty AXS File: This option generates an AXS file that is totally empty (no
templates used):
a. Click Next to proceed to the Master Source Code File Name dialog.
b. Enter a name (up to 128 characters) for the new (empty) Master Source Code File.
c. Click Source Code File Description to enter a description (up to 2,000 characters)
in the Source Code File Description dialog, and click OK to return to the Master
Source Code File Name dialog.
d. Click Next to proceed to the New File Location dialog.
e. Specify the target location for the new file in the text field (click the Browse button to
locate and select a target directory via the Browse For Folder dialog).
f. Click Next to complete the Wizard.
Add an existing AXS File to the System: This option adds an existing AXS file to the
System as the Master Source Code File:
a. Click Next to proceed to the Existing Master Source File Location dialog.
b. Enter a path and filename of the desired Master Source Code File, or click the
Browse button to locate and select the desired AXS file via the Open dialog.
c. Click Source Code File Description to enter an optional description (up to 2,000
characters) in the Source Code File Description dialog, and click OK to return to the
Existing Master Source File Location dialog.
d. Click Next to complete the Wizard.
Create an AXS File using Templates: This option generates an AXS file using either
the NetLinx or Axcess template, depending on the System type specified in Step 9. This
option results in a Source Code file that is formatted with header/footer information and
all of the main sections of a typical Source Code File of the selected type:
a. Click Next to proceed to the File Template dialog.
b. Enter a name (up to 128 characters) for the new Master Source Code File.
c. Click Next to proceed to the New File Location dialog.
d. Specify the target location for the new file in the text field (click the Browse button to
locate and select a target directory via the Browse For Folder dialog).
e. Click Source Code File Description to enter an optional description (up to 2,000
characters) in the Source Code File Description dialog, and click OK to return to the
Master Source Code File Name dialog.
f. Click Next to proceed to the New File Location dialog.
g. Specify the target location for the new file in the text field (click the Browse button to
locate and select a target directory via the Browse For Folder dialog).
h. Click Next to complete the Wizard.
Add the Master Source Code File Later: This option allows you to exit the Workspace
Wizard at this point, and manually specify the System's Master Source Code File later.
17. In the Wizard Completed dialog, click Finish to exit the Wizard.
The new Workspace, with your new Project containing the new System is represented in the
Workspace tab of the Workspace Window.
Since you can only have one Workspace open at a time, the program will prompt you
to save any changes before closing the active Workspace and opening the selected
one.
Right-click anywhere inside the Workspace tab to access the Workspace context menu,
and select New Workspace.
Before the new Workspace is created, the program will prompt you to save any changes
made to the currently open Workspace (if applicable).
A new Workspace file is created. As indicated in the Workspace tab, this Workspace contains no
Projects/Systems. All Projects/Systems and associated files must be added manually.
To create a new Workspace with a Project and System, use the Workspace Wizard.
The same Project can be included in more than one Workspace file.
3. In the Import Components From a Workspace dialog, use the check boxes to select which
Project(s) contained in the specified Workspace file to import.
4. Click OK.
If the selected Project(s) contain any identifiers that are already being used by the
target Workspace, the program prompts you to change them. In this case, use the
Import Name Change dialog to specify a new identifier for the imported Project.
5. The specified Project(s) should now appear as part of the open Workspace.
Any errors detected by the program before the build operation starts are listed in the Pre-
Build Errors dialog. This dialog gives you the option of ignoring the errors and
continuing with the build.
2. The status and results of the build are displayed in the Status tab of the Output Display
Window.
This option is intended for file backups only, as opposed to creating a self-contained
Workspace file to be distributed to remote sites. To create a compressed and self-
contained Workspace file with relative file path information intact for distribution, use
the Project > Export Workspace Files To Go option instead.
1. Select Project > Backup Workspace File to access the Backup Workspace Files dialog.
2. By default, the target directory and file name for the Backup file match the directory and name
of the open Workspace file, with the .ZIP file extension. You can change the name and target
location in the Backup File To text field, if necessary.
3. If the open Workspace 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 not contain any user-defined IRN files.
4. The Progress bar indicates the progress of the backup operation.
Once the export operation is done, detailed results of the operation are listed in the Backup
Workspace Files Report dialog.
While this feature exists primarily to allow you to unzip exported Workspace files, you
can use this feature to unzip any .ZIP file.
3. In the Files From a ZIP File dialog, the selected file (with full directory path) 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 To field, specify the target directory for the extracted Workspace files, and click
Extract to extract the files.
If a file with the same name already exists in the specified target directory, the
program alerts you, and prompts you to overwrite it or pick a different target directory.
• New Workspace Closes the currently open Workspace, and starts a new (empty) work-
space (no Project/System associated until you add them manually).
• Workspace Wizard Launches the Workspace Wizard, which steps you through the process
of creating a new Workspace with a Project/System.
• Open Workspace Opens the Open Workspace dialog, where you can locate and select
an existing Workspace (.APW) file. You can have only one Workspace
open at any time, so in the event that you have a Workspace open, it
will be replaced by the one you open.
• Close Workspace Closes the Workspace file. The program prompts you to close the files
associated with the Workspace before closing them.
• Save Workspace Saves the Workspace file, under its current name and location.
• Save Workspace As Opens the Save Workspace As dialog, where you can specify a new
name and/or location for the saved Workspace file.
• Build Workspace Builds (compiles) the Workspace (including all contained Projects). The
progress and results of the build can be viewed in the Status tab of the
Output Display window.
• Export Workspace Opens the Export Workspace dialog, which allows you to export the
Files Workspace file as a ZIP file. The options in this dialog allow you to
specify the name of the resulting ZIP file, the target folder for the ZIP
file, and whether to include the full directory paths within the ZIP file.
• New Project Opens the New Project Properties dialog, which allows you to assign
an Identifier and general properties for a new Project. Once created,
the new project is added to the Workspace.
• Import a Project Opens the Open Workspace dialog, where you can locate and select a
Workspace (.APW) file. This invokes the Import Components From a
Workspace dialog. Use the dialog to select a specific Project contained
in the Workspace.
• Paste Project You can copy and paste Projects by selecting Copy Project from the
Project Folder context menu, and selecting the Paste Project command.
• Collapse Tree Collapses the Project/System/File tree to show only the Workspace and
its Project(s).
• Expand To System Expands the Project/System/File tree to show the Workspace,
Level Project(s) and System(s).
• Docking view Changes the Workspace Window to a dockable window that can be
resized and moved to anywhere within the NetLinx Studio work area.
• Hide Hides the Workspace Window
• Workspace Properties Opens the Workspace Properties dialog, where you can view the basic
properties of the Workspace. The options in this dialog also allow you to
edit the Workspace Identifier and Description.
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. It is important to
understand that in the event that the file is linked to multiple Systems, any changes
made to the file will be reflected in every instance that the file is used (not just the
System that you were in when the changes were made).
Even if you don't have multiple links to the same file, and instead have only a single
link, you still need to be careful about altering the file. If you are linking to a file that
other people might use, they will be affected by the changes you make to the file. So,
if you intend to make changes to a System file, and you want those changes to be
specific to only one System in the Workspace, you should 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.
2. Enter an Identifier (name) for the Project (required). The Identifier can have a maximum of
128 characters, and must be unique within the open Workspace file.
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.
Any errors detected by the program before the build operation starts are listed in the Pre-
Build Errors dialog.
Assuming that a Master Source Code file has been defined for the System, this dialog
gives you the option of ignoring the errors and continuing with the build.
3. The status and results of the build are displayed in the Status tab of the Output Display
Window.
• Identifier The Project Identifier is required and can have a maximum of 128 characters.
• Dealer optional, maximum of 128 characters.
• Sales Order optional, maximum of 128 characters.
• Designer optional, maximum of 128 characters.
• Purchase Order optional, maximum of 128 characters.
• Description optional, maximum of 2,000 characters.
• New Project Opens the New Project Properties dialog. The options in this dialog
allow you to specify information for the new Project, including Project
Identifier, Dealer, Sales Order, Designer, Purchase Order and
Description.
• Delete Project Deletes the selected Project from the Workspace. This option does
not delete the Project or its associated files from the disk.
• Build Project Builds (compiles) the Project (including all contained Systems and
System files). The progress and results of the build can be viewed in
the Status tab of the Output Display window.
• Copy Selected Project Copies the selected Project to clipboard memory, so it can be pasted
(within the same Workspace only), via the Paste Project command in
the Workspace context menu.
• New System Opens the System Properties dialog, which allows you to assign an
Identifier, System ID, and Description for a new System. The System
Properties dialog also contains options that allow you to set custom
communication settings for the new system. Once created, the new
system is added to the Project.
• Import a System Opens the Open Workspace dialog, where you can locate and select
the Workspace (.APW) file that contains the System you want to
import into the Project. Once you select an APW file, the Import Com-
ponents From a Workspace dialog is invoked. Use this dialog to select
specific Systems contained in the selected Workspace.
• Paste System You can copy and paste Systems (within a single Workspace) by
selecting Copy Selected System from the System context menu, then
opening the target Project, and selecting the Paste System command.
• Collapse Tree Collapses the Project/System/File tree to show only the Workspace
and its Project(s).
• Expand To System Level Expands the Project/System/File tree to show the Workspace,
Project(s) and System(s).
• Docking View Changes the Workspace Window to a dockable window that can be
resized and moved to anywhere within the NetLinx Studio work area.
• Hide Hides the Workspace Window.
• Project Properties Opens the Project Properties dialog, where you can view and edit the
basic properties of the Project (Project Identifier, Dealer, Sales Order,
Designer, Purchase Order and Description).
Source Code Files - These include the Master Source Code File and all other source code
(.AXS) files associated with the System.
Include files - These are Axcess or NetLinx code files (.AXI) that are referenced in any
source code file by the 'Include' statement.
Module Files - NetLinx Module files provide pre-fabricated (.AXS) code or compiled
(.TKO) code to control a specific device on the bus. Module files cannot be designated as
master files. When the System is being compiled, Module files are compiled first, then
copied to the directory where the designated Master Source code file resides.
User Interface (UI) files - These files (.TPD, .TP4 or .KPD) are created in TPDesign3,
TPDesign4 or KPDesign, and contain touch panel pages, buttons and their associated
functionality.
Infrared (IR) library files - These files (.IRL or .IRV) are created in IREdit, and contain
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 are not directly utilized by
the control system.
In NetLinx Studio v2.x, all Projects and associated Systems and System files are linked to the
Workspace, so that you can add and remove Projects and Systems without having to make copies of
the files. NetLinx Studio v2.x also allows you to copy and paste Projects within the Workspace; in
case you need to create several similar Projects you can quickly generate multiple Projects and
modify each one as necessary.
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. It is important to
understand that in the event that the file is linked to multiple Systems, any changes
made to the file will be reflected in every instance that the file is used (not just the
System that you were in when the changes were made).
Even if you don't have multiple links to the same file, and instead have only a single
link, you still need to be careful about altering the file. If you are linking to a file that
other people might use, they will be affected by the changes you make to the file. So,
if you intend to make changes to a System file, and you want those changes to be
specific to only one System in the Workspace, you should 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.
When you create a new System, it is automatically added to the Project that is
currently selected (highlighted) in the Workspace tab.
1. Select the Project that you want to add the new System to in the Workspace Window
(Workspace tab).
2. Select New System from either the Project menu or the Project context menu (or click the
toolbar button) to open the New System dialog. Use the options in this dialog to specify an
Identifier, System ID and Description for the new System.
The System ID number only applies to NetLinx systems. If you are creating an
Axcess system, ignore the System ID field.
3. Click Communication Settings to open the Communication Settings dialog, where you
specify the System platform, communications port settings or network settings as required:
a. Click the Platform Selection radio buttons to select either Axcess or NetLinx as the system
platform.
b. Select a Transport Connection Option (TCP/IP, Serial or Modem).
TCP/IP - To specify network TCP/IP settings (NetLinx systems only), select the TCP/IP
radio button, and click Settings to open the TCP/IP Settings dialog, where you can enter
the System's IP Address assignment.
Do not change the Port number! It should always be set to 1319 (default).
Serial - Select the Serial radio button, and click Settings to open the Serial Settings
dialog, where you can select and configure a Serial COM port to use.
Modem - Select the Modem radio button, and click Settings to open the Modem Settings
dialog, where you can select and configure a Modem COM port to use.
4. Click OK to add the new System to the selected Project.
The System ID number only applies to NetLinx systems. If you are creating an
Axcess system, ignore the System ID field.
3. Click Configure to open the Communication Settings dialog, where you specify the System
platform, communications port and network settings as required:
a. Click the Platform Selection radio buttons to select either Axcess or NetLinx as the
system platform.
b. Select a Transport Connection Option (TCP/IP, Serial or Modem).
TCP/IP - To specify network TCP/IP settings (NetLinx systems only), select the TCP/IP
radio button, and click Configure to open the TCP/IP Settings dialog, where you can
enter the System's IP Address assignment.
Do not change the IP Port number! It should always be set to 1319 (default).
Serial - Select the Serial radio button, and click Configure to open the Serial Port
Settings dialog, where you can select and configure a Serial COM port to use.
Modem - Select the Modem radio button, and click Configure to open the Modem Port
Settings dialog, where you can select and configure a Modem COM port to use.
4. Click OK to add the new System to the selected Project.
The Workspace tree indicates the active System with bold type, and the status bar at the bottom of
the program will display the selected System communication settings.
If there is currently an active connection to a master controller when you select a System to be
active, the program will prompt you to see if you want to stop the current connection and continue
with the selected Active System communication settings.
To designate the active System, select (highlight) a System (in the Workspace tab of the Workspace
Window), then select Set as Active System from either the Project menu or the System Folder
context menu (or click the toolbar button).
3. Click the Communication Settings button to access the Communication Settings dialog.
4. Select the default platform (NetLinx or Axcess).
5. Select a transport connection type (TCP/IP, Serial or Modem).
6. Click Settings to open either the TCP/IP Settings, Serial Settings or Modem Settings dialog
(depending on the transport connection selected).
7. Specify the communications settings for the selected port.
For serial ports, specify the COM port, and set baud, data bits, parity, stop bits and flow
control.
For modems, specify the COM port, and set baud, data bits, parity, stop bits, flow control
and target phone number.
By default, the Files of Type option is set to look for Source (.AXS) files. Change this
option to look for the desired file type if necessary. 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.
In Windows Explorer, select a file that you want to add to a System in the Workspace.
Window (Workspace tab). Drag and drop the file into the System folder.
In the Output Display Window, you can select any of the files listed as search results in
either the Find In Files or Find IR Files tabs. Drag and drop the file into the System
folder.
Do not drop the file into the specific System File folder that matches its type.
Regardless of type, all files must be dropped into the System folder to be added
(imported) correctly into the System.
When the file is dropped into the System folder, the File Properties dialog is invoked. Use the
options in this dialog to rename the selected file, browse for a different file, and/or enter a
description for the file (if desired).
Click OK to add the file to the System. Note that the file is placed in the appropriate System File
folder based on the file type.
Alternatively, you can simply select a System file and press the Delete key for the
same results.
The currently active System is indicated in bold (in the Workspace tab of the
Workspace Window).
Any errors detected by the program before the build operation starts are listed in the Pre-
Build Errors dialog.
Assuming that a Master Source Code file has been defined for the System, this dialog
gives you the option of ignoring the errors and continuing with the build.
2. The status and results of the build are displayed in the Status tab of the Output Display
Window.
• Set as Active System Sets the currently selected System as the Active System.
• New System Opens the New System dialog. The options in this dialog allow you to
specify information for the new System, including System Identifier, Sys-
tem ID, Description and Communication Settings.
• Delete System Deletes the selected System from the selected Project. This option does
not delete the System or its associated files from the disk.
• Build System Builds (compiles) the active System (including all contained System
files). The progress and results of the build can be viewed in the Status
tab of the Output Display window.
• Copy Selected System Copies the selected System to clipboard memory, so it can pasted into
another Project (via the Paste System command in the Project Folder
context menu).
• Add File To System Opens the Add Existing File dialog, which allows you locate and select
an individual file to be added to the active System. The selected file will
automatically be added to the appropriate System File folder, based on
file type.
• Collapse Tree Collapses the System/File tree to hide all System files.
• Expand System Tree Expands the System/File tree to show all System files contained in the
System File folders.
• Docking View Changes the Workspace Window to a dockable window that can be
resized and moved to anywhere within the NetLinx Studio work area.
• Hide Hides the Workspace Window.
• System Properties Opens the System Properties dialog, where you can view and edit the
basic properties of the active System (System Identifier, System ID,
Description and Communication settings).
System Files
System Files represent the actual files that are needed to operate a particular controlled device in
the named System. System files include Source Code, Include files, NetLinx Module files, IRLib
files, User-Interface (UI) files and any other (*.*) files that you might want to include. System files
are placed in the appropriate System file folder (in the Workspace tab of the Workspace Window)
as links only.
The supported System file types are described below:
• Source Code files These include all code files (.AXS) that are not Master Code Files.
Source Code Files are created in NetLinx Studio, and are sent to spe-
cific devices on the bus. Master Source Code files are placed in the
Source file folder.
• Master Source Code file This is the Source Code file that defines the devices in the System.
Master Code files are sent only to the Axcess or NetLinx Master Con-
troller. Source Code files are placed in the Source file folder.
• Include files These are Axcess or NetLinx code files (.AXI) that are separate from
the main Master and Source Code files, but are included in the com-
pile process. These files are created in NetLinx Studio. Include files
are placed in the Include file folder.
• Module Files These files provide pre-fabricated (.AXS) code or compiled (.TKO)
code to control a specific device on the bus. Module files cannot be
designated as master files. When the System is being compiled, these
Module files are compiled first, then copied to the directory where the
designated Master Source code file resides. Module files are placed in
the Module file folder.
• User-Interface (UI) files These are (.TPD/.TP4) or (.KPD) files that are imported into Projects.
TPD/TP4 touch panel UI files define the look and functionality of touch
panel pages. TPD files are touch panel UI files created in TPDesign3
(for use with G3 level firmware touch panels), TP4 files are created in
TPDesign4 (for use with G4 level firmware touch panels, i.e. Modero
series panels). KPD files are created in the KPDesign KeyPad Design
program, and define the buttons and functionality of PLK-DMS and
PLK-IMS Keypads. UI files represent the user-interface for the control
system. UI files are placed in the User Interface file folder.
• Infrared (IR) library files These files (.IRL or .IRV) are created in IR Edit and contain infrared
(IR) control functions for 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 utilized by the control system. "Other" files are placed
in the Other file folder.
Use the Project > Add File To System command to add the file to a System.
The Workspace Wizard option launches the Workspace Wizard, which steps you
through the process of creating a new Workspace with a Project and one System.
See the Using the Workspace Wizard section on page 28 for details.
Identifiers must be unique to each System, regardless of the file type. If you assign an
identifier to a file that already exists in the Project, the program will prompt you to enter
a different identifier.
You can change the assigned identifier of any System file (via the File Properties dialog),
but remember that identifiers (alias file names) only to apply to the specific file that they
are applied to, and not to any others. For example if you change a file's identifier, the
file's associated *.TOK file still reflects the disk file name.
• Identifier The File Identifier can have a maximum of 128 characters, and must be unique
within a System.
• File Name You can change the file name in this text box. Use the browse button to navigate
to the desired file you want.
• Relative Path This (read-only) field represents the location of the file, relative to the WORK-
SPACE.APW file that is currently displayed. All files are linked to the workspace
(not copied over to the workspace directory).
• Description The Description text is optional and can have a maximum of 2,000 characters.
• Master File This check box designates that this file is the Master Source Code file. When
checked, the Compile As combo box will be grayed out. The Master File will be
compiled for the platform designated in the System Properties dialog.
• Compile As This combo box allows you to compile a source code file to a platform (Axcess or
NetLinx) different than the System's designated platform. This option is available
if the Master File check box is deselected (unchecked).
• Creation Date The date the file was created (read only).
• Set As Master Sets the selected Source Code file as the Master Source file for the
(Source files only) system it belongs to.
• Compile Compiles the selected file, using the compiler (Axcess or NetLinx)
(Source and Module associated with the file. The status and results of the build are dis-
files only) played in the Status tab of the Output Display Window.
• Device Mapping (Source, Opens the Device Mapping dialog which allows you to map the file
Module, UI and IR files to a system device for transfer.
only)
• Device Mapping Opens the Device Mapping dialog to map the selected User Inter-
(UI and IR files only) face file to a specific device on the bus.
• Export to IRL File This option is only available if the IR file you selected was extracted
(IRN files only) from an IR Database (*.IRN) file. IR Database files come from the
IREdit application, and represent either the AMX IR Database
(included with the IREdit application), or a user-defined IR Database
file.
Once you have added an IR file from an IR Database file (via the
Add From AMX IR Database or Add From User IR Database options
in the Project menu, IR File Folder context menu, or Project toolbar),
you can use this option to export the file as an IRL file that can then
be treated as a stand-alone IR entity (independent of the IR Data-
base file that originally contained it).
• Remove File From System Removes the selected file from its System (the file is not deleted
from the disk, only removed from the System).
• File Properties Opens the File Properties dialog, where you can view (and edit)
properties for the selected file.
Master Source Code file — The Source Code that is downloaded to an Axcess or
NetLinx Master Controller. The Master Source 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 downloaded to
specific NetLinx or Axcess devices on the bus. You can have as many Source Code files
in the Source Code System folder as is required for the System.
Source Code files are stored in the Source folder (in the Workspace tab of the Workspace Window).
If you click Yes, you will prompted to select the template (NetLinx or Axcess).
If you click No, you will proceed directly to the New File Location dialog.
If you select to use one of the existing templates (NetLinx or Axcess), the new Source
Code file will include all of 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.
4. In the New File Location dialog, enter a File Name, and specify a target directory for the file.
By default, the target directory is the NetLinx Studio directory. Use the Browse button to
navigate to another folder if necessary.
5. The program notifies you that the file was created.
6. Click Finish to close the File Template dialog. The new file should appear in the Source folder,
under the selected System.
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.
If you click Yes, you will be prompted to select the template (NetLinx or Axcess). Click
Next to proceed.
If you click No, you can start developing the file immediately, in a new Source Code
Editor window.
If you select to use one of the existing templates (NetLinx or Axcess), the new Source
Code file will include all of 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.
Existing Source Code files can be added to Systems via the Project > Add File To
System command.
You can designate a Source Code file as the Master Source at the time that it is added to
the System, via the Master File option in the File Properties dialog.
Alternatively, you can designate any Source Code file in the System as the Master Source
by right-clicking on a Source Code file (in the Workspace tab of the Workspace
Window), and selecting Set As Master from the Source Code File context menu.
Right-click on a Source Code file (in the Workspace tab of the Workspace Window), and
select Compile from the Source Code File context menu.
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.
The Build With Source option also allows you later send the Source files to another
Master, with the ability to debug the code.
The Extract From SRC File command allows you to extract these files:
1. Select Tools > File Extraction > Extract From SRC File to open the Select SRC File dialog.
2. Locate and select the SRC file you want to extract, and click Open.
This is the directory containing the actual program file (.AXS). Source files only exist
in the directory if the program file has been successfully compiled (using the Build
With Source option).
3. In the NetLinx Source From a SRC File dialog, the selected file (with full directory path) is
indicated in the SRC File To Extract From field.
Select the Extract using original directory path(s) option to preserve the original directory
paths of the files (default = enabled).
4. In the Extract To field, specify the target directory for the extracted NetLinx Source files, and
click Extract to extract the files. If a file with the same name already exists in the specified
target directory, the program alerts you, and prompts you to overwrite it or pick a different
target directory.
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).
If you receive this error message, click OK in the error message dialog to access the
Enter Password dialog, and re-enter the password exactly as it was entered when the
file was compiled.
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.
Existing Include files can be added to Systems via the Project > Add File To System
command.
When the System is being compiled, first the pre-compiled modules (.TKO) are copied to
the Source folder, then the Module files are compiled, and then the Master Source Code
(.AXS) file is compiled.
• Module_Name DMS-IMSMod.tko
• Virtual_Dev A virtual device you define.
• Real_Dev The device number of the DMS or IMS panel.
• StrFileName A string variable (CHAR array) containing the file name of the KPD file to
run.
• StrVarTextArray A two-dimensional array to store variable text in. The first dimension
should be the largest variable text number you want to use. The second
dimension should be the maximum size of the string you want displayed
(maximum is 40 characters).
For example, a NetLinx module for a DMS keypad would look like:
DEFINE_MODULE "DMS-IMSMod" mdlDMS (dvDMS, dvDMS_R, strFILE_NAME,
StrVartextArray)
Where:
If you click Yes, you will prompted to select the template (NetLinx or Axcess).
If you click No, you will proceed directly to the New File Location dialog.
If you select to use one of the existing templates (NetLinx or Axcess), the new Source
Code file will include all of 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.
4. In the New File Location dialog, enter a File Name, and specify a target directory for the
module file. By default, the target directory is the NetLinx Studio directory. Use the Browse
button to navigate to another folder, if necessary.
5. The program notifies you that the module file was created.
6. Click Finish to close the File Template dialog. The new file should appear in the Module
folder, under the selected System.
4. Click Open to access the File Properties dialog, where you can view/edit general file
information for the selected module 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.
Right-click on a Module file (in the Workspace tab of the Workspace Window), and select
Compile from the Module File context menu.
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.
TPDesign3 is a touch panel design program for use with G3-firmware touch panels (all
models except Modero and NXP-TPI/4).
TPDesign4 is a touch panel design program for use with G4-firmware touch panels
(Modero panels and NXP-TPI/4).
KPDesign is a keypad design program for use with PLK-DMS and PLK-IMS keypads.
Use the KPDesign to design the keypad display pages and buttons, and their associated
functionality, and use NetLinx Studio to transfer the KPDesign file (KPD) to the NetLinx
Master. In order to use KPDesign file with the appropriate keypads, the NetLinx code file
must first be configured (in NetLinx Studio), compiled, and then transferred to the
NetLinx Master.
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.
While Touch Panel UI files are transferred to the panels themselves, KPD files are
transferred to the master and not directly to the keypad.
If the TPDesign3, TPDesign4 and/or KPDesign applications are installed on your PC, you can
double-click on any UI file in the Workspace tab to launch the associated editor program
(TPDesign3, TPDesign4 or KPDesign). You can add external programs to the Tools menu via the
Add Tool option.
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.
3. In the STARTING CODE GOES HERE / CREATE FILE section of the program, the
StrFILE_NAME must equal the exact name of the KPD file being used in the compile. This file
is added to the project file in the UI system folder of the Panel Navigator.
4. Add the KPD file to the project by choosing File > File Import.
5. Browse for the KPD file.
6. Uncheck the Use System Generated File Names option (because you want to keep the file
name identical to what you are using in the actual NetLinx Studio program - StrFILE_NAME).
7. Select the Add as Link option (if you do not want to copy the file to your project folder).
Where:
• DVVirt an arbitrary Virtual Device number you define (range for keypad panels =
32768 -36863).
• DvDMS the real device number of the DMS or IMS panel.
• StrFileName a string variable (CHAR array) containing the file name of the KPD file to
download or run.
• StrVarTextArray a two-dimensional array to store variable text in. The first dimension should
be the largest variable text string number you want to use. The second
dimension should be the maximum size of the string you want displayed
(maximum is 40 characters).
When using two or more keypad panels, you can create a single three-dimensional array for a
keypad panels, instead of separate two-dimensional arrays for each keypad panel.
IR files are stored in the IR folder (in the Workspace tab of the Workspace Window).
IRV files are IR files exported from the VPXpress application (for use with AMX
ViewPoint wireless touch panels).
NetLinx Studio v2.x 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).
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.
IREdit
IREdit is a separate application that works in conjunction with NetLinx Studio v2.x. Once IREdit is
installed, you can double-click on any IR file in the Workspace tab of the Workspace Window or
the Find IR Files tab of the Output Display Window to open the selected IR file for viewing and
editing in IREdit.
To launch the IREdit program, double-click on an IR file in the Workspace tab of the Workspace
Window or double-click on an IR file in the Find IR Files tab of the Output Display Window
(results of a search).
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.
3. Double-click on the file (or select the file and click the Add To List button) to add the file to
the Selected IR List.
4. Repeat steps 2 and 3 as often as necessary to populate the Selected IR List, and click OK to
close the Select IR From a Database dialog.
5. The selected IR files are add to the selected System (in the IR system file folder).
The file(s) will be added to the selected (highlighted) System in the Workspace tab,
which is not necessarily the active system.
The file(s) will be added to the selected (highlighted) System in the Workspace tab,
which is not necessarily the active system.
1. Select Add From User IR Database from the Project menu, the IR File Folder context menu,
or click the toolbar button to opens the Select IRN User Database dialog.
2. Locate and select the *IRN file that contains the IR file(s) that you want to add to the selected
System.
3. Click Open to open the selected IRN file in the Select IR From a Database dialog.
4. In the Select IR From a Database dialog, select the Manufacturer, Product Category, Model #,
Hand Control Model # and then select the IR file to add to the System.
5. With the desired IR file selected, click Add to add the file to the Selected IR File(s) list.
6. Repeat steps 4 and 5 as many times as is necessary to 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 the File Properties dialog,
where you can change the selected file's name (Identifier) and Description if necessary. You
can assign multiple different identifiers, file names and descriptions to the same file for use in
different Projects and Systems, as needed.
8. Click OK to add the file to the selected System. The file appears in the IR System File Folder
(in the Workspace tab of the Workspace Window).
Manufacturer - Enter the name manufacturer of the IR device associated with the file
you are searching for.
Hand Control Model # - Enter the model number for the hand-held IR remote associated
with the file you are searching for.
Device Model # - Enter the manufacturer's model number for the IR device associated
with the file you are searching for.
Where To Search - Use the radio buttons to select one of three ways to specify where to
search for IR files:
• IR Files in Folder Use this option to specify a target directory to search. Click the Browse
button to select the directory to search in the Browse For Folder dialog.
The first time you search within any given directory, NetLinx Studio gen-
erates an index file of all IR files in that directory. The status of this opera-
tion 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. IRN files are generated in the IREdit utility program.
Once you have entered one or more items in the search criteria fields, you can use
the down arrows to the right of these fields to open and select from a list of previously
entered items. For example, once you have typed "Sony" in the Manufacturer field,
the next time you need to search for Sony devices, just select "Sony" from the drop-
down list.
Double-click any item in the Find IR Files tab to open the selected IR file in the IREdit
application.
Right-click in the Find IR Files tab to open the Output Display window context menu.
Do not open .LIB or .SYN files for editing in the Source Code Editor. These are binary
file types that cannot be edited in NetLinx Studio v2.x.
Use the Other folder to store standard text files, image files, etc.
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.
Programming
Source Code Editor Windows
Use Source Code Editor windows (see FIG. 2) 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.
NetLinx Studio features a Code Wizard that steps you through the process of
generating several different types of code.
Use the Source Code Editor windows to generate and edit Axcess and/or NetLinx code. Source
Code Editor window features include:
Source Code Editor window features include:
Syntax highlighting: The text in the Editor windows is syntax highlighted for increased
readability with a default set of colors. Use the options in the Editor Options tab of the
Preferences dialog to customize various aspects of the Source Code editor windows (i.e.
syntax highlighting, auto-indent, show/hide line numbers and clipboard text buffer
settings).
Syntax highlighting assigns different colors to different types of data in your Source
Code file. Use syntax highlighting to make your code easier to read and manage. For
example, you could syntax highlight all comments to yellow, all identifiers to red and
strings to blue to make them more easily identifiable in your code file.
Drag and drop any supported file type from Explorer into the Source Code Editor to open
that file in a new Source Code Editor window.
Drag and drop selected text to another Editor window (at the cursor location), or to
another location within the same Editor window.
Source Code Editor windows are moveable and resizeable. Use the options in the
Window menu to arrange (cascade or tile) multiple windows.
Use the New Window option in the Window menu to open the same code file in multiple
Editor windows. This feature allows you to view and edit different locations in a large
code file.
Right-click anywhere within a Source Code Editor window to open the Source Code
Editor context menu (see page 70).
Hold down the Alt key and select text with the left mouse button for columnar Cut, Copy,
and Paste operations.
Use the Edit > Insert Section option to insert a (empty) section of code at the cursor
position.
Use the Edit > Goto Section option to move the cursor to the beginning of a selected
section of code in the active Editor window.
The Edit > Undo and Redo commands allow unlimited Undo/Redo operations.
Use the Edit > Make Selection Uppercase and Make Selection Lowercase commands
to automatically change the case on a selection of text.
Use the Edit > Sequentially Renumber Selection command to sequentially renumber
selected number text in the active Editor window.
The Edit > Block Comment-Uncomment option allows you to block comment-
uncomment selected text in the active Editor window.
To indent a block of text, select text and press the Tab key. Use Shift + Tab to remove the
indentation.
• Build Active System Compiles all Source Code files (and any associated
Include and Module files) in the active System.
• Compile <active Source Code File> Compiles the active file, using the compile type associated
with the file (the compile type can be changed via the File
Properties dialog).
• Compile as NetLinx Click to compile the active file using the NetLinx compiler,
regardless of it's Compile As property.
• Compile as Axcess Click to compile the active file using the Axcess compiler,
regardless of it's Compile As property.
• Undo, Redo Undo and Redo the last text editing action.
• Cut, Copy, Paste Cut the selected text to the clipboard, Copy the selected
text to the clipboard, and Paste the contents of the clip-
board to the active file, at the cursor position.
• Delete Deletes the selected (highlighted) text in the active Source
Code Editor window.
• Select All Selects all of the code in the active file.
• Goto Section Click to open the Goto Section sub-menu, which contains a
listing of code sections in a Source Code File. Select a sec-
tion from this list to jump to the beginning of that section in
the active file. If a section that does not exist within the
active code file is chosen, nothing happens.
• Goto Line Opens the Goto Line dialog, where you can specify the line
of code to which you want to move the cursor in the active
file. If a line number is entered that is beyond the max num-
ber of lines in the file, the cursor is moved to the last line in
the file.
Regular Expressions
Regular expressions are notations used for describing patterns of text. They are a form of
metacharacters, or characters that define other characters. The regular expressions supported by
NetLinx Studio are described below:
^ - 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.
For example, "$x" only matches an "x" that occurs at the end of a line.
. - Represents any character.
For example, "x.y" matches "xay" and "xzy" but not "xy" or "xyxy".
* - Specifies zero or more occurrences of the previous "." or literal character.
Syntax Highlighting
When a source file is loaded in the editor, it is read line by line. Each line is broken up into its
constituent words. Technically the line is broken into tokens, but the concept of a word is more
familiar to most people. Different words and groups of words are handled differently. Here is a
breakdown of the mechanism used:
Comments - Any portion of the line that initiates or falls within a comment is considered
to be one comment (essentially it’s treated as one big word). The comment is then syntax
highlighted using the color specified in Preferences > Editor > Comment.
Language Reserved Words - When NetLinx Studio is started it loads two files:
NetLinx.rw and Axcess.rw. These are the “reserved word” files. These files contain all of
the words that NetLinx Studio will consider to be “Language Reserved Words”.
Language Reserved Words are syntax highlighted using the color specified in Preferences
> Editor > Language Reserved Word.
If a partial word that is typed is recognized as a reserved word, the editor will suggest its
closest match.
are syntax highlighted using the color specified in Preferences > Editor > Operator.
Number - A number is any series of digits that does not include a decimal point. A
number may have the optional prefix “$” for hex or the optional postfix “b” for binary. If
the number is a hexadecimal number then it may contain the letters A-F or a-f. Numbers
are syntax highlighted using the color specified in Preferences > Editor > Number.
String - Strings are any series of characters and digits that occur within two single
quotes. Strings are syntax highlighted using the color specified in Preferences > Editor >
String.
Constants, Devices, Type, Variable - These are new to NetLinx Studio 2.1. Since
NetLinx code may be divided into the following sections DEFINE_CONSTANT,
DEFINE_DEVICE, DEFINE_TYPE, DEFINE_VARIABLE, anytime a word is encountered
that falls within one of these sections it is parsed, remembered and then syntax
highlighted according to the section in which it occurred. So if a DEFINE_DEVICE
section contains a line that reads “dvTP = 128” the word dvTP will be remembered as a
device and syntax highlighted using the color specified in Preferences > Editor > Device.
Additionally, if the editor recognizes that you have partially typed the name of the above
section variable (for example “dv”), it will autosuggest “dvTP”. It does this for all of the
items it encountered in any of the above DEFINE_ sections.
Default Text - Any word that is not recognized as any of the above is syntax highlighted
using the color specified in Preferences > Editor > Default Text.
There is no default for Next Suggestion in order to avoid conflicting with pre-existing
user keystrokes. You must set your own.
The collection of words from DEFINE_ sections that the editor recognizes is updated whenever the
file is loaded and saved. Additionally, whenever a portion of the editor is redrawn that portion is re-
examined for possible DEFINE_ type items. All of this is done to optimize speed. If the file was
continuously scanned, the performance would suffer greatly. It is possible that the information that
the editor has stored can be “out of date”, this is best remedied by saving the file.
Match whole word only — Searches for instances of the search string that exist as whole
words only. For example, a search for "yell", only finds the word "yell", as opposed to
any instance of the search string (i.e. "yellow").
Match case — Searches only for instances that match the case (UPPERCASE or
lowercase) of the characters in the search string.
Loop — Start the search at the cursor's position, and automatically loop the cursor to
either the top or bottom of the file (depending on the Direction setting) to finish searching
the entire file, to the cursor's position.
Start At Top — Start the search at the top of the file (regardless of the cursor's position).
BUTTON_EVENTs
CHANNEL_EVENTs
LEVEL_EVENTs
DATA_EVENTs
SEND_COMMANDs
IR Constants
A source file must be open in Source Code Editor window in order to use the Code
Wizard.
A source file must be open in Source Code Editor window in order to use the Code
Wizard.
• Device The device name used during code generation. This name may
appear in a DEVCHAN definition, BUTTON_EVENT, PUSH,
RELEASE or feedback assignment statements depending on the
platform and options selected.
• From, To, Total The button range used during code generation. The range is 1 -
1000. You may change any of these values; the others will adjust
automatically. A value of 0 (zero) in the From field will generate an
“all button” handler. In this case, code generation cannot support
arrays or feedback.
• Array Name The array name used for generating DEVCHAN or INTEGER array
for button ranges.
• Hold Time This value is used when generating the HOLD statement.
• Comment This value is used on the lines before the array definition,
BUTTON_EVENT, PUSH, and RELEASE and feedback statements
as determined by the options. Comments in NetLinx are always line-
style comments (i.e. //).
• Insert Once you have made the relevant selections on this tab, click this
command button to insert the specified code into the file.
• On Generate ON statements
• Off Generate OFF Statements
• No Arrays Channel ranges will be generated without using arrays, i.e. multi-
ple CHANNEL_EVENTs will be generated.
• Use DEVCHAN Channel ranges will be placed in a 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. Note that when Use DEVCHAN is selected,
GET_LAST() is selected and grayed out. This option is not avail-
able if generating code for Axcess.
• Use INTEGER Channel ranges will be placed in an INTEGER array named Array
Name using the channel range defined as From through To in the
DEFINE_VARIABLE section. A single CHANNEL_EVENT state-
ment referencing Device and Array Name will be generated.
• Channel Index/GET_LAST() This option will include a calculation for the channel index using a
mathematical calculation, CHANNEL.CHANNEL – From, for non-
array channel ranges and a function call to GET_LAST(),
GET_LAST(Array Name), for array channel ranges. The channel
index calculation is used if generating code for Axcess.
• SWITCH/CASE This option will include a SWITCH/CASE construct under the ON
and/or OFF statements. The SWITCH will be based on the Chan-
nel Index. Note that when SWITCH/CASE is selected, the Channel
Index option is selected, and grayed out.
• Stacked This option will cause each channel in the Array Name definition to
be generated on its own line with an empty comment at the end of
the line. If this option is not selected, eight channels will be gener-
ated on each line with an empty comment above the line.
• Device The device name used during code generation. This name may
appear in a DEVCHAN definition or CHANNEL_EVENT statement
depending on the platform and options selected.
• From, To, Total The channel range used during code generation. The range is 1 -
1000. You may change any of these values; the others will adjust
automatically. A value of 0 (zero) in the From field will generate an
“all channel” handler. In this case, code generation cannot support
arrays.
• Array Name The array name used for generating DEVCHAN or INTEGER array
for channel ranges.
• Comment This value is used on the lines before the array definition,
CHANNEL_EVENT statements as determined by the options.
Comments in NetLinx are always line-style comments (i.e. //).
• Insert Once you have made the relevant selections on this tab, click this
command button to insert the specified code into the file.
• Stacked This option will cause each level in the Array Name definition to be
generated on it’s own line with an empty comment at the end of the
line. If this option is not selected, eight levels will be generated on
each line with an empty comment above the line Device The device
name used during code generation. This name may appear in a DEV-
LEV definition, LEVEL_EVENT, CREATE_LEVEL or SEND_LEVEL
statements depending on the platform and options selected.
• 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. In this case, code generation cannot support
arrays.
Note: The range setting (1-1000) affects the load placed on the CPU
at compile time. Higher range settings may result in slower compile
operations.
• Array Name The array name used for generating DEVLEV or INTEGER array for
level ranges.
• Value/Variable Name The array name or value used for generating CREATE_LEVEL or
SEND_LEVEL statements. If generating code for a level 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 Name 1, Variable Name
2, etc…
• Comment This value is used on the lines before the array definition,
LEVEL_EVENT, CREATE_LEVEL, and SEND_LEVEL statements as
determined by the options. Comments in NetLinx are always line-style
comments (i.e. //).
• Insert Once you have made the relevant selections on this tab, click this
command button to insert the specified code into the file.
• Insert Once you have made the relevant selections on this tab, click this command
button to insert the specified code into the file.
• Page Generate PAGE- page flip send command for touch panels.
• !T Generate !T variable text send command for touch panels.
• @BMF Generate @BMF variable text send command for touch panels.
• @PPN Generate @PPN- popup on send command for touch panels.
• @PPF Generate @PPF- popup off send command for touch panels.
• @PPK Generate @PPK- popup kill send command for touch panels.
• @PPX Generate @PPX- kill all popups send command for touch panels.
• Custom Generate a custom send command.
• Device The device name used during code generation. This name will appear in the
SEND_COMMAND statement.
• Sub Command The command parameter used in the SEND_COMMAND. Depending on
options, this may be the Page Name, Text to Send, @BMF sub-command,
popup page name or custom command.
• Comment This value is used on the line before the SEND_COMMAND statement. Com-
ments in NetLinx are always line-style comments (i.e. //).
• Insert Once you have made the relevant selections on this tab, click this command
button to insert the specified code into the file.
• 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 to generate constants.
• Constant Prefix The prefix to precede all constant declaration. By default, this will be
<Device>_.
• Comment This value is used on the line before the constant declarations. Comments in
NetLinx are always line-style comments (i.e. //).
• Insert Once you have made the relevant selections on this tab, click this command
button to insert the specified code into the file.
Insert Section
The Insert Section option in the Edit menu allows you to insert a particular section heading in your
code, at the cursor's position. This command only works on the open Source Code Editor window.
1. Select Edit > Insert Section (or use the toolbar button) to access the Insert Section sub-menu.
2. Position the cursor at the beginning of the line that you want to add the section heading to.
3. Select the section heading that you want to add from the sub-menu. The available options are:
NetLinx: Axcess:
• DEFINE_DEVICE • DEFINE_DEVICE
• DEFINE_CONSTANT • DEFINE_CONSTANT
• DEFINE_TYPE
• DEFINE_VARIABLE • DEFINE_VARIABLE
• DEFINE_LATCHING • DEFINE_LATCHING
• DEFINE_TOGGLING • DEFINE_TOGGLING
• DEFINE_MUTUALLY_EXCLUSIVE • DEFINE_MUTUALLY_EXCLUSIVE
• DEFINE_CONNECT_LEVEL • DEFINE_CONNECT_LEVEL
• DEFINE_START • DEFINE_START
• DEFINE_MODULE
• DEFINE_EVENT
• DEFINE_PROGRAM • DEFINE_PROGRAM
The Insert Section and Goto Section sub-menus may include sections that do not
exist in that are appropriate for the file's System type (NetLinx or Axcess). The valid
commands for the System type will be available whether they are actually in the file or
not.
Goto Line
The Goto Line option in the Edit menu allows you to jump to a particular line number in your code.
To display line numbers in the Source Code Editor windows, select the Show Line
Numbers option in the Editor Options tab of the Preferences dialog.
1. Select Edit > Goto Line (or use the toolbar button) to access the Goto Line dialog.
2. Enter the line number in the Enter Line Number field and click OK to jump to the specified
line number in the open Source Code Editor window.
If the line number entered is greater then the number of lines in the file, this function
will take you to the last line in the file.
Goto Section
The Goto Section option in the Edit menu allows you to jump to a particular section in your code.
1. Select Edit > Goto Section (or use the toolbar button) to access the Goto Section sub-menu.
2. Select the section that you want to jump to from the sub-menu. The available options are listed
in the Insert Section sub-section above
3. The cursor jumps to the top of the selected section in the open Source Code Editor window.
Use the Next Bookmark and Previous Bookmark options to jump to your bookmarks.
Use the Clear Bookmarks command to clear all bookmarks in the Source Code Editor
window.
To use debugging, the Build With Source option must be selected in the
Preferences dialog (Axcess Compiler and/or NetLinx Compiler tabs), before the file is
compiled.
1. Open and compile an 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 to open the Watch window. If this option is disabled, make sure your
Master Communications Port settings are set to connect to your Master Controller.
3. Right-click inside the Watch window to open the Watch Window context menu.
4. Click Add to insert a new variable in the Watch window. A box appears in the window, with a
cursor blinking in the Name column.
5. Type the syntax of the variable exactly as it is defined in the code and press the Enter key. The
value of the specified variable appears next to the variable (in the Value column).
6. You can select different view formats for the Value by right-clicking on the line containing the
variable/value, and clicking on Display in the Watch window context menu. This opens the
Display sub-menu, containing the following view options:
• ASCII Display: displays the value of the watched variable in ASCII format.
• Decimal Display: displays the value of the watched variable in decimal format.
• Hexadecimal Display: displays the value of the watched variable in hexadecimal format.
• Octal Display: displays the value of the watched variable in octal format.
• Binary Display: displays the value of the watched variable in binary format.
You cannot compile, send/receive files, or change port settings while the program is
in debug mode.
In NetLinx, you can use breakpoints with single-step mode. When the breakpoint is
encountered (and the program is suspended), you can single-step without a watched
variable reference.
You cannot use the Terminal window while a communication port is in use for a file
transfer or debug operation.
If the Terminal window becomes unresponsive, close and re-open the window.
To leave the Terminal window active for a long session, click the Terminal Locks the
Port option in the General tab of the Preferences dialog.
Use the Format tab of the Preferences dialog to change the appearance of the elements of
the Terminal window.
To use the Terminal window with NetLinx systems, you must be connected to the Master
via the PROGRAM port. Otherwise, you can use Windows TelNet for terminal control of
NetLinx systems.
• Start/Stop Debugging Ability to toggle the debug state of the application. There is no limitation
on then number of NetLinx variables that can be watched in the Debug
Watch windows. A maximum of 10 watch variables are allowed when
debugging an Axcess master controller.
• 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-
troller.
The following options are only needed for debugging code located on a NetLinx master controller:
• Run To continue execution after a Single Step operation or from a toggled break
point.
• Run To Cursor Execute the program and break on the line of code where the cursor is
residing on the screen.
• Break Stop execution of the program and highlight the line of code on the screen.
• Edit Breakpoints A dialog box appears listing all the break points within the code.
• Toggle Break Point Toggle a break point on the screen where the cursor is residing. A red dia-
mond appears next to the line of code to signify a break point.
• Clear Break Points Clears all the break points within the source code file.
Setting a Breakpoint
1. Place the cursor on a line of code in the DEFINE_PROGRAM section (other than a comment).
2. Right-click to open the Source Code Editor context menu, and select Toggle Breakpoint, or
use the Toggle Breakpoint toolbar button to insert the breakpoint. You can also access the
Toggle Breakpoint command through the Source Code Editor context menu (right-click inside
the Source Code Editor window to open).
3. A red circle appears in the Source Code Editor window, to the left of the cursor position.
A green bar highlighting the line of code, and the execution arrow (a little green arrow)
indicate the current execution point.
To execute the next line of code, right-click and choose Step Into. You'll see the
execution pointer advance one line.
If you are not currently debugging, you won't see execution break until you start
debugging (Debug > Start Debugging).
Clearing Breakpoints
You clear an individual breakpoint, or clear all breakpoints in a file:
To clear an individual breakpoint - Place the cursor on a line of code containing a set
breakpoint, and choose Debug > Toggle Breakpoint, or use the Toggle Breakpoint
toolbar button to unset the breakpoint on that line.
To clear all breakpoints in a file - Choose Debug > Clear All Breakpoints, or use the
Clear All Breakpoints toolbar button.
Goto Line
Select Goto Line from the Edit menu, the Source Code Editor context menu (or click the toolbar
button) to jump to a particular line number in your code.
To display line numbers in the Source Code Editor windows, select the Show Line
Numbers option in the Editor Options tab of the Preferences dialog.
1. Right-click inside a Source Code Editor window to access the Source Code Editor context
menu, and select Goto Line to access the Goto Line dialog.
2. Enter the line number in the Enter Line Number field and click OK to jump to the specified
line number in the open Source Code Editor window.
If the line number entered is greater then the number of lines in the file, this function
will take you to the last line in the file.
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.
Select Edit > Goto Section to access the Goto Section sub-menu.
Select the section that you want to jump to from the sub-menu. The available options are:
NetLinx: Axcess:
• DEFINE_DEVICE • DEFINE_DEVICE
• DEFINE_CONSTANT • DEFINE_CONSTANT
• DEFINE_TYPE
• DEFINE_VARIABLE • DEFINE_VARIABLE
• DEFINE_LATCHING • DEFINE_LATCHING
• DEFINE_TOGGLING • DEFINE_TOGGLING
• DEFINE_MUTUALLY_EXCLUSIVE • DEFINE_MUTUALLY_EXCLUSIVE
• DEFINE_CONNECT_LEVEL • DEFINE_CONNECT_LEVEL
• DEFINE_START • DEFINE_START
• DEFINE_MODULE
• DEFINE_EVENT
• DEFINE_PROGRAM • DEFINE_PROGRAM
The Insert Section and Goto Section sub-menus may include sections that are not
defined in the Source Code file being edited. The valid commands for the System
type will be available whether they are actually in the file or not.
The cursor jumps to the top of the selected section in the open Source Code Editor window.
Printing Files
You can print the active file in the Source Code Editor using the Print option in the File menu.
1. Choose File > Print Preview to open the Print Preview window, to preview the file, as it will
be printed (if necessary).
2. Choose File > Print Setup to open the Print Setup dialog, to choose and configure your printer
(if necessary).
3. Choose File > Print to print the file.
If you don't have a printer installed on your PC, the Print and Print Preview options
invoke a message alerting you to install a printer.
Compile Operations
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.x 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.
To send the compiled code to the Master Controller, use the File Transfers option in the Tools
menu.
The currently active System is indicated in bold (in the Workspace tab of the
Workspace Window).
If you create a new non-Project related file, without a Workspace file open, the Compile
command compiles the file using the compiler (NetLinx or Axcess) associated with the
file when it was created.
If you open an existing non-Project related file, with a Workspace open, the Compile
command compiles the file using the compiler specified in the System communication
settings for the currently active System.
The Compile as NetLinx command compiles the selected file using the NetLinx
compiler.
The Compile as Axcess command compiles the selected file using the Axcess compiler.
There are several ways to access the Compile commands - via the Build menu, the System File
context menus (in the Workspace tab of the Workspace Window), the Source Code Editor context
window, or via the toolbar buttons.
To compile an individual file:
1. Select the file that you want to compile:
If the file is already included in the open Workspace, click to select the file and select the
appropriate Compile command.
If the file is not part of the open Workspace, open the file via the File > Open command,
then right-click on the file (in the Source Code Editor window) and select the appropriate
Compile command from the Source Code Editor context menu.
2. Click to select and highlight the System that you want to compile (in the Workspace tab of the
Workspace window). The Build System command always works on the selected System,
regardless of whether it is currently designated as the active system or not.
3. Select Build > Build System.
Any errors detected by the program before the build operation starts are listed in the Pre-Build
Errors dialog. This dialog gives you the option of ignoring the errors and continuing with the
build.
4. The status and results of the build are displayed in the Status tab of the Output Display
Window.
Compilation errors - Errors that occur at compile time. The compiler alerts you to these
errors immediately and identifies each error and the line where it is located.
Run-time errors - Errors that occur after the program has been compiled and loaded into
the Master Controller. These errors are caused by program statements that attempt illegal
operations.
Logic errors - Logic errors are errors in program design and thus are the programmer's
responsibility; The master cannot tell if the program it is executing is accomplishing what
the user intends.
Compiler Errors
When the compiler finds an error during the compilation process, it informs the programmer. Most
of the time these errors occur due to a typographical error or incorrect syntax of a particular
command. Unlike warnings, errors must be corrected before your program can be executed.
Compilation errors are described below:
Compiler Errors
A "<symbol>" was expected The compiler is expecting a certain symbol at this particu-
lar place.
Active keyword expected An ACTIVE keyword is not present after a SELECT key-
word.
Allowed only in DEFINE_START A keyword that is only allowed to appear in the
DEFINE_START section of the program was encountered
elsewhere.
Attempted CALL to undefined subroutine A CALL statement refers to a subroutine that has not been
defined with a DEFINE_CALL statement.
Comment never ends, EOF encountered A comment begins but never ends. Place a close com-
ment, * ) at the end of the unfinished comment.
Conditional compile nesting too deep There are too many nested #IF_DEFINED or
#IF_NOT_DEFINED conditional compilation statements.
The limit is 20 nested conditional compilation statements
Constant type not allowed A constant value was declared as latching, toggling, or
mutually exclusive, as shown below:
DEFINE_CONSTANT
PLAY = 1
DEFINE_LATCHING
PLAY (* Error: PLAY is a constant *)
DEFINE_CALL must have a name DEFINE_CALL must have a name after it. For example,
DEFINE_CALL 'VHS'.
DEFINE_CALL name already used The name of the DEFINE_CALL has already been used.
This name cannot be the same as an already declared
identifier of any type.
Compiler Warnings
Sometimes the compiler generates a warning message instead of an error message; these warning
messages always start with "w". A warning about a particular statement means that the statement is
not technically an error, but you should be careful doing it. Warnings, unlike errors, do not stop the
program from compiling.
Some types of warnings can be disabled in the Compiler Options tab of the Preference dialog.
Common compiler warnings are described below:
Compiler Warnings
(w) Cannot assign unlike types This warning occurs when a variable or value of one type is assigned
to a variable of a different type. Here are some 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 integer array to a non-integer array
• Assigning a two-dimensional array to a one-dimensional array, or
vice versa
• Assigning the result of a function that returns an array type to a non-
array variable or to a two-dimensional array variable (for example, X
= ITOA(12), where X is a non-array variable or two-dimensional
array variable)
• 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 Ø and 65,535. The generation of this warning can be
turned on or off in the Compiler Options tab of the Preference dialog.
(w) Define_Call is not used This warning occurs at the end of program compilation for each
DEFINE_CALL subroutine that was declared but never used. The gen-
eration of this warning can be turned on or off in the Compiler Options
tab of the Preference dialog
(w) Integer applies to arrays only This warning appears when the keyword INTEGER is applied to a
non-array type of variable. Doing this is not an error, because non-
array variables are already integers, but it is redundant. The genera-
tion of this warning can be turned on or off in the Compiler Options tab
of the Preference dialog.
(w) Long_While within While This warning occurs if the compiler finds a LONG_WHILE or
MEDIUM_WHILE inside a block of code following a WHILE keyword.
This warning exists because the WHILE command has a 1/2 second
timeout period, and the LONG_WHILE and MEDIUM_WHILE key-
words do not. This could create a hard-to-find logic error. The solution
is to change the WHILE to a LONG_WHILE to fix this problem. The
generation of this warning can be turned on or off in the Compiler
Options tab of the Preference dialog.
(w) Possibly too many nested levels This warning appears if there is a large amount of nesting in the pro-
gram. This can happen with a long chain of IF...ELSE IF statements.
The solution is to use the SELECT...ACTIVE set of statements. The
generation of this warning can be turned on or off in the Compiler
Options tab of the Preference dialog.
(w) Variable is not used This warning occurs at the end of compilation for each variable that
was declared but never used. The generation of this warning can be
turned on or off in the Compiler Options tab of the Preference dialog.
Run-Time Errors
In many cases, a program is compiled and sent to the Master Controller error-free, but the System
does not act in the way it should. If the program code is correct, you should check for run-time
errors. These errors occur in the Master Controller, usually when it could not perform a particular
operation in the program. Run-Time errors are errors that occur during program execution, and are
described below:
Run-Time Errors
Bad assign 2dim... These errors occur if an attempt is made to assign a two-dimensional array to a
different type (such as a variable or one-dimensional array), and vice versa.
Bad assign Call... These errors occur if the Master Controller cannot assign a parameter in a
CALL statement to the parameter in the corresponding DEFINE_CALL state-
ment.
Bad element assign... These errors occur if an assignment is attempted past the end of an array, or to
the Ø location of an array (for example, ARRAY[Ø]).
Bad Off... Bad On... Bad To... These errors indicate that the device-channel or variable that is being refer-
enced by an OFF, ON, or TO keyword is out of range.
Bad re-assign Call... These errors occur when the Master Controller attempts to re-assign the
parameter variables in a DEFINE_CALL to the parameters in the correspond-
ing CALL statement, and the assignment cannot be made.
Bad run token This error occurs when the Master Controller does not understand a piece of
data in the program it is executing.
Bad Set_Length... These errors occur if the SET_LENGTH_STRING keyword tries to set the
length value of an array to a value greater than the array's storage capacity.
Bad While This error occurs whenever a WHILE loop terminates due to the half-second
timeout imposed on WHILE loops.
The Port should always be set to 1319 (default setting). Do not change the Port
assignment.
The number of Masters in this System, total number of devices online, and the total
number of ports in the System are indicated in the (read-only) Master(s), Devices and
Ports fields a the bottom of this tab.
5. Double-click any device to expand the Device folder, to show the device port count and any
sub-devices that require firmware (with firmware information listed).
Sub-devices are hardware components contained within a parent device, which may
require their own firmware. For example, and NXI Master Controller contains three
components, each of which require firmware.
Diagnostics
Using NetLinx Diagnostics
The Diagnostics menu contains options that allow you to run various diagnostics operations on
NetLinx systems.
The options in this menu are enabled only if the communications platform is set to NetLinx in the
Communication Setting dialog.
The D:P:S combination of 0:0:0 is the default setting and will show up as "All
Devices".
4. Check each notification type that you want to enable for that device.
To set the selected set of notifications as the default notifications for this device, click the
Set As Defaults button.
Once you set the default notifications, you can use the Use Defaults button to recall the
default set.
5. Click OK to return to the NetLinx Device Notifications Options dialog. The new 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 labeled
as ON in the associated column(s).
6. Repeat steps 2-5 to configure NetLinx Notifications for as many additional devices as is
necessary.
A very large amount of data may be generated if all options are enabled for every
device in a large System.
7. Click Close to save the changes and exit the NetLinx Device Notifications Options dialog.
A very large amount of data may be generated if all options are enabled for every
device in a large System.
4. Click OK to save your changes and return to the NetLinx Device Notifications Options dialog.
The new notification options are indicated (as ON) in the notifications list.
The program will not allow you to remove the All Devices (0:0:0) listing.
Select the Push button to emulate a push/release on the channel specified. You may click
and hold down the Push button to see how the master controller responds to the push
message.
Select the On or Off buttons to emulate Channel ON (CHON) and Channel OFF (CHOFF)
messages for the specified <D:P:S>.
4. To emulate a level, enter the desired Level (number), Value and data Type (BYTE, CHAR,
WIDECHAR, INTEGER, SINTEGER, ULONG, LONG, FLOAT, or DOUBLE), and click Send to
emulate the specified level and value.
The list below indicates the valid level data types and their ranges:
Hold down the Shift key to select a specific range of lines to send to the controller
instead of all the lines within the edit control.
a. Click the Message Type radio buttons (String or 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 text box to the
master. If none of the messages are selected (highlighted), all messages are sent. If you
have selected a line or a range of lines, only the selected messages will be sent.
6. Check the Messaging Options checkboxes to Enable Asynchronous Notifications and/or
Enable Internal Diagnostic Messages.
It is recommended that you enable NetLinx Notifications to view the results in the
Notifications tab of the Output Display window. For example, in order to view a string
sent to a device (via the Emulate Device dialog), you must first enable the Strings to
Device notification (in the NetLinx Device Notifications Options dialog). Additionally,
to view any strings returned from the device, you must enable the Strings From
Device notification.
2. Enter the Device, Port and System <D:P:S> combination of the device you wish to control.
The <D:P:S> value ranges are 0 - 65,535.
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.
Select the On or Off buttons to emulate Channel ON (CHON) and Channel OFF (CHOFF)
messages for the specified <D:P:S>.
4. To emulate a level, enter the desired Level (number), Value and data Type (BYTE, CHAR,
WIDECHAR, INTEGER, SINTEGER, ULONG, LONG, FLOAT, or DOUBLE), and click Send to
emulate the specified level and value.
The list below contains the valid level data types and their ranges:
Hold down the Shift key to select a specific range of lines to send to the controller
instead of all the lines within the edit control.
a. Click the Message Type radio buttons (String or 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 text box to the
master. If none of the messages are selected (highlighted), all messages are sent. If you
have selected a line or a range of lines, only the selected messages will be sent.
6. Check the Messaging Options checkboxes to Enable Asynchronous Notifications and/or
Enable Internal Diagnostic Messages.
It is recommended that you enable NetLinx Notifications to view the results in the
Notifications tab of the Output Display window. For example, in order to view a string
sent to a device (via the Emulate Device dialog), you must first enable the Strings to
Device notification (in the NetLinx Device Notifications Options dialog). Additionally,
to view any strings returned from the device, you must enable the Strings From
Device notification.
Use the set of options on the left side of this dialog to specify the Device and System
assignments, when you know the current address assignments as well as the address that
you want to change the device to.
Alternatively, you can use the set of ID Mode options on the right side of this tab to
change the address assignment for a specified NetLinx device, using Identity (ID) Mode.
The Start Identify Mode button places the entire NetLinx system (specified in the
Destination System text box) in ID Mode.
Use ID Mode when you don't know the current address assignments.
1. Enter the Device and System numbers that you want to assign to the device in the (Change to
Device) Device and System text boxes.
The Destination System number must be a System that is defined in the URL List
dialog.
2. Enter the Device and System numbers that you want to assign to the device in the (Change to
Device) Device and System text boxes.
3. Click the Start Identify Mode button to place the named System in ID Mode. The text box
below this button displays a Waiting…Press Cancel to Quit message. The Start Identify
Mode button changes to Cancel Identify Mode (click to cancel ID Mode).
4. Generate an event from the device that you want to assign the new Device and System numbers
to:
URL Lists
Creating a URL List
Use the URL Listing dialog to create a URL List for the specified master. The URL List identifies
all NetLinx Masters present in the same System as the Master that you are connected to.
You must enter a URL for each master in the System before you can use ID Mode on other masters.
Only devices defined in the URL list will appear in the On-line device tree (with the
exception of the Master that you are connected to).
If you enter a valid URL for a Master, the program generates the device's IP Address.
5. Initially the connection status reads Looking up URL. Once found, the new device appears in
the URL List with its IP Port assignment = 1319.
Do not change the IP Port number! An IP Address is assigned to this URL and is
displayed in the IP Address column.
6. Click Get URL List to refresh the URL List after adding a device.
7. Repeat steps 1-5 for as many additional Masters as are required.
To retrieve a list of all URL's in the list, click Get URL List. The URL List is populated
with all previously set URL's.
To remove a URL from the list, select the URL and click Remove.
Network Addressing
Use the options in the Networking Addresses dialog to change the network settings for a specified
NetLinx master.
When you change the IP Address of a master (if connected via IP), you must also
change the communication settings to match the new IP Address in the Master
Communications Settings dialog.
3. Click Get DNS Information to populate the DNS Address fields with the current Domain
Suffix, DNS IP Address #1, DNS IP Address #2 and DNS IP Address #3 assignments (as
applicable).
4. Edit the DNS Address assignments and/or add new DNS address information as needed.
5. Click Set DNS Information to set the new DNS address assignments.
3. Click Get IP Information to populate the IP Address fields with the current Host Name, IP
Address, Subnet Mask and Gateway assignments.
4. Click the Specify IP Address radio button, and enter the new IP Address, Subnet Mask and
Gateway assignments in the text boxes, as necessary.
5. Click Set IP Information to set the new IP Address assignment.
6. Click Reboot Master to reboot the master and accept the new changes. Allow 20-30 seconds
for the master to reboot.
3. Click the Get IP Information button to populate the IP Address fields with the current Host
Name and Gateway assignments.
4. Click the Use DHCP radio button, and enter the new Host Name in the text box, if necessary.
5. Click the Set IP Information button to set the new Host Name assignment. A message will be
displayed indicating that the Master has accepted the new settings.
6. Click the Reboot Master button to reboot the Master and accept the new changes. Allow 20-
30 seconds for the Master to reboot.
If you change the IP Address of a Master (if connected via IP), you must also change
the communication settings to match the new IP Address (in the Communication
Setting dialog).
3. Click the Get IP Information button to populate the IP Address fields with the current Host
Name, IP Address, Subnet Mask and Gateway assignments.
4. Click the Specify IP Address radio button, and enter the new IP Address, Subnet Mask and
Gateway assignments in the text boxes, as necessary.
5. Click the Set IP Information button to set the new IP Address assignment. A message will be
displayed indicating that the Master has accepted the new settings.
6. Click the Reboot Master button to reboot the Master and accept the new changes. Allow 20-
30 seconds for the Master to reboot.
If you change the IP Address of a Master (if connected via IP), you must also change
the communication settings to match the new IP Address (in the Master
Communication Setting dialog).
Alternatively, you can highlight the field in the Time display that you want to adjust and
type the desired number in its place.
If no field is selected within the time display, the up/down arrows affect the hours setting.
5. To set the specified Time/Date settings for the target system click Set Time/Date.
NetLinx Diagnostics
The Diagnostics menu contains options that allow you to run various diagnostics operations on
NetLinx systems. The options in this menu are enabled only if the communications platform is set
to NetLinx in the Communication Setting dialog.
The D:P:S combination of 0:0:0 is the default setting and will show up as "All
Devices".
4. Check each notification type that you want to enable for that device.
To set the selected set of notifications as the default notifications for this device, click the
Set As Defaults button.
Once you set the default notifications, you can use the Use Defaults button to recall the
default set.
5. Click OK to close the NetLinx Notification Properties (Add) dialog and return to the NetLinx
Device Notifications Options dialog. The new target device specified has its own line in the
notifications list. The Device:Port:System values (for example, 1:0:0) identify the device in the
Device column. The selected notification option(s) are labeled as ON in the associated
column(s).
6. Repeat steps 2-5 to configure NetLinx Notifications for as many additional devices as
necessary.
A very large amount of data may be generated if all options are enabled for every
device in a large System.
The program will not allow you to remove the All Devices (0:0:0) listing.
Select the Push button to emulate a push/release on the channel specified. You may click
and hold down the Push button to see how the master controller responds to the push
message.
Select the On or Off buttons to emulate Channel ON (CHON) and Channel OFF (CHOFF)
messages for the specified <D:P:S>.
4. To emulate a level, enter the desired Level (number), Value and data Type (BYTE, CHAR,
WIDECHAR, INTEGER, SINTEGER, ULONG, LONG, FLOAT, or DOUBLE), and click Send to
emulate the specified level and value.
The list below contains the valid level data types and their ranges:
Hold down the Shift key to select a specific range of lines to send to the controller
instead of all the lines within the edit control.
a. Click the Message Type radio buttons (String or 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 text box to the
master. If none of the messages are selected (highlighted), all messages are sent. If you
have selected a line or a range of lines, only the selected messages will be sent
6. Check the Messaging Options checkboxes to Enable Asynchronous Notifications and/or
Enable Internal Diagnostic Messages.
It is recommended that you enable NetLinx Notifications to view the results in the
Notifications tab of the Output Display window. For example, in order to view a string
sent to a device (via the Emulate Device dialog), you must first enable the Strings to
Device notification (in the NetLinx Device Notifications Options dialog). Additionally,
to view any strings returned from the device, you must enable the Strings From
Device notification.
Select the Push button to emulate a push/release on the channel specified. You may click
and hold down the Push button to see how the master controller responds to the push
message.
Select the On or Off buttons to emulate Channel ON (CHON) and Channel OFF (CHOFF)
messages for the specified <D:P:S>.
4. To emulate a level, enter the desired Level (number), Value and data Type (BYTE, CHAR,
WIDECHAR, INTEGER, SINTEGER, ULONG, LONG, FLOAT, or DOUBLE), and click Send to
emulate the specified level and value.
The list below contains the valid level data types and their ranges:
Hold down the Shift key to select a specific range of lines to send to the controller
instead of all the lines within the edit control.
a. Click the Message Type radio buttons (String or 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 text box to the
master. If none of the messages are selected (highlighted), all messages are sent. If you
have selected a line or a range of lines, only the selected messages will be sent.
6. Check the Messaging Options checkboxes to Enable Asynchronous Notifications and/or
Enable Internal Diagnostic Messages.
It is recommended that you enable NetLinx Notifications to view the results in the
Notifications tab of the Output Display window. For example, in order to view a string
sent to a device (via the Emulate Device dialog), you must first enable the Strings to
Device notification (in the NetLinx Device Notifications Options dialog). Additionally,
to view any strings returned from the device, you must enable the Strings From
Device notification.
Use the set of options on the left side of this dialog to specify the Device and System
assignments, when you know the current address assignments as well as the address that
you want to change the device to.
Alternatively, you can use the set of ID Mode options on the right side of this tab to
change the address assignment for a specified NetLinx device, using Identity (ID) Mode.
The Start Identify Mode button places the entire NetLinx system (specified in the
Destination System text box) in ID Mode.
To reboot the master, select Reboot Master from the Tools menu.
The Destination System number must be a System that is defined in the URL List
dialog.
2. Enter the Device and System numbers that you want to assign to the device in the (Change to
Device) Device and System text boxes.
3. Click the Start Identify Mode button to place the named System in ID Mode. The text box
below this button displays a Waiting…Press Cancel to Quit message. The Start Identify Mode
button changes to Cancel Identify Mode (click to cancel ID Mode).
4. Generate an event from the device that you want to assign the new Device and System numbers
to:
Network Addressing
Use the options in the Networking Addresses dialog to change the network settings for a specified
NetLinx master.
When you change the IP Address of a master (if connected via IP), you must also
change the communication settings to match the new IP Address in the Master
Communications Settings dialog.
3. Click Get DNS Information to populate the DNS Address fields with the current Domain
Suffix, DNS IP Address #1, DNS IP Address #2 and DNS IP Address #3 assignments (as
applicable).
4. Edit the DNS Address assignments and/or add new DNS address information as needed.
5. Click Set DNS Information to set the new DNS address assignments.
3. Click Get IP Information to populate the IP Address fields with the current Host Name, IP
Address, Subnet Mask and Gateway assignments.
4. Click the Specify IP Address radio button, and enter the new IP Address, Subnet Mask and
Gateway assignments in the text boxes, as necessary.
5. Click Set IP Information to set the new IP Address assignment.
6. Click Reboot Master to reboot the master and accept the new changes. Allow 20-30 seconds
for the master to reboot.
3. Click the Get IP Information button to populate the IP Address fields with the current Host
Name and Gateway assignments.
4. Click the Use DHCP radio button, and enter the new Host Name in the text box, if necessary.
5. Click the Set IP Information button to set the new Host Name assignment. A message will be
displayed indicating that the Master has accepted the new settings.
6. Click the Reboot Master button to reboot the Master and accept the new changes. Allow 20-
30 seconds for the Master to reboot.
If you change the IP Address of a Master (if connected via IP), you must also change
the communication settings to match the new IP Address (in the Communication
Setting dialog.
3. Click the Get IP Information button to populate the IP Address fields with the current Host
Name, IP Address, Subnet Mask and Gateway assignments.
4. Click the Specify IP Address radio button, and enter the new IP Address, Subnet Mask and
Gateway assignments in the text boxes, as necessary.
5. Click the Set IP Information button to set the new IP Address assignment. A message will be
displayed indicating that the Master has accepted the new settings.
6. Click the Reboot Master button to reboot the Master and accept the new changes. Allow 20-
30 seconds for the Master to reboot.
If you change the IP Address of a Master (if connected via IP), you must also change
the communication settings to match the new IP Address (in the Master
Communication Setting dialog).
To set the system to today’s date, click Today at the bottom of the calendar.
4. To change the target Master's time setting, select a field within the time display (hours,
minutes, seconds, or AM/PM) and click the up and down arrows to adjust the selected field.
Alternatively, you can highlight the field in the Time display that you want to adjust and
type the desired number in its place.
If no field is selected within the time display, the up/down arrows affect the hours setting.
5. To set the specified Time/Date settings for the target system click Set Time/Date.
Device Mapping
NetLinx Studio makes it easy to map System files to devices on the bus for file transfer operations:
1. Select and open the Project containing the file to be mapped to a device (in the Workspace tab
of the Workspace Window).
2. Select the System containing the file.
3. Select Device Mapping from the Project menu (or use the toolbar button) to open the Device
Mapping dialog.
You can also access the Device Mapping command via the Source File, User
Interface, and IR File context menus. The Device Mapping option is only available if
you have selected a Source Code file that is not designated as the Master Source
Code file.
4. In the Device Mapping dialog, select a System from the File View window on the left side of
the dialog (if different than the System already selected).
5. Double-click to expand the System folder to view the System File folders (Source, User
Interface and IR).
6. Double-click to expand the System File folder containing the file you want to map to a device,
and select the file you want to map.
7. In the Device View window (on the right side), select the target device for the selected file from
the list of devices (as specified in the in the DEFINE_DEVICE section of the System's Master
Source Code file).
To map to a device that is not specified in the Master Source Code file, select <Custom>, and
enter the device's D:P:S assignment (in the Enter DPS dialog).
The System's Master Source file will always be mapped automatically to 0:1:0 for
NetLinx Masters, and 0 for Axcess Masters.
8. Click the Map button to map the file to the target device.
Once a file has been mapped to a device, the mapping assignment is indicated in the File View
window of the Device Mapping dialog as well as in the Workspace tab of the Workspace Window.
The file mapping information is saved with the file, and this association is maintained until the
mapping information is removed (via the Remove option in the Device Mapping dialog, or the
Delete command in the System File Device Map context menu.
Workspace mappings are only updated when the source code file is saved.
Double click to expand the System folders to show the System File folders (Source, User
Interface and IR only, since these are the only file types that can mapped).
With a file selected (in the File View window), select a target device for the file in the
Device View window, and click the Map button to map that file to the selected device.
If you select <Custom>, the Enter DPS dialog will prompt you to enter the D:P:S
assignment of the device you want to map to.
In Axcess, Master Source Code files are always mapped to the Master Controller (device
= 0), and cannot be mapped to any other device. This does not apply to NetLinx Master
Source Code files.
Once a file has been mapped to a device, the mapping assignment is indicated in the File View
window of the Device Mapping dialog as well as in the Workspace tab of the Workspace Window.
The file mapping information is saved with the file, and this association is maintained until the
mapping information is removed (via the Remove option in the Device Mapping dialog, or the
Delete command in the System File Device Map context menu.
Workspace mappings are only updated when the source code file is saved.
• Device Mapping Opens the Device Mapping dialog for mapping files to System devices.
• Delete Removes the selected file's device-file mapping association.
Device:Port:System (D:P:S)
A device is any hardware component that can be connected to the NetLinx bus. Each device must
be assigned a unique number to locate 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 are
reserved for internal use.
NetLinx requires a Device:Port:System (D:P:S) specification where Axcess expected only a device
number. This D:P:S triplet can be expressed as series of constants, variables separated by colons, or
as a DEV structure, to explicitly represent a device number, port and system.
Here's the syntax:
DEVICE:PORT:SYSTEM
where:
Port: 16-bit integer representing the port number (in the range 1 through the number of
ports on the device)
System: 16-bit integer representing the system number (0 = this system) that the device
belongs to.
For example, 128:1:0 represents the first port on device 128 on this system.
DEV structure example:
STRUCTURE DEV
{
INTEGER Number // device number
INTEGER Port // port on device
INTEGER System // system device belongs to
}
In Axcess, Master Source Code files are always mapped to the Master Controller
(device = 0), and cannot be mapped to any other device. This does not apply to
NetLinx Master Source Code files.
Communication Settings
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.
6. Click Settings to open either the TCP/IP Settings, Serial Settings or Modem Settings dialog
(depending on the transport connection selected).
7. Specify the communication settings for the selected port.
For serial ports: Specify the COM port, and set baud rate, data bits, parity, stop bits and
flow control.
For modems: Specify the COM port, and set baud rate, data bits, parity, stop bits, flow
control and target phone number.
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.
6. Click Settings to open either the TCP/IP Settings, Serial Settings or Modem Settings dialog
(depending on the transport connection selected).
7. Specify the communications settings for the selected port.
For serial ports, specify the COM port, and set baud, data bits, parity, stop bits and flow
control.
For modems, specify the COM port, and set baud, data bits, parity, stop bits, flow control
and target phone number.
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.
For serial ports, specify the COM port, and set baud, data bits, parity, stop bits and flow
control.
For modems, specify the COM port, and set baud, data bits, parity, stop bits, flow control
and target phone number.
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.
C = Call - means that the FileTransfer program can get the modem to call another modem
and establish communications.
A = Answer - means that the FileTransfer program can get the modem to answer inbound
calls and establish communications with the master controller.
X = Not supported.
Axcess or NetLinx Source Code files (.AXS) can be sent to the Master Controller, or
other control devices on the bus. Source code files must be successfully compiled before
they can be sent.
Touch Panel UI files created in TPDesign3 (.TPD) are sent directly to wired Touch Panels
on the bus via an AXlink/serial connection where the Device ID = 0.
Touch Panel UI files created in TPDesign4 (.TP4) are sent to the Master, either serially or
over TCP/IP. G4 panels are connected to the Masters via TCP/IP and cannot be sent over
AXlink. You can choose to include buttons and pages only, or include fonts, bitmaps and/
or icons in the transfer.
IR library files (.IRL/.IRV) are sent to IR-controlled devices on the bus, or directly to a
System device (i.e. ViewPoint Touch Panels).
The File Transfer dialog provides an easy to understand approach to file transfer while still
providing a high level of flexibility.
Source Code files cannot be sent until they have been successfully compiled.
In order for NetLinx Debugging to work, both the source (SRC) and token (TKO) files
must be successfully sent to the Master. Always use the Compile With Debug Info and
Build With Source options (Preferences dialog - NetLinx Compiler Options tab) to
compile NetLinx code files that allow debugging.
While Touch Panel UI files are sent to the panels themselves, Keypad UI files are sent to
the master and not directly to the keypad. Before sending a KPDesign (KPD) file to the
target keypad(s), be sure that you have successfully compiled the Source Code file that
contains the keypad module, and sent it to the Master (see Configuring NetLinx Source
Code for KPD Files).
To send Workspace files to the Master or to a System device, you will first add the file(s) you want
to send to the Files to Send table:
1. Select Tools > File Transfers (or click the toolbar button) to access the File Transfers dialog
(already opened to the Send tab).
2. Click the Add button to add the Workspace file(s) you want to send to the Files To Send table.
This opens the Select Files for File Transfer dialog (Current Workspace tab), containing a
display of all Projects, Systems and associated System files in a tree structure, similar to that of
the Workspace tab of the Workspace Window. The mapping information for each file is also
indicated in this display (files that have not yet been mapped to a device are labeled as Not
Mapped).
3. Select the Workspace System file(s) that you want to add to the Files to Send table:
You can only select files with device-mapping information. You can always edit the
file's mapping information later via the File Transfer dialog, but without any mapping
information associated with the file, it cannot be selected (since the selection
checkboxes are not provided). Since each file has its own device-mapping
association, you can add all of the System files in a Workspace, and send them all to
their individual target devices with the Send command in the File Transfer dialog.
To add all of the (mapped) System files (contained in the open Workspace) to the Files To
Send table, select the Projects directory at the top of the tree structure. This selection
automatically selects all Projects in the Workspace, their contained Systems, and
(transferrable) System files.
To add all of the (mapped) System files contained in a particular Project, select the
desired Project directory. This automatically selects all of the Systems contained in the
selected Project, and all (transferrable) System files.
To add all of the (mapped) files contained in a particular System, select the desired
System directory to automatically selected all transferrable files in that System.
The checkbox to the left of each file in the Files To Send table indicates wether the file is
selected to be included in the transfer. By default, the checkbox is selected when a file is
added to the list. Deselect this checkbox to exclude the file from the transfer.
To rearrange the files in the list, select a file and use the Up and Down command buttons,
as desired. If a file is already at the top of the list, selecting the Up button will "wrap" the
item to the bottom of the list. The opposite is true for the Down button.
To remove a file from the list, select a file and click the Remove command button.
To edit the communication and/or mapping information for a file, select a file and click
the Edit command button. This opens the File Transfers Edit sub-menu:
• Communication Opens the Communication Settings dialog, where you can edit the Platform,
Settings Transport Connection type and Communication Settings for the selected file.
Alternatively, you can double-click in the Connection column to access the
Communication Settings dialog.
• Device Opens the Enter DPS dialog, where you can edit the D:P:S assignment for the
Mapping selected file. Alternatively, you can double-click in the Mapping column to
access the Enter DPS Settings dialog.
In Axcess, Master Source Code files are always mapped to the Master Control-
ler (device = 0). Master Source Code files cannot be mapped to any other
device. NetLinx Master Source Code files are mapped according to the System
settings when the Project was created. The only way to modify these settings is
via the System Properties dialog.
Also, when sending TPD files directly to a Touch Panel (i.e. via serial cable con-
nection), the device = 0.
• Options This option is only available if you have selected a TPD or TP4 touch panel UI
file.
If you have selected a TPD (TPdesign3) file, this option opens the TPD Transfer
Options dialog, where you can select which parts of the TPD file to include
when the file is sent (the options are Bitmaps, Fonts and Icons - by default they
are all selected).
If you have selected a TP4 (TPDesign4) file, this option opens the TP4 Transfer
Options dialog, where you can select to enable Smart Transfer. Smart Transfer
automatically optimizes the transfer by identifying the various components
(fonts, bitmaps, sound files, even pages and popup pages) of the selected
panel file, and comparing them to the elements already present on the target
panel. Any shared components are not sent, resulting in a much faster transfer
(assuming that there are shared components).
When sending a TP4 file to a G4 panel, verify that the NetLinx Master Firmware is
build 85 or later. Verify the TPDesign4 program being used is Version 1.01 or higher.
Earlier versions of the firmware and TPD4 software are incompatible with G4 panels.
5. Click the Send command button to send the files, in the order that they are arranged in the
queue.
By default, the Reboot option (indicated by checkboxes in the Reboot column of the
Files To Send table) is enabled (for Workspace files only), so that the System Master will
automatically reboot after the transfer is complete.
The Reboot option always reboots the Master, regardless of the device mapping
associated with the file itself. For example, TPD/TP4 files are transferred directly to
the panel, but the Reboot option will reboot the Master - not the panel that received
the file.
The progress of each file transfer is indicated in the File Transfer Status tab of the Output
Display Window. This tab also lists the file’s communications port assignment, transfer
status (pending, failed, in progress, complete, or cancelled), filename, type (send or
receive), errors, date received, and other data on the transfer. The file will sent as soon as
the specified communications port is available.
When a file is in the process of being sent, it cannot be re-compiled. If you need to re-
compile a file that is being sent, cancel the file transfer first, re-compile and re-submit
for transfer.
Source Code files cannot be sent until they have been successfully compiled.
In order for NetLinx Debugging to work, both the source (SRC) and token (TKO) files
must be successfully sent to the Master. Always use the Compile With Debug Info and
Build With Source options (Preferences dialog - NetLinx Compiler Options tab) to
compile NetLinx code files that allow debugging.
While Touch Panel UI files are downloaded to the panels themselves, KPDesign (KPD)
files are sent to the master and not directly to the keypad. Before sending a KPD file to
the target keypad(s), be sure that you have successfully compiled the Source Code file
that contains the keypad module, and sent it to the Master (see the Configuring NetLinx
Source Code for KPD Files section on page 60).
To send files that are not associated with a System to the Master or to a System device, you will first
add the file(s) you want to send to the Files to Send table:
1. Select Tools > File Transfers (or click the toolbar button) to access the File Transfers dialog
(already opened to the Send tab).
2. Click the Add button to add the file(s) you want to send to the Files To Send table. This opens
the Select Files for File Transfer dialog. click on the Other tab.
3. The Other tab contains a set of icons representing the different types of files that can be
transferred (IR Codes, Touch Panel Design File, NetLinx Source Code, Compiled NetLinx
Source Code, Compiled Axcess Source Code, TP4 Touch Panel Design File, and KPD Keypad
Touch File). Select the type of file you want to add to the Files to Send list, and click the Add
button.
4. Locate and select the desired file(s) via the Open dialog. Click Open to return to the Select
Files For File Transfer dialog (Other tab). Before the file(s) are opened, the program prompts
you to specify device-mapping for each file, via the Enter Device Information dialog. Once a
D:P:S assignment (for the intended target device for each file) has been specified, the selected
file(s) appear in the File list at the bottom of this tab.
5. Click OK to return to the File Transfer dialog (Send tab) - the selected files appear in the Files
To Send table.
The checkbox to the left of each file in the Files To Send table indicates wether the file is
selected to be included in the transfer. By default, the checkbox is selected when a file is
added to the list. Deselect this checkbox to exclude the file from the transfer.
To rearrange the files in the list, select a file and use the Up and Down command buttons
as desired.
To remove a file from the list, select a file and click the Remove command button.
To edit the communication and/or mapping information for a file, select a file and click
the Edit command button. This opens the File Transfers Edit sub-menu (described in the
previous section, Sending Workspace Files to the Master Controller or System Device.
6. Click the Send command button to send the files, in the order that they are arranged in the
queue.
The progress of each file transfer is indicated in the File Transfer Status tab of the Output
Display Window. This tab also lists the file’s communications port assignment, transfer
status (pending, failed, in progress, complete, or cancelled), filename, type (send or
receive), errors, date received, and other data on the transfer. The file will sent as soon as
the specified communications port is available.
When a file is in the process of being sent, it cannot be re-compiled. If you need to re-
compile a file that is being sent, cancel the file transfer first, re-compile and re-submit
for transfer.
Source Code files can only be received from a device if the Build With Source option
(Preferences dialog - Axcess and NetLinx Compiler Options tabs) was selected when
the file was compiled, prior to transfer.
To receive files from the Master or System device, you will first add the file(s) you want to receive
to the Files to Receive table:
1. Select Tools > File Transfer (or click the toolbar button) to access the File Transfer dialog,
and open the Receive tab.
2. Click the Add button to access the Select Files for File Transfer dialog (Other tab). This dialog
contains a set of icons representing the various types of files that can be received from the
Master or System device (IR Codes, Touch Panel Design File, NetLinx Source Code File ,
Axcess Source Code File and TP4 Touch Panel Design File). Select the type of file you want to
receive, and click the Add button.
IR files cannot be received from Axcess devices. Even if the device is connected
through a Netlinx Master, if it's an Axcess device you can't receive IR files.
3. In the Save As dialog, enter a name for the received file, or select an existing file to replace
with the received file, and click Save to return to the Select Files For File Transfer dialog
(Other tab).
4. Specify a source device for each file, via the Enter Device Information dialog. Once a D:P:S
assignment has been specified for each file, the selected file(s) appear in the file list at the
bottom of the Select Files for File Transfer dialog.
5. Click OK to return to the File Transfer dialog (Receive tab) - the selected files appear in the
Files To Receive table.
The checkbox to the left of each file in the Files To Receive table indicates wether the file
is selected to be included in the transfer. By default, the checkbox is selected when a file
is added to the list. Deselect this checkbox to exclude the file from the transfer.
To rearrange the files in the list, select a file and use the Up and Down command buttons
as desired.
To remove a file from the list, select a file and click the Remove command button.
To edit the communication and/or mapping information for a file, select a file and click
the Edit command button. This opens the File Transfer Edit sub-menu:
• Connection Opens the Communication Settings dialog, where you can edit the Platform, Trans-
port Connection type and Communication Settings for the selected file. Alterna-
tively, you can double-click in the Connection column to access the Communication
Settings dialog.
• Mapping Opens the Enter DPS dialog, where you can edit the D:P:S assignment for the
selected file. Alternatively, you can double-click in the Mapping column to access
the Enter DPS dialog.
Right-click on any file in the list to access the File Transfer context menu.
6. Click the Receive command button to receive the files, in the order that they are arranged n the
queue. The progress of each file transfer is indicated in the File Transfer tab of the Output
Display window. This tab also lists the file's communication port assignment, transfer status
(pending, failed, in progress, complete or cancelled), filename, transfer type (send or receive),
errors, date received, and other data on the transfer.
Canceling Transfers
A file transfer may be cancelled by right-clicking on the item in the Output Display Window - File
Transfer Status tab and selecting Cancel Current Transfer from the context menu. Canceling an
item that is not currently transferring removes it from the transfer queue.
Canceling during a file transfer may leave the target device in an unstable state.
You have the option to reconnect after the master has rebooted.
Selection Options menu Click the down arrow to access the following load options:
Current Source File Loads the currently active file (SRC and/or TKN-TOK) that
is displayed in the Source Code Editor window.
Active System Loads only the files from the active System.
File type checkboxes The checkbox options in this dialog allow you to simplify the
transfer operation by only sending only specific file types (including TKN, TOK, SRC,
IRL, KPD, TP4 and TPD files).
Use the Select All and Deselect All command buttons to streamline the selection
process.
Note that there are additional options associated with TP4 and TPD files. If you
select TP4 Files, you also have the option of enabling Smart Transfer for those files.
Similarly, if you select TPD files, you have the additional options of including
Bitmaps, Icons, and/or Fonts for those files.
Remove Duplicates When Loading Enable this option to prevent having any duplicate
entries in the Send list of the File Transfer dialog (default = enabled).
Firmware Transfers
NetLinx Studio provides the ability to download KIT and TSK firmware files to a NetLinx or
Axcess master controller.
To send firmware files, select Tools > Firmware Transfers, then select either Send to NetLinx
Device, or Send to Axcess Device from the sub-menu.
The Online Device Tree (Online Tree tab of the Workspace Window) displays
information about each online device, including the current firmware version.
Before attempting to upgrade the firmware, you must have the appropriate Kit file for
your NetLinx Master.
If for any reason your Kit file transfer should fail, continue to retry the transfer until you
are successful. DO NOT reboot the Master, or change connections until the transfer
is complete. Failure to complete this operation successfully may result in a factory
repair of the Master.
Click the Send button to send the selected KIT file to the specified device. You can watch
the progress of the transfer in the Send to NetLinx Device dialog.
When the transfer is finished, and the reboot is complete, press the Close button.
If the device is a NetLinx Master or NXI, then the Reboot option is valid. Other
NetLinx devices need to be given the command to reboot (if they support it). Allow
20-30 seconds for NetLinx Masters to reboot. When the Master has rebooted, the
Status LED on the front panel blinks once a second to indicate that it is functioning
properly. Once it has rebooted, click OK.
Preferences Dialog
Select Settings > Preferences to open the Preferences dialog, where you can set various
application-level preferences. This dialog contains the following tabs:
Axcess Compiler - Contains options to set default preferences for the Axcess compiler
NetLinx Compiler - Contains options to set default preferences for the NetLinx compiler
Editor - Contains options to set default preferences for the Source Code Editor windows
File Transfer - Contains options to set default preferences for file transfer operations.
Workspace - Contains options to set various display and file preferences relating to the
Workspace Window
Tools - Contains options to add a shortcut to another application in the Tools menu.
Menu - Contains options to customize the menus and reset the menus to their original
default state. To reset a menu, select a particular window view (i.e. AXS type views or
TXT type views) from the combo box and then select the Reset button.
Window Color Display Options - This area of the dialog allows you to change the
foreground/background colors for the following windows of the application:
Output Bar - Find in Files - Find in Files tab of the Output Display window
Output Bar - Find IR Files - Find IR Files tab of the Output Display window
Output Bar - File Transfer Status - File Transfer Status tab of the Output Display
window
Foreground Color - This is the text color setting for the selected window.
Background Color - This is the background color setting for the selected window.
Recent File List Size - This field allows you to change the size of the recent file list,
displayed at the bottom of the File menu (range = 1-9),
Warnings - Click these checkboxes to specify which warnings to display in the Build tab
of the Output Window, after compile operations. The warnings are described below:
Assignment of unlike types - This warning occurs when a variable or value of one
type is assigned to a variable of a different type. Here are some examples:
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 Ø and
65,535.
Variable not used - This warning occurs at the end of compilation for each variable
that was declared but never used.
Define_Call not used - This warning occurs at the end of program compilation for
each DEFINE_CALL subroutine that was declared but never used.
Too many nested levels - This warning appears if there is a large amount of nesting
in the program. This can happen with a long chain of IF...ELSE IF statements. The
solution is to use the SELECT...ACTIVE set of statements.
the LONG_WHILE and MEDIUM_WHILE keywords do not. This could create a hard-
to-find logic error. The solution is to change the WHILE to a LONG_WHILE to fix
this problem.
Separate Define Call list - Check to store all DEFINE_CALL subroutines in a separate
section of the Master Controller memory than the DEFINE_PROGRAM section. This
effectively allows the code size of a program to reach 128K (64K for the DEFINE_CALLS
and 64K for the DEFINE_PROGRAM section).
Build with Source - Check to download the executable code and the source code to the
Master Controller or data device when the file is downloaded (memory permitting). If
Build with Source is disabled, only the executable code is downloaded, which cannot be
retrieved from the Master Controller.
Directories - Click to open the directories menu, where you select the directories to point
the compiler to, by file type. Once a directory type is selected, the directory list is
populated with the directories of that type that have been mapped. There are a maximum
of 100 directories that can be entered for each type.
Select Include Files to select or create the directory that the compiler will look for
Include files in.
Select Library Files to select or create the directory that the compiler will look for
(IR) Library files in.
Directories — Click to open the directories menu, where you select the directories to
point the compiler to, by file type. Once a directory type is selected, the directory list is
populated with the directories of that type that have been mapped. There are a maximum
of 100 directories that can be entered for each type.
Select Include Files to select or create the directory that the compiler will look for
Include files in.
Select Library Files to select or create the directory that the compiler will look for
System Call files in.
Compile With Debug Info Select this option to include variable symbol information in
the compiled file. This allows the debugger to identify and validate variable symbols in
the code. You must compile with debug info in order to debug NetLinx files.
Build With Source Check to include the executable code and the source code to the
Master Controller or data device when the file is sent (memory permitting). This allows
the Receive option to retrieve the source code from the Master Controller. If Build with
Source is disabled, only the executable code is sent, which cannot be retrieved from the
Master Controller.
When building with source, only the files needed for the compilation process are
compressed. Though the APW may contain many files, if the source file only uses
one AXI file, then only 2 files will be compressed.
Build With Password Protection — Select this option to apply a password to the Source
file. Select the Change button to edit the password (via the Change Password dialog). A
password must be at least 6 characters in length (maximum of 20 characters).
Syntax Highlighting - These options allow you to customize syntax highlighting within
the Source Code Editor windows. The term Syntax Highlighting refers to the fact that
various terms in the code file (including Reserved Identifiers, Constants, Devices, Types
and Variables) are automatically highlighted (displayed in a specific foreground and/or
background) in the Source Code Editor windows.
Item list - This is a list of all the items that can be customized in the Source Code
Editor Windows. Select an item from this list to customize.
Foreground Color - This is the text color setting for the selected Item.
Background Color - This is the background color setting for the selected Item.
Style - This is the text style setting for the selected Item (Default, Normal, Bold or
Italic).
Clipboard Text Buffer - These options allow you to define the number of clip-board
buffer entries and the maximum width to display:
Max Items - You can have a maximum of 30 clip-board buffer items (default = 20).
Max Display Width - You can set the maximum display width to up to 80 characters
(default = 50).
Clear Text Buffer History - Clears all the clipboard text items from the list.
Formatting - These options allow you to set various text display and formatting options:
Auto-indent - This option automatically indents your text as you type (default =
enabled).
Show Line Numbers - This option toggles line numbers in the view containing the
source code file (default = disabled).
Tab Size - Use the up and down arrows to increase/decrease the number of spaces
used for tabs (default = 4).
Font Point Size - Click the down arrow to select a font size (in points) for the text in
the Code Editor window (default = 10)
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).
Additionally, if the editor’s suggestion is not what you intended, you may choose to
have the editor display it’s next suggestion. You can cycle through all of the
suggestions by using the keystroke defined in the Keyboard tab of the Preferences
dialog (the Next Suggestion item in the Advanced Editor category).
There is no default keystroke assignment for Next Suggestion (to avoid conflicting
with pre-existing custom keystrokes). You must set your own keystroke to take effect.
Categories - This is a list of command categories. Each command category in this list
contains several commands (displayed in the Commands list).
Commands - This is a list of the commands included in the selected Command Category.
Toolbars - This list represents all toolbars currently loaded in the GUI, including any
custom toolbars. The checkboxes next to each toolbar indicate which toolbars are
currently enabled. Use these check boxes to specify which toolbars to show by default at
startup.
Reset - With one of the System (non-custom) toolbars selected in the Toolbars list, the
Reset button resets the toolbar to its default set of command buttons .
Reset All - Click to reset all System toolbars to their default set of command buttons.
New - Click to create a new custom toolbar via the Toolbar Name dialog.
Rename - Select a custom toolbar and click Rename to rename the selected toolbar via
the Toolbar Name dialog. You cannot rename or delete system toolbars.
Delete - Select a custom toolbar and click Delete to delete the selected toolbar. You
cannot rename or delete system toolbars.
Menu Contents - This list represents all shortcuts to external applications currently
loaded in the Tools menu. This list is empty until you add a shortcut. The text entered
here is what will be displayed in the Tools menu.
Command - Click the browse button (to the right of the Command text box) to locate and
select the .EXE for the application that you want to add to the Tools menu.
Arguments - Click the right-arrow button (to the right of the Arguments text box) to
access a list of supported arguments. Select an argument from the list (if necessary).
Initial Directory - Click the right-arrow button (to the right of the Initial Directory text
box) to access a sub-menu containing the following options:
o$(FilDir)
o$(CuDir)
oBrowse
Category - This drop-down list represents the various command categories. Select a
Category to populate the Commands list.
Commands - This list represents all of the commands contained within the selected
command Category.
Description - With a command selected (in the Commands list), this text box displays a
brief (read-only) description of the selected command.
Current Keys - With a command selected (in the Commands list), this text box displays
the current keyboard accelerator assignment (read-only).
Press the New Shortcut Key - With a command selected (in the Commands list), this
text box allows you to enter the new keyboard shortcut for that command.
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.
Application Frame Menus - Click the down-arrow to access a list of all Application
Frame Menus. These relate to file types that can be opened and edited in NetLinx Studio.
Reset - Click to reset the selected application frame menu to its default state.
Context Menus - Click the down-arrow to access the two context menu options: Source
View and Text View.
Source View sets the context menu to include commands associated with creating/
editing source code files.
Text View sets the context menu to list only commands that relate to creating/editing
text documents.
Reset - Click to reset the selected context menu to its default state.
To reset an Application Frame Menu to its original default state, select a particular window view
(i.e. AXS type views or TXT type views) from the combo box and then select the Reset button (in
the Application Frame Menus area).
To add a command: Select a command category and a select the command you want to
add to the menu. Click and drag the command out of the Commands list and into the
desired position in the open menu.
To remove a command: Select a command from the open menu, and click and drag it
outside of the menu.
4. Click Close to close the Preferences dialog.
Show Screen Tips on Toolbars - This option toggles the display of screen tips (a brief
description of the toolbar button) anytime the mouse hovers over a toolbar button (default
= enabled).
Show Shortcut Keys In Screen Tips - This option toggles the display of any shortcut
keys associated with the command (as part of the screen tip). This option is disabled if
the Show Screen Tips on Toolbars option is disabled.
Large Icons - This option toggles the display of large icons in the toolbar buttons (default
= disabled).
Notification View - Use this set of options to set default display preferences for the
Notification tab of the Output Display Window.
Display Control Codes as - select the default display option (Hex or Decimal
Values) for control codes in asynchronous notification displays (default = Hex
Values).
Hex values will display with a leading $ character. For example the message:
STRING from CHANNEL 6 - $0F$1D has two control codes converted to
hexadecimal.
Diagnostics View - Use this set of options to set default display preferences for the
Diagnostics tab of the Output Display Window.
Display Line Numbers - toggles the display of line numbers in system diagnostics
displays (default = enabled).
Display Time Stamp - toggles the display of time stamps in system diagnostics
displays (default = enabled). When enabled, the Display Milliseconds option causes
diagnostics time stamps to be displayed in milliseconds (default = disabled).
Display Control Codes as - select the default display option (Hex or Decimal
Values) for control codes in system diagnostics displays (default = Hex Values).
Buffer File Options - Use the text box to specify the total size of the two files that are
used by the program to buffer the asynchronous notification and system diagnostic
messages. The number specified here will be divided evenly between the two files. The
range is 2 - 500 MB (default = 10).
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.
Add line feed character - This option toggles the display of a line feed character in the
terminal window (default = disabled).
Send Ctrl characters to port - This option toggles the transmission of control characters
to the terminal's port (default = disabled).
Terminal Window Colors - These options allow you to customize the colors for both
states (Active (Connected) and Inactive (Disconnected)) of the terminal window.
To change the colors on the terminal window, select Active (Connected), then click the
down arrows to access the Foreground (text) and Background color palettes. Select the
desired colors, and repeat for the Inactive (Disconnected) state.
When sending a TKN, automatically send the associate 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 Icons" when sending a TPD file (default = enabled).
By default, select "Send Fonts" when sending a TPD file (default = enabled).
Restore Workspace On Startup - This option (on by default) automatically restores the
workspace file upon startup of the application. With this option enabled, all files that
were opened and the dockable windows that were displayed when you closed the
application will be restored when you restart the program.
Display System Configuration Setting in the Identifier - This option (off by default)
displays the System Configuration settings as part of the System identifier (as displayed
in the Workspace tab of the Workspace Window).
Enable Auto Save - Toggles the timed auto-saving of text files and the duration of time
between auto saves (default = disabled).
Auto Save Every <x> Minutes - This field is only enabled when the Enable Auto
Save option is selected. The range is 1-120 minutes, the default setting is 5.
Automatically Save File Before Compile - Toggles auto-saving of code files before a
compile.
Enable Window Tabs - This option toggles the display of the window tabs that appear by
default along the lower edge of the Source Code Editor windows area of the GUI.
These tabs provide easy access for each open Source Code Editor window. If this option
is not selected, the following tab-oriented options are disabled.
Enable File Icons In Tabs - This option toggles the file icons displayed in the
Source Code Editor window tabs.
Enable Window Close Button - This option toggles the Window Close button ( ).
When Closing the Workspace - This section contains options for closing files associated
with a Workspace that is being closed. The options are:
When Removing a File From the Workspace - This section contains various options
for closing files when they are removed from the current Workspace. The options are:
Keyboard Settings 7 Q
L quick descriptions 7
Quick Load Project 12
Language Reserved Words 20 Quick Load System 13
Last commands 24 Quick Load Workspace 11
Last Push Message and History 7
Last Transfer 16 R
Length 24 Refresh List 25
Level Events 3 Refresh Network 14, 15
Line (NetLinx only) 24 Refresh System 14, 15
linked files 13 Remove Project 11
M Remove System 12
Rescan Current Source File 21
Mapping 15
Master Communication Settings 22 S
Master communications port 23 Save All Items 17
Master Controller Connection Save Selected Items 17
Information 7 Save To File 24
Master Source Code file 13 Save Workspace 10
Menu Bar 8 Save Workspace As 10
Modem Settings 22 Select All 21
N Select Line 19
Select Line Left 19
Name 24 Select Line Right 19
NetLinx Module files 1 Select None 19
NetLinx Studio 2.0 Work Area 6 Select Word 19
NetLinx Studio Code Wizard 3 Select Word Left 19
NetLinx Studio v1.2 1 Select Word Right 19
NetLinx Studio V1.2 PJS File 5 Send Commands 3
NetLinx Studio v2.0 1 Send Ctrl characters to port 24
New Project 11 Serial Settings 22
New System 12 Set as Active System 12
New Workspace 10 Setting Terminal Preferences 24
Notifications Messages Status 7 Single Step 26
Notifications tab 16 Software History 2 Application 3
Number 20 Source Code Editor Context Menu 21
O Source Code Editor Windows 18
Start Debugging 24
Octal 24 Status 15
Octal Display 25 Status Bar 7
Online Device Tree 14 Step Mode 26
Online Tree Context Menu 15 String 20
Open Workspace 10 Sub-devices 15
Operator 20 Supported Keyboard Movements 19
Output Display Window 15 Supported operating systems 2
Output Display Window - Diagnostics tab 15 Syntax Highlighting 20
Output Display Window - File Transfer Status tab 15 System File Folders 13
Output Display Window - Find In Files tab 16 System Folder Context Menu 12
Output Display Window - Find IR Files tab 16 System Folders 12
Output Display window - Status tab 17 System Properties 13
Output Display Window Context Menu 17 Systems 1, 4
P T
Paste Operations 22 Terminal buffer size 24
Paste Project 11 Terminal Locks the Port 23
Paste System 12 Terminal Options tab of the Preferences dialog 24
Path 16 Terminal Settings 22
PC Requirements 2 Terminal Window 22
PROGRAM port 23 Terminal window 23
Project Folder Context Menu 11 Terminal window Context Menu 24
Project Folders 11 The NetLinx Studio Code Wizard 3
Project Properties 12 The NetLinx Studio Workspace Wizard 3
Title Bar 7
Toggle Breakpoint 22
Toggling the Windows 26
Toolbars 8
Total Length 26
TPDesign4-generated UI (.TP4) files 1
transport connection type 22
Type 15, 20
U
Undo, Redo 21
Using the Terminal Window 23
V
Value 24
Variable 20
Viewing Push Results 115
W
Watch Window 24
Watch Window Context Menu 25
WebUpdate 3
What’s New Dialog 2
Windows TelNet 23
Working With Workspace Files 27
Workspace 1, 4
Workspace Context Menu 10
Workspace file 27
Workspace Folder 10
Workspace Properties 11
Workspace tab of the Workspace Window 4
Workspace Window 9
Workspace Window - Online Tree tab 14
Workspace Window - Workspace tab 9
Workspace Wizard 3, 10
Workspace, Projects and Systems 4
X
XML 27
Index
AMX reserves the right to alter specifications without notice at any time.
ARGENTINA • AUSTRALIA • BELGIUM • BRAZIL • CANADA • CHINA • ENGLAND • FRANCE • GERMANY • GREECE • HONG KONG • INDIA • INDONESIA • ITALY • JAPAN
LEBANON • MALAYSIA • MEXICO • NETHERLANDS • NEW ZEALAND • PHILIPPINES • PORTUGAL • RUSSIA • SINGAPORE • SPAIN • SWITZERLAND • THAILAND • TURKEY • USA
ATLANTA • BOSTON • CHICAGO • CLEVELAND • DALLAS • DENVER • INDIANAPOLIS • LOS ANGELES • MINNEAPOLIS • PHILADELPHIA • PHOENIX • PORTLAND • SPOKANE • TAMPA
3000 RESEARCH DRIVE, RICHARDSON, TX 75082 USA • 800.222.0193 • 469.624.8000 • 469-624-7153 fax • 800.932.6993 technical support • www.amx.com