instruction manual Café DuetTM Integrated Development Environment for NetLinx Duet (version 1.8) User's Guide Software 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. This license does not grant Licensee the right to create derivative works of the AMX Software. The AMX Software consists of generally available programming and development software, product documentation, sample applications, tools and utilities, and miscellaneous technical information. Please refer to the README.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. LICENSEE MAY NOT SUBLICENSE, RENT, OR LEASE THE AMX SOFTWARE. Licensee 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. Licensee 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, the Licensee shall return or destroy all originals and copies of the AMX Software to AMX and certify in writing that all originals and copies have been returned or 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 WARRANTIES. 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, INCLUDING, BUT NOT LIMITED TO IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, WITH REGARD TO THE AMX SOFTWARE. THIS LIMITED WARRANTY GIVES LICENSEE SPECIFIC LEGAL RIGHTS. Any supplements or updates to the AMX SOFTWARE, including without limitation, any (if any) service packs or hot fixes provided to Licensee after the expiration 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 Licensee's exclusive remedy shall be repair or replacement of the AMX Software that does not meet AMX's Limited 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 DAMAGES, THE ABOVE LIMITATION MAY NOT APPLY TO LICENSEE. U.S. GOVERNMENT RESTRICTED RIGHTS. The AMX Software is provided with RESTRICTED RIGHTS. Use, duplication, or disclosure by the Government is subject to restrictions as set forth in subparagraph ©(1)(ii) of The Rights in Technical Data and Computer Software clause at DFARS 252.227-7013 or subparagraphs ©(1) and (2) of the Commercial Computer Software Restricted Rights at 48 CFR 52.227-19, as applicable. SOFTWARE AND OTHER MATERIALS FROM AMX.COM MAY BE SUBJECT TO EXPORT CONTROL. The United States Export Control laws prohibit the export of certain technical data and software to certain territories. No software from this Site may be downloaded or exported (i) into (or to a national or resident of) Cuba, Iraq, Libya, North Korea, Iran, Syria, or any other country to which the United States has embargoed goods; or (ii) anyone on the United States Treasury Department's list of Specially Designated Nationals or the U.S. Commerce Department's Table of Deny Orders. AMX does not authorize the downloading or exporting of any software or technical data from this site to any jurisdiction prohibited by the United States Export Laws. This Agreement replaces and supersedes 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. For any questions concerning this Agreement, or to contact AMX for any reason, please write: AMX Corporation, 3000 Research Drive, Richardson, TX 75082. Table of Contents Introduction........................................................................ 1 What's New in this Release .................................................... 1 Café Duet version 1.8 features ................................................... 1 Duet SDK features supported in this release.............................. 2 Café Duet Minimum System Requirements ............................ 2 Supported operating systems ..................................................... 2 PC requirements......................................................................... 2 NetLinx Master Requirements................................................. 3 Installing NetLinx Studio.......................................................... 3 Installing Café Duet................................................................. 3 Launching Café Duet .................................................................. 8 Overview of the Duet Plug-in............................................ 9 Application Preferences .......................................................... 9 Setting up the Café Duet Preferences ........................................ 9 Setting up the Manifest Editor Preferences .............................. 10 Creating a Duet Module Project ............................................ 11 Defining the Module.................................................................. 14 Generating a new device class................................................. 16 Overriding or Implementing Methods........................................ 17 Duet Perspective................................................................... 18 Debug Perspective................................................................ 20 Accessing the Debug Perspective ............................................ 22 Creating your own perspective ................................................. 22 Duet Manifest Editor.............................................................. 23 Component Editor ................................................................. 29 Procedures for using the Extract Interface dialog ................. 30 Using the Extract Interface dialog............................................. 31 Café Duet v1.8 - User's Guide i Creating NetLinx-compliant Java Files.................................. 32 Compiling the Module Stub ....................................................... 32 Packing a Module...................................................................... 32 Quick Packing the Module ........................................................ 36 Regenerating the Project files ............................................... 36 Using NetLinx Studio to Transfer JAR Files.......................... 37 Downloading the Project Files to a Target Master ................ 38 Using AMX WebUpdate to update the Plug-in ...................... 38 Using Duet Remote Debug .............................................. 41 Default Settings and Initial Preferences ................................ 41 Default Compiler Compliance ................................................... 41 Default Duet Perspective Behavior ........................................... 42 Default Progress View - When Launching a Remote Duet Debug Session ................................................ 43 Default Launch Timeout ............................................................ 45 Reboot Sequence Problems ..................................................... 46 Accessing the Debug Perspective ........................................ 47 Using Duet Remote Debug ................................................... 47 Preparing a Duet Module for Debugging............................... 47 Debugging a Duet Module .................................................... 48 Setting Breakpoints and Watchpoints ................................... 49 Changing Variable Values During a Duet Debug Session .... 50 Making Incremental Code Changes and Starting a New Debug Session .......................................... 51 Finishing a Duet Debug Session........................................... 51 Duet Remote Debug Launch Configuration Error Messages.................................................................. 52 Creating a Sample Module .............................................. 53 Obtaining Pre-configured AMX Duet Modules ...................... 53 Creating a New Duet Module ................................................ 54 ii Café Duet v1.8 - User's Guide Step 1 - Run the Module Wizard .............................................. 54 Step 2 - Adding Necessary Plumbing ....................................... 56 Step 3 - Adding the Device Specific Code................................ 58 Step 4 - Compile and Pack Process ......................................... 60 Step 5 - Regenerating Project files (if a change is made) ........ 60 Using SNAPI and Duet Modules in NetLinx Studio............... 61 Step 1 - Using SNAPI and NetLinx Studio................................ 61 Step 2 - The Compile Process - NetLinx Studio preparation .... 61 Step 3 - Sending the file to the NetLinx Master ........................ 62 Appendix - Metadata........................................................ 63 Café Duet v1.8 - User's Guide iii iv Café Duet v1.8 - User's Guide Introduction Introduction With Café DuetTM, AMX opens the door to a broad knowledge base and vast programming resources by integrating JavaTM and NetLinx technologies. This NetLinx Duet architecture extends the power of your existing NetLinx systems long into the future and expands the capabilities of your future projects. As a plug-in to the main Eclipse© application, Café Duet provides a unique dual-interpreter environment that supports either NetLinx or Java programming, or both. The Standard NetLinx API (SNAPI) router keeps NetLinx and Java in perfect sync. Café Duet module development is fast and efficient within the Café Duet Integrated Development Environment (IDE), using the Duet Software Development Kit (SDK). The Duet SDK includes a module Wizard with several device-specific Application Program Interfaces (APIs) to streamline module creation. Additionally, you can leverage the CDC/Foundation Class Library of over 750 high-level native Java language classes to simplify the programming of today's most complex applications and interface modules. Prerequisite to the installation of Café Duet is the presence of NetLinx Studio v2.4 (or higher) on your PC. If you have not already installed NetLinx Studio, you will be prompted to do so before installing Café Duet. This is to ensure that you are using the latest NetLinx Compiler to build and extract the module files. What's New in this Release Café Duet version 1.8 features New to this release is the Cafe Duet Remote Debug functionality, which allows you to debug Duet modules remotely by providing any valid IP Address for the NetLinx Master running your code. See the Using Duet Remote Debug section on page 41 for details. The DeviceSDK has also been fully documented in this latest release. Café Duet v1.8 - User's Guide 1 Introduction Duet SDK features supported in this release This release of Café Duet supports the following Device Module Application Programming Interfaces: Device Module Application Programming Interfaces Amplifier Audio Conferencer Audio Mixer Audio Processor Audio Tape AudioTuner Device Ca ...