NX-Series Controllers WebConsole & Programming Guide WebConsole & Programming Guide NX-Series Controllers NX-1200 NX-2200 NX-3200 NX-4200 Central Controllers Init ial Re le ase : 6/2 6 /20 1 4
AMX Limited Warranty and Disclaimer This Limited Warranty and Disclaimer extends only to products purchased directly from AMX or an AMX Authorized Partner which include AMX Dealers, Distributors, VIP’s or other AMX authorized entity.
Table of Contents Table of Contents Overview ............................................................................................................1 NetLinx Integrated Controllers ................................................................................. 1 About This Document ............................................................................................... 1 Quick Setup and Configuration Overview ................................................................
Table of Contents Default User Names and Passwords.............................................................................. 20 Device Tree............................................................................................................. 20 Device Network Settings Pages.............................................................................. 21 ZeroConfig Networking ................................................................................................
Table of Contents Enabling Diagnostics on a Selected System Device ...................................................... 40 Diagnostics Options Definitions .................................................................................... 43 Disabling all Diagnostic Options for a Device ............................................................... 43 Creating and Recalling Diagnostics Presets .................................................................. 44 Manage System - Server Options ........
Table of Contents Viewing Physical Device Properties............................................................................... 65 Manage Devices - Manage Polled Ports.................................................................. 66 Editing Polled Port Settings .......................................................................................... 66 Manage Devices - Network Settings....................................................................... 67 Manage Devices - URL List............
Table of Contents RS-232/422/485 SEND_STRING Escape Sequences................................................ 79 27,17,
Table of Contents AXPWRON.............................................................................................................................. 89 GET AX FAULT ....................................................................................................................... 89 SET POWER ON...................................................................................................................... 89 Terminal (Program Port/Telnet) Commands .............................................
Table of Contents PWD ....................................................................................................................................... 96 REBOOT ................................................................................................................................. 97 RENEW DHCP......................................................................................................................... 97 RESETADMINPASSWORD ........................................................
Table of Contents ZEROCONF[ENABLE|DISABLE|STATUS] ............................................................................... 109 Accessing the Security Configuration Options...................................................... 110 Setup Security Menu............................................................................................. 111 Enabling LDAP via the Program Port .......................................................................... 112 Security Options Menu.....................
Table of Contents CLKMGR_SET_DAYLIGHTSAVINGS_OFFSET (CONSTANT CLKMGR_TIMEOFFSET_STRUCT T) ............................................................... CLKMGR_GET_ACTIVE_TIMESERVER(CLKMGR_TIMESERVER_STRUCT T) ........................... CLKMGR_SET_ACTIVE_TIMESERVER(CONSTANT CHAR IP[]) .............................................. CLKMGR_GET_TIMESERVERS(CLKMGR_TIMESERVER_STRUCT T[]).....................................
Overview Overview NetLinx Integrated Controllers NetLinx Integrated Controllers (Masters) can be programmed to control RS-232/422/485, Relay, IR/Serial, and Input/ Output devices using the NetLinx Studio application (version 4.0 or higher).
Overview Quick Setup and Configuration Overview Installation Procedures The general steps involved with most common installations of this device include: Unpack and confirm the contents of box (see the Specifications tables in the Hardware Reference Guide for each controller). Connect all rear panel components and supply power to the NX controller from the external power supply.
Overview Using Zero Configuration NetLinx Masters support using "zero-configuration" client software to quickly install multiple devices on the network. Bonjour (Zero-Configuration) Client You can use a zero-configuration client to determine the IP address of the Controllers. There are many zero-configuration clients available which are free and widely available for download. NetLinx Studio includes a zero-configuration client which we will use for the purposes of this document.
Initial Configuration Initial Configuration Overview This section describes using the NetLinx Studio software application to perform the initial configuration of the NetLinx Master. NetLinx Studio is used to setup a System number, obtain/assign the IP/URL for the NX controller, as described in this section (as well as to transfer firmware Kit files to the Master - see the Upgrading Firmware section on page 13). Before You Start 1.
Initial Configuration 3. Click the System Settings button to open the Communications Settings dialog (FIG. 5). If there is no system selected, click the Default Settings button to open the dialog. FIG. 5 Communication Settings dialog - Recent tab 4. Select the USB tab to view the USB options (FIG. 6). FIG. 6 Communications Settings dialog - USB tab 5. On the USB tab, highlight the Master you want to connect to and click Select. 6.
Initial Configuration 9. Right-click the Online Tree tab entry and select Refresh System: the Controller should appear in the Device Tree (FIG. 7): FIG. 7 Workspace Bar - Online Tree If the Master does not appear in the list, verify that the USB cable is connected properly. Once USB communication has been established, use NetLinx Studio to configure the Controller for LAN Communication, as described in the next section. Configuring the NX Controller for LAN Communication 1.
Initial Configuration 3. Click Get IP Information to enable the fields for editing (FIG. 9): FIG. 9 Network Addresses dialog showing initial IP information 4. Enter the System, Device (0 for NetLinx Masters), and Host Name information. Note: Host names may contain only the ASCII letters 'a' through 'z' (in a case-insensitive manner), the digits '0' through '9', and the hyphen ('-'). 5. To configure a network address via DHCP (FIG. 10): FIG. 10 Network Addresses dialog (DHCP) a. b. c. d.
Initial Configuration a. b. c. d. e. Select Specify IP Address. Enter the IP parameters into the available fields. Click Set IP Information to retain the pre-reserved IP address to the Master. To finish the process, click Reboot Device. Click OK to close the dialog. 7. Repeat steps 1 - 5 from the previous section, but rather than selecting the USB tab, select Network and edit the settings to match the IP address you are using (Static or Dynamic). 8.
Initial Configuration Assigning a Static IP to the NX Controller Note: Verify there is an active LAN connection on the LAN port of the Master before beginning these procedures. 1. In NetLinx Studio, select Diagnostics > Network Addresses to open the Network Addresses dialog (FIG. 13): FIG. 13 NetLinx Studio: Network Addresses dialog 2.
Initial Configuration Communicating via IP Address Whether the on-board Master’s IP address was set or obtained via DHCP, use the IP address information from the Network Addresses dialog to establish communication via the LAN-connected Master. 1. Use NetLinx Studio to obtain the IP address of the NX controller.
Initial Configuration 4. Select the Network tab (FIG. 17). FIG. 17 Communications Settings dialog - Network tab 5. Click New to open the New TCP/IP Setting dialog. In this dialog, you can enter both a previously obtained DHCP or static IP address and an associated Description for the connection into their respective fields. (FIG. 18): FIG.
Initial Configuration 6. Click OK to close the New TCP/IP Settings dialog and return to the Communication Settings dialog: (FIG. 19). FIG. 19 NetLinx Studio - Communication Settings dialog a. Click on the new IP address entry in the List of Addresses window b. Click Select to use the selected IP address as the current IP address. 7. Click OK to save your newly entered information and close the Communication Settings dialog and return to the Communication Settings dialog.
Upgrading Firmware Upgrading Firmware Overview The basic process of upgrading firmware on NX-series controllers involves downloading the latest firmware files from www.amx.com and using NetLinx Studio to transfer the files to a target NX controller. Use the OnLine Device tree in NetLinx Studio to view the firmware files currently loaded on the Central Controller. FIG. 21 shows an example OnLine Tree indicating an NX-3200: FIG.
Upgrading Firmware Before You Start 1. Verify you have the latest version of the NetLinx Studio application installed on your PC. 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. 2.
Upgrading Firmware Downloading the Latest Firmware Files from www.amx.com NetLinx Integrated Controllers NX-series Controllers require two firmware (*.kit) files: Master firmware and Device firmware. The Master firmware file is not the same as the Device firmware file. Both files should be used when upgrading any firmware associated with the Integrated Controllers. Note: The process of downloading and transferring firmware files is the same for all types of firmware.
Upgrading Firmware Upgrading Firmware via NetLinx Studio Note: These steps assume that you have already established a connection with the target Central Controller (IP connection is preferred.) See the Initial Configuration section on page 4 for details. 1. In NetLinx Studio. click on the OnLine Tree tab (in the Workspace Bar) to view the devices on the System. 2. In the OnLine Tree tab, click Display and select Refresh System from the context menu.
Upgrading Firmware 6. Verify the target’s System number matches the value listed within the active System folder in the OnLine Tree. The Device number is always 0 for the NX Master. Note that the Port field is disabled (FIG. 25). FIG. 25 Send to NetLinx Device dialog (showing on-board NX Master firmware update) 7. Verify that the Reboot Device checkbox is selected to reboot the NX controller after the firmware update process is complete (selected by default). 8. Click Send to begin the transfer.
Upgrading Firmware Resetting the Factory Default System and Device Values 1. In NetLinx Studio, access the Device Addressing dialog: Right-click on any system device listed in the Workspace and select Device Addressing. Select Diagnostics > Device Addressing from the Main menu. 2. Click the Set Device/System to Factory Default button (FIG. 26): FIG. 26 Device Addressing dialog This resets both the system value and device addresses (for definable devices) to their factory default settings.
On-Board WebConsole User Interface On-Board 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" (FIG. 27).
On-Board WebConsole User Interface Accessing the WebConsole From any PC that has access to the LAN that the target Master resides on: 1. Open a web browser and type the IP Address of the target Master in the Address Bar. 2. Press Enter to access WebConsole for that Master. The initial view is the Web Control page (FIG. 27). Default User Names and Passwords The following table lists the default user names and passwords for accessing the NX-series controllers through NetLinx Studio or the WebConsole.
On-Board 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. 30). FIG. 30 Example Network Settings page Use the options on this page to view/edit the device’s network settings. Refer to the Manage Devices - Network Settings section on page 67 for details. ZeroConfig Networking By default, zeroconf is enabled (On option selected).
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 24 for details. Group Level - changes made at this level affect specific User Groups.
WebConsole - Security Options Default Security Configuration By default, the NetLinx Master creates the following accounts, access rights, directory associations, and security options: Default Security Configuration Account 1 Username: administrator Account 2 Group 1 Username: NetLinx Password: password Password: password Group: administrator Group: none Rights: All Rights: FTP Access Rights: All Directory Association: /* Directory Association: none Directory Association: /* Note: The "admini
WebConsole - Security Options System Security - System Level The System Level Security options provide authorized users the ability to alter the current security options of the entire system assigned to the Master. System Level Security - System Security Settings Click the System Security Settings link to access the System Security Details page (FIG. 32).
WebConsole - Security Options (System Security) Access Options (Cont.) Option Configuration: Description If selected, a valid user name and password is required before allowing a group/user to alter the current Master’s security and communication settings via NetLinx Studio. This includes such things as: IP configuration/Reset, URL list settings, Master communication settings, and security parameters.
WebConsole - Security Options LDAP Options (Cont.) LDAP BASE DN: This parameter specifies the Distinguished Name (DN) of an entry in the directory. It identifies the entry that is the starting point of the user search. BIND DN: This parameter specifies the Distinguished Name (DN) to use to bind to the LDAP server for the initial search for the user's DN. User Query Attr. This LDAP attribute is used for the AMX equipment user search (for example, UID).
WebConsole - Security Options System Security - Group Level Note: A Group represents a logical collection of individual users. Any properties possessed by a group are inherited by all members of that group. Select the Group Level tab of the Security Page to access the Group Security Details page (FIG. 33). FIG.
WebConsole - Security Options 4. Enable the security access rights you want to provide to the group. By default, all of these options are disabled. See the Group and User Security Access Options section on page 28 for details. 5. Click the Accept button to save your changes to the target Master. If there are no errors within any of the page parameters, a “Group added successfully” displays at the top of the page.
WebConsole - Security Options Viewing Group Security Settings Details Click on any Group listed in the Group Security Details page to expand the view to show details for the selected user Group (FIG. 35): Click to add a new Group FIG. 35 Group Security Details Page Click the Edit button to edit the Security Access options for the selected user group. Click Delete to delete the selected User Group from the Master. Modifying the Properties of an Existing Group 1.
WebConsole - Security Options 3. Modify the previously configured access rights by enabling / disabling the checkboxes. See the Group and User Security Access Options section on page 28 for details. 4. Click the Accept button to save your changes to the Master. If there are no errors with the modification of any of this page’s parameters, a “Group updated successfully” is displayed at the top of the page. Note: The "administrator" group account cannot be modified or deleted.
WebConsole - Security Options Adding a New User 1. Select the User Level tab (in the Security section) to open the User Security Details page. 2. Click the Add New User button (see FIG. 37) to access the Add/Modify User page (FIG. 38). FIG. 38 User Security Settings Page (Add/Modify User page) 3. In the User Name field, enter a unique name for the new group. The name must be a unique alpha-numeric character string (4 - 20 characters), and is case sensitive.
WebConsole - Security Options Viewing and Editing User Security Settings Click on any User listed in the User Security Details page to view and edit security settings for the selected User (FIG. 39): Click to edit Access settings for this User Click to delete this User FIG. 39 User Level Security Settings Page (Viewing User Security Settings Details) Click the Edit button to edit the Security Access options for the selected User. Click Delete to delete the selected User from the Master.
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. 40). 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.
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 devices, perform Diagnostics, configure Server settings and set the time/date via the Clock Manager.
WebConsole - System Options Manage System - System Number The options on this page display the current System Number assigned to the target Master (read-only), and allow you to change the system number (see FIG. 41). Changing the System Number on the Master 1. Enter the new numeric value into the New System Number field. 2. Click the Accept button to save this new value to the system on the target Master. The message "System number changed to X. Master must be rebooted for the change to take effect.
WebConsole - System Options Manage System - Control/Emulate Options Click the Control/Emulate link (in the Manage System tab) to access the Control/Emulate Options page (FIG. 42). The options on this page allow you to Control or Emulate a device connected to this Master. Device Control/Emulation is accomplished by manipulating a target device’s channels, levels, and sending both send commands and strings to the device.
WebConsole - System Options Controlling or Emulating a System Device 1. Select the device that you want to Control or Emulate, via the Device Tree: a. Click the Show Device Tree option to show the Device Tree window (if it is not already enabled). b. In the Device Tree, click on the Information (i) icon for the device that you want to control or emulate. This opens a Network Settings page showing network configuration details for the selected device.
WebConsole - System Options 4. Select the Push button to Emulate a push/release on the specified channel (not displayed if the Control option is selected). Click and hold the Push button to observe how the device/Master responds to the push message. 5. In the Level Code section, enter a valid Level number and Level data value for the specified and press the Send button to transmit the level data. The Level number range is 1 - 65535.
WebConsole - System Options Manage System - Diagnostics Options Click the Diagnostics link (in the Manage System tab) to access the Diagnostics Options page (FIG. 44). The options on this page allow authorized users to enable and monitor various diagnostic messages coming from and going to System Devices. FIG. 44 Diagnostics Options page Note: The System Number, Device Number, and Port Number value fields are read-only (disabled).
WebConsole - System Options Enabling Diagnostics on a Selected System Device 1. Select the device that you want to Control or Emulate via the Device Tree: a. Click the Show Device Tree option to show the Device Tree window (if it is not already enabled). b. In the Device Tree, click on the Information (i) icon for the device for which you want to enable or modify Diagnostics options.
WebConsole - System Options 2. By default, all diagnostics are disabled (see FIG. 45). To enable diagnostic messages from this device, click on one of the Edit buttons along the bottom of the Diagnostics Options table. This opens the Edit Options window (FIG. 46), where you can select which Diagnostics messages to enable or disable for this device.
WebConsole - System Options All returned messages are displayed in the Incoming Messages window. By default, all messages are refreshed every 5 seconds, as indicated by the Refresh Interval field. Use the Refresh Interval drop-down to specify how often your messages are updated (available values = 2 seconds, 5 seconds, or 10 seconds). The default setting is 5 seconds. 4. To add more devices to the Diagnostics Options page: Repeat steps 1-3.
WebConsole - System Options Diagnostics Options Definitions The following table describes each of diagnostics options that can be enabled via the Edit Options window: Diagnostic Options Diagnostic Option Description All Notifications: Enables every notification field. System • Number • Device • Port: Use these fields to enter a Device:Port:System (D:P:S) combination for the device for which you want to enable notifications. A value of 0 for any option gives you all of the systems, devices, or ports.
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. 1. Click the Presets down arrow to open a list of previously stored Presets. By default, the only preset is called 0: All Devices, All Notifications. This default Preset cannot be modified. 2.
WebConsole - System Options The options on this page are described below: Port Settings Allows a user to modify the server settings; specifically those port assignments associated with individual services. All items can be either enabled/disabled via the Enabled checkboxes. The port number values (except the FTP port) can be modified in this page. The default port for each service is listed to the right.
WebConsole - System Options Server Port Settings (Cont.) Feature Description SSH: • The port value used for secure Telnet communication. A separate secure SSH Client would handle communication over this port. When using a secure SSH login, the entire login session (including the transmission of passwords) is encrypted; therefore it is secure method of preventing an external user from collecting passwords. • SSH version 2 is supported. • The default port value is 22.
WebConsole - System Options Creating an SSL Server Certificate Initially, a NetLinx Master is not equipped with any installed certificates. To prepare a Master for later use with "CA" (officially issued) server certificates, it is necessary to: First create a self-generated certificate which is automatically installed onto the Master. Secondly, enable the SSL feature from the Enable Security page.
WebConsole - System Options SSL Certificate Entries The following table describes the SSL Certificate entries presented in the Create SSL Certificate window (FIG. 50): SSL Certificate Entries Entry Bit Length: Description Provides a drop-down selection with three public key lengths (512, 1024, 2048). • A longer key length results in more secure certificates. • Longer key lengths result in increased certificate processing times.
WebConsole - System Options Creating a Request for an SSL Certificate 1. Click the Create SSL Certificate link in the Server Options page to open the Create SSL Certificate window. 2. Fill out the fields, according to the descriptions in the SSL Certificate Entries section on page 48. 3. Click the down arrow next to the Action field, and choose Create Request from the drop-down list. 4.
WebConsole - System Options 7. 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). 8. Submit the request. 9. Paste the copied text into your e-mail document and send it to the CA with its accompanying certificate application. WARNING!: When a certificate request is generated, you are creating a private key on the Master.
WebConsole - System Options Manage System - Clock Manager Options Click the Clock Mgr link (on the Manage System tab) to access the Clock Manager Options page (FIG. 53). 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. FIG.
WebConsole - System Options Setting Daylight Savings Rules 1. In the Daylight Savings tab (FIG. 54), enable Daylight Savings mode by clicking the On button. FIG. 54 Clock Manager Options - Daylight Savings tab 2. 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. Note: Although most places that support Daylight Savings usually adjust the local time by one hour this doesn't cover all locations.
WebConsole - System Options Selecting a Custom NIST Server FIG. 55 Clock Manager Options - NIST Servers tab 1. In the NIST Servers tab (FIG. 55), use the radio buttons to select one of the NIST Servers in the list. 2. Click Accept to save these settings to the Master. Adding a Custom NIST Server to the List 1. Click on the radio button next to the last (blank) entry in the NIST Server Manager list. 2. In the URL field, enter the URL of the NIST Server.
WebConsole - System Options Manage System - App Manager Options Click the App Mgr link (on the Manage System tab) to access the App Manager Options page (FIG. 56). The options on this page allow you to specify a directory location on the Master where you want to store Java applications used by the Master and then manage the applications, including installing, starting, stopping, and deleting them. FIG.
WebConsole - System Options Adding a New License 1. Click the Add New License button to access the Add a License page (FIG. 58). FIG. 58 Manage License - Add a License page 2. Enter the Product ID (certificate number) provided with the product into the Product ID fields.
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. 59). FIG. 59 System - Manage NetLinx tab The table on this page consists of five columns: NetLinx Device Details Column Description System: Displays the System value being used by the listed NetLinx Master. Device: Displays the assigned device value of the listed unit.
WebConsole - System Options Refresh List: Click this button to regenerate the device listing by looking for broadcasting devices. This causes the Master to send out a message asking devices to resend their NDP device announcements. The list is then updated as those devices send back their announcements to the Master. The information displayed can not only include Masters and devices on this system but Masters and devices on other systems as well. By default, the target Master always appears in the list.
WebConsole - System Options Manage Devices - Device Options Click the Device Options link (in the Manage Devices tab) to access the Details for Additional Devices page (FIG. 60). The options on this page display various details specific to additional (non-NetLinx) System Devices. Configuring Device Binding Options 1.
WebConsole - System Options Deleting a Module Select a module and click the Delete Module button. This action deletes the selected module from the /unbound directory. Note: Any corresponding module within the /bound directory will not be deleted. Bound modules must be deleted via the Purge Bound Modules on Reset selection described within the Configure Device Bindings section. To browse for a Module file and then upload it to the Master: 1.
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 *) (********
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 NetLinx physical device port to which the application device is always associated (i.e. statically bound).
WebConsole - System Options Viewing Physical Device Properties Hold the mouse cursor over the Physical Device - Device entry in the table to display detailed device properties for that device, in a pop-up window (FIG. 63). Hold the mouse cursor over the Device D:P:S assignment to open the Device Properties pop-up FIG.
WebConsole - System Options Adding a User-Defined Device 1. Click the Add Device button (in the User-Defined Devices page) to access the Add User Defined Device page (FIG. 65): FIG. 65 User-Defined Devices - Add User Defined Device 2. Fill in the device information fields, as described in the following tables: User-Defined Device Information Fields Address: Enter the address of the physical device in the Address field.
WebConsole - System Options SDK-Class Types Amplifier Digital Video Recorder PreAmpSurroundSoundProcessor AudioConferencer Disc Device Receiver Utility VCR AudioMixer DocumentCamera RelayDevice VideoConferencer AudioProcessor HVAC Security System VideoProcessor AudioTape IODevice Sensor Device VideoProjector AudioTunerDevice Keypad SettopBox VideoWall Camera Light SlideProjector VolumeController Weather Digital Media Decoder Monitor Switcher Digital Media Encoder Motor Text
WebConsole - System Options 2. Once a list of all compatible modules is compiled, the Available Modules list is displayed on this page. Each module is listed with its calculated “match” value. The greater the “match” value, the better the match between the Duet Module's properties and the physical device's properties. 3. Select a module and click the Accept button to associate the selected Duet module with the physical device.
WebConsole - System Options Manage Devices - Manage Polled Ports Click the Polled Ports link (in the Manage Devices tab) to access the Manage Polled Ports page (FIG. 68). The options on this page allow you to view/modify settings for all polled ports in the System. Click to open the Edit Port Settings page FIG. 68 System - Manage Devices (Manage Polled Ports) Note: Polled Ports must be specified in the Master’s code in order for this page to be populated.
WebConsole - System Options Manage Devices - Network Settings With the Master selected in the Device drop-down menu, click the Network Settings link (in the Manage Devices tab) to access the Network Settings page (FIG. 70). Use the options on this page to view/edit the Master’s network settings. FIG.
WebConsole - System Options Manage Devices - URL List With the Master selected in the Device drop-down menu, click the URL List link (in the Manage Devices tab) to access the URL List page (FIG. 71). The options on this page allow you to view and edit the URL List of devices for the Master. FIG. 71 System - Manage Devices (URL List) Adding a URL to the Master’s List of Devices In the Manage Devices - URL List page, click the Add URL button to open the Add a URL page (FIG. 72): FIG.
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. 73). The options on this page allow you to change the device number on the Master. FIG. 73 System - Manage Devices (Device Number) Default = 0 (zero) Note that in most cases, the Device Number for Masters should remain set to zero.
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. 75). This page displays message logs for the Master. FIG.
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. 76). Diagnostic Options table FIG. 76 Diagnostics Options Page (with diagnostic messages enabled) This page can also be accessed via the Manage System options, as described in the Manage System - Diagnostics Options section on page 39.
NetLinx Programming NetLinx Programming Overview This section describes the Send_Commands, Send_Strings, and Channel commands you can use to program the Master. The examples in this section require a declaration in the DEFINE_DEVICE section of your program to work correctly. Refer to the NetLinx Programming Language instruction manual for specifics about declarations and DEFINE_DEVICE information. Note: All file names on the X-Series controllers are case sensitive.
NetLinx Programming Master SEND_COMMANDs (Cont.) Command Description G4WC Add G4 Web Control devices to Web control list displayed by the Web server in a browser. The internal G4WC Send command (to Master 0:1:0) has been revised to add G4 Web Control devices to Web control list displayed in the browser.
NetLinx Programming LED SEND_COMMANDs Note: The following sections only apply to the integrated controller component of the NX-series controllers. The following commands enable or disable the LEDs on the Controller. In the examples: = Port 1 of the device. Sending to port 1 of the controller affects all ports. LED SEND_COMMANDs Command Description LED-DIS Disable all LEDs (on 32 LED hardware) for a port. Regardless of whether or not the port is active, the LED will not be lit.
NetLinx Programming RS-232/422/485 SEND_COMMANDs (Cont.) Command Description B9MON Override and set the current communication settings and parameters on the RS-232 serial port to 9 data bits with one stop bit. This command works in conjunction with the 'B9MOFF' command. Syntax: SEND_COMMAND ,"'B9MON'" Example: SEND_COMMAND RS232_1,"'B9MON'" Resets the RS-232 port's communication parameters to nine data bits, one stop bit, and locks-in the baud rate.
NetLinx Programming RS-232/422/485 SEND_COMMANDs (Cont.) Command Description GET BAUD Get the RS-232/422/485 port’s current communication parameters. The port sends the parameters to the device that requested the information.
NetLinx Programming RS-232/422/485 SEND_COMMANDs (Cont.) Command Description RXON Start transmitting received characters to the Master (default). Enables sending incoming received characters to the Master. This command is automatically sent by the Master when a 'CREATE_BUFFER' program instruction is executed. Syntax: SEND_COMMAND ,"'RXON'" Example: SEND_COMMAND RS232_1,"'RXON'" Sets the RS232_1 device to transmit received characters to the Master.
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. Note: On NX-series controllers, you can use the RS-422/485 ports as 232 ports by using the TSET BAUD command to disable both 422 and 485 modes on the port.
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: = device. RS-232/422/485 SEND_STRING Escape Sequences Command Description 27,17,
NetLinx Programming IR/Serial Ports Channels IR / Serial Ports Channels CHANNELS: Description 00001 - 00229 IR commands. 00229 - 00253 May be used for system call feedback. 00254 Power Fail. (Used w/ 'PON' and 'POF' commands). 00255 Power status. (Shadows I/O Link channel status). 00256 - 65000 IR commands. 65000 - 65534 Future use. IRRX Port Channels IRRX Ports Channels 00001 - 00255 PUSH and RELEASE channels for the received IR code.
NetLinx Programming IR/Serial SEND_COMMANDs (Cont.) Command Description CH Send IR pulses for the selected channel. All channels below 100 are transmitted as two digits. • If the IR code for ENTER (function #21) is loaded, an Enter will follow the number. • If the channel is greater than or equal to (>=) 100, then IR function 127 or 20 (whichever exists) is generated for the one hundred digit. • Uses 'CTON' and 'CTOF' times for pulse times.
NetLinx Programming IR/Serial SEND_COMMANDs (Cont.) Command Description GET BAUD Get the IR port’s current DATA mode communication parameters. The port sends the parameters to the device that requested the information. Only valid if the port is in Data Mode (see SET MODE command).
NetLinx Programming IR/Serial SEND_COMMANDs (Cont.) Command Description POF Turn Off 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 ON (such as if someone turned it on manually at the front panel), IR function 28 (if available) or IR function 9 is automatically generated in an attempt to turn the device back OFF. If three attempts fail, the IR port will continue executing commands in the buffer.
NetLinx Programming IR/Serial SEND_COMMANDs (Cont.) Command Description SET BAUD Set the IR port's DATA mode communication parameters. Only valid if the port is in Data Mode (see SET MODE command). Syntax: SEND_COMMAND ,"'SET BAUD ,,,'" Variables: baud = baud rates are: 19200, 9600, 4800, 2400, and 1200. parity = N (none), O (odd), E (even), M (mark), S (space). data = 7 or 8 data bits. stop = 1 and 2 stop bits.
NetLinx Programming IR/Serial SEND_COMMANDs (Cont.) Command Description SP Buffers IR commands which haven’t had time to execute yet, and executes each command until the buffer is empty. Syntax: SEND_COMMAND ,"'SP'," Variable: code = IR code value 1 - 252 (253-255 reserved). Example: SEND_COMMAND IR_1, "'SP',25" Pulses IR code 25 on IR_1 device. XCH Transmit the selected channel IR codes in the format/pattern set by the 'XCHM' send command.
NetLinx Programming IR/Serial SEND_COMMANDs (Cont.) XCHM Changes the IR output pattern for the 'XCH' send command. Syntax: SEND_COMMAND ,"'XCHM-'" Variable: extended channel mode = 0 - 4. Example: SEND_COMMAND IR_1,"'XCHM-3'" Sets the IR_1 device's extended channel command to mode 3. Mode 0 Example (default): [x][x] SEND_COMMAND IR_1,"'XCH-3'" Transmits the IR code as 3-enter. SEND_COMMAND IR_1,"'XCH-34'" Transmits the IR code as 3-4-enter.
NetLinx Programming Input/Output SEND_COMMANDs The I/O port is port 22 on the NX-series controllers. The following SEND_COMMANDs program the I/O ports on the Integrated Controller. I/O SEND_COMMANDs Command Description GET DBT Get Debounce Time Syntax: GET DBT Variable: n = the channel number of the I/O input port Example: SEND_COMMAND 5001:22:0,'GET DBT 1' Retrieves the Debounce time channel 1 on the I/O port.
NetLinx Programming PoE SEND_COMMANDs The NX-4200 has 4 ICSLAN ports, each of which feature Power-over-Ethernet (PoE). The ports are numbered 1-4. The following PoE SEND_COMMANDs program the ICSLAN ports on the controller. PoE SEND_COMMANDs Command Description GET CLASS Retrieve the class type of the device connected via PoE. This command receives a response of ’DISABLED’, ’NO DEVICE’, or ’CLASS x DEVICE’, with x being a value from 0 to 4.
NetLinx Programming PoE SEND_COMMANDs (Cont.) Command Description SET POWER ON Enables PoE to the port. PoE is turned on by default. Syntax: SEND_COMMAND ,"'SET POWER ON'" Example: SEND_COMMAND PoE_24,"'SET POWER ON'" AxLink Commands The following commands program the AxLink ports on the NX controller. AxLink SEND_COMMANDs Command Description AXPWROFF Powers off the specified AxLink port.
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 Type-B USB port located on the front panel of the Master that allows terminal communication with the Master. This type of terminal communication requires that you are physically connected to the Master to access the configuration options and commands supported.
Terminal (Program Port/Telnet) Commands To restrict access to the Master via terminal connection, enable Configuration Security on the Master via the CONFIGURATION SECURITY option in the Security Options menu - see the Security Options Menu section on page 113 for details). With Configuration Security enabled, a valid user with Configuration Security access will have to login before being able to execute Telnet commands. If security is not enabled, these commands are available to all.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description DEVICE STATUS Displays a list of all active (on) channels for the specified D:P:S. If you enter DEVICE STATUS without the D:P:S variable, the Master displays ports, channels, and version information. DIPSWITCH Displays the current state of the Master's hardware dip switches. DISK FREE Displays the total bytes of free space available on the Master.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description EXPORT (CONFIG|CLONE) TO USB (FRONT|BACK) Exports a Master's configuration (config) or entire clone to USB media connected to the front or back of the master.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description GET IP Displays the IP configuration of a device. If you enter GET IP without the D:P:S variable, the Master displays its D:P:S, Host Name, Type (DHCP or Static), IP Address, Subnet Mask, Gateway IP, and MAC Address. Example: >GET IP [0:1:50] IP Settings for 0:1:50 HostName MLK-INSTRUCTOR Type DHCP IP Address 192.168.21.101 Subnet Mask 255.255.255.0 Gateway IP 192.168.21.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description MEM 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.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description PASS [D:P:S or NAME] Sets up a pass through mode to a device. In pass through mode, any string received by the device is displayed on the screen, and anything typed is sent as a string to the device. The device can be on any system that the Master you are connected to is able to reach.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description REBOOT Reboots the Master or specified device. Options for rebooting the Master are cold, soft, and warm. The reboot command with no parameter executes as "reboot cold". Example (Rebooting device): >REBOOT [0:1:0] Rebooting... Example (Rebooting Master): >reboot cold Reboots the Master and restarts the entire operating system.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description SET DATE Prompts you to enter the new date for the Master. When the date is set on the Master, the new date will be reflected on all devices in the system that have clocks (i.e. touch panels). By the same token, if you set the date on any system device, the new date will be reflected on the system’s Master, and on all connected devices.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description SET HTTPS PORT Sets the Master’s IP port listened to for HTTPS connections. Note: The Master must be rebooted to enable new settings.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description SET IP 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. • Enter Y (yes) to approve/store the information into the Master. • Enter N (no) to cancel the operation. Note: The Device must be rebooted to enable new settings.
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 Profile can only be configured via the terminal interface of the Master's Program port.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description SET SECURITY PROFILE (Cont.) DoD: DoD security profile has all of the security specifications of "secure" profile along with the following additional features: • The default Web login banner text consists of the following: "This is a Department of Defense (DOD) computer system provided only for authorized U.S. Government use. This system may be monitored for all lawful purposes.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description SET SYSTEM NUMBER Sets the system number for this Master. A reboot of the Master following the execution of this command is required for the change to take effect. Example: >set system number Current System number = 1 Enter new System number : 2 Setting System number to 2 New System number set, reboot the master for the change to take effect.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description SET UDP BC RATE Sets the UDP broadcast rate. A broadcast message is sent by the Master to allow devices to discover the Master. This command allows the broadcast frequency to be changed or eliminate the broadcast message. Example: >SET UPD BC RATE Current broadcast message rate is 5 seconds between messages.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description SHOW BUFFERS Displays a list of various message queues and the number of buffers in each queue Example: show buffers Thread TX ----------- ---Axlink 0 UDP 0 IPCon Mgr 0 Con Manager Interpreter Device Mgr Diag Mgr Msg Dispatch Cfg Mgr Route Mgr Notify Mgr Total ---0 RX ---- Queued ---0-Sent=NO Waiting=NO 0 0 0 0 0 0 0 0 ---0 ---0 GrandTotal 0 Note: See the SHOW MAX BUFFERS section on page 107.
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 • Date, Day, and Time message was logged • Which object originated the message • The text of the message: SHOW LOG [start] [end] SHOW LOG ALL - specifies message to begin the display.
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.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description SHOW START LOG Displays the startup log (see START LOG below). specifies the message to begin the display. 'ALL' will display all startup log messages. Note: This command is identical in implementation to the SHOW LOG command (see page 106), except that it executes the startup log. SHOW SYSTEM Displays a list of all devices in all systems currently on-line.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description USB LOG [front|back] [enable|disable] Directs the Master logs to a USB flash media file. The log files are named with the current date and time. Syntax: USB LOG [front|back] [enable|disable] ZEROCONF [ENABLE|DISABLE|STATUS] Enable, disable or view the new Zeroconf client in the Master.
Terminal (Program Port/Telnet) Commands Accessing the Security Configuration Options Security configuration options are only available to Program Port connections (see the Overview section on page 90). Note: Refer to the SET SECURITY PROFILE on page 101 for information on setting Security Profiles. 1. In the Terminal session, type help security to view the available security commands.
Terminal (Program Port/Telnet) Commands Setup Security Menu The Setup Security menu is described below: Setup Security Menu Command 1) Set system security options for NetLinx Master See the Security Options Menu section on page 113 for descriptions of each menu item. Description This selection will bring up the Security Options Menu that allows you to change the security options for the NetLinx Master. These are "global" options that enable rights given to users and groups.
Terminal (Program Port/Telnet) Commands Setup Security Menu (Cont.) Command 15) Make changes permanent by saving to flash Description When changes are made to the security settings of the Master, they are initially only changed in RAM and are not automatically saved permanently into flash. This selection saved the current security settings into flash.
Terminal (Program Port/Telnet) Commands 3. To proceed, enter y and press enter. The following menu will be displayed: Select to change current security option 1) 2) 3) 4) 5) 6) 7) Terminal (RS232) Security...........Enabled HTTP Security.......................Enabled Telnet Security.....................Enabled Configuration Security..............Enabled ICSP Security.......................Disabled ICSP Encryption Required............Disabled LDAP Security.......................
Terminal (Program Port/Telnet) Commands Edit User Menu The Edit User Menu is accessed whenever you enter the Add user, or Edit user selections from the Setup Security menu. The Edit User Menu options are described in the following table: Edit User Menu Command Description 1) Change User Password This selection prompts you to enter the new password (twice) for the user. Once the new password is entered, the user must use the new password from that point forward.
Terminal (Program Port/Telnet) Commands Access Rights Menu The Access Rights Menu is accessed whenever you select Change Access Rights (option 6) from the Edit User menu, or Change Access Rights from the Edit Group menu. The options in this menu is described below: Access Rights Menu Command 1) Terminal (RS232) Access (Enable/Disable) Description Enables/disables Terminal (RS232 Program port) Access. The account has sufficient access rights to login to a Terminal session if this option is enabled.
Terminal (Program Port/Telnet) Commands Edit Group Menu: Add Directory Association 1. At the Edit Group prompt, type 1 to add a new directory association. A Directory Association is a path that defines the directories and/or files that a particular user or group can access via the HTTP (Web) Server on the NetLinx Master. This character string can range from 1 to 128 alpha-numeric characters. This string is case sensitive. This is the path to the file or directory you want to grant access.
Terminal (Program Port/Telnet) Commands Default Security Configuration By default, the NetLinx Master will create the following accounts, access rights, directory associations, and security options.
Terminal (Program Port/Telnet) Commands Telnet Diagnostics Commands The following Telnet Diagnostics Commands provide visibility to remote Masters, in order to determine the current state of operations, and are provided as diagnostic/troubleshooting tools. While these commands are available for any user to execute, their output is interpretable primarily by an AMX Technical Support Engineer.
Appendix A: LDAP Implementation Details Appendix A: LDAP Implementation Details Overview The process of verifying credentials and obtaining user authorization is designed to support most organizations requirements for 'least privilege'. The account used to search LDAP to provide user objects for authentication never needs access to user information. Authorization lookups are performed as the authenticated user and as such, no elevated permission is required.
Appendix A: LDAP Implementation Details 3. The client connects to the LDAP server and starts a bind operation with the BIND DN, uid=amxBindAccount,ou=people,dc=example,dc=com, and the Search Password, secret. 4. The password, secret, is then compared by the server to the value of the userPassword attribute for the record uid=amxBindAccount,ou=people,dc=example,dc=com. If this step is successful, the bind is successful and the client is logged in. 5.
Appendix A: LDAP Implementation Details 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).
Appendix A: LDAP Implementation Details ICSP Connectivity Security Example If ICSP connectivity is enabled, a valid user name 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. User Access LDAP Server Configuration Master Configuration An ICSP user should be configured for a specific Master and should be set up as a normal user.
Appendix B: SMTP Support Appendix B: SMTP Support Overview NetLinx Integrated Controllers (Masters) have built-in support for transmission or email via an SMTP server. NetLinx Master support includes the configuration of a single outbound SMTP server and the subsequent transmission of individual emails via the configured server. SMTP Server Configuration The SMTP Server is configured by specifying a set of server properties.
Appendix B: SMTP Support Example server configuration: SMTP_SERVER_CONFIG_SET(SMTP_ADDRESS,'mail.mymailserver.com') SMTP_SERVER_CONFIG_SET(SMTP_PORT_NUMBER,'25') SMTP_SERVER_CONFIG_SET(SMTP_USERNAME,'myAccountUsername') SMTP_SERVER_CONFIG_SET(SMTP_PASSWORD,'myAccountPassword') SMTP_SERVER_CONFIG_SET(SMTP_REQUIRE_TLS, SMTP_TLS_TRUE) SMTP_SERVER_CONFIG_SET(SMTP_FROM,'John Doe') Sending Mail Sending mail is accomplished with the use of the Master's built-in Mail Service.
Appendix C: Clock Manager NetLinx Programming API Appendix C: Clock Manager NetLinx Programming API Types/Constants The NetLinx.axi file that ships with NetLinx Studio includes the following types/constants: (*-----------------------------------------------------------------------------*) (* Added v1.
Appendix C: Clock Manager NetLinx Programming API NetLinx.axi - Library Calls (Cont.) CLKMGR_SET_ACTIVE_TIMESERVER (CONSTANT CHAR IP[]) Sets the time server entry that has the matching IP-ADDRESS to the IP parameter as the active time server entry. CLKMGR_GET_TIMESERVERS (CLKMGR_TIMESERVER_STRUCT T[]) Populates the currently configured time server entries from the Clock Manager into the specified TIMESERVER array.
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" with all fields as numeric except for the word "occurence".
Appendix C: Clock Manager NetLinx Programming API NX-Series Controllers - WebConsole & Programming Guide 128
In the ever-changing AV industry, continual education is key to success. AMX University is dedicated to ensuring that you have the opportunity to gather the information and experience you need to deliver strong AMX solutions. Plus, AMX courses also help you earn CEDIA, NSCA, InfoComm, and AMX continuing education units (CEUs).
