AMX NI-700 Webconsole & Programming Manual
Netlinx integrated controllers firmware version 4.0 or higher
Hide thumbs
Also See for NI-700:
- Installation manual (2 pages) ,
- Quick start manual (2 pages) ,
- Specifications (1 page)
Related Manuals for AMX NI-700
Summary of Contents for AMX NI-700
- Page 1 WE B CO N S O LE & P RO G RA M M IN G G UI DE N E T L I N X I N TEG RATED C O N T RO L LE RS ( FI R MW A RE VERS I O N 4 . 0 O R H I G H E R ) NI -70 0/ 900 NI -210 0/ 3100 /4 10 0 NI -310 1- SI G...
- Page 2 COPYRIGHT NOTICE AMX© 2016, all rights reserved. No part of this publication may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without the prior written permission of AMX. Copyright protection claimed...
-
Page 3: Table Of Contents
A/V Switcher/Scaler Firmware ............................. 24 Before You Start ......................25 Verifying the Current Firmware Version ................. 25 Downloading the Latest Firmware Files from www.amx.com ......... 25 NetLinx Integrated Controllers ......................25 Master and Device Firmware Kit Files for NetLinx Integrated Controllers............25 Downloading NI Controller Firmware Files on www.amx.com................ - Page 4 Table of Contents Required Order of Firmware Updates ................27 Required Order of Firmware Updates for NI Controllers..............27 Required Order of Firmware Updates for DVX Controllers ..............27 Upgrading Firmware Files ....................27 Upgrading NXC Card Firmware ..................28 Resetting the Factory Default System and Device Values..........
- Page 5 Table of Contents Manage System - System Number ................. 44 Changing the System Number On the Master ..................44 Using Multiple NetLinx Masters ......................44 Resetting the Master Controller to the Factory Defaults Configuration ..........45 Manage System - Control/Emulate Options..............45 Controlling or Emulating a System Device ...................
- Page 6 Table of Contents Viewing Physical Device Properties...................... 64 Manage Devices - User-Defined Devices ................. 65 Adding a User-Defined Device ......................65 Manage Devices - Active Devices ..................66 Searching For All Compatible Duet Modules for a Selected Device ............. 66 Viewing Physical Device Properties......................
- Page 7 Table of Contents RS-232/422/485 SEND_STRING Escape Sequences............. 79 27,17,<time> ..................................79 27,18,0 ....................................79 27,18,1 ....................................79 27,19,<time> ..................................79 27,20,0 ....................................79 27,20,1 ....................................79 IR / Serial Ports Channels ....................79 IR RX Port Channels ....................... 80 IR/Serial SEND_COMMANDs................... 80 CAROFF ....................................
- Page 8 Table of Contents GET ETHERNET MODE ................................88 GET IP <D:P:S> ..................................88 HELP SECURITY ..................................88 ICSPMON ENABLED|DISABLED [PORT]........................... 88 IP STATUS ....................................88 MEM ......................................89 MSG ON|OFF.................................... 89 MSG STATS ..................................... 89 NETLINX LOG LEVEL................................89 OFF [D:P:S or NAME,CHAN] ..............................89 ON [D:P:S or NAME,CHAN] ..............................
- Page 9 Appendix A: LDAP Implementation Details ..........108 Overview ........................108 Assumptions and Prerequisites ................... 108 AMX LDAP Client Authentication Sequence ..............108 Example - Setting Up User's Access Rights ..............109 Administrator Access Example ......................109 User Access Example ......................... 109 ICSP Connectivity Security Example ....................
- Page 10 Table of Contents CLKMGR_SET_DAYLIGHTSAVINGS_OFFSET(CONSTANT CLKMGR_TIMEOFFSET_STRUCT T) ..........113 CLKMGR_GET_ACTIVE_TIMESERVER(CLKMGR_TIMESERVER_STRUCT T) ................. 113 CLKMGR_SET_ACTIVE_TIMESERVER(CONSTANT CHAR IP[])..................... 113 CLKMGR_GET_TIMESERVERS(CLKMGR_TIMESERVER_STRUCT T[]) .................. 114 CLKMGR_ADD_USERDEFINED_TIMESERVER(CONSTANT CHAR IP[], CONSTANT CHAR URL[], CONSTANT CHAR LOCATION[]) ............................114 CLKMGR_DELETE_USERDEFINED_TIMESERVER(CONSTANT CHAR IP[]) ................114 CLKMGR_GET_START_DAYLIGHTSAVINGS_RULE() ......................114 CLKMGR_SET_START_DAYLIGHTSAVINGS_RULE(CONSTANT CHAR RECORD[])..............114 CLKMGR_GET_END_DAYLIGHTSAVINGS_RULE() ........................
-
Page 11: Overview
The Web Console is described in this document (starting with the Onboard WebConsole User Interface section on page 31). These NI Controllers are Duet-compatible and can be upgraded via firmware. Duet is a dual-interpreter firmware platform from AMX ®... -
Page 12: About This Document
Firmware version 4.x may not be available for all Central Controllers. For f irmware versions prior to version 4.0, refer to the previous version of this document (available to download from the v3.x f irmware pages on www.amx.com). Quick Setup and Conf iguration Overview... - Page 13 Overview Internet Explorer with Bonjour plug-in FIG. 1 Double-click on the desired Master to access the Web Console. This requires valid login information - the browser will prompt you for User ID and Password before displaying the configuration pages for the selected device. Notice that the serial number is appended to the name of the device.
-
Page 14: Initial Configuration
NetLinx Studio is available to download from www.amx.com. Login to download the latest version. Alternatively, if it is already installed, use the Web Update option in NetLinx Studio’s Help menu to obtain the latest version. The default location for the NetLinx Studio application is Start > Programs > AMX Control Disc > NetLinx Studio > NetLinx Studio. - Page 15 Initial Configuration Communication Settings dialog - Recent tab FIG. 4 Select NetLinx Master under Platform Selection to indicate you are working with a NetLinx Master. Select the Serial tab to view the serial options (FIG. 5). Communications Settings dialog - Serial tab FIG.
- Page 16 Initial Configuration Master Communication Settings dialog indicating a Serial Connection FIG. 6 Click OK to close the Master Communication Settings dialog and return to the main application. 10. Right-click the Online Tree tab entry and select Refresh System: the Controller should appear in the Device Tree (FIG. 7): Online Tree indicating a Serial Connection FIG.
-
Page 17: Configuring The Ni Controller For Lan Communication
Initial Configuration Conf iguring the NI Controller for LAN Communication NOTE: Before continuing, complete the COM port steps described above to establish a serial connection with the NetLinx Master. Use an LAN cable to connect the Controller to the LAN to which the PC running NetLinx Studio is connected. NOTE: The NI-x100 Controllers feature an Auto MDI/MDI-X LAN port. -
Page 18: Using The Id Button To Change The Master Device Value
Use the ID Button on the rear panel of the Controller in conjunction with ID Mode function in NetLinx Studio to establish a NetLinx Device ID for the device. The steps described and the dialogs shown in this section are in the NetLinx Studio application. NetLinx Studio is available to download from www.amx.com. ... -
Page 19: Obtaining The Ni Controller's Ip Address (Using Dhcp)
Initial Configuration Device Addressing dialog - Identify Mode active FIG. 13 Press the NI Controller’s ID button to assign the new Device / System values entered in step 3 to the Controller. At this point, the "Successful Identif ication Made " message is displayed (FIG. 14): Device identified ID Mode no longer active Device Addressing dialog - Successful Identification Made... -
Page 20: Assigning A Static Ip To The Ni Controller
Initial Configuration Select Use DHCP. Click Set IP Information to retain the IP Address from the DHCP server and assign it to the on-board Master. A popup window is displayed to indicate that setting the IP information was successful and to prompt you to reboot the Master. NOTE: Verify that these IP values are also entered into the related f ields within either the IP Settings section of the System Connection page (on the touch panel) or within the Address f ield on the web browser. -
Page 21: Communicating Via Ip Address
Initial Configuration Click Done to close the dialog. NOTE: On the front panel of the NetLinx Master, the STATUS and OUTPUT LEDs should begin to alternately blink during the incorporation. Wait until the STATUS LED is the only LED to blink. Complete the communication process by continuing on to the Communicating Via IP Address section on page 21. - Page 22 Initial Configuration Communications Settings dialog - Network tab FIG. 20 Click New to open the New TCP/IP Setting dialog, where you can enter both a previously obtained DHCP or Static IP Address and an associated Description for the connection into their respective fields. (FIG. 21): NetLinx Studio - New TCP/IP Setting dialog FIG.
- Page 23 Initial Configuration Click OK to save your newly entered information and close the Communication Settings dialog and return to the Master Communication Settings dialog. Note the selected IP address is indicated in the Conf iguration field (FIG. 23): NetLinx Studio - Communication Settings dialog (Configuration field indicating the selected IP Address) FIG.
-
Page 24: Upgrading Firmware
The basic process of upgrading firmware on NI Controllers as well as Enova DVX All-In-One Presentation Switchers is essentially the same. In all cases it involves downloading the latest firmware files from www.amx.com and using NetLinx Studio to transfer the files to a target NI Controller. -
Page 25: Before You Start
NetLinx Studio is available to download from www.amx.com. Login to download the latest version. Alternatively, if it is already installed, use the Web Update option in NetLinx Studio’s Help menu to obtain the latest version. The default location for the NetLinx Studio application is Start > Programs > AMX Control Disc > NetLinx Studio > NetLinx Studio. -
Page 26: Enova Dvx All-In-One Presentation Switchers
Switcher Firmware: SW1905_DVX_KIT_DVX_2100HD_SP_T_v1_4_xx.kit Downloading Enova DVX Firmware Files on www.amx.com Visit the appropriate product page on www.amx.com for the latest NI Master, Device Controller, and A/V Switcher/Scaler firmware (*.kit) files for your Enova DVX All-In-One Presentation Switcher. Firmware file links are available along the right-side of the catalog page (FIG. -
Page 27: Required Order Of Firmware Updates
Upgrading Firmware Required Order of Firmware Updates The Upgrading Firmware Files instructions (below) apply equally to all types of firmware files. However, it is important that the firmware files are upgraded in the following order: Required Order of Firmware Updates for NI Controllers First, upgrade the Master firmware. -
Page 28: Upgrading Nxc Card Firmware
Upgrading Firmware Send to NetLinx Device dialog (showing on-board NI_Master firmware update) FIG. 29 Verify that the Reboot Device checkbox is selected to reboot the NI unit after the firmware update process is complete (selected by default). Click Send to begin the transfer. The file transfer progress is indicated in the Progress section of the dialog. NOTE: Only upon the initial installation of a new Kit f ile to an on-board Master will there be a error message displayed indicating a failure of the last component to successfully download. - Page 29 FIG. 30 NOTE: If the control card f irmware is not up to date; download the latest f irmware f ile from www.amx.com > Tech Center > Downloadable Files > Firmware Files > NXC-XXX. In this example, the NXC-VOL card contains out-of-date f irmware and requires build 1.00.09.
-
Page 30: Resetting The Factory Default System And Device Values
Upgrading Firmware 14. Click Reboot (from the Tools > Reboot the Master Controller dialog) and wait for the System Master to reboot. The STATUS and OUTPUT LEDs should begin to alternately blink during the incorporation. Wait until the STATUS LED is the only LED to blink. -
Page 31: Onboard Webconsole User Interface
Onboard WebConsole User Interface Onboard WebConsole User Interface WebConsole UI Overview NetLinx Masters have a built-in WebConsole that allows you to make various configuration settings via a web browser on any PC that has access to the Master. The webconsole consists of a series of web pages that are collectively called the "Master Configuration Manager"... -
Page 32: Device Tree
Port settings. At the Port view, you can use the Device Tree to make specific port assignments (including Channel and Level assignments) (FIG. 35). (all Collapsed) (System devices expanded) (NI-700 ports expanded) (NI-700 Port 1 expanded) Opens the Network Settings page for this device Online Device Tree FIG. 35... -
Page 33: Device Network Settings Pages
Onboard WebConsole User Interface Device Network Settings Pages Click on the blue Information (i) icon next to any device listed in the Device Tree to access the Network Settings page for the selected device (FIG. 36). Example Network Settings page FIG. -
Page 34: Webconsole - Security Options
WebConsole - Security Options WebConsole - Security Options Security Overview The Security System Details page is accessed by clicking on the Security button. This page allows you to view configure and modify the Master’s security settings at three levels: System Level - changes made at this level affect the system globally. See the System Security - System Level section on ... -
Page 35: Login Rules
NOTE: This username and password information is also used by both G4 touch panels (within the System Connection f irmware page) and AMX software applications such as NetLinx Studio to communicate securely with a Master using encrypted communication. User Name and Password Rules Case-sensitive ... -
Page 36: Access Options
If selected, this option requires that any data being transmitted or received via an ICSP connection (among the Connection: various AMX products) be encrypted, and that any application or hardware communicating with the Master over ICSP must provide a valid username and password. -
Page 37: Ldap Options
Users may not be added or deleted via the web pages when LDAP is enabled. AMX equipment users are set up on the LDAP server with either full access to the master or HTTP access only. User access privileges cannot be changed via the web pages. -
Page 38: Testing The Connection To The Ldap Server
WebConsole - Security Options Testing the Connection to the LDAP Server After entering and accepting the parameters, the Test button (see FIG. 38 on page 35) can be used to test the connection to the LDAP server. This test does a bind to the BIND DN using the Search Password entered. If the bind is successful, the message Connection successful is displayed. -
Page 39: Group And User Security Access Options
If selected, this option requires that any data being transmitted or received via an ICSP connection (among the Connection: various AMX products) be encrypted, and that any application or hardware communicating with the Master over ICSP must provide a valid username and password. -
Page 40: Modifying The Properties Of An Existing Group
WebConsole - Security Options Modifying the Properties of an Existing Group Select the Group Level tab (in the Security section) to open the Group Security Details page. Click the Edit button to open the Group Security Details page for the selected group (FIG. 42). Group Security Details Page (Edit Group Security Details) FIG. -
Page 41: System Security - User Level
WebConsole - Security Options System Security - User Level Select the User Level tab of the Security Page to access the User Security Details page (FIG. 43). The options on this page allow authorized users to add/delete User accounts and configure User’s Access rights. Click to add a new User User Security Settings Page FIG. -
Page 42: Viewing And Editing User Security Settings
WebConsole - Security Options Enable the security access rights you want to provide to the user. See the Group and User Security Access Options section on page 39 for details. Click the Accept button to save your changes to the Master. NOTE: Any security changes made to the Master from within the web browser are instantly reflected within a Terminal session without the need to reboot. -
Page 43: Webconsole - Web Control Options
WebConsole - Web Control Options WebConsole - Web Control Options Manage Web Control Connections The Web Control page is accessed by clicking on the Web Control button (FIG. 46). This page allows you to view all touch panels running the G4 Web Control application. Each G4 Web Control-equipped touch panel connected to this Master is indicated by a link. Click on any of the links to open a new G4 Web Control window, displaying the selected panel, using the native resolution of the target panel. -
Page 44: Webconsole - System Options
WebConsole - System Options WebConsole - System Options System Overview The Manage System page is accessed by clicking on the System button. This page allows you to view and configure various aspects of the NetLinx System, separated by four tabs: Manage System - Options in this tab allow you to view/change the Master’s System Number, Control/Emulate system ... -
Page 45: Resetting The Master Controller To The Factory Defaults Configuration
WebConsole - System Options Resetting the Master Controller to the Factory Defaults Conf iguration Click the Reset To Factory Defaults button. This resets the Master to its’ factory default state. This includes: Removal of all security settings Removal of all user files ... - Page 46 WebConsole - System Options Click on Control/Emulate from within the device’s Network Settings page to Control/Emulate that device Select Control/Emulate from within a selected Device’s Network Settings page FIG. 49 Select either the Control or Emulate option. In the Channel Code section, enter a valid Channel number to emulate Channel messages (i.e., Push/Release, CHON, and CHOFF) for the specified <D:P:S>.
-
Page 47: Manage System - Diagnostics Options
WebConsole - System Options When entering a Send Command, do not include the "send c" or "SEND_COMMAND" in the statement - only type what would normally occur within the quotes (but don't include the quotes either). For example to send the "CALIBRATE" send command, type CALIBRATE (no quotes) rather than SEND_COMMAND <dev> "CALIBRATE". - Page 48 WebConsole - System Options Click on Diagnostics from within the device’s Network Settings page to enable/modify diagnostics for that device Select Diagnostics from within a selected Device’s Network Settings page FIG. 51 NOTE: The currently selected device is also indicated in the Device f ield at the top of the page. By default, all diagnostics are disabled (see FIG.
- Page 49 WebConsole - System Options Click to delete this device from the Diagnostics page (disables all diagnostics on this device) Click to apply changes Click to close the Edit Options window (without disabling diagnostics) Click to select from Presets (saved sets of enabled Diagnostic messages) Click to Store and Recall Presets To set Diagnostic Options for a different System Device, enter the device’s System, Device and Port...
-
Page 50: Diagnostics Options Definitions
WebConsole - System Options The device will appear in the Diagnostics Options window, in the next available column (to the right of the last device added - see FIG. 54). Edit Options window indicating four devices with Diagnostics enabled FIG. 54 NOTE: You can monitor diagnostics for up to eight System Devices in this page. -
Page 51: Creating And Recalling Diagnostics Presets
WebConsole - System Options Creating and Recalling Diagnostics Presets The Store and Recall options in the Edit Options window allow you to save and recall preset diagnostics configurations. NOTE: Presets are saved via cookies, so they do not persist across multiple browsers/computers. Click the Presets down arrow to open a list of previously stored Presets. -
Page 52: Ssl Certificate Options
Description ICSP: The port value used for ICSP data communication among the different AMX software and hardware products. This type of communication is used by the various AMX product for communication amongst themselves. Some examples would be: NetLinx Studio communicating with a Master (for firmware or file information updates) and TPDesign4 communicating with a touch panel (for panel page and firmware updates). -
Page 53: Creating An Ssl Server Certificate
WebConsole - System Options Creating an SSL Server Certif icate Initially, a NetLinx Master is not equipped with any installed certificates. In order to prepare a Master for later use with "CA" (off icially issued) server certificates, it is necessary to: First create a self-generated certif icate which is automatically installed onto the Master. -
Page 54: Displaying Ssl Server Certificate Information
WebConsole - System Options SSL Certif icate Entries (Cont.) Entry Description State/Province: Name of the state or province where the certificate is used (alpha-numeric string, 1 - 50 characters in length). Note: The state/province name must be fully spelled out. Country Name: Provides a drop-down selection with a listing of currently selectable countries. -
Page 55: Importing An Ssl Certificate
WebConsole - System Options Copy (Ctrl + C) the text to the clipboard. Paste (Ctrl + V) this text into the Submit Request field on the CA’s Retrieve Certificate web page. Choose to view the certificate response in raw DER format. Note the Authorization Code and Reference Number (for use in the e-mail submission of the request). -
Page 56: Manage System - Clock Manager Options
WebConsole - System Options Manage System - Clock Manager Options Click the Clock Manager link (in the Manage System tab) to access the Clock Manager Options page (FIG. 59). The options on this page allow you to enable/disable using a network time source and provide access to Daylight Saving configuration and which NIST servers to use as a reference. -
Page 57: Setting Daylight Savings Rules
WebConsole - System Options Setting Daylight Savings Rules In the Daylight Savings tab (FIG. 60), enable Daylight Savings mode by clicking the On button. Clock Manager Options - Daylight Savings tab FIG. 60 Use the Offset drop-down menus to adjust the amount of time (hours and minutes) to offset Daylight Savings. By default, the offset is set to 1 hour. -
Page 58: Adding A Custom Nist Server To The List
WebConsole - System Options In the NIST Servers tab (FIG. 61), use the radio buttons to select one of the NIST Servers in the list. Click Accept to save these settings to the Master. Adding a Custom NIST Server To the List Click on the radio button next to the last (blank) entry in the NIST Server Manager list. -
Page 59: Adding A New License
Key information (typically 32 to 36 digits in length) which is then entered into the Key fields on this page. Enter the Product Key into the Key fields. The Product Key is Master-specific and is typically provided by AMX upon registration. -
Page 60: System - Manage Netlinx
WebConsole - System Options System - Manage NetLinx The Manage NetLinx tab displays a list of NetLinx devices connected to the Master, and indicates device status for each (FIG. 64). System - Manage NetLinx tab FIG. 64 The table on this page consists of five columns: NetLinx Device Details Column Description... -
Page 61: System - Manage Devices
WebConsole - System Options System - Manage Devices The Manage Devices tab (FIG. 65) contains links to several different device-related pages, as described in the following subsections. System - Manage Devices (Details for Additional Devices) FIG. 65 Manage Devices - Device Options Click the Device Options link (in the Manage Devices tab) to access the Details for Additional Devices page (FIG. -
Page 62: Managing Device Modules
Description Enable/Disable Module This option toggles the capability of searching the Internet (either AMX's site or a device specified site) for a Search via Internet: device’s compatible Duet modules. This capability is automatically disabled if the Master does not have Internet connectivity. - Page 63 WebConsole - System Options Example Code: PROGRAM_NAME='DDD' DEFINE_DEVICE COM1 = 5001:1:0 COM2 = 5001:2:0 dvRECEIVER1 = 41000:1:0 dvDiscDevice = 41001:1:0 DEFINE_CONSTANT DEFINE_TYPE DEFINE_VARIABLE DEFINE_START STATIC_PORT_BINDING(dvDiscDevice, COM1, DUET_DEV_TYPE_DISC_DEVICE, 'My DVD', DUET_DEV_POLLED) DYNAMIC_POLLED_PORT(COM2) DYNAMIC_APPLICATION_DEVICE(dvRECEIVER1, DUET_DEV_TYPE_RECEIVER, 'My Receiver') (***********************************************************) THE EVENTS GO BELOW (***********************************************************) DEFINE_EVENT DATA_EVENT [dvRECEIVER1]...
-
Page 64: Application Devices And Association Status
WebConsole - System Options Application Devices and Association Status There are two types of application devices: Static Bound application devices and Dynamic application devices: Static Bound application devices specify both a Duet virtual device and its associated Device SDK class type, as well as a ... -
Page 65: Manage Devices - User-Defined Devices
WebConsole - System Options Manage Devices - User-Def ined Devices Click the User-Def ined Devices link (in the Manage Devices tab) to access the User-Def ined Devices page (FIG. 69). This page provides a listing with all of the dynamic devices that have been discovered in the system, and allows you to add and delete User- Defined Devices. -
Page 66: Manage Devices - Active Devices
Unless the Disable Module Search via the Internet option was selected in the Manage Devices page (see the Manage Devices - Device Options section on page 61), the search includes a query of the AMX online database as well as any manufacturer specified URLs that match the IP Address of the physical device for a compatible module. -
Page 67: Viewing Physical Device Properties
WebConsole - System Options Viewing Physical Device Properties Hold the mouse cursor over the Device entry in the table to display detailed device properties for that device, in a pop-up window (FIG. 72). Hold the mouse cursor over the Physical Device IP Address to open the Device Properties pop-up View All Active Devices - Device Properties pop-up FIG. -
Page 68: Editing Polled Port Settings
WebConsole - System Options Editing Polled Port Settings Click the Edit button for a port in the Physical Port list to access the Edit Port Settings page (FIG. 74): Manage Polled Ports - Edit Port Settings FIG. 74 Use the drop-down menus to modify the Port settings. Click Reset to Default Settings to return this port to its default configuration: Default Port Settings Baud Rate:... -
Page 69: Manage Devices - Network Settings
Use these radio buttons to enable/disable the NetLinx Discovery Protocol (NDP) beacons client in the Master. By default, NDP Beacon is enabled (On option selected). With NDP Beacon enabled, the Master will transmit NDP beacons for AMX's proprietary device discovery. -
Page 70: Ip Device Discovery
WebConsole - System Options IP Device Discovery Use these radio buttons to enable/disable the detection of third party multicast IP based Device Discovery beacons. By default, IP Device Discovery is enabled (On option selected). With IP Device Discovery enabled, the Master will detect third party multicast IP based Device Discovery beacons. -
Page 71: Manage Devices - Device Number
WebConsole - System Options Manage Devices - Device Number With the Master selected in the Device drop-down menu, click the Device Number link (in the Manage Devices tab) to access the Change Device Number page (FIG. 78). The options on this page allow you to change the device number on the Master. System - Manage Devices (Device Number) FIG. -
Page 72: Manage Devices - Log
WebConsole - System Options Manage Devices - Log With the Master selected in the Device drop-down menu, click the Log link (in the Manage Devices tab) to access the Message Log For Device page (FIG. 80). This page displays message logs for the Master. Manage System (Message Log For Device) FIG. -
Page 73: Manage Devices - Diagnostics
WebConsole - System Options Manage Devices - Diagnostics With the Master selected in the Device drop-down menu, click the Diagnostics link (in the Manage Devices tab) to access the Diagnostics Options page (FIG. 81). Diagnostic Options table Diagnostics Options Page (with diagnostic messages enabled) FIG. -
Page 74: Netlinx Programming
NOTE: NetLinx programming information for each Master is provided in the Master’s Operation/Reference Guide (available at www.amx.com). Port Assignments by NetLinx Master Port Assignments By Master Master RS-232/422/485 IR/Serial IR/RX Relays NI-700 Ports 1 - 2 Port 3 Port 5 Port 4 NI-900 Port 1 Ports 2-4 Port 6... -
Page 75: Master Ip Local Port Send_Commands
NOTE: The following sections only apply to the integrated controller component of the NIs. The following commands enable or disable the LEDs on the Integrated Controller. In the examples: <DEV> = Port 1 of the device. Sending to port 1 of the NI-700 affects all ports. LED SEND_COMMANDs... -
Page 76: Rs-232/422/485 Send_Commands
NetLinx Programming RS-232/422/485 SEND_COMMANDs RS-232/422/485 SEND_COMMANDs Command Description B9MOFF Disables 9-bit in 232/422/455 mode. By default, this returns the communication settings on the serial port to the last programmed parameters. This command works in conjunction with the 'B9MON' command. Syntax: SEND_COMMAND <DEV>,"'B9MOFF'"... -
Page 77: Hsoff
NetLinx Programming RS-232/422/485 SEND_COMMANDs (Cont.) Command Description HSOFF Disable hardware handshaking (default). Syntax: SEND_COMMAND <DEV>,"'HSOFF'" Example: SEND_COMMAND RS232_1,"'HSOFF'" Disables hardware handshaking on the RS232_1 device. HSON Enable RTS (ready-to-send) and CTS (clear-to-send) hardware handshaking. Syntax: SEND_COMMAND <DEV>,"'HSON'" Example: SEND_COMMAND RS232_1,"'HSON'" Enables hardware handshaking on the RS232_1 device. -
Page 78: Tset Baud
NetLinx Programming RS-232/422/485 SEND_COMMANDs (Cont.) Command Description TSET BAUD Temporarily set the RS-232/422/485 port's communication parameters for a device. TSET BAUD works the same as SET BAUD, except that the changes are not permanent, and the previous values will be restored if the power is cycled on the device. -
Page 79: Rs-232/422/485 Send_String Escape Sequences
NetLinx Programming RS-232/422/485 SEND_STRING Escape Sequences This device also has some special SEND_STRING escape sequences: If any of the 3 character combinations below are found anywhere within a SEND_STRING program instruction, they will be treated as a command and not the literal characters. In these examples: <DEV>... -
Page 80: Ir Rx Port Channels
NetLinx Programming IR RX Port Channels IR / Serial Ports Channels 00001 - 00255 PUSH and RELEASE channels for the received IR code. IR/Serial SEND_COMMANDs The following IR and IR/Serial Send_Commands generate control signals for external equipment. In these examples: <DEV> = device. -
Page 81: Cton
NetLinx Programming IR/Serial SEND_COMMANDs (Cont.) Command Description CTON Set the total time of IR pulses transmitted and is stored in non-volatile memory. This command sets the pulse length for each pulse generated by the 'CH' or 'XCH' send commands in tenths of seconds. Syntax: SEND_COMMAND <DEV>,"'CTON',<time>"... -
Page 82: Pon
NetLinx Programming IR/Serial SEND_COMMANDs (Cont.) Command Description Turn On a device connected to an IR port based on the status of the corresponding I/O Link input. If at any time the IR sensor input reads that the device is OFF (such as if one turned it off manually at the front panel), IR function 27 (if available) or IR function 9 is automatically generated in an attempt to turn the device back ON. -
Page 83: Set Mode
NetLinx Programming IR/Serial SEND_COMMANDs (Cont.) Command Description SET MODE Set the IR/Serial ports for IR or Serial-controlled devices to either IR, Serial, or Data mode. Syntax: SEND_COMMAND <DEV>, 'SET MODE <mode>'" Variable: mode = IR, SERIAL, or DATA. Example: SEND_COMMAND IR_1,"'SET MODE IR'" Sets the IR_1 port to IR mode for IR control. -
Page 84: Input/Output Send_Commands
Transmits the IR code as 0-3-4-3. SEND_COMMAND IR_1,"'XCH-1343'" Transmits the IR code as 1-3-4-3. Input/Output SEND_COMMANDs NOTE: I/O ports: Port 4 (NI-700). Channels: 1 - 8 I/O channels. The following SEND_COMMANDs program the I/O ports on the Integrated Controller. I/O SEND_COMMANDs Command... -
Page 85: Set Input
NetLinx Programming I/O SEND_COMMANDs (Cont.) Command Description SET INPUT Set the input channel's active state. An active state can be high (logic high) or low (logic low or contact closure). Channel changes, Pushes, and Releases generate reports based on their active state. Setting an input to ACTIVE HIGH will disable the ability to use that channel as an output. -
Page 86: Terminal (Program Port/Telnet) Commands
Terminal (Program Port/Telnet) Commands Terminal (Program Port/Telnet) Commands Overview There are two types of terminal communications available on NetLinx Integrated Controllers: Program Port - The "Program" port is a RS232 port located on the rear panel of the Master that allows terminal ... -
Page 87: Terminal Commands
Enables/Disables/queries the auto locate feature on the Master. Auto locate adds additional (ENABLE|DISABLE|STATUS) broadcast information for use by AMX Touch Panel devices configured in Auto connect mode. BOOT STATUS Returns the current boot state of the master. Response is either "Boot in progress." or "Boot complete."... -
Page 88: Device Status
DNS LIST <D:P:S> Displays the DNS configuration of a specific device including: • Domain suffix· • Configured DNS IP Information Example: >DNS LIST [0:1:0] Domain suffix:amx.com The following DNS IPs are configured Entry 1-192.168.20.5 Entry 2-12.18.110.8 Entry 3-12.18.110.7 ECHO ON|OFF Enables/Disables echo (display) of typed characters. -
Page 89: Mem
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description Displays the largest free block of the Master’s memory. Example: >MEM The largest free block of memory is 11442776 bytes. MSG ON|OFF Enables/Disables extended diagnostic messages. • MSG On [error|warning|info|debug] sets the terminal program to display log messages generated by the Master. -
Page 90: Pass [D:p:s Or Name]
>PROGRAM INFO -- Program Name Info -- Module Count = 1 Name is i!-PCLinkPowerPointTest -- File Names = 2 1 = C:\Program Files\AMX Applications\i!-PCLinkPowerPoint 2 = C:\Program Files\Common Files\AMXShare\AXIs\NetLinx.axi 2 = Name is MDLPP -- File Names = 2 1 C:\AppDev\i!-PCLink-PowerPoint\i!-PCLinkPowerPointMod.axs 2 C:\Program files\Common Files\AMXShare\AXIs\NetLinx.axi... -
Page 91: Route Mode Direct|Normal
Enter DNS Entry 2 : 12.18.110.8 Enter DNS Entry 3 : 12.18.110.7 You have entered: Domain Name: amx.com DNS Entry 1: 192.168.20.5 DNS Entry 2: 12.18.110.8 DNS Entry 3: 12.18.110.7 Is this correct? Type Y or N and Enter -> Y Settings written. -
Page 92: Set Ethernet Mode
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description SET ETHERNET MODE <CMD> This command sets the current LAN configuration. • <CMD> = "auto" or <speed> <duplex> where <speed> = 10 | 100 and <duplex> = full | half Examples: Set Ethernet mode auto Set Ethernet mode 100 full Set Ethernet mode 10 half... -
Page 93: Set Ip
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description SET IP <D:P:S> Sets the IP configuration of a specified device. Enter a Host Name, Type (DHCP or Fixed), IP Address, Subnet Mask, and Gateway IP Address. Note: For NetLinx Central Controllers, the "Host Name" can only consist of alphanumeric characters. •... -
Page 94: Set Security Profile
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description SET SECURITY PROFILE Sets a pre-defined Security Profile (a grouped set of security settings). The Security Profile can be set to "none" (default setting), "Secure", or "DOD" (see below). Note: The Security Prof ile can only be conf igured via the terminal interface of the Master's Program port. -
Page 95: Set Snmp
Enter Write community string: private You have entered: Description = NetLinx VxWorks SNMPv1/v2c Agent Contact = AMX LLC Location = Richardson, TX USA Read Community = public Write Community = private Is this correct? Type Y or N and Enter->... -
Page 96: Set Threshold
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description SET THRESHOLD Sets the Master's internal message thresholds. This command will set the thresholds of when particular tasks are pended. The threshold is the number of messages queued before a task is pended. -
Page 97: Show Audit Log
Displays a list of devices present on the bus, with their device attributes. Example: >SHOW DEVICE [0:1:0] Local devices for system #1 (This System) ---------------------------------------------------------------------------- Device (ID)Model (ID)Mfg FWID Version 00000 (00256)NXC-ME260/64M (00001)AMX Corp. 00336 v3.00.312 (PID=0:OID=0) Serial=0,0,0,0,0,0,0,0,0,0,0,0, Physical Address=NeuronID 000531589201 (00256)vxWorks Image (00001) 00337 v3.00.312 (PID=0:OID=1) Serial=N/A (00256)BootROM (00001) 00338 v3.00.312... -
Page 98: Show Log
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description SHOW LOG Displays the log of messages stored in the Master's memory. The Master logs all internal messages and keeps the most recent messages. The log contains:· • Entries starting with first specified or most recent •... -
Page 99: Show Max Buffers
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description SHOW MAX BUFFERS Displays a list of various message queues and the maximum number of message buffers that were ever present on the queue. Example: show max buffers Thread ----------- ---- ---- Axlink IPCon Mgr 0 (Total for TCP Connections TX=0) -
Page 100: Show System
(PID=0:OID=1) Serial=N/A (00256)BootROM (00001) 00258 v2.00.76 (PID=0:OID=2) Serial=N/A (00256)AXlink I/F uContr(00001) 00270 v1.02 (PID=0:OID=3) Serial=0000000000000000 00096 (00192)VOLUME 3 CONTROL BO(00001)AMX Corp. 00000 v2.10 (PID=0:OID=0) Serial=0000000000000000 Physical Address=Axlink 00128 (00188)COLOR LCD TOUCH PAN(00001)AMX Corp. 32778 v5.01d (PID=0:OID=0) Serial=0000000000000000 Physical Address=Axlink 05001 (00257)NXI Download (00001)AMX Corp. -
Page 101: Esc Pass Codes
Terminal (Program Port/Telnet) Commands ESC Pass Codes There are 'escape' codes in the pass mode. These codes can switch the display mode or exit pass mode. The following 'escape' codes are defined. Escape Pass Codes Command Description + + ESC ESC Exit Pass Mode: Typing a plus (shift =) followed by another plus followed by an ESC (the escape key) followed by another escape exits the pass mode. -
Page 102: Setup Security Menu
Terminal (Program Port/Telnet) Commands Setup Security Menu The Setup Security menu is described below: Setup Security Menu Command Description This selection will bring up the Security Options Menu that allows you to change the security 1) Set system security options for the NetLinx Master. These are "global" options that enable rights given to users options for NetLinx Master See the Security Options Menu section and groups. -
Page 103: Enabling Ldap Via The Program Port
Terminal (Program Port/Telnet) Commands Setup Security Menu Command Description If a user has been given "administrator rights", this additional menu option is displayed. This 17) Display Database selection will display the current security settings to the terminal (excluding user (administrator only function) passwords). -
Page 104: Security Options Menu
This selection enables/disables security of ICSP data being transmitted between the target Master 5) ICSP Security and external AMX components (software and hardware such as TPD4 and a Modero Touch Panel). (Enabled/Disabled) This selection enables/disables the need to require encryption of the ICSP communicated data. If... -
Page 105: Access Rights Menu
This selection enables/disables the need to require encryption of the ICSP communicated data. 6) ICSP Encryption Required If enabled: (Enabled/Disabled) • All communicating AMX components must authenticate with a valid username and password before beginning communication with the Master. • All communication must be encrypted. Adding a Group Type 7 and <Enter>... -
Page 106: Default Security Configuration
The SPY and SPY STOP interfaces are provided by VxWorks; AMX has made it available to the user. • SPY lists out all of the tasks running in the Master and their CPU usage, refreshing every 10sec. -
Page 107: Notes On Specific Telnet/Terminal Clients
Terminal (Program Port/Telnet) Commands Notes on Specif ic Telnet/Terminal Clients Telnet and terminal clients will have different behaviors in some situations. This section states some of the known anomalies. Windows Client Programs Anomalies occur when using a Windows™ client if you are not typing standard ASCII characters (i.e. using the keypad and the ALT key to enter decimal codes). -
Page 108: Appendix A: Ldap Implementation Details
AMX LDAP Client Authentication Sequence An example of the operation of the AMX client, using the example LDAP directory tree in the server section of this document, is presented next in a step-by-step breakdown. DallasUser1 will be used for this example. -
Page 109: Example - Setting Up User's Access Rights
Example - Setting Up User's Access Rights In order to give AMX equipment users access rights to the Master, group memberships for users will be defined by the GroupOfNames object class (refer to LDAP RFC4519). Two records need to be created in the database: One that represents users with administrative privileges (Admin Change Password Access, Terminal (RS232) Access, FTP ... -
Page 110: Icsp Connectivity Security Example
ICSP Connectivity Security Example If ICSP connectivity is enabled, a valid username and password is required to communicate with the NetLinx Master via an ICSP connection (TCP/IP, UDP/IP and RS-232). This is used with communication amongst various AMX hardware and software components. -
Page 111: Appendix B: Smtp Support
Settings are saved to the configuration database & thus are static upon reboot. cfgName is the server property name that is being set. Acceptable values are ADDRESS - SMTP server name, such as "mail.amx.com". The maximum number of characters allowed for email destination ... -
Page 112: Sending Mail
- The DPS address to return asynchronous send status. Ex. 0:3:0 toAddress - The email address of destination. Ex. john.doe@amx.com. Note that the NetLinx mail service supports up to eight recipient address (semi-colon delimited). These are "To" addresses only (not "Cc"... -
Page 113: Appendix C: Clock Manager Netlinx Programming Api
Appendix C: Clock Manager NetLinx Programming API Appendix C: Clock Manager NetLinx Programming Types/Constants The NetLinx.axi file that ships with NetLinx Studio includes the following types/constants: (*-----------------------------------------------------------------------------*) (* Added v1.28, Clock Manager Time Offset Structure *) (*-----------------------------------------------------------------------------*) STRUCTURE CLKMGR_TIMEOFFSET_STRUCT INTEGER HOURS;... -
Page 114: Clkmgr_Get_Timeservers(Clkmgr_Timeserver_Struct T[])
Appendix C: Clock Manager NetLinx Programming API NetLinx.axi - Library Calls (Cont.) CLKMGR_GET_TIMESERVERS Populates the currently configured time server entries from the Clock Manager (CLKMGR_TIMESERVER_STRUCT T[]) into the specified TIMESERVER array. The function returns a negative SLONG value if it encounters an error, otherwise the return value is set to the number of records populated into the CLK-MGR_-TIMESERVER_STRUCT array. -
Page 115: Clkmgr_Get_End_Daylightsavings_Rule()
Appendix C: Clock Manager NetLinx Programming API NetLinx.axi - Library Calls (Cont.) CLKMGR_GET_END_DAYLIGHTSAVINGS_RULE() Gets a string representation of when Daylight Savings is supposed to END. The Fixed-Date rules have the form: "fixed:DAY,MONTH,HH:MM:SS" with all fields as numeric except for the word "fixed". The Occurrence-Of-Day rules have the form: "occurence:OCCURENCE,DAY-OF-WEEK,MONTH,HH:MM:SS"... - Page 116 © 2016 Harman. All rights reserved. NetLinx, AMX, AV FOR AN IT WORLD, HARMAN, and their respective logos are registered trademarks of HARMAN. Last Revised: Oracle, Java and any other company or brand name referenced may be trademarks/registered trademarks of their respective companies.