Operation/Reference Guide NI-3101-SIG Signature Series NetLinx® Integrated Controller NetLinx Controllers Latest Release: 4/14/2008
AMX Limited Warranty and Disclaimer AMX warrants its products to be free of defects in material and workmanship under normal use for three (3) years from the date of purchase from AMX, with the following exceptions: • Electroluminescent and LCD Control Panels are warranted for three (3) years, except for the display and touch overlay components that are warranted for a period of one (1) year.
Introduction ........................................................................................................1 NI-3101-SIG Specifications........................................................................................ 2 Installation and Upgrading .................................................................................7 Device:Port:System (D:P:S) ....................................................................................... 7 Installation into an Equipment Rack.............
Verifying the current version of NetLinx Master Firmware ..................................... 34 Upgrading the On-board Master Firmware via an IP .............................................. 35 Upgrading the NI Controller Firmware via IP.......................................................... 37 NetLinx Security within the Web Server ...........................................................41 NetLinx Security Terms .....................................................................................
Server - Creating a Request for an SSL Certificate ........................................................ 81 Common Steps for Requesting a Certificate from a CA.......................................... 83 Communicating with the CA ......................................................................................... 83 Server - Exporting an SSL Certificate Request .............................................................. 84 Server - Importing a CA created SSL Certificate ........................
Option 3 - Add user .................................................................................................... 121 Option 4 - Edit User .................................................................................................... 122 Option 5 - Delete user................................................................................................. 124 Option 6 - Show the list of authorized users ............................................................... 125 Option 7 - Add Group ...
Introduction Introduction The NI-3101-SIG Signature Series NetLinx Integrated Controller satisfies the control and automation features common in a larger area or multiple rooms, which may include the integration of a larger number of devices including VCR and DVD players, projectors, lighting, thermostats and other electronic equipment. In technology-driven environments, this solution allows for the future addition of more devices and control capabilities.
Introduction NI-3101-SIG Specifications The NI-3101-SIG (FIG. 1) provides support for 6 configurable RS-232/RS-422/RS-485 Ports, 8 IR/ Serial Output ports, 8 Digital Input/Output ports, and 8 Relays. FIG.
Introduction NI-3101-SIG Specifications (Cont.) Front Panel Components: Input/Output LEDs • White Output LED blinks when the Controller transmits data, sets channels On/Off, sends data strings, etc. White Input LED blinks when it receives data from button pushes, strings, commands, channel levels, etc.
Introduction NI-3101-SIG Specifications (Cont.) Digital I/O (Port 17) • Eight-channel binary I/O port for contact closure • Each input is capable of voltage sensing. Input format is software selectable. • Interactive power sensing for IR ports • Channel range = 1-8 • All inputs are assigned to respective IR/Serial ports for "automatic" power control through the use of software commands. Power control is provided via commands such as: ’PON’, ’POF’, ’POD’, ’DELAY’, I/O Link etc.).
Introduction NI-3101-SIG Specifications (Cont.) Rear Panel Connectors (Cont.): AXlink LED • Green LED indicates the state of the AXlink connector port. • Normal AXlink activity = 1 blink/second • Abnormal AXlink activity = cycle of 3 consecutive blinks and then Off AXlink port • 4-pin 3.5 mm mini-Phoenix (male) connector provides data and power to external control devices. Power port • 2-pin 3.5 mm mini-Phoenix (male) connector Included Accessories: • 2-pin 3.
Introduction 6 NI-3101-SIG Signature Series NetLinx Integrated Controller
Installation and Upgrading Installation and Upgrading Device:Port:System (D:P:S) A device is any hardware component that can be connected to an AXlink bus. Each device must be assigned a unique number to locate that device on the bus. Only the Device value can be set through the DIP switch settings mentioned above. NetLinx requires a Device:Port:System (D:P:S) specification. This D:P:S triplet can be expressed as a series of constants, variables separated by colons, or a DEV structure.
Installation and Upgrading Installation into an Equipment Rack Use the rack-mounting ears supplied with the NI-3101-SIG controller for equipment rack installations. The device comes installed with four rubber feet for flat surface installations. The maximum operating ambient temperature is 40°C. Connect the unit only to a properly-rated supply circuit. Never restrict the airflow through the devices’ fan or vents. When installing equipment into a rack, distribute the units evenly.
Connections and Wiring Connections and Wiring Setting the Configuration DIP Switch for the Configuration Port Prior to installing the Controller, use the Configuration DIP switch to set the information used by the Configuration Port for communication. The DIP switchsets the starting address (the device number in the D:P:S specification) for the Control Cards installed in the controller with a range of 1-1536. The four-pin Configuration DIP switch is located on the rear of the device.
Connections and Wiring Configuration Port Connections and Wiring The NI-3101 is equipped with a low-speed USB connection located on the rear of the unit. Use a standard USB cable to establish a connection between the device and your PC's USB port. This connection provides communication with the NetLinx Integrated Controller. From there, configure the on-board Master as needed for your application.
Connections and Wiring Port Assignments and Functionality The rear Port Assignments are as follows: NI-3101 Port Assignments Port ICSP Port # Serial Port #1 1 Serial Port #2 2 Serial Port #3 3 Serial Port #4 4 Serial Port #5 5 Serial Port #6 6 Relays Ports (1-8) 8 IR Serial Port #1 9 IR Serial Port #2 10 IR Serial Port #3 11 IR Serial Port #4 12 IR Serial Port #5 13 IR Serial Port #6 14 IR Serial Port #7 15 IR Serial Port #8 16 I/O Port 17 AXlink Port and LED All NI units
Connections and Wiring Wiring Guidelines The Integrated Controllers use a 12 VDC-compliant power supply to provide power through the rear 2-pin 3.5 mm mini-Phoenix PWR connector, or through the 4-pin 3.5 mm mini-Phoenix (female) captive-wire connector used for data communication and power transfer. Use the power requirements referenced in the product’s Specifications table to determine the power draw.
Connections and Wiring Wiring a power connection To use the 2-pin 3.5 mm mini-Phoenix connector with a 12 VDC-compliant power supply, the incoming PWR and GND cables from the external source must be connected to their corresponding locations on the connector (FIG. 4). 1. Insert the PWR and GND wires on the terminal end of the 2-pin 3.5 mm mini-Phoenix cable. Match the wiring locations of the +/- on both the power supply and the terminal connector. 2. Tighten the clamp to secure the two wires.
Connections and Wiring Using the 4-pin mini-Phoenix connector for data with external power To use the 4-pin 3.5 mm mini-Phoenix (female) captive-wire connector for data communication and power transfer, the incoming PWR and GND cable from the 12 VDC-compliant power supply must be connected to the AXlink cable connector going to the device (FIG. 6). Always use a local power supply to power the device.
Connections and Wiring DB9 Device Port: Connections and Wiring FIG. 7 shows the connector pinouts for the rear RS-232/RS-422/RS-485 (DB9) Device Ports. These ports support most standard RS-232 communication protocols for data transmission. This figure gives a visual representation of the wiring specifications for the RS-232/422/485 Device connectors.
Connections and Wiring Relay connections Use A for common and B for output (FIG. 8). Each relay is isolated and normally open. A metal connector strip is also provided to common multiple relays. RELAYS (Port 8) 8 7 6 5 B A B A B A B A 4 3 2 1 B A B A B A B A NI-3101-SIG relay connector configuration (Port 8) FIG.
Connections and Wiring I/O Port Wiring Specifications - NI-3101-SIG Pin Signal Function 1 GND Signal GND 2 I/O 1 Input/Output 3 I/O 2 Input/Output 4 I/O 3 Input/Output 5 I/O 4 Input/Output 6 I/O 5 Input/Output 7 I/O 6 Input/Output 8 I/O 7 Input/Output 9 I/O 8 Input/Output 10 12 VDC PWR IR/Serial Port: Connections and Wiring Up to eight IR- or Serial-controllable devices may be connected to the IR/Serial connectors on the rear of the NI-3101 (FIG. 10).
Connections and Wiring Ethernet/RJ-45 Port: Connections and Wiring The following table lists the pinouts, signals, and pairing for the Ethernet connector.
Connections and Wiring Ethernet ports used by the Integrated Controllers Ethernet Ports Used by the NetLinx Integrated Controllers Port type Description Standard Port # FTP The on-board Master has a built-in FTP server. 21/20 (TCP) SSH 22 (TCP) The SSH port functions using the same interface as Telnet but over a secure shell where it uses SSL as a mechanism to configure and diagnose a NetLinx system. This port value is used for secure Telnet communication. Note: only SSH version 2 is supported.
Connections and Wiring Replacing the Timekeeper Battery The NI-3101-SIG uses a combination lithium battery and clock crystal package called a Timekeeper. Only one Timekeeper unit is installed within a given NI-3101-SIG. The battery can be expected to have up to 3 years of usable life under very adverse conditions. Actual life is appreciably longer under normal operating conditions.
Configuration and Firmware Update Configuration and Firmware Update This section refers to steps necessary to both communicate with and upgrade the NI-3101-SIG. Before continuing, verify that you are using the latest version of NetLinx Studio and the latest firmware Kit file (this file contains both the NI Integrated Controller and on-board Master firmware). The NI-3101-SIG Kit file begins with 2105_04_X100. Before beginning: 1. Set up and configure the NI-3101-SIG.
Configuration and Firmware Update Communicating with the Master via the Program Port 1. From your computer, launch NetLinx Studio 2.x. 2. Select Settings > Master Communication Settings, from the Main menu, to open the Master Communication Settings dialog box (FIG. 13). FIG. 13 Master Communication Settings dialog box 3. Click the Communications Settings button to open the Communications Settings dialog (FIG. 14). FIG. 14 Communication Settings dialog box 4.
Configuration and Firmware Update No authentication username or password information is required when selecting a direct connection such as USB or Serial. 7. Set the COM port parameters for the selected COM port used for communication to the NetLinx Master. Default parameters are: COM1 115200 8 Data Bits No Parity 1 Stop Bit No Flow Control If communication fails on a known COM port, change the baud rate to 115200 and try again. 8.
Configuration and Firmware Update This tab represents the only way to change the System Number associated to the active on-board NI Master. The Master must have its power cycled to incorporate the new System number, as often a simple reboot via Studio will not be enough to incorporate this new number). 2. Select the Change System selection box from the System to Change section. 3. Enter both the current and new system address values. 4. Click the Change Device/System Number button.
Configuration and Firmware Update Changing the Device Address of a NetLinx Device 1. Access the Device Addressing dialog (FIG. 17) by either one of these two methods: Right-click on any system device (such as a Modero panel) listed in the OnLine Tree tab of the Workspace and select Device Addressing (from the popup list). Select Diagnostics > Device Addressing from the Main menu. Device Address (original device value) Check-Off to verify change Enter new device value FIG.
Configuration and Firmware Update Recommended NetLinx Device numbers • 1 - 255 • Axcess Devices use Axcess standards • 301 - 3072 • NetLinx CardFrames start at frame number 25 - (frame# * 12) + Card # • 5001 - 5999 • ICSNet NetLinx devices: NXI, NXM-COM2, NXM-IRS4, etc.
Configuration and Firmware Update 4. Press the target NI device’s ID button to begin process of reading the current device value of the NI Controller and then assigning it to the new value entered in step 2. Once the swap has been made, a red Successful Identification Made field appears. The previous Device value and associated System number of the targeted NI Controller are then displayed below the red field.
Configuration and Firmware Update Obtaining the Master’s IP Address (using DHCP) Verify there is an active Ethernet connection on the Ethernet port of the NI-Series Controller before beginning these procedures. 1. Select Diagnostics > Network Addresses from the Main menu to access the Network Addresses dialog (FIG. 19). System Address reflects the value set in the Device Addressing tab Used to obtain a Dynamic IP Address FIG. 19 Network Addresses dialog (for a DHCP IP Address) 2.
Configuration and Firmware Update 10. Click Reboot from the Tools > Reboot the Master Controller dialog, and wait for the System Master to reboot and retain the newly obtained DHCP Address. The STATUS and OUTPUT LEDs should begin to blink alternately during the incorporation. Wait until the STATUS LED is the only LED blinking. 11. Press Done once until the Master Reboot Status field reads *Reboot of System Complete*.
Configuration and Firmware Update Assigning a Static IP to the NetLinx Master Verify that the Controller has an active Ethernet connection before beginning these procedures. 1. Select Diagnostics > Network Addresses from the Main menu to access the Network Addresses dialog (FIG. 20). System Address reflects the value set in the Device Addressing tab Used to retain an IP Address FIG. 20 Network Addresses dialog (for a pre-obtained Static IP Address) 2.
Configuration and Firmware Update 12. Complete the communication process by continuing on to the Communicating with the NI Device via an IP section on page 31. Communicating with the NI Device via an IP Whether the on-board Master’s IP Address was Static Set (Set IP Info) or Dynamically obtained (Get IP Info), use the IP Address information from the Network Addresses dialog to establish communication via the Ethernet-connected Integrated Controller. 1. From your PC, launch NetLinx Studio 2. 2.
Configuration and Firmware Update 6. Click the Edit Settings button (on the Communications Settings dialog) to open the TCP/IP Settings dialog (FIG. 23). This dialog contains a series of previously entered IP Address/URLs and their associated names, all of which are stored within NetLinx Studio and are user-editable. FIG. 23 TCP/IP Settings dialog box 7. Click the New button to open the New TCP/IP Setting dialog box (FIG.
Configuration and Firmware Update 12. Press the User Name and Password button to open the Master Controller User Name and Password dialog box (FIG. 25). Within this dialog, enter a previously configured username and password (with sufficient rights) before attempting to connect to the Master. FIG. 25 Master Controller User Name and Password dialog box 13. Click OK to save the newly entered information and return to the previous Communication Settings dialog box.
Configuration and Firmware Update Verifying the current version of NetLinx Master Firmware All NI Controllers contain both an on-board NI Master and an Integrated Controller. The on-board Master shows up within the Online Tree as 00000 NI Master The Integrated Controller of the NI device shows up as 0XXXX NI-XXXX (ex: 050001 NI-700) Each of these components has its own corresponding firmware shown in parenthesis (). 1.
Configuration and Firmware Update Upgrading the On-board Master Firmware via an IP The on-board Master firmware Kit file is not the same as the Integrated Controller Kit file.
Configuration and Firmware Update 7. From within Studio, select Tools > Firmware Transfers > Send to NetLinx Device from the Main menu to open the Send to NetLinx Device dialog (FIG. 27). Verify the target’s System number matches the value listed within the active System folder in the OnLine Tree tab of the Workspace. The Device number is always 0 for the NI Master.
Configuration and Firmware Update 14. Press Done once until the Master Reboot Status field reads *Reboot of System Complete*. 15. Repeat steps 5 - 9 again (the last component will now successfully be installed). 16. Click Close once the download process is complete. The OUTPUT and INPUT LEDs alternately blink to indicate the on-board Master is incorporating the new firmware. Allow the Master 20 - 30 seconds to reboot and fully restart. 17. Right-click the System number and select Refresh System.
Configuration and Firmware Update 7. From within NetLinx Studio, select Tools > Firmware Transfers > Send to NetLinx Device from the Main menu to open the Send to NetLinx Device dialog (FIG. 29). Verify that the target’s System number matches the value listed within the active System folder in the OnLine Tree tab of the Workspace. The Device must match the entry for the on-board Integrated Controller (NI-X000/NI-X000) device.
Configuration and Firmware Update If the connection fails to establish, a Connection Failed dialog appears. Try selecting a different IP Address if communication fails. Press the Retry button to reconnect using the same communication parameters. Press the Change button to alter the communication parameters and repeat steps 2 thru 11.
Configuration and Firmware Update 40 NI-3101-SIG Signature Series NetLinx Integrated Controller
NetLinx Security within the Web Server NetLinx Security within the Web Server NetLinx Masters incorporate built-in security for HTTPS and Terminal sessions (enhanced with SSL and SSH respectively), ICSP data verification/encryption, and Server Port configuration. By using both SSL certificate verification and encryption over a secured HTTP (HTTPS) connection, this version of NetLinx firmware provides users with a more convenient web-based method of securing both the Master and its data communications.
NetLinx Security within the Web Server The third layer of protection is an SSL Certificate (specifically identifying the target Master and using a unique key to encrypt data). SSL works by using a private key to encrypt data that's transferred over the SSL connection. By default, current Masters are shipped with a default AMX SSL certificate called sslexample.amx.com. This pre-configured certificate can be used as a road map to create a unique certificate.
NetLinx Security within the Web Server Accessing an Unsecured Master via an HTTP Address Refer to theUpgrading the On-board Master Firmware via an IP section on page 35 for more detailed information on how to download the latest firmware from www.amx.com. This firmware build enables SSL certificate identification and encryption, HTTPS communication, ICSP data encryption, and disables the ability to alter the Master security properties via a TELNET session.
NetLinx Security within the Web Server Browser Application Frames A web page (FIG. 30) can be divided into separate sections or frames, each of which can be independent of one another and display their own information. Located on the left side of the populated Browser window is the Navigation frame which allows a user to navigate throughout the application.
NetLinx Security within the Web Server If a user is not currently logged-into the Master (via the initial Login screen) and they attempt to access a feature wherein authentication is required, they are prompted with a message to log into the Master (via the Log In button) (FIG. 31). After the user’s information and rights are confirmed, the login process is successfully completed and the button changes state and displays Log Out.
NetLinx Security within the Web Server The administrator user account cannot be deleted or modified with the exception of its password. Only a user with both Configuration access and administrator rights can alter the administrator’s password. The NetLinx user account was created to be compatible with previous NetLinx Master firmware versions. This account is initially created by default and can later be deleted or modified. The administrator group account cannot be deleted or modified.
NetLinx Security within the Web Server Web Control This section of the Navigation frame contains the Mange Connections feature which allows control of compatible devices communicating with the target Master. Managing WebControl Connections This page (FIG. 32) is accessed by clicking on the Manage connections link. Once activated, this page displays links to G4 panels running the latest G4 Web Control feature. G4 panels Compatible devices field (showing G4 WebControl links) Compression Options FIG.
NetLinx Security within the Web Server The following table lists the features available to an administrator or other authorized user from the Manage WebControl Connections page: Manage WebControl Connection Page Features Feature Description Compatible Devices Field: This area displays G4 icons (with associated links) if a G4 panel running Web Control is communicating with the target Master.
NetLinx Security within the Web Server The following table lists the NetLinx System Security options that can be granted or denied by an administrator or other authorized user: Security Features Feature Description System Level: Provides an authorized user with the ability to alter the current security options of the system assigned to the target Master.
NetLinx Security within the Web Server Requiring verification from a communicating AMX software (such as NetLinx Studio v 2.4 or TPD4 v 2.5) before accepting communication for file/firmware transfers, the Configuration, ICSP Connectivity and Require Encryption options must be enabled. Security Level features NetLinx Master security features Require Encryption option (enable/disable) FIG.
NetLinx Security within the Web Server System Level Security Page (Cont.) Feature Description Telnet Access: This selection determines if a username and password is required for Telnet Access (see FIG. 35). • If Telnet access is enabled, a username and password is required before allowing communication over either the Telnet and/or SSH Ports. SSH version 2 is only supported. • This authorized user must have sufficient access rights to login through a Telnet session to the Master.
NetLinx Security within the Web Server The following graphic illustrates the Ports which can be enabled for the validation of rights by using a valid username and password. When one of the above options is enabled, the Master then requires the entry of a valid username and password to validate rights for that action and then grant or deny access.
NetLinx Security within the Web Server 4. Click on the desired access parameters and configuration checkboxes necessary to require user validation prior to usage. Security Level features NetLinx Master security features Require Encryption option (enable/disable) FIG. 36 System Level Security - Enable/Disable System Security page with selections Enabling the Terminal, HTTP, and Telnet Access options require that a valid username and password be entered prior to gaining access to the desired action.
NetLinx Security within the Web Server ICSP Authentication In a Master-to-Master system, the Master which accepts the IP connection initiates the authentication process. This configuration provides compatibility with existing implementations and provides more flexibility for the implementation of other devices. Security - Group Level Security page To access this page, click the Group Level link (from within the Security section of the Navigation frame). This page (FIG.
NetLinx Security within the Web Server Configure Group Properties Page Feature Description Configure Group Properties: This page allows an authorized user to configure the options for either a pre-existing or new group. Configuration on this page consists of both the options and directories to which the group is granted access. Update • This button submits the modified page (form) information back to the server.
NetLinx Security within the Web Server Adding a new Group 1. Click the Group Level link (from within the Security section of the Navigation frame) to open the Manage Groups page. 2. Click the New button to be transferred to the Configure Group Properties page (FIG. 37). 3. From within the Group Security Details section, enter a unique name for the new group. The name must be a valid character string consisting of 4 - 20 alpha-numeric characters.
NetLinx Security within the Web Server Deleting an existing Group 1. Click the Group Level link (from within the Security section of the Navigation frame) to open the Manage Groups page. 2. Press the Select button (next to the selected Group name) to open the Configure Group Properties page (FIG. 37) for the particular group. 3. Click the Delete button to remove the selected group and return to the Manage Groups page.
NetLinx Security within the Web Server Security - User Level Security page To access the User Level Security page (FIG. 38), click on the User Level link (from within the Security section of the Navigation frame). This page allows an authorized user to add a user account (FIG. 30) and then assign that user’s current access rights. Configure User Properties page (adding a new user) Manage Users page FIG.
NetLinx Security within the Web Server Configure User Properties Page Feature Description Configure User Properties: This page allows an authorized user to configure the options for either a pre-existing or new user. Configuration on this page consists of both the options and directories to which the user is granted access. Update • This button submits the modified page (form) information back to the server.
NetLinx Security within the Web Server Configure Users Properties Page (Cont.) Feature Description User Security Details (Cont.): Encrypt ICSP Connection • This selection enables encryption of the ICSP communication. Password/Password Confirm Enter a password for the new user. • This checkbox is greyed-out until ICSP Access is enabled. • A user password is a valid character string (4 - 20 alpha-numeric characters) that is used to supplement the username/ID in defining the potential client.
NetLinx Security within the Web Server 9. Click the Back button to return to the Manage User page. Modifying the properties of an existing User 1. Click the User Level link (from within the Security section of the Navigation frame) to open the Manage Users page. The fields displayed when modifying users are the same as those available when adding a new user, except for the pre-populated User Name field. 2.
NetLinx Security within the Web Server Deleting an existing User 1. Click on the User Level link (from within the Security section of the Navigation frame) to open the Manage Users page. 2. Press the Select button next to the selected Username to open the Configure User Properties page (FIG. 38) for the particular user. 3. Click the Delete button to remove the selected user and return to the Manage Users page. The NetLinx account can be deleted from the Manage User page.
NetLinx Security within the Web Server System Settings - Manage System page To view all of the available options within the right frame, it is recommended that you maximize the browser window. To access this page (FIG. 41), click on the Manage System link (from within the System Settings section of the Navigation frame).
NetLinx Security within the Web Server System Number (purple) Devices (violet) Ports (blue) Commands (orange) Strings (red) Channels (green) Levels (yellow) FIG. 42 System - Online Tree frame Manage System Page Components (Cont.) Feature Description Management menu options: These management buttons change depending on the source chosen from the Online Tree. • There are three menu groupings available: - System Menu (to configure Master properties).
NetLinx Security within the Web Server Manage System Page Components (Cont.) Feature Description Device menu buttons: The selected system number: device number are displayed below these menu buttons. Network Settings • Allows a user to configure the network IP/DNS settings. URL List • Allows a user to setup the URL List for the specified device. Device Number • Allows a user to change the device number of a selected device.
NetLinx Security within the Web Server Manage System - System Menu Buttons These buttons appear (on the right) when a user clicks on the purple System icon from within the Online Tree. The selected system number is displayed below these System menu buttons. System Menu - Modifying the Date/Time 1. Click the Manage System link (from within the System Settings section of the Navigation frame). 2.
NetLinx Security within the Web Server System Menu - Changing the System Number 1. Click the Manage System link (from within the System Settings section of the Navigation frame). 2. Click on the purple System icon from within the Online Tree to open the System menu buttons within the right frame. 3. Click the System Number button to open the Change System Number dialog (FIG. 44). This dialog shows the current system number (read-only) on the target Master. Current System Number FIG.
NetLinx Security within the Web Server 1. Click the Manage System link (from within the System Settings section of the Navigation frame). 2. Clicking on any of the Online Tree items opens menu items with the Control/Emulate button option available. 3. Click the Control/Emulate button to open the Control/Emulate dialog (FIG. 45). 4. Click the Update Status button to query the Master for the status of the currently entered level and channel.
NetLinx Security within the Web Server The Device, Port, and System value ranges are 1 - 65535. 7. Within the Channel Code section, enter a valid Channel number to emulate Channel messages (i.e., Push/Release, CHON, and CHOFF) for the specified . The Channel number range is 1 - 65535. 8. Select the On or Off buttons to Emulate Channel ON (CHON) and Channel OFF (CHOFF) messages for the specified . 9. Select the Push button to Emulate a push/release on the channel specified.
NetLinx Security within the Web Server Manage System - Diagnostics This page allows an authorized user to setup and monitor diagnostic messages coming from and going to devices available on the Online Tree. This dialog also allows the user to watch the ICSP commands being sent to/from a device. There are several different types of asynchronous notifications that can be selected for a device:port:system (D:P:S) combination. Each notification type is represented by a column in the table.
NetLinx Security within the Web Server Setting up and removing a Diagnostic Filter 1. Setup a diagnostic filter by scrolling down the page and clicking the Modify button below the first empty column. This action opens the Device Configuration dialog as a secondary popup window. Up to 8 concurrent diagnostic filter slots can be simultaneously active using any eight of the 10 available user-configurable Presets available through the Device Configuration dialog. 2.
NetLinx Security within the Web Server Diagnostic Configuration Dialog (Cont.) Feature Description Presets: This list of up to 10 presets comes defaulted with Preset 0: All Devices, All Notifications • Store: Save the current notification selections to a Preset profile. Pressing this button opens a popup field labeled Explorer User Prompt - Preset Name? where you enter the name associated with this new Preset.
NetLinx Security within the Web Server 5. Remove a diagnostic filter by clicking the Modify button below it (from the Diagnostics dialog), then pressing the Remove button to delete this filter from the Diagnostics dialog. Once a Preset is assigned to a specific Diagnostic filter "slot" (up to 8), its System:Device:Port fields are greyed-out, and can’t be modified unless the Preset in that slot is removed and replicated with new information within these fields.
NetLinx Security within the Web Server Setting the Master’s Port Configurations Manage System - Server This page allows a user to both change the port numbers (used for various Web services) and configure the SSL settings used on the Master by bringing up a submenu of options such as: Server Submenu Options Feature Description Port Settings: Allows a user to modify the server settings; specifically those port assignments associated with individual services.
NetLinx Security within the Web Server The following graphic illustrates the Ports which can be enabled for validation using a valid username and password, as well as what method of communication is used with each.
NetLinx Security within the Web Server Modifying the Server Port Settings 1. From within the Server submenu, press the Port Settings button to open the Server Port Settings dialog seen above in FIG. 47. 2. Uncheck any services (and corresponding ports) to disable their functionality. 3. Modify any preset service port value by first enabling that service with a checkmark within the Enabled checkbox and then entering a value within the Port Number field.
NetLinx Security within the Web Server Server Port Settings (Cont.) Feature Description HTTPS/SSL Port: The port value used by web browser to securely communicate between the web server UI and the target Master. This port is also used to simultaneously encrypt this data using the SSL certificate information on the Master as a key. • The default port value is 443.
NetLinx Security within the Web Server SSL Server Certificate Creation Procedures Initially, a NetLinx Master is not equipped with any installed certificates. In order 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.
NetLinx Security within the Web Server This page allows an authorized user to display an installed certificate, create a certificate request, selfgenerate, and regenerate SSL Server Certificates. Server Certificate Entries Feature Description Server Certificate Field Information: Update Updates the target Master with the information entered on this page. • This process can take a few minutes. Bit Length Provides a drop-down selection with three available public key lengths: 512, 1024, and 2048.
NetLinx Security within the Web Server Server - Display SSL Server Certificate Information 1. Navigate to the Server Certificate page by clicking System Settings > Manage System > Server > Create SSL Certificate to open the Server Certificate page. By default, the Display Certificate Action is selected and these fields are populated with information from an installed certificate. If the Master does not have a previously installed certificate, these fields are blank. 2.
NetLinx Security within the Web Server ONLY use the Regenerate certificate option when you have Self Generated your own certificate. DO NOT regenerate an external CA-generated certificate. Server - Regenerating an SSL Server Certificate Request 1. Navigate to the Server Certificate page by clicking System Settings > Manage System > Server > Create SSL Certificate to open the Server Certificate page.
NetLinx Security within the Web Server 4. Enter the name of the business or organization into the Organization Name field. This is an alphanumeric string, 1 - 50 characters in length. 5. Enter the name of the department using the certificate into the Organizational Unit field. This is an alpha-numeric string, 1 - 50 characters in length. 6. Enter the name of the city where the certificate resides into the City/Location field. This is an alphanumeric string, 1 - 50 characters in length. 7.
NetLinx Security within the Web Server Common Steps for Requesting a Certificate from a CA Once the request has begun, a user has the choice to either remain using their self-generated SSL certificate or obtain a CA created certificate by exporting their request for the certificate and then, once received, import the returned certificate information onto the Master. Communicating with the CA A certificate is a cryptographically signed object that associates a public key and an identity.
NetLinx Security within the Web Server Server - Exporting an SSL Certificate Request 1. First follow the procedures outlined in theServer - Creating a Request for an SSL Certificate section on page 81 to begin the process of requesting an SSL by creating a session-specific Master certificate. 2. Click the Export Certificate Request button to display the certificate text file within the Server Certificate page (FIG. 50). Certificate text field FIG. 50 Export SSL Certificate dialog 3.
NetLinx Security within the Web Server 11. Once the returned CA certificate has been received, follow the procedures outlined in the following section to import the returned certificate (over a secure connection) to the target Master. Server - Importing a CA created SSL Certificate Before importing a CA server certificate: First, have a self-generated certificate installed onto the target Master.
NetLinx Security within the Web Server 5. Use the Server > Create SSL Certificate > Display Certificate option to confirm that the new certificate was imported properly to the target Master. A CA server certificate can only be imported to a target Master only after both a self-generated certificate has been created and the SSL Enable feature has been selected on the Master. These actions configure the Master to the secure communication necessary during the importing of the CA certificate.
NetLinx Security within the Web Server Network Settings Dialog Feature Description IP Address: Host Name Use this field to view/edit the target Master's current Host Name. DHCP/Specify IP Address Use these radio buttons to specify an address for the target Master: • DHCP - obtained from a DHCP Server. • Specify an IP Address - typically obtained from a System Administrator. IP Address Use this field to view/edit the target Master's current IP Address.
NetLinx Security within the Web Server Device Menu - Developing a URL List 1. Click the System Settings > Manage System link from within the System Settings section of the Navigation frame. 2. Click on a violet Device icon from within the Online Tree to open the Device menu buttons within the right frame. 3. Click the URL List button to open the URL List dialog (FIG. 53). This dialog allows the user to view, add, and remove URLs from the specified devices URL list.
NetLinx Security within the Web Server 10. Confirm that the newly added URLs appear within the URL List dialog (FIG. 54). Successful connection established Connection could not be made Attempting to connect FIG. 54 URL List dialog (with entries) If the newly added URL doesn’t appear on this page, click the Refresh button. 11.
NetLinx Security within the Web Server 5. Click the Update button to save this new value to the device. The following message; "Device number changed to XXX. Device must be rebooted for the change to take effect.", reminds the user that the Master must first be rebooted before the new settings take effect. Device Menu - Controlling or Emulating a device Refer to the procedures outlined within theSystem Menu - Controlling/Emulating Devices on the Master section on page 67 for more information.
NetLinx Security within the Web Server System Settings - Manage License This page (FIG. 57) displays both the currently used license keys and the pending keys. New button allows for the addition of new license keys Shows exiting license keys FIG. 57 System Settings - Manage License page The New button allows for the addition of new license keys associated with currently used modules/products. Adding new License Keys requires the use of both a Product ID and a Serial Key.
NetLinx Security within the Web Server 4. Contact the AMX Sales department with both the product serial number (or certificate number) and the serial number of target Master to register your product and in turn receive the necessary Key information (typically 32 to 36 digits in length) which is then entered into the Key fields on this page. The Key is Master specific and is typically provided by AMX upon registration.
NetLinx Security within the Web Server System Settings - Manage NetLinx Devices To access this page, click on the Manage NetLinx Devices link (from within the System Settings section of the Navigation frame). These pages (FIG. 59) have some additions that have been incorporated as part of build 323 (or higher). These features include the display the device status as well as some background color changes which indicate system groupings.
NetLinx Security within the Web Server Manage NetLinx Devices Page (Cont.) Feature Description Device Listings: • This page (in addition to the target Master which is typically the first entry) lists those NetLinx Masters which have sent out NetLinx Discovery Master Announce packets (NDPs). • Each entry contains the data necessary to describe the devices detected by the system.
NetLinx Security within the Web Server Manage NetLinx Devices - Displaying NDP-capable devices Note that in the previous example (FIG. 59), the first NetLinx Master has a "+" icon next to it, which shows that this Master is indicating the presence of NDP-capable devices currently connected to it. 1. Click the "+" icon to expand the particular Master’s listing and reveal those NDP-capable devices connected to it, as shown below in FIG. 60.
NetLinx Security within the Web Server Manage NetLinx Devices - Obtaining NetLinx Device information To obtain more description than is provided by the listing: 1. Hover the cursor over a particular device within the listing to display a mouse-over popup dialog (FIG. 61). This field illustrates the MAC Address of the Master. NetLinx Master’s associated property information (displayed via a mouse-over popup dialog) FIG.
NetLinx Security within the Web Server System Settings - Manage Other Devices - Dynamic Device Discovery Pages Before beginning to manage any other devices, the target Master must be loaded with the program which defines the new devices and modules. In addition to this code, all IP/Serial devices must be pre-configured and connected to the system. To access this page, click on the Manage Other Devices link (from within the System Settings section of the Navigation frame). This page (FIG.
NetLinx Security within the Web Server Manage Other Devices Page Feature Description Dynamic Device Discovery links: These links direct the user to additional Dynamic Device Discovery (DDD) configuration pages which include: • Manage Device Bindings page is used for configuring application-defined Duet virtual devices by using discovered physical devices.
NetLinx Security within the Web Server Manage Other Devices Page (Cont.) Feature Description Configure Binding Options (Cont.): Enable Subnet Match This selection allows an end-user to toggle whether or not IP devices should only be detected/discovered if they are on the same IP Subnet as the Master. Purge Bound Modules on Reset • This selection indicates that all modules should be deleted from the /bound directory upon the next reboot.
NetLinx Security within the Web Server Manage Other Devices Page (Cont.) Feature Description Delete Selected • Clicking this button deletes a 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 previous Configure Device Bindings section.
NetLinx Security within the Web Server What is Dynamic Device Discovery? The Dynamic Device Detector (DDD) monitors the system for newly connected devices. New devices can be detected via either an external discovery protocol manager (built into firmware build 320 or higher), Multicast reception of a Dynamic Device Beacon, or via the receipt of a beacon response on an application specified list of serial devices.
NetLinx Security within the Web Server What is the difference between Program and Run-time defined binding? In DDD, the device discovery activity is always dynamic because the devices will always be detected at run-time. Note that DDD splits the binding activity into two different categories: Program defined binding (also known as static) Run-time defined binding (also known as dynamic).
NetLinx Security within the Web Server Configuring application-defined devices Elements such as DUET_DEV_TYPE_DISC_DEVICE and DUET_DEV_POLLED are defined within the NetLinx axi. The latest version of the NetLinx.axi file contains both the new API definitions, as well as the pre-defined constants that are used as some of the API arguments (ex: DUET_DEV_TYPE_DISC_DEVICE). Sample code can be found within the DEFINE_START section seen in FIG.
NetLinx Security within the Web Server FIG. 65 Manage Device Bindings page - showing the NetLinx code relation Dynamic application devices (Bind/Unbind) Static bound application devices (blank/Release) Device’s associated property information (displayed via a mouse-over popup dialog) FIG. 66 Manage Device Bindings page Dynamic application devices specify both the Duet virtual device and its associated Device SDK with no association to a physical port.
NetLinx Security within the Web Server its associated property information is then displayed in a mouse-over popup dialog when the cursor hovers over the physical device ID. Each entry in the table has one of four values appear within the far right of the Manage Device Bindings page (FIG. 66). Static bound application devices will either be blank or display a Release button. - Static application devices that have not yet detected a physical device attached to their associated port are left blank.
NetLinx Security within the Web Server If the manufacturer device does not support Dynamic Device Discovery (DDD) beaconing, you must use the Add New Device page to both create and manage those values necessary to add a dynamic physical device. This process is described in detail within the following section. Manage Other Devices Menu - Viewing Discovered Devices This page (FIG. 68) provides a listing with all of the dynamic devices that have been discovered in the system.
NetLinx Security within the Web Server Once a list of all compatible modules is compiled, the Select Device Module page (FIG. 69) is then displayed with a listing of each module along 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. Module Properties (displayed via a mouse-over popup dialog) FIG.
NetLinx Security within the Web Server Manage Other Devices Menu - Creating a new User-Defined Device This page provides the ability to both add and remove any user-defined devices. Existing user-defined devices are listed at the bottom of the display along with a corresponding Remove button alongside each new entry. Although FIG. 70 shows a populated page, by default, all fields are blank and no devices are pre-populated. List of discovered physical devices (manually entered info) FIG.
NetLinx Security within the Web Server 6. Enter the name of the manufacturer for the device being used (up to 55 alpha-numeric characters) (ex: Sony, ONKYO, etc.) into the Make field. Either the GUID or Make/Model must be specified within this field. Note that spaces in the name will be converted to underscores. 7. Enter the model number of the device being used (up to 255 alpha-numeric characters) (ex: Mega-Tuner 1000) into the Model field.
NetLinx Security within the Web Server 3. To configure a Dynamic application interface: Add the DYNAMIC_APPLICATION_DEVICE API call to the section of the NetLinx program (FIG. 65 on page 104) containing the Duet Virtual Device D:P:S, the Duet Device type constant, and the associated friendly name string. - DYNAMIC_APPLICATION_DEVICE specifies a Duet device that is completely dynamic.
NetLinx Security within the Web Server The installer can then select which module to use with that discovered device by selecting the corresponding radio box and then clicking the upper-left Save button. This action then returns the installer back to the View Discovered Devices page. If the installer has the Duet module on a PC, the file can be downloaded to the Master via the Manage Device Modules section of the Manage Other Devices web page (FIG. 63 on page 97). 3.
NetLinx Security within the Web Server 4. The user is then presented with a Security Alert popup window and Certificate information (FIG. 71). FIG. 71 Security Alert and Certificate popups The above alert only appears if an SSL Server Certificate has been installed on the target Master, the SSL Enable options has been enabled, from within the Enable Security window of the Security tab, and there is a problem with the site’s certificate.
NetLinx Security within the Web Server 7. The user is then presented with a Certificate Import Wizard that begins the process of adding the certificate (FIG. 72). FIG. 72 Certificate Import Wizard 8. Click Next to proceed with the certificate importation process. FIG. 73 Certificate Import Wizard- storing the certificate 9. Click Next to automatically use the default certificate store settings and locations (FIG. 73). 10. Click Finish button to finalize the certificate installation process. 11.
NetLinx Security within the Web Server Using your NetLinx Master to control the G4 panel Refer to the specific panel instruction manual for detailed information on configuring and enabling WebControl. This firmware build enables SSL certificate identification and encryption, HTTPS communication, ICSP data encryption, and disables the ability to alter the Master security properties via a TELNET session. Once the Master’s IP Address has been set through NetLinx Studio version 2.4 or higher: 1.
NetLinx Security within the Web Server 7. This Manage WebControl Connections page (FIG. 74) is accessed by clicking on the Manage connections link (within the Web Control section within the Navigation frame). Once activated, this page displays links to G4 panels running the latest G4 Web Control feature (previously setup and activated on the panel). G4 panels Compatible devices field (showing G4 WebControl links) Compression Options FIG.
NetLinx Security within the Web Server 10. Some circumstances might open a Connection Details dialog (FIG. 76) requesting a VNC Server IP Address. This is not the IP of the Master but of the target touch panel. Depending on which method of communication you are using, it can be found in either the: Wired Ethernet - System Connection > IP Settings section within the IP Address field. Wireless - Secondary Connection > IP Settings section within the IP Address field.
NetLinx Security with a Terminal Connection NetLinx Security with a Terminal Connection NetLinx Masters currently have built-in security capabilities. They require a user entering a valid username and password to access the NetLinx System’s Telnet, HTTP, ICSP, and FTP services. The security capabilities are configured and applied via a Telnet connection or the NetLinx Master’s RS232/USB terminal interface (the RS232/USB Configuration Port).
NetLinx Security with a Terminal Connection Initial Setup via a Terminal Connection Security administration and configuration is done via a Terminal communication through the RS232/ USB Configuration Port on the NetLinx Master. If connecting to the target Master via the TCP/IP (Winsock) option, some command sets (such as the security setup) will not be available.
NetLinx Security with a Terminal Connection 2.
NetLinx Security with a Terminal Connection If you answer y for yes, security will be enabled and you will be taken to the Security Options Menu. If you answer n for no, all security settings (except FTP security) will remain disabled and you will be taken back to the Main Security Menu. The Security Options Menu is displayed as follows: Select to change current security option 1) Terminal (RS232) Security.................. Enabled 2) HTTP Security.............................. Disabled 3) Telnet Security.
NetLinx Security with a Terminal Connection The items in the Security Options Menu are described below: Security Options Menu Command Description 1) Terminal (RS232/USB) Security (Enabled/Disabled) This selection enables/disables Terminal Security (through the USB connector). If Terminal Security is enabled, a user must have sufficient access rights to login to a Terminal session. 2) HTTP Security (Enabled/Disabled) This selection enables/disables HTTP (Web Server) Security.
NetLinx Security with a Terminal Connection 2. At the Enter username prompt, enter a new username (for example "techpubs"). A username is a valid character string (4 - 20 alpha-numeric characters) defining the user. This string is case sensitive. Each username must be unique. 3. Press to enter the new username. The session then prompts you for a password for the new user. 4. Enter a password for the new user.
NetLinx Security with a Terminal Connection 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. 2) Change Inherits From Group This selection will display the current group the user is assigned to (if any). It will then display a list of current groups and prompts you to select the new group.
NetLinx Security with a Terminal Connection Press to exit the menu and return to the previous menu. The Access Rights Menu is described in the following table: Access Rights Menu Command Description 1) Terminal (RS232/USB) Access (Enable/Disable) Enables/disables Terminal Access through the USB connector. The account has sufficient access rights to login to a Terminal session if this option is enabled.
NetLinx Security with a Terminal Connection Option 6 - Show the list of authorized users 1. Type 6 and at the Security Setup prompt (at the bottom of the Main Security Menu) to view a list of currently enrolled users. 2. Press to return to the Security Setup menu. Option 7 - Add Group 1. Type 7 and at the Security Setup prompt (at the bottom of the Main Security Menu) to add a group account.
NetLinx Security with a Terminal Connection A single '/' is sufficient to grant access to all files and directories in the user directory and it's subdirectory. The '*' wildcard can also be added to enable access to all files. All entries should start with a '/'. Here are some examples of valid entries: Path Notes / Enables access to the user directory and all files and subdirectories in the user directory. /* Enables access to the user directory and all files and subdirectories in the user directory.
NetLinx Security with a Terminal Connection Edit Group menu: Change Access Rights 1. At the Edit Group prompt, type 4 to change the current access rights for the selected group account. A sample session response is: Select to change current access right 1) Terminal (RS232) Access................. Disabled 2) Admin Change Password Access............ Disabled 3) FTP Access.............................. Disabled 4) HTTP Access............................. Enabled 5) Telnet Access...........................
NetLinx Security with a Terminal Connection 2. Select a group from the list of currently enrolled groups and press to open the Edit Group Menu. This is the same Edit Group Menu that was access via the Add Group option: 1) Add Directory Association 2) Delete Directory Association 3) List Directory Associations 4) Change Access Rights 5) Display Access Rights Or to return to previous menu Edit group -> This menu is described on the previous pages (see Edit Group Menu section on page 125).
NetLinx Security with a Terminal Connection Option 12 - Display Telnet Timeout in seconds This feature is disabled after the installation of firmware build 130 or higher onto your target Master. 1. Type 12 and at the Security Setup prompt (at the bottom of the Main Security Menu) to view the current Telnet Timeout value (in seconds). A sample session response is: Telnet Timeout is 10 seconds. 2. Press to return to the Security Setup Menu.
NetLinx Security with a Terminal Connection Main Security Menu The Main Security menu is described below: Main Security Menu Command Description This selection will bring up the Security Options Menu that allows you to change the security options for the NetLinx Master (refer to theSecurity Options Menu section on page 121 for details). These are "global" options that enable rights given to users and groups.
NetLinx Security with a Terminal Connection Main Security Menu (Cont.) Command Description 13) Make changes permanent by saving to When changes are made to the security settings of the flash 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.
NetLinx Security with a Terminal Connection The FTP Security and Admin Change Password Security are always enabled and cannot be disabled. Help menu Type help at the prompt in the Telnet session to display the following help topics: Help Menu Options Command ----- Help ----- Description (Extended diag messages are OFF) : Device:Port:System. If omitted, assumes Master. ? or Help Displays this list. DATE Displays the current date.
NetLinx Security with a Terminal Connection Help Menu Options (Cont.) Command SEND_COMMAND D:P:S or NAME,COMMAND Description Sends the specified command to the device. The Command uses NetLinx string syntax. • Ex: send_command 1:1:1,"'This is a test',13,10" • Ex: send_command RS232_1,"'This is a test',13,10" SEND_STRING D:P:S or NAME,STRING Sends the specified string to the device. SET DATE Sets the current date. SET DNS Sets up the DNS configuration of a device.
NetLinx Security with a Terminal Connection Logging Into a Session Until Telnet security is enabled, a session will begin with a welcome banner. Welcome to NetLinx v3.01.320 Copyright AMX Corp. 1999-2005 > The welcome banner is not displayed for Terminal sessions. It is very important for a user properly execute the 'logout' command prior to disconnecting from a Master.
NetLinx Security with a Terminal Connection Logout The logout command will log the user out of the current secure telnet session. For a Terminal session, the user will be logged out and to access Terminal commands again the user will first have to login. It is very important for a user properly execute the 'logout' command prior to disconnecting from a Master.
NetLinx Security with a Terminal Connection 136 NI-3101-SIG Signature Series NetLinx Integrated Controller
Programming Programming This section describes the Send_Commands, Send_Strings, and Channel commands you can use to program the Integrated Controller. 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.
Programming Master Send_Commands (Cont.) Command Description G4WC The internal G4WC Send command (to Master 0:1:0) has been revised to add G4 WebControl devices to Web control list displayed in the browser. Add G4 Web Control devices to Web control list displayed by the Web server in a browser. Syntax: SEND_COMMAND ,"'G4WC "Name/Description",IP Address/URL,IP Port,Enabled'" Variables: Name/Description = A string, enclosed in double quotes, that is the description of the G4 Web Control instance.
Programming Master IP Local Port Send_Commands These commands are specific to the Master and not the Controller. These commands are sent to the DPS 0:1:0 (the Master). A device must first be defined in the NetLinx programming language with values for the Device: Port: System. In these programming examples, = Device. The term = Device:Port:System. Master IP Local Port Send_Commands Command Description This is only available for Type 2 and Type 3 Local Ports.
Programming Device:Port:System (D:P:S) A device is any hardware component that can be connected to an AXlink or ICSNet bus. Each device must be assigned a unique number to locate that device on the bus. The NetLinx programming language allows numbers in the range 1-32,767 for ICSNet (255 for AXlink). NetLinx requires a Device:Port:System (D:P:S) specification. This D:P:S triplet can be expressed as a series of constants, variables separated by colons, or a DEV structure.
Programming In your terminal program, type "Help" or a question mark ("?") and to display the Configuration Port commands listed in the following table. Configuration Port Commands Command DATE Description Displays the current date and day of the week. Example: >DATE 10/31/2004 Wed DEVICE HOLDOFF ON|OFF Sets the Master to holdoff devices and not allow them to report online until the NetLinx program has completed executing the DEFINE_START section. Example: >Device Holdoff ON Device Holdoff Set.
Programming Configuration Port Commands (Cont.) Command GET DUET MEMORY Description Display the amount of memory allocated for Duet Java pool. This is the current Java memory heap size as measured in Megabytes. An example is a value of 5 = 5 MB. GET ETHERNET MODE Displays the current ethernet configuration setting.
Programming Configuration Port Commands (Cont.) Command OFF Description Turns off a channel on a device. The device can be on any system the Master you are connected to can reach. You can specify the device number, port, and system, or the name of the device that is defined in the DEFINE_DEVICE section of the program. Syntax: OFF[name,channel] -orOFF[D:P:S,channel] Example: >OFF[5001:7:4] Sending Off[5001:7:4] ON Turns on a channel on a device.
Programming Configuration Port Commands (Cont.) Command PULSE Description Pulses a channel on a device on and off. The device can be on any system the Master you are connected to can reach. You can specify the device number, port, and system; or the name of the device that is defined in the DEFINE_DEVICE section of the program. Example: >PULSE[50001:8:50,1] Sending Pulse[50001:8:50,1] PWD Displays the name of the current directory.
Programming Configuration Port Commands (Cont.) Command SET DATE Description 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. This will not update clocks on devices connected to another Master (in Master-to-Master systems).
Programming Configuration Port Commands (Cont.) Command SET HTTP PORT Description Sets the IP port listened to for HTTP connections. Example: >SET HTTP PORT Current HTTP port number = 80 Enter new HTTP port number (Usually 80) (0=disable HTTP) : Setting HTTP port number to New HTTP port number set, reboot the master for the change to take effect. SET HTTPS PORT Sets the IP port listened to for HTTPS connections.
Programming Configuration Port Commands (Cont.) Command SET LOG COUNT Description Sets the number of entries allowed in the message log. 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. SET QUEUE SIZE Provides the capability to modify maximum message queue sizes for various threads.
Programming Configuration Port Commands (Cont.) Command SET THRESHOLD Description Sets the Master's internal message thresholds. Example: >SET THRESHOLD -- This 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.
Programming Configuration Port Commands (Cont.) Command SHOW BUFFERS Description Displays a list of various message queues and the number of buffers in each queue Example: show buffers Thread TX RX Queued ----------- ---- ---- ---Axlink 0 UDP 0 0-Sent=NO Waiting=NO IPCon Mgr 0 Con Manager 0 Interpreter 0 Device Mgr 0 Diag Mgr 0 Msg Dispatch 0 Cfg Mgr 0 Route Mgr 0 Notify Mgr 0 ---- ---- ---Total 0 0 0 GrandTotal 0 Note: See SHOW MAX BUFFERS. SHOW COMBINE Displays a list of any combined devices.
Programming Configuration Port Commands (Cont.) Command SHOW LOG Description 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 If start is not entered, the most recent message will be first.
Programming Configuration Port Commands (Cont.) Command SHOW MAX BUFFERS Description Displays a list of various message queues and the maximum number of message buffers that were ever present on the queue. Example: show max buffers Thread TX RX ----------- ---- ---Axlink 1 UDP 1 IPCon Mgr 0 (Total for TCP Connections TX=0) Con Manager 8 Interpreter 17 Device Mgr 8 Diag Mgr 1 Msg Dispatch 0 Cfg Mgr 0 Route Mgr 0 Notify Mgr 0 ---- ---- ---Total 2 34 GrandTotal 36 See SHOW BUFFERS.
Programming Configuration Port Commands (Cont.) Command SHOW SYSTEM Description Provides a list of all devices in all systems currently on-line. The systems lists are either directly connected to this Master (i.e. 1 hop away), or are referenced in the DEFINE_DEVICE section of the NetLinx program. Optionally, you may provide the desired system number as a parameter to display only that system's information (e.g. SHOW SYSTEM 2001). The systems listed are in numerical order.
Programming ESC Pass Codes There are 'escape' codes in the pass mode. These codes can switch the display mode or exit pass mode. The following 'escape' codes are defined. Escape Pass Codes Command + + ESC ESC Description Exit Pass Mode: Typing a plus (shift =) followed by another plus followed by an ESC (the escape key) followed by another escape exits the pass mode. The Telnet session returns to "normal".
Programming THE FOLLOWING SECTIONS ONLY APPLY TO THE INTEGRATED CONTROLLER COMPONENT OF THE NI-3101-SIG. LED Disable/Enable Send_Commands The following commands enable or disable the LEDs on the Integrated Controller. In these examples: = Port 1 of the device. Sending to port 1 of the NI-Controller (affects all ports). LED Send_Commands Command Description LED-DIS Regardless of whether or not the port is active, the LED will not be lit.
Programming RS-232/422/485 Send_Commands In these examples: = device. RS-232/422/485 Send_Commands Command Description B9MOFF Disables 9-bit in 232/422/455 mode. By default, this returns the communication settings on the serial port to the last programmed parameters. This command works in conjunction with the 'B9MON' command. Set the port's communication parameters for stop and data bits according to the software settings on the RS-232 port (default).
Programming RS-232/422/485 Send_Commands (Cont.) Command Description GET BAUD The port sends the parameters to the device that requested the information. Get the RS-232/422/485 port’s current communication parameters. The port responds with: ,,,, 485 Syntax: SEND_COMMAND ,"'GET BAUD'" Example: SEND_COMMAND RS232_1,"'GET BAUD'" System response example: Device 1,115200,N,8,1 485 DISABLED HSOFF Disable hardware handshaking (default).
Programming RS-232/422/485 Send_Commands (Cont.) Command Description SET BAUD Syntax: Set the RS-232/422/485 port's communication parameters. SEND_COMMAND ,"'SET BAUD ,,, [485 ]'" Variables: baud = baud rate is: 115200. parity = N (none), O (odd), E (even), M (mark), S (space). data = 7 or 8 data bits. stop = 1 and 2 stop bits. 485 Disable = Disables RS-485 mode and enables RS-422. 485 Enable = Enables RS-485 mode and disables RS-422.
Programming RS-232/422/485 Send_Commands (Cont.) Command Description XON Syntax: Enable software handshaking. SEND_COMMAND ,"'XON'" Example: SEND_COMMAND RS232_1,"'XON'" Enables software handshaking on the RS232_1 device. 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 commands and not the literal characters.
Programming RS-232/422/485 Send_String Escape Sequences (Cont.) Command Description 27,20,1 Syntax: Set the RTS hardware handshake's output to low/inactive (< 3V). SEND_STRING ,"27,20,1" Example: SEND_STRING RS232_1,"27,20,1" Sets the RTS hardware handshake's output to low on the RS232_1 device. IR / Serial Ports Channels IR / Serial Ports Channels 00001 - 00229 IR commands. 00229 - 00253 May be used for system call feedback. 00254 Power Fail. (Used w/ 'PON' and 'POF' commands).
Programming IR/Serial Send_Commands The following IR and IR/Serial Send_Commands generate control signals for external equipment. In these examples: = device. IR/Serial Send_Commands Command Description CAROFF Syntax: Disable the IR carrier signal until a 'CARON' command is received. SEND_COMMAND ,"'CAROFF'" Example: SEND_COMMAND IR_1,"'CAROFF'" Stops transmitting IR carrier signals to the IR_1 port. CARON Enable the IR carrier signals (default).
Programming IR/Serial Send_Commands (Cont.) Command Description CTOF Off time settings are stored in non-volatile memory. This command sets the delay time between pulses generated by the 'CH' or 'XCH' send commands in tenths of seconds. Set the duration of the Off time (no signal) between IR pulses for channel and IR function transmissions. Syntax: SEND_COMMAND ,"'CTOF',
Programming IR/Serial Send_Commands (Cont.) Command Description POD Channel 255 changes are enabled. This command is used in conjunction with the I/O Link command. Disable previously active 'PON' (power on) or 'POF' (power off) command settings. Syntax: SEND_COMMAND ,"'POD'" Example: SEND_COMMAND IR_1,"'POD" Disables the 'PON' and 'POF' command settings on the IR_1 device. POF Turn Off a device connected to an IR port based on the status of the corresponding I/O Link input.
Programming IR/Serial Send_Commands (Cont.) Command Description PTOF This time increment is stored in permanent memory. This command also sets the delay between pulses generated by the 'PON' or 'POF' send commands in tenths of seconds. It also sets the delay required after a power ON command before a new IR function can be generated. This gives the device time to power up and get ready for future IR commands. Set the time duration between power pulses in .10-second increments.
Programming IR/Serial Send_Commands (Cont.) Command Description SET MODE Sets an IR port to either IR, Serial, or Data mode. Set the IR/Serial ports for IR Note: IR DATA Mode works best when using both a lower baud rate and a or Serial-controlled devices connected to a CardFrame or short cable length (< 10 feet). NetModule. Syntax: SEND_COMMAND , 'SET MODE '" Variable: mode = IR, SERIAL, or DATA. Example: SEND_COMMAND IR_1,"'SET MODE IR'" Sets the IR_1 port to IR mode for IR control.
Programming IR/Serial Send_Commands (Cont.) Command Description XCHM Syntax: Changes the IR output pattern for the 'XCH' send command. Variable: SEND_COMMAND ,"'XCHM '" 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.
Programming Input/Output Send_Commands The following Send_Commands program the I/O ports on the Integrated Controller. In these examples: = device. I/O ports: Port 17. Channels: 1 - 8 I/O channels. I/O Send_Commands GET INPUT Get the active state for the selected channels. 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. The port responds with either 'HIGH' or 'LOW'.
Troubleshooting Troubleshooting This section describes the solutions to possible hardware/firmware issues that could arise during the common operation of a NetLinx device. Troubleshooting Information Symptom Solution My NI Controller can’t obtain a DHCP Address. In requesting a DHCP Address, the DHCP Server can take up to a few minutes to provide the address to the on-board Master.
Troubleshooting Troubleshooting Information (Cont.) Symptom Solution I can’t connect to my NI Controller via the rear Configuration Port using a USB cable. A USB cable is used for Serial communication between the PC and the Master. • Verify the USB connectors are securely inserted into their respective ports on both the rear Configuration Port (on the NI) and on the PC. • The NI-3101-SIG is configured to a fixed Baud Rate of 115200.
Troubleshooting NI-3101-SIG Signature Series NetLinx Integrated Controller 169
4/08 ©2007 AMX. All rights reserved. AMX and the AMX logo are registered trademarks of AMX. AMX reserves the right to alter specifications without notice at any time. It’s Your World - Take Control™ 3000 RESEARCH DRIVE, RICHARDSON, TX 75082 USA • 800.222.0193 • 469.624.8000 • 469-624-7153 fax • 800.932.6993 technical support • www.amx.
