NetLinx Integrated Controllers WebConsole & Programming Guide WebConsole & Programming Guide NI & DVX Central Controllers (Firmware version 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 Enova DVX All-In-One Presentation Switchers ......................................................... 1 Enova DVX-21xxHD & DVX-315xHD............................................................................... 2 About This Document .....
Table of Contents Master, Switcher and Device Firmware Files for Enova DVX All-In-One Presentation Switchers .......................................................................... 20 Downloading Enova DVX Firmware Files on www.amx.com..................................................... 20 Required Order of Firmware Updates .................................................................... 20 Required Order of Firmware Updates for NI Controllers ..............................................
Table of Contents WebConsole - System Options .........................................................................45 System Overview .................................................................................................... 45 System - Manage System ........................................................................................ 45 Manage System - System Number .......................................................................... 45 Changing the System Number On the Master .....
Table of Contents Deleting a Module .................................................................................................................... 67 Manage Devices - Bindings ..................................................................................... 67 Configuring Application-Defined Devices ..................................................................... 67 Application Devices and Association Status ..................................................................
Table of Contents HSOFF .................................................................................................................................... HSON ..................................................................................................................................... RXCLR..................................................................................................................................... RXOFF ......................................................................
Table of Contents Terminal Commands ............................................................................................... 99 ----- Help ----- ............................................................................................................. 99 ? or Help ................................................................................................................................ 99 AUTO LOCATE (ENABLE|DISABLE|STATUS)..............................................................
Table of Contents SET IP ..................................................................................................................... SET LOG COUNT .................................................................................................................. SET QUEUE SIZE................................................................................................................... SET SECURITY PROFILE.................................................................................
Table of Contents PHYSICAL STATUS ............................................................................................................... 121 MSG STATS .......................................................................................................................... 121 Logging Out of a Terminal Session ....................................................................... 121 Notes on Specific Telnet/Terminal Clients ............................................................
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 2.4 or higher).
Overview Enova DVX-21xxHD & DVX-315xHD Enova DVX-21xxHD All-in-One Presentation Switchers utilize an NI-2100 Controller, therefore all controller-related information that applies to the NI-2100 is fully applicable to DVX-21xxHD products. Enova DVX-315xHD All-in-One Presentation Switchers utilize an NI-3101-SIG Controller, therefore all controller-related information that applies to the NI-3101-SIG is fully applicable to DVX-315xHD products.
Overview Update the On-board Master and Controller Firmware Before using your new NI unit, you must first update your NetLinx Studio to the most recent release. Upgrade the on-board Master firmware through an IP Address via the LAN connector (Upgrading Firmware section on page 18) (IP recommended). Upgrade the Integrated Controller firmware through an IP Address via the LAN connector (Upgrading the NI Controller Firmware section on page 21) (IP recommended).
Overview 4 NI & DVX Central Controllers - WebConsole & Programming Guide
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 NI Controller, as described in this section (as well as to transfer firmware Kit files to the Master - see the Upgrading Firmware section on page 17). Before You Start 1.
Initial Configuration 3. Click the Communications Settings button to open the Communications Settings dialog (FIG. 4): FIG. 4 Communication Settings dialog - Recent tab 4. Select NetLinx Master under Platform Selection to indicate you are working with a NetLinx Master. 5. Select the Serial tab to view the serial options (FIG. 5). FIG. 5 Communications Settings dialog - Serial tab 6. On the Serial tab, set the COM port parameters (used to communicate to the NetLinx Master).
Initial Configuration 8. Note that the serial configuration is indicated in the Configuration text field (FIG. 6): FIG. 6 Master Communication Settings dialog indicating a Serial Connection 9. 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): FIG.
Initial Configuration Configuring the NI Controller for LAN Communication Before continuing, complete the COM port steps described above to establish a serial connection with the NetLinx Master. 1. Use an LAN cable to connect the Controller to the LAN to which the PC running NetLinx Studio is connected. The NI-x100 Controllers feature an Auto MDI/MDI-X LAN port.
Initial Configuration 5. To configure a network address via DHCP (FIG. 10): FIG. 10 Network Addresses dialog (DHCP) a. b. c. d. Select Use DHCP, then click Get IP Information to obtain a DHCP Address from the DHCP Server. Click SET IP Information to retain the new address, To finish the process, click Reboot Device. Click OK to close the dialog. 6. To specify a network IP address (FIG. 11): FIG. 11 Network Addresses dialog (Specify IP Address) a. b. c. d. e. Select Specify IP Address.
Initial Configuration 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. Refer to the NetLinx Studio on-line help for information on using NetLinx Studio. 1.
Initial Configuration 5. 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 Identification Made " message is displayed (FIG. 14): Device identified ID Mode no longer active FIG. 14 Device Addressing dialog - Successful Identification Made The previous Device and System numbers of the NI Controller are displayed below the red field.
Initial Configuration If the IP Address field is empty, give the Master a few minutes to negotiate a DHCP Address with the DHCP Server, and try again. The DHCP Server can take anywhere from a few seconds to a few minutes to provide the Master with an IP Address. 5. Verify that NetLinx appears in the Host Name field (if not, then enter it in at this time). 6. Select Use DHCP. 7. Click Set IP Information to retain the IP Address from the DHCP server and assign it to the on-board Master.
Initial Configuration 4. Select Specify IP Address to enable the IP fields for editing (FIG. 17): FIG. 17 NetLinx Studio: Network Addresses dialog (Specify IP Address) 5. Verify that NetLinx appears in the Host Name field (if not, then enter it in at this time). 6. Enter the IP Address, Subnet Mask, and Gateway information into their respective fields (as defined by the System Administrator).
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 NI Controller from your System Administrator.
Initial Configuration 5. Select the Network tab (FIG. 20). FIG. 20 Communications Settings dialog - Network tab 6. 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): FIG.
Initial Configuration 7. Click OK to close the New TCP/IP Settings dialog and return to the Communication Settings dialog: (FIG. 22). FIG. 22 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. 8. Click OK to save your newly entered information and close the Communication Settings dialog and return to the Master Communication Settings dialog.
Upgrading Firmware Upgrading Firmware Overview 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.
Upgrading Firmware Enova DVX Enova DVX All-In-One Presentation Switchers contain three devices (NI Master, Device Controller and A/V Switcher/ Scaler), each of which require a separate Kit file. These three devices must be kept at compatible firmware versions for proper operation. Therefore, all three files should be used when upgrading any firmware associated with the Enova DVX All-In-One Presentation Switchers.
Upgrading Firmware Downloading the Latest Firmware Files from www.amx.com NetLinx Integrated Controllers NetLinx Integrated (NI) 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. The process of downloading and transferring firmware files is the same for all types of firmware.
Upgrading Firmware Master, Switcher and Device Firmware Files for Enova DVX All-In-One Presentation Switchers Below is a table outlining the Master, Device, and Switcher firmware (*.kit) files used by Enova DVX Controllers: Master Firmware Kit File Usage for Enova DVX Controllers DVX-3150/3155/3156 2150/2155 HD Master Firmware: SW1905-25_Master_v4_x_xxx.kit DVX-2100HD Master Firmware: SW1905-01_Master_v4_x_xxx.kit Device Firmware: SW2105_NI_X101_Device_v1_xx_x.
Upgrading Firmware Upgrading Firmware Files These steps assume that you have already established a connection with the target Central Controller (see the Initial Configuration section on page 5 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 NI Master. Note that the Port field is disabled (FIG. 27). FIG. 27 Send to NetLinx Device dialog (showing on-board NI_Master firmware update) 7. Verify that the Reboot Device checkbox is selected to reboot the NI unit after the firmware update process is complete (selected by default). 8. Click Send to begin the transfer.
Upgrading Firmware Upgrading NXC Card Firmware Before beginning with this section, verify that both the on-board Master and on-board Integrated Controller have been updated with the latest firmware and that the NetLinx cards are securely inserted into the NI-4100. 1. Follow the procedures outlined within the Communicating Via IP Address section on page 14 to connect to the target NI device via the web. 2.
Upgrading Firmware 8. Select Tools > Firmware Transfers > Send to NetLinx Device from the Main menu to open the Send to NetLinx Device dialog (FIG. 29). Verify the target’s Device and System numbers matches the value listed within the System folder in the Workspace window. Description field for selected Kit file Selected Control Card Firmware file Firmware download status System Number and Device Number must match the System and Device values listed in the Workspace window FIG.
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. 30): FIG. 30 Device Addressing dialog This resets both the system value and device addresses (for definable devices) to their factory default settings.
Upgrading Firmware 26 NI & DVX Central Controllers - WebConsole & Programming Guide
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" (FIG. 31).
Onboard 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. 31). Device Tree Click the Show Device Tree checkbox to show/hide the online device tree, which indicates all devices currently connected to this Master.
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. 34). FIG. 34 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 75 for details.
Onboard WebConsole User Interface 30 NI & DVX Central Controllers - WebConsole & Programming Guide
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 33 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 Account 2 Username: administrator Username: NetLinx Group 1 Password: password Password: password Group: administrator Group: none Rights: All Rights: FTP Access Rights: All Directory Association: /* Directory Association: none Directory Association: /* Note: The "admin
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. 36).
WebConsole - Security Options (System Security) Access Options (Cont.) Option Configuration: Description If selected, a valid username 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 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. 37). 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 37 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” is displayed 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. 39): Click to add a new Group FIG. 39 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 37 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. The "administrator" group account cannot be modified or deleted.
WebConsole - Security Options A User represents a single client of the Master, while a Group represents a collection of Users. Any properties possessed by a Group are inherited by all of the Users in the group. 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. 41) to access the Add/Modify User page (FIG. 42). FIG. 42 User Security Settings Page (Add/Modify User page) 3.
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. 43): Click to edit Access settings for this User Click to delete this User FIG. 43 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 - Security Options 42 NI & DVX Central Controllers - WebConsole & Programming Guide
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. 44). 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 - Web Control Options 44 NI & DVX Central Controllers - WebConsole & Programming Guide
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 Example: Using an NI-2100 and NI-4100: The NI-2100 could be assigned to System 1 (with an Address of 00000). The NI-4100 could be assigned to System 2 (with an Address of 00000). Resetting the Master Controller to the Factory Defaults Configuration Click the Reset To Factory Defaults button. This resets the Master to its’ factory default state.
WebConsole - System Options The System Number, Device Number, and Port Number fields are read-only. Instead of specifying these values for a System Device, select a device via the Device Tree to populate these fields with that device’s information. 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.
WebConsole - System Options Select the On or Off buttons to Emulate Channel ON (CHON) and Channel OFF (CHOFF) messages for the specified . 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.
WebConsole - System Options Manage System - Diagnostics Options Click the Diagnostics link (in the Manage System tab) to access the Diagnostics Options page (FIG. 48). The options on this page allow authorized users to enable and monitor various diagnostic messages coming from and going to System Devices. FIG. 48 Diagnostics Options Page (with diagnostic messages enabled) The System Number, Device Number, and Port Number value fields are read-only (disabled).
WebConsole - System Options Click on Diagnostics from within the device’s Network Settings page to enable/modify diagnostics for that device FIG. 49 Select Diagnostics from within a selected Device’s Network Settings page The currently selected device is also indicated in the Device field at the top of the page. 2. By default, all diagnostics are disabled (see FIG. 49). To enable diagnostic messages from this device, click on one of the Edit buttons along the bottom of the Diagnostics Options table.
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 information in these fields (and press Update to add the specified device/diagnostics
WebConsole - System Options 4. To add more devices to the Diagnostics Options page: Repeat steps 1-3. Alternatively, you can click one of the Edit buttons to open the Edit Options window, and specify a System Number, Device and Port for a known System Device. Select the Diagnostics messages that you want to enable for this device and click Update. The device will appear in the Diagnostics Options window, in the next available column (to the right of the last device added - see FIG. 52). FIG.
WebConsole - System Options Diagnostic Options (Cont.) Diagnostic Option Description Device Options • Level Changes From Generates a message when there is a level channel change from the target device. • Level Changes To Generates a message when there is a level channel change to the target device. • Strings To Generates a message when there is a string sent to the target device. • Strings From Generates a message when there is a string from the target device.
WebConsole - System Options Manage System - Server Options Click the Server link (in the Manage System tab) to access the Server Options page (FIG. 53). The options on this page allow you to: Change the port numbers (used by the Master for various Web services) Configure the SSL settings used on the Master Manage existing and pending license keys, manage the active NetLinx system communication parameters Configure/modify the SSL certificates on the target Master FIG.
WebConsole - System Options Server Port Settings (Cont.) Feature 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).
WebConsole - System Options SSL Certificate Options There are three SSL Certificate options, presented as links along the bottom of this page: SSL Certificate Options Create SSL Certificate: Opens the Create SSL Certificate window where you can create a self-generated SSL certificate. Note: A self-generated certificate has lower security than an external CA (officially issued) generated certificate.
WebConsole - System Options SSL Certificate Entries The following table describes the SSL Certificate entries presented in the Create SSL Certificate window (FIG. 54): 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 4. Click the Create SSL Certificate button to accept the information entered into the above fields and generate a certificate file. Click Close to exit without making changes to the Master. This refreshes the Server Certificate page, and if the certificate request was successful, displays a "Certified request generated" message. Self-Generating an SSL Certificate 1. Click the Create SSL Certificate link in the Server Options page to open the Create SSL Certificate window. 2.
WebConsole - System Options 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. When a certificate request is generated, you are creating a private key on the Master. You can not request another certificate until the previous request has been fulfilled. Doing so voids any information received from the previously requested certificate and it becomes nonfunctional if you try to use it.
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. 57). 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. Date and Time are only available if Stand Alone is selected as the Time Synch option. FIG.
WebConsole - System Options Setting Daylight Savings Rules 1. In the Daylight Savings tab (FIG. 58), enable Daylight Savings mode by clicking the On button. FIG. 58 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. 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. 59 Clock Manager Options - NIST Servers tab 1. In the NIST Servers tab (FIG. 59), 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 System - Manage License The Manage License tab displays current as well as pending license keys (FIG. 60). FIG. 60 System - Manage License tab (with one example entry) The Add New License button allows for the addition of new license keys associated with currently used modules/ products. Adding new License Keys requires the entry of both a Product ID and a Serial Key (example: i!-Voting). The Master confirms this registration information before running the module or product.
WebConsole - System Options 3. Press the Accept button to save the information. System - Manage NetLinx The Manage NetLinx tab displays a list of NetLinx devices connected to the Master, and indicates device status for each (FIG. 62). FIG. 62 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 NetLinx Device Details (Cont.) Column Status (Cont.): Description • Bound: Indicates that the device has established communication with it's associated Master. This state shows an adjacent Unbind button which is used to release/disassociate the device from communicating with its current Master. • Lost: Indicates that the device has tried to establish communication with it's associated or “bound” Master, but was after a period of time, unable to establish communication.
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. 63). 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. 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. 66). Hold the mouse cursor over the Device D:P:S assignment to open the Device Properties pop-up FIG.
WebConsole - System Options FIG. 68 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. This information can be either the NetLinx Master port value (D:P:S) or an IP Address (#.#.#.#). Category: Use the drop-down list to select the control method associated with the physical target device (IR, IP, Serial, Relay, Other).
WebConsole - System Options 3. Once you are done creating the profile for the new device, click the Add Property button to access the Name and Value fields property information for association with the new User Defined Device. 4. Click the Accept button. The new device is indicated in the list of discovered physical devices (in the User-Defined Devices page). Manage Devices - Active Devices Click the Active Devices link (in the Manage Devices tab) to access the View All Active Devices page (FIG. 69).
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. 70). Hold the mouse cursor over the Physical Device IP Address to open the Device Properties pop-up FIG. 70 View All Active Devices - Device Properties pop-up Manage Devices - Manage Polled Ports Click the Polled Ports link (in the Manage Devices tab) to access the Manage Polled Ports page (FIG. 71).
WebConsole - System Options FIG. 72 Manage Polled Ports - Edit Port Settings Use the drop-down menus to modify the Port settings.
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. 73). Use the options on this page to view/edit the Master’s network settings. FIG. 73 System - Manage Devices (Network Settings) ZeroConfig Networking Use these radio buttons to enable/disable the Zero-Configuration (ZeroConfig) client in the Master.
WebConsole - System Options NDP Beacon 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. 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).
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. 76). The options on this page allow you to change the device number on the Master. FIG. 76 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. 78). 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. 79). Diagnostic Options table FIG. 79 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 49.
WebConsole - System Options 80 NI & DVX Central Controllers - WebConsole & Programming Guide
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.
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 Disable/Enable SEND_COMMANDs 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: = Port 1 of the device. Sending to port 1 of the NI-700 affects all ports. LED SEND_COMMANDs Comm and 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 CHARD Set the delay time between all transmitted characters to the value specified (in 100 Microsecond increments). Syntax: SEND_COMMAND ,"'CHARD-
NetLinx Programming RS-232/422/485 SEND_COMMANDs (Cont.) Command Description HSON Enable RTS (ready-to-send) and CTS (clear-to-send) hardware handshaking. Syntax: SEND_COMMAND ,"'HSON'" Example: SEND_COMMAND RS232_1,"'HSON'" Enables hardware handshaking on the RS232_1 device. RXCLR Clear all characters in the receive buffer waiting to be sent 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.
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. The NI series of NetLinx Masters support Serial control via the IR/RX port when using firmware version 300 or greater.
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 PON 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.
NetLinx Programming IR/Serial SEND_COMMANDs (Cont.) Command Description SET IO LINK Link an IR or Serial port to a selected I/O channel for use with the 'DE', 'POD', 'PON', and 'POF' commands. The I/O status is automatically reported on channel 255 on the IR port. The I/O channel is used for power sensing (via a PCS or VSS). A channel of zero disables the I/O link. Syntax: SEND_COMMAND ,"'SET IO LINK '" Variable: I/O number = 1 - 8. Setting the I/O channel to 0 disables the I/O link.
NetLinx Programming IR/Serial SEND_COMMANDs (Cont.) Command Description 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 IR/Serial SEND_COMMANDs (Cont.) XCHM (Cont.) Mode 6 Example: SEND_COMMAND IR_1,"'XCH-3'" Transmits the IR code as 0-0-0-3. SEND_COMMAND IR_1,"'XCH-34'" Transmits the IR code as 0-0-3-4. SEND_COMMAND IR_1,"'XCH-343'" 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 I/O ports: Port 4 (NI-700). Channels: 1 - 8 I/O channels.
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. Syntax: SEND_COMMAND ,"'SET INPUT '" Variable: channel = Input channel 1 - 8.
NetLinx Programming 96 NI & DVX Central Controllers - WebConsole & Programming Guide
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 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 PC COM Port Communication Settings Be sure that your PC's COM port and terminal program's communication settings match those in the table below: PC COM Port Communication Settings • Baud: 38400 (default) • Parity: None • Data Bits: 8 • Stop Bits: 1 • Flow Control: None Establishing a Terminal Connection Via Telnet 1. In your Windows taskbar, go to Start > Run to open the Run dialog. 2.
Terminal (Program Port/Telnet) Commands Terminal Commands The Terminal commands listed in the following table can be sent directly to the Master via either a Program Port or a Telnet terminal session (with the exception of the "Help Security" and "Resetadminpassword" commands, which are only available to a Program Port (RS232) connection.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description DNS LIST 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. GET DEVICE HOLDOFF Displays the state of the Master’s device holdoff setting.
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 RESETADMINPASSWORD This command resets the administrator password back to "password". Note: This command is only available to Program Port terminal sessions. It is not available to Telnet sessions (see the Overview section on page 97). RESET FACTORY Resets the Master to factory default state including removal of all security settings, removal of all user files, resetting to DHCP, and loading an empty NetLinx program.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description SET DNS Sets up the DNS configuration of a device. This command prompts you to enter a Domain Name, DNS IP #1, DNS IP #2, and DNS IP #3. Then, enter Y (yes) to approve/store the information in the Master. Entering N (no) cancels the operation. Note: The device must be rebooted to enable new settings.
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 LOG COUNT Sets the number of entries allowed in the message log. Note: The Master must be rebooted to enable new settings. Example: >SET LOG COUNT Current log count = 1000 Enter new log count (between 50-10000): Once you enter a value and press the ENTER key, you get the following message: Setting log count to New log count set, reboot the Master for the change to take affect.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command SET SECURITY PROFILE Description Secure: • Unsecured interface ports are disabled including HTTP, Telnet and FTP. Only HTTPS and SSH and terminal user ports are available. • All user access requires a username/password login including HTTPS, SSH and terminal. • NetLinx/ICSP security is enabled requiring all NetLinx devices connecting with the Master to provide username/password authentication and encryption.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description SET SECURITY PROFILE (Cont.) Secure and DoD profile configuration can be tailored with more or less security features by manually altering the Master's configuration following the secure profile selection. For example, the Master can be put into "secure" profile and then the HTTP and Telnet interfaces can be manually re-enabled via their existing configuration mechanism.
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. Use extreme caution when adjusting these values. Note: The Master must be rebooted to enable new settings. Example: >SET THRESHOLD -- This will set the thresholds of when particular tasks are pended.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description SHOW AUDIT LOG Displays the User Account Access Audit Log.
Terminal (Program Port/Telnet) Commands Terminal Commands (Cont.) Command Description SHOW DEVICE 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.
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 111), 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 ZEROCONF [ENABLE|DISABLE|STATUS] Enable, disable or view the new Zeroconf client in the Master. When Zeroconf is enabled (default) the Master's web interface will be registered via Zeroconf and can be viewed through a Zeroconf browser plug-in such as Bonjour for IE. ESC Pass Codes There are 'escape' codes in the pass mode. These codes can switch the display mode or exit pass mode.
Terminal (Program Port/Telnet) Commands 6) Show the list of authorized users 7) Add group 8) Edit group 9) Delete group 10) Show list of authorized groups 11) Set Telnet Timeout in seconds 12) Display Telnet Timeout in seconds 13) Enter LDAP security information 14) Test connection to the LDAP server 15) Make changes permanent by saving to flash 16) Reset Database 17) Display Database Or to return to previous menu Security Setup -> 3. The Setup Security menu shows a list of choices and a prompt.
Terminal (Program Port/Telnet) Commands Setup Security Menu (Cont.) Command Description 8) Edit group This selection will prompt you select a Group to edit properties for. Once you have selected the Group you want to edit, it will take you to the Edit Group Menu so you can edit the group's rights (see page 118). 9) Delete group This selection will prompt you select a group to delete. A group can only be deleted if there are no users assigned to that group.
Terminal (Program Port/Telnet) Commands 9) Delete group 10) Show list of authorized groups 11) Set Telnet Timeout in seconds 12) Display Telnet Timeout in seconds 13) Enter LDAP security information 14) Test connection to the LDAP server 15) Make changes permanent by saving to flash 16) Reset Database 17) Display Database Or to return to previous menu Security Setup -> 2. To enable LDAP, enter 1 and press Enter.
Terminal (Program Port/Telnet) Commands Security Options Menu (Cont.) Command Description 3) Telnet Security (Enabled/Disabled) This selection enables/disables Telnet Security. If Telnet Security is enabled, a user must have sufficient access rights to login to a Telnet terminal session. 4) Configuration Security (Enabled/Disabled) This selection enables/disables configuration access rights for the Master.
Terminal (Program Port/Telnet) Commands Edit Group Menu Command Description 5) List Directory Associations This selection will display any current Directory Associations assigned to the group. 6) Change Access Rights This selection will display access the Access Rights menu, which allows you to set the rights assigned to the group. Note: See the Access Rights Menu section (below) for descriptions of each menu item.
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 The administrator user account cannot be deleted or modified with the exception of its password. Only a user with "Change Admin Password Access" rights can change the administrator password. The NetLinx user account is created to be compatible with previous firmware versions. The administrator group account cannot be deleted or modified. The FTP Security and Admin Change Password Security are always enabled and cannot be disabled.
Terminal (Program Port/Telnet) Commands Notes on Specific 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). Most programs will allow you to enter specific decimal codes by holding ALT and using keypad numbers.
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. Please refer to RFC 2256, RFC 2798 and RFC 4519.
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 Administrator Access Example Administrator Access LDAP Server Configuration Master Configuration Example: On the System Security Details page, enter the Administrator groupOfNames cn.
Appendix A: LDAP Implementation Details 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. 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 132 NI & DVX Central Controllers - WebConsole & Programming Guide
Appendix C: Clock Manager NetLinx Programming API NI & DVX Central Controllers - WebConsole & Programming Guide 133
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).
