instruction manual NetLinx Integrated Controllers (NI-2000, NI-3000, and NI-4000) N e t L i n x C e n t ra l C o n t r o l l e r s a n d C a r d s
AMX Limited Warranty and Disclaimer AMX Corporation 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 Corporation, 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.
Table of Contents Table of Contents Introduction ...............................................................................................................1 NI-2000 Specifications ...................................................................................................... 1 NI-3000 Specifications ...................................................................................................... 5 NI-4000 Specifications ......................................................................
Table of Contents Installation and Upgrading .................................................................................... 29 Installing NetLinx Control Cards (NI-4000 Only) ............................................................. 29 Setting the NetLinx Control Card Addresses (NI-4000 Only).......................................... 30 Device:Port:System (D:P:S)............................................................................................
Table of Contents Security tab - Modify User page............................................................................................. 64 Security tab - User Directory Associations page.................................................................... 65 Security tab - SSL Server Certificate page ............................................................................ 67 Security tab - Export Certificate Request page ......................................................................
Table of Contents Accessing the Security configuration options.................................................................. 94 Option 1 - Set system security options for NetLinx Master (Security Options Menu) ............ 95 Option 2 - Display system security options for NetLinx Master.............................................. 96 Option 3 - Add user ................................................................................................................ 96 Option 4 - Edit User..............
Introduction Introduction NetLinx Integrated Master Controllers can be programmed to control RS-232/422/485, Relay, IR/ Serial, and Input/Output devices through the use of both the NetLinx programming language and the NetLinx Studio application (version 2.2 or higher). Another key feature of this products is the ability to easily access the configuration switches without having to remove a cover plate.
Introduction FIG. 1 NI-2000 NetLinx Integrated Controller (front view) RS-232/422/485 TX/RX LEDs (red/yellow) Link/Active-Status-Output-Input Relay LEDs (red) IR/Serial LEDs (red) I/O LEDs (yellow) Front ICSNet (2) Rear RS-232/422/485 (Ports 1-3) Relays (Port 4) ICSHub Out Ethernet IR/Serial (Ports 5-8) I/O (Port 9) DIP switch Program port AXLink LED (green) AXLink port PWR ID Pushbutton FIG. 2 NI-2000 front and rear panel components NI-2000 Specifications Dimensions (HWD): • 3.47" x 17.
Introduction NI-2000 Specifications (Cont.) Front Panel Components: LINK/ACT • Green LED lights when the Ethernet cable is connected and an active link is established. This LED also blinks when receiving Ethernet data packets. Status • Green LED lights to indicate that the system is programmed and communicating properly. Output • Red LED lights when the Controller transmits data, sets channels On/Off, sends data strings, etc.
Introduction NI-2000 Specifications (Cont.) Digital I/O (Port 9) • Four-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-4 • 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-2000 Specifications (Cont.) Ethernet Link/Activity LED • LEDs show communication activity, connections, speeds, and mode information: SPD-speed - Yellow LED lights On when the connection speed is 100 Mbps and turns Off when the speed is 10 Mbps. L/A-link/activity - Green LED lights On when the Ethernet cables are connected/terminated correctly and blinks when receiving Ethernet data packets. AXlink LED • One green LED indicates the state of the AXlink connector port.
Introduction FIG. 3 NI-3000 NetLinx Integrated Controller (front view) RS-232/422/485 TX/RX LEDs (red/yellow) Link/Active-Status-Output-Input Relay LEDs (red) IR/Serial LEDs (red) I/O LEDs (yellow) Front ICSNet (2) Rear RS-232/422/485 (Ports 1-7) Relays (Port 8) ICSHub Out IR/Serial (Ports 9-16) I/O (Port 17) Program port DIP switch Ethernet AXLink LED (green) AXLink port PWR ID Pushbutton FIG.
Introduction NI-3000 Specifications (Cont.) Dimensions (HWD): • 3.47" x 17.00" x 3.47" (8.81 cm x 43.18 cm x 8.82 cm) • 2 RU (rack unit) high Power requirements: • 900 mA @ 12 VDC Memory: • 32 MB SDRAM • 1 MB of Non-volatile Flash Compact Flash: • 32 MB Card (upgradeable). Refer to the Optional Accessories section on page 10 for more information. Weight: • 4.55 lbs (2.
Introduction NI-3000 Specifications (Cont.) Rear Panel Components: RS-232/422/485 (Ports 1 -7) • Seven RS-232/422/485 control ports using DB9 (male) connectors with XON/XOFF (transmit on/transmit off), CTS/RTS (clear to send/ready to send), and 300-115,200 baud.
Introduction NI-3000 Specifications (Cont.) IR/Serial (Ports 9-16) • Eight IR/Serial control ports support high-frequency carriers up to 1.
Introduction NI-3000 Specifications (Cont.) Optional Accessories: • 2 Pin Black Male Phoenix Connector (3.5mm) (41-5026) • CC-NIRC IR cables (FG10-000-11) • CC-NSER IR/Serial cables (FG10-007-10) • CSB Cable Support Bracket (FG517) • NCK, NetLinx Connector Kit (FG2902) • NI-3000 Quick Start Guide (93-2105-01) • PSN2.8 12 VDC power supply (FG423-17) • PSN6.
Introduction RS-232/422/485 TX/RX LEDs (red/yellow) Relay LEDs (red) IR/Serial LEDs (red) Link/Active-Status-Output-Input NetLinx Card slots (1-4) I/O LEDs (yellow) Front RS-232/422/485 (Ports 1-7) Rear Relays (Port 8) I/O (Port 17) ICSNet (2) ICSHub Out IR/Serial (Ports 9-16) AXLink LED (green) AXLink port Ethernet DIP switch Program port PWR CardFrame DIP switch Slot 1-4 connectors ID Pushbutton FIG. 6 NI-4000 front and rear panel components NI-4000 Specifications Dimensions (HWD): • 5.
Introduction NI-4000 Specifications (Cont.
Introduction NI-4000 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-4000 Specifications (Cont.) CardFrame Number DIP switch • Sets the starting address for the Control Cards in the CardFrame.(Factory default CardFrame DIP switch value = 0). • The Control Card address range is 1-3064. NetLinx Control Card connectors (1-4) Included Accessories: • Four 20-pin (male) connectors that bridge the gap between the Control Cards in the CardFrame and external equipment. • Two CC-NIRC IR Emitters (FG10-000-11) • One 10-pin 3.
Quick Setup and Configuration Overview Quick Setup and Configuration Overview Installation Procedures These are the steps involved with the most common installation procedures of these devices: Carefully unpack the contents of the box. Confirm the contents of box (page 2 thru page 14). Familiarize yourself with the units’ connectors and wiring configurations (Connections and Wiring section on page 17).
Quick Setup and Configuration Overview Update the Controller and Control Card Firmware Before using your new Integrated Controller, you must FIRST update your NetLinx Studio to the most recent release. Upgrade the on-board Master firmware through an IP Address via the Ethernet connector (Upgrading the On-board Master Firmware via an IP section on page 46) (IP recommended).
Connections and Wiring Connections and Wiring Setting the Configuration DIP Switch (for the Program Port) Prior to installing the Controller, use the Configuration DIP switch to set the baud rate used by the Program port for communication. The Configuration DIP switch is located on the rear of the NI-4000/3000/2000 Integrated Controllers.
Connections and Wiring Think of the PRD Mode (On) equating to a PC’s SAFE Mode setting. This mode allows a user to continue powering a unit, update the firmware, and download a new program while circumventing any problems with a currently downloaded program. Power must be cycled to the unit after activating/deactivating this mode on the Program Port DIP switch #1. Using the Configuration DIP switch 1.
Connections and Wiring Preparing captive wires You will need a wire stripper and flat-blade screwdriver to prepare and connect the captive wires. Never pre-tin wires for compression-type connections. 1. Strip 0.25 inch (6.35 mm) of insulation off all wires. 2. Insert each wire into the appropriate opening on the connector (according to the wiring diagrams and connector types described in this section). 3. Tighten the screws to secure the wire in the connector.
Connections and Wiring Using the 4-pin mini-Phoenix connector for data and power Connect the 4-pin 3.5 mm mini-Phoenix (female) captive-wire connector to an external NetLinx device as shown in FIG. 8. To the Integrated Controller’s AXlink/PWR connector To the external NetLinx device Top view PWR + AXM/RX GND - AXP/TX PWR + AXM/RX GND - AXP/TX Top view FIG.
Connections and Wiring Program Port Connections and Wiring The Integrated Controllers are equipped with one Program port located on the rear of the unit. Use an RS232 programming cable to connect the Program port to your PC's COM port, this connection provides communication with the NetLinx Integrated Controller. Then you can download NetLinx programs to this on-board Master using the NetLinx Studio 2.2 software program. Refer to the NetLinx Studio instruction manual for programming instructions.
Connections and Wiring RS-232/422/485 Device Port Wiring Specifications Pin Signal Function RS-232 1 RX- 2 RXD Receive data X 3 TXD Transmit data X 4 TX+ Transmit data 5 GND Signal ground 6 RX+ Receive data 7 RTS Request to send X 8 CTS Clear to send X 9 TX- Transmit data RS-422 RS-485 Receive data X X X (strap to pin 9) X X (strap to pin 6) X X X (strap to pin 4) X X (strap to pin 1) ICSNet RJ-45 Connections/Wiring The following tables show the signal and pinout
Connections and Wiring The FIG. 11 illustrates the relative location of the ICSNet and ICSHub Out connectors on the rear panel. Ports PORT 1 ICSNet ICSNet ICSHub Out FIG. 11 Location of ICSNet and ICSHub Out connectors Unlike the ICSNet ports, the ICSHub connections require a specific polarity. The IN/OUT configuration, on the hub ports, was implemented to use the same cables as ICSNet, but these ports need TX and RX crossed. You must connect an OUT to an IN, or an IN to an OUT port.
Connections and Wiring RJ-45 plug 8 7 6 5 4 3 2 1 8 7 6 5 4 3 2 1 RJ-45 plug FIG. 12 RJ-45 wiring diagram Ethernet LEDs L/A - Link/Activity LED lights (green) when the Ethernet cables are connected and terminated correctly. ETHERNET 10/100 SPD - Speed LED lights (yellow) when the connection speed is 100 Mbps and turns Off when speed is 10 Mbps. FIG.
Connections and Wiring A metal commoning strip is supplied with each Integrated Controller to connect multiple relays. Relay connections Use A for common and B for output (FIG. 14). Each relay is isolated and normally open. A metal connector strip is also provided to common multiple relays.
Connections and Wiring I/O Port Wiring Specifications NI-4000 and NI-3000 Pin Signal 1 GND 2 I/O 1 3 4 5 6 I/O Port Wiring Specifications NI-2000 Function Pin Signal Signal GND 1 GND Signal GND Input/Output 2 I/O 1 Input/Output I/O 2 Input/Output 3 I/O 2 Input/Output I/O 3 Input/Output 4 I/O 3 Input/Output I/O 4 Input/Output 5 12 VDC I/O 5 Input/Output 7 I/O 6 Input/Output 8 I/O 7 Input/Output 9 I/O 8 10 12 VDC Function PWR Input/Output PWR IR/Serial Connecti
Connections and Wiring NetLinx Control Card Slot Connector (NI-4000 unit only) FIG. 17 shows the 20-pin (male) connector that provides connection to the NetLinx Control Cards. SLOT 1 20 19 18 17 16 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 FIG.
Connections and Wiring 28 NetLinx Integrated Controllers
Installation and Upgrading Installation and Upgrading Installing NetLinx Control Cards (NI-4000 Only) NetLinx Cards can be installed into the front card slots. The cards mount horizontally through the card slot openings on the front of the enclosure. To install a NetLinx Card: 1. Discharge the static electricity from your body, by touching a grounded object. 2. Remove the three screws by turning them in a counter-clockwise direction and then remove the faceplate (FIG. 18).
Installation and Upgrading If the cards do not appear in the Workspace window for the selected Master System number: give the system time to detect the inserted cards (and refresh the system) and/or cycle power to the NI-4000 unit. Setting the NetLinx Control Card Addresses (NI-4000 Only) The 8-position CardFrame Number DIP switch, located on the rear of the Integrated Controller, sets the starting address (the device number in the D:P:S specification) for the Control Cards installed in the CardFrame.
Installation and Upgrading Here's the syntax: NUMBER:PORT:SYSTEM where: NUMBER: 16-bit integer represents the device number PORT: 16-bit integer represents the port number (in the range 1 through the number of ports on the Controller or device) SYSTEM: 16-bit integer represents the system number (0 = this system) Removing NetLinx Control Cards (NI-4000 Only) To install NetLinx Control Card: 1.
Installation and Upgrading Chassis housing screws (top) - 6 on top - sides vary per model Mounting Brackets Compact Flash Compact Flash insert location Chassis housing screws (side) - 4 on each side of the NI-4000 - 3 on each side of the NI-3000/2000 NXC Card Slot faceplate NXC Card Slots FIG. 20 Location of the Compact Flash within a sample Integrated Controller 3. Carefully pull-up and remove the housing up and away from the Controller to expose the internal circuit board (FIG. 20). 4.
Installation and Upgrading 6. Insert the upgrade card into the connector opening with the arrow facing towards the pins, then push it in firmly until the contact pins are completely inside the flash card and securely attached to the connector (FIG. 21). Under-side groove located below Card Removal Grooves Insert with arrow facing towards the connector pins FIG. 21 Removing the Compact Flash card 7.
Installation and Upgrading Installing the Integrated Controller into an Equipment Rack Use either the rack-mounting brackets (supplied with the NI-4000/3000/2000 controller) for equipment rack installations. Remove the mounting brackets for flat surface installations. Before completing the install process, it is recommended that you complete any firmware upgrade of the NetLinx Control Cards.
Installation and Upgrading 7. Slide the unit into the rack until the attachment holes, along both sides, align to their corresponding locations on the mounting brackets, as shown in FIG. 22. 8. Secure the Rack Mount to the equipment rack by screwing in the four #10-32 screws (80-0186) and four #10 washers (80-0342) supplied in the Assembly Kit (KA2105-01) (in a clockwise direction). 9.
Installation and Upgrading 36 NetLinx Integrated Controllers
Configuration and Firmware Update Configuration and Firmware Update This section refers to steps necessary to both communicate and upgrade the various NI Controller components. Before commencing, verify you are using the latest firmware for both the NI (2105_NI_X000) and on-board Master (2105_NI_Master). Verify the NetLinx Studio being used is Version 2.2 build 78 or higher. Before beginning: 1. Setup and configure your Integrated Controller.
Configuration and Firmware Update The default setting for these units is 38400 FIG. 23 Assigning Communication Settings and Baud Rates 6. Click the Edit Settings button to open the Serial Settings dialog (FIG. 23). 7. Set the COM port parameters for the selected COM port used for communication to the NetLinx Master. Default parameters are: COM1, 38400, 8 Data Bits, No Parity, 1 Stop Bit, and 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 be rebooted to incorporate the new System number. 2. Select the Change System selection box from the System to Change section. 3. Enter both the current and new system address values (this example uses 2). 4. Click the Change Device/System Number button. This configures the NI Master to accept the new value and incorporate the information.
Configuration and Firmware Update Changing the Device Address on a NetLinx Device 1. Access the Device Addressing dialog (FIG. 25) by either one of these two methods: Right-click on any system device listed in the OnLine Tree tab of the Workspace and select Device Addressing (from the pop-up list). Select Diagnostics > Device Addressing from the Main menu. Device Address (original device value) Check-Off to verify change 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 Obtaining the Master’s IP Address (using DHCP) Verify there is an active Ethernet connection attached to the rear of the NI-Series Controller before beginning these procedures. 1. Select Diagnostics > Network Addresses from the Main menu to access the Network Addresses dialog. 2. Verify the System number corresponds to the value previously assigned in the Device Addressing tab and verify that zero (0) is entered into the Device field.
Configuration and Firmware Update 8. Click OK to accept the new changes. 9. Click the Reboot Master button and select Yes to close the Network Address dialog. 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 alternately blink during the incorporation. Wait until the STATUS LED is the only LED to blink. 11.
Configuration and Firmware Update 7. Click the Set IP Information button to retain a known IP Address (obtained from the System Administrator) on the specified System Master. 8. Click OK to accept the new changes. 9. Click the Reboot Master button and select Yes to close the Network Address dialog. 10. Click Reboot (Reboot the Master Controller dialog) and wait for the System Master to reboot. The STATUS and OUTPUT LEDs should begin to alternately blink during the incorporation.
Configuration and Firmware Update FIG. 28 Assigning Communication Settings and TCP/IP Settings 7. Click the Edit Settings button (on the Communications Settings dialog) to open the TCP/IP Settings dialog (FIG. 28). 8. Enter the IP Address into the TCP/IP Address field. This information is obtained from either your System Administrator or from the Obtaining the Master’s IP Address (using DHCP) section on page 42. 9. Click OK three times to close the open dialogs and save your settings.
Configuration and Firmware Update Verifying the current version of NetLinx Master Firmware All NI Integrated Controllers contain both an on-board Master and Controller. Each of these components has its own corresponding firmware. The on-board Master firmware KIT file is described as 2105_NI_Master and the Controller firmware KIT file is described as 2105_NI_X000. 1. Click on the OnLine Tree tab in the Workspace window to view the devices on the System. The default System value is one (1). 2.
Configuration and Firmware Update 3. If the firmware version is not version 2 - build 135 or higher (ex: v2.XX.135), download the latest NI Master firmware file from www.amx.com > Tech Center > Downloadable Files > Firmware Files > NI Series. 4. Verify you have downloaded the latest NI Master firmware (KIT) file to a known location. 5. Select Tools > Firmware Transfers > Send to NetLinx Device from the Main menu to open the Send to NetLinx Device dialog (FIG. 30).
Configuration and Firmware Update 11. Repeat steps 8 - 11 again (the last component will successfully be installed). 12. Click Close once the download process is complete. The OUTPUT and INPUT LEDs alternately blink to indicate the Master is incorporating the new firmware. Allow the Master 20 - 30 seconds to reboot and incorporate the new firmware. 13. Right-click the System number and select Refresh System.
Configuration and Firmware Update 8. Enter the IP Address into the TCP/IP Address field. This information is obtained from either your System Administrator or from the Obtaining the Master’s IP Address (using DHCP) section on page 42. 9. Click OK three times to close the open dialogs and save your settings. If you are currently connected to the assigned Master, a popup asks whether you would want to temporarily stop communication to the Master and apply the new settings. 10.
Configuration and Firmware Update If the NI Integrated Controller firmware version is not version 1 - build 121 or higher (ex: v1.XX.121), download the latest NI Integrated Controller firmware file from www.amx.com > Tech Center > Downloadable Files > Firmware Files > NI Series. Then Download the 2105 NI_X000 KIT file to your Controller. 2. Verify you have downloaded the latest NetLinx Integrated Controller (KIT) file to a known location. 3.
Configuration and Firmware Update 10. Right-click the System number and select Refresh System. This establishes a new connection to the System and populates the list with the current devices (and their firmware versions) on your system.
Configuration and Firmware Update Selected Control Card Firmware file Description field for selected KIT file Firmware download status System Number and Device Number must match the System and Device values listed in the Workspace window FIG. 34 Select Control Card firmware file for download page (via IP) The OUTPUT and INPUT LEDs alternately blink to indicate the Master is incorporating the new firmware. Allow the Master 20 - 30 seconds to reboot and incorporate the new firmware. 13.
NetLinx Security and Web Server NetLinx Security and Web Server NetLinx Masters (installed with firmware build 130 or higher) incorporate new built-in security and SSL certificate verification capabilities. By using both SSL certificate verification and secured HTTP access, this new NetLinx firmware provides users with a more convenient web-based method of securing both the Master and the incoming and outgoing information.
NetLinx Security and Web Server When using Mozilla on a Linux machine, the Group Rights column checkboxes (from within the Modify User page) can become greyed-out but are actually present. New Master Firmware Security Features Master Security Telnet Security Terminal (RS232 Program port) security HTTP (Web Server) Security FTP Security SSL Certificate Encryption and Identification Technology Installation of this new SSL functionality onto your Master will cause security setup via Telnet to be disabled.
NetLinx Security and Web Server NetLinx Security Terms (Cont.) Directory Associations A Directory Association is a path that defines the directories or files a particular user or group can access via the 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.
NetLinx Security and Web Server G3 panel pages accessed through the WebControl tab are virtual pages created by a user in TPDesign3 and then downloaded to the target Master. Interaction with these pages are not reflected on an actual G3 panel unless you use specific programming commands that link these virtual pages with their real G3 panel counterparts.
NetLinx Security and Web Server The NetLinx user account is 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. The FTP Security and Admin Change Password Security are always enabled and cannot be disabled. Internet Explorer is used for the purposes of these instructions.
NetLinx Security and Web Server Security Tab Features (Cont.) SSL Certificate section Allows an authorized user to select the method for SSL certificate generation and implementation on the target Master. • A certificate can be self generated, requested, or regenerated. • Once a certificate has been installed onto a target Master, that certificate remains there until it is either replaced or regenerated.
NetLinx Security and Web Server Security System Features (Cont.) OK/Cancel • Press OK to accept any changes made within this tab and incorporate the information into the target Master. • Press Cancel to void any changes made within this tab, disable the security configuration session, void any changes made to the Master, and return the user to the empty Security tab. You must first enable the Master Security selection and then click OK before altering any settings.
NetLinx Security and Web Server Add Group Entries (Cont.) OK/Cancel • Press OK to accept any changes made within this tab and incorporate the information into the target Master. • Press Cancel to void any changes made within this tab, disable the security configuration session, void any changes made to the Master, and return the user to the empty Security tab. A User represents a single potential client of the NetLinx Master, while a Group represents a logical collection of users.
NetLinx Security and Web Server Modify Group Entries (Cont.) HTTP Access This selection enables or disables Web Server access for the selected group. Telnet Access This selection enables or disables Telnet Security for the selected group. Security Config Access This selection enables or disables the ability of a group to alter the Security Configuration settings. OK/Cancel/Delete • Press OK to accept any changes made within this tab and incorporate the information into the target Master.
NetLinx Security and Web Server Here are some examples of valid entries: Valid Directory Association Entries Path Description / Enables access to all files within the user’s main directory and subdirectories. /* Enables access to all files within the user’s main directory and subdirectories. /user1 If user1 is a file in the user directory, only the file is granted access. If user1 is a subdirectory of the user directory, all files in the user1 and its sub-directories are granted access.
NetLinx Security and Web Server Security tab - Add User page The Users > Add User link allows an authorized user to add a user account (FIG. 40) and then assign that user’s current access rights. FIG. 40 Security Tab - Add User Add User Entries Feature Description User ID (user name) A valid character string defining the name of the user (4 - 20 alpha-numeric characters). The string is case sensitive and must be unique. Group Provides a drop-down listing of the available groups.
NetLinx Security and Web Server Security tab - Modify User page The Users > Modify User link allows an authorized user to select from a listing of available users (FIG. 41) and then modify the Master’s access rights for the selected user. Group Rights are greyed-out and are read-only from within Modify User. The Group Rights column will appear greyed-out when viewed within the Mozilla browser on a Linux machine. FIG.
NetLinx Security and Web Server Modify User Entries (Cont.) Telnet Access This selection enables or disables Telnet access for the selected user. Security Config Access This selection enables or disables the ability of a user to alter the Security Configuration settings. Password/Confirm Enter a new password assigned to the selected user. • A user password is a valid character string (4 - 20 alpha-numeric characters). The string is case sensitive and must be unique.
NetLinx Security and Web Server 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: Valid Directory Association Entries Path Description / Enables access to the user directory and all files and subdirectories in that user directory.
NetLinx Security and Web Server Security tab - SSL Server Certificate page A certificate is a cryptographically signed object that associates a public key and an identity. Certificates also include other information in extensions such as permissions and comments. A "CA" is short for Certification Authority and is an internal entity or trusted third party that issues, signs, revokes, and manages these digital certificates.
NetLinx Security and Web Server Server Certificate Entries (Cont.) City/Location Name of the city where the certificate is used. This is an alpha-numeric string (1 - 50 characters in length). State/Province Name of the state or province where the certificate is used. This is an alpha-numeric string (1 - 50 characters in length). Country Name Provides a drop-down selection with a listing of currently selectable countries.
NetLinx Security and Web Server Security tab - Export Certificate Request page The SSL > Export Certificate Request link opens an Export Certificate Request field (FIG. 44) where an authorized user can copy the raw text from a generated Certificate request into their clipboard and then send it to the CA. FIG. 44 Security Tab - Export Certificate Request field Security tab - Import Certificate page The SSL > Import Certificate link opens an Import Certificate field (FIG.
NetLinx Security and Web Server System Tab Displays the firmware version and log information for the NetLinx Master (FIG. 46). FIG. 46 System Tab Show Devices Tab Displays the device values and firmware versions of devices connected to the current NetLinx Master System (FIG. 47). FIG. 47 Show Devices tab Network Tab Provides a list of the DNS and URL associated with the NetLinx Master. The DNS List identifies the Domain Name servers that translates domain names for the Master into IP Addresses.
NetLinx Security and Web Server Master Security Setup Procedures Setting the system security options for a NetLinx Master (Security Options Menu) 1. Enter the URL/IP Address of the target Master into the Address/URL field within the web browser. Refer to the Accessing the NetLinx Master via its IP Address section on page 55 for more detailed instructions on using your web browser to access your Master. 2. Click on the Security tab.
NetLinx Security and Web Server 6. Click on the checkbox next to SSL Enable to enable the use of SSL encryption and server certificate usage. Activating this feature requires the creation of a server certificate. Refer to the SSL Certificate Procedures section on page 81 for instructions on creating and requesting a server certificate for the target Master. Before initially enabling the SSL feature on the Master, a self-generated certificate should first be installed.
NetLinx Security and Web Server 4. Click on the checkbox next to the requested access rights desired for the selected group. Placing a check in these fields activates the access rights (Terminal/Admin Change/FTP/ HTTP/Telnet/Security Configuration). Refer to the Security tab - Add Group page section on page 59 for more detailed field descriptions. 5. Click OK to accept and save the changes made on this tab to the Master.
NetLinx Security and Web Server 5. Click OK to accept and save the changes made on this tab to the Master. Clicking Delete removes the selected group from the list of authorized groups on the Master. Clicking Cancel voids any changes made within this tab, disables the security configuration session, voids any changes made to the Master, and returns you to the empty Security tab. 6. Successful modification of the new group results in an on-screen message "Group ‘XXX’ modified".
NetLinx Security and Web Server Adding a Group directory association 1. Click on the Security tab. By default this tab is blank until a security option is selected from the left of the browser window. Refer to the Security tab - Group Directory Associations page section on page 61 for more detailed descriptions on the security configuration options. 2.
NetLinx Security and Web Server Not only can an administrator provide group access to a file or folder on the Master, but also to an Application tab displayed within the web browser (such as Show Devices or Network). To add an association to an Application tab, enter the association location (ex: /showdevices.asp) into the Adding Association field. 5. Click Add to add the new directory path to the group and save it to the Master. 6.
NetLinx Security and Web Server Adding a User and configuring their access rights 1. Click on the Security tab. By default this tab is blank until a security option is selected from the left of the browser window. Refer to the Security tab - Add User page section on page 63 for more detailed descriptions on the security configuration options. 2.
NetLinx Security and Web Server Each selection simply toggles the security setting from enabled to disabled. Modifying an existing User’s access rights 1. Click on the Security tab. By default this tab is blank until a security option is selected from the left of the browser window. Refer to the Security tab - Modify User page section on page 64 for more detailed descriptions on the security configuration options. 2.
NetLinx Security and Web Server 6. Enter the same password for the user into both the Password and Confirm fields if you want to change the password. Leaving this field blank retains the current or previous password. A user password is a valid character string (4 - 20 alpha-numeric characters) that is used to supplement the user name/ID in defining the potential client. The string is case sensitive and must be unique. 7. Click OK to accept and save the changes made on this tab to the Master.
NetLinx Security and Web Server Adding a User directory association 1. Click on the Security tab. By default this tab is blank until a security option is selected from the left of the browser window. Refer to the Security tab - User Directory Associations page section on page 65 for more detailed descriptions on the security configuration options. 2.
NetLinx Security and Web Server Confirming the new directory association 1. Click on the Security tab. 2. Click the Directory Associations link. 3. From the Delete Association section of the User Directory Associations window, click the down arrow from the Select Association field to open a list of associations and confirm the new directory association has been assigned to the user. Deleting a directory association 1. Click on the Security tab. 2. Click the Directory Associations link. 3.
NetLinx Security and Web Server Self-Generating a SSL Server Certificate Request 1. Click on the Security tab (FIG. 55). Refer to the Security tab - SSL Server Certificate page section on page 67 for more detailed descriptions on the security configuration options. 2. Click the Server Certificate link (on the left of the browser window) to display the Security tab with the fields necessary for developing a new certificate. FIG. 55 Security tab - showing the Server Certificate creation fields 3.
NetLinx Security and Web Server 11. Choose Self Generate Certificate from the drop-down list. When this request is submitted, the certificate is generated and installed into the Master in one step. 12. Click OK to save the new encrypted certificate information to the Master or click Cancel to void any changes made within this tab and exit without making changes to the target Master. ONLY use the Regenerate certificate option when you have Self Generated your own certificate.
NetLinx Security and Web Server 10. Click the down arrow from the Action field to open a drop-down listing of available certificate generation options. 11. Choose Create Request from the drop-down list. 12. Click OK to accept the information entered into the above fields and generate a certificate file. Refer to the Security tab - Export Certificate Request page section on page 69.
NetLinx Security and Web Server 4. Click OK to enter the new encrypted certificate information and save it to the Master or click Cancel to void any changes made within this tab and exit without making changes to the target Master. Once a certificate has been purchased from an external CA and then installed onto a specific Master, DO NOT regenerate the certificate or alter its properties (example: bit length, city, etc.).If the purchased certificate is regenerated, it becomes invalid.
NetLinx Security and Web Server This method of certificate generation is used to modify or recreate a previously existing certificate already on the Master. By default, if a certificate is already present on the target Master, the Display Certificate Action is selected and these fields are populated with information. Ex: if the company has moved from Dallas to Houston, all of the information is reentered exactly except for the City. 3. Enter any new or changed information into its respective field. 4.
NetLinx Security and Web Server 4. Enter the name of the server being used (this is the Master). The server name is the name as it shows up in the URL of the Master you are securing with this server certificate. For example, if the URL of the Master will be https://www.myNetLinxMaster.com/, then enter the server name as www.myNetLinx Master.com. 5. Send the CA the text created by your certificate request through the Master.
NetLinx Security and Web Server Accessing an SSL-Enabled Master via an IP Address 1. Enter the IP Address of the target Master (example: 198.198.99.99) into the web browser Address field. 2. Press the Enter key on your keyboard to begin the communication process between the target Master and your computer. 3. The user is then presented with a Security Alert popup window and Certificate information (FIG. 56). FIG.
NetLinx Security and Web Server 6. The user is then presented with a Certificate Import Wizard that begins the process of adding the certificate (FIG. 57). FIG. 57 Certificate Import Wizard 7. Click Next to proceed with the certificate storage process. FIG. 58 Certificate Import Wizard- storing the certificate 8. Click Next to automatically use the default certificate storage settings and locations (FIG. 58). 9. Click the Finish button to finalize the certificate installation process. 10.
NetLinx Security and Web Server 18. The first tab displayed within your open browser window is WebControl. Using your NetLinx Master to control the G4 panel Refer to the specific panel instruction manual for detailed information on configuring and enabling WebControl. Once the Master’s IP Address has been set through NetLinx Studio (version 2.2 or higher): 1. Launch your web browser. In order to fully utilize the SSL encryption, your web browser should incorporate an encryption feature.
NetLinx Security and Web Server FIG. 60 WebControl VNC installation and Password entry screens 8. Click Yes from the Security Alert popup window to agree to the installation of the G4 WebControl application on your computer. This application contains the necessary Active X and VNC client applications necessary to properly view and control the panel pages from your computer. The G4 WebControl application is sent by the panel to the computer that is used for communication.
NetLinx Security and Web Server 3. Restart your computer and launch your browser. 4. Repeat steps 1 - 5 from the previous section to launch the WebControl tab associated with your Master. 5. Click on the G3 panel name link associated with the target panel. 6. A secondary web browser window appears on the screen to notify you that the computer is Loading the Java Virtual Machine. What to do when a Certificate Expires Self-generated certificates have a duration period of approximately 30 years.
NetLinx Security with a Terminal Connection NetLinx Security with a Terminal Connection NetLinx Masters (version 2.10.80 or later) have built-in security capabilities. It will require a valid user name and password to access the NetLinx System’s Telnet, HTTP and FTP servers. The security capabilities are configured and applied via a Telnet connection or the NetLinx Master’s RS-232 terminal interface (the RS232 Program port).
NetLinx Security with a Terminal Connection 4. Enter any text into the Name field of the HyperTerminal Connection Description dialog window and click OK when done. 5. From the Connect Using field, click the down-arrow and select the COM port being used for communication by the target Master. 6. Click OK when done. 7. From the Bits per second field, click the down-arrow and select the baud rate being used by the target Master.
NetLinx Security with a Terminal Connection Option 1 - Set system security options for NetLinx Master (Security Options Menu) Type 1 and at the Security Setup prompt (at the bottom of the Main Security Menu) to display the Security Options Menu. The Security Options Menu sets the "global" options for the NetLinx Master. It is accessed by the Set Security system options of the Main Security Menu. This first thing that will happen is you will be asked one of two questions.
NetLinx Security with a Terminal Connection Changes made to the target Master from within the Terminal window are not reflected within the web browser, until the Master is rebooted and the web browser connection is refreshed. Any changes made to the Master, from within the web browser are instantly reflected within the Terminal session without the need to reboot.
NetLinx Security with a Terminal Connection 4. Enter a password for the new user. A password is a valid character string (4 - 20 alpha-numeric characters) to supplement the user name in defining the potential client. This string is also case sensitive. 5. The session then prompts you to verify the new password. Enter the password again, and press . 6. Assuming the password was verified, the session then displays the Edit User menu (see below). Option 4 - Edit User 1.
NetLinx Security with a Terminal Connection The Edit User Menu options are described in the following table: Edit User Menu Command Description 1) Change User Password This selection prompts you to enter the new password (twice) for the user. Once the new password is entered, the user must use the new password from that point forward. 2) Change Inherits From Group This selection will display the current group the user is assigned to (if any).
NetLinx Security with a Terminal Connection Access Rights Menu Command Description 1) Terminal (RS232) Access (Enable/Disable) Enables/disables Terminal (RS232 Program port) Access. The account has sufficient access rights to login to a Terminal session if this option is enabled. 2) Admin Change Password Access (Enable/Disable) Enables/disables Administrator Change Password Access. The account has sufficient access rights to change the administrator password if this option is enabled.
NetLinx Security with a Terminal Connection 2. Enter a name for the group. A group name is a valid character string (4 - 20 alpha-numeric characters) defining the group. This string is case sensitive, and each group name must be unique. 3.
NetLinx Security with a Terminal Connection access to a file or directory. From the answer, it will enter the appropriate Directory Association. The NetLinx Master will not create the path if it is not valid. That must be done via another means, most commonly by using an FTP client and connecting to the FTP server on the NetLinx Master. Edit Group menu: Delete directory association 1. At the Edit Group prompt, type 2 to delete an existing directory association.
NetLinx Security with a Terminal Connection Edit Group menu: Display Access Rights 1. At the Edit Group prompt, type 5 to view the current access rights for the selected group account. A sample session response is: Terminal (RS232)...................Disabled Admin Password Change..............Disabled FTP................................Disabled HTTP...............................Disabled Telnet.............................Disabled Security Configuration.............
NetLinx Security with a Terminal Connection Option 10 - Show List of Authorized Groups 1. Type 10 and at the Security Setup prompt (at the bottom of the Main Security Menu) to display a list of all authorized group accounts. A sample session response is: The following groups are currently enrolled: administrator Group 1 Press key to continue 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 1) Set system security options for NetLinx Master Description This selection will bring up the Security Options Menu that allows you to change the security options for the NetLinx Master (refer to the Security Options Menu section on page 96 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 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. DEVICE HOLDOFF ON|OFF Sets the Master to holdoff devices (i.e.
NetLinx Security with a Terminal Connection Help Menu Options (Cont.) Command Description SET DNS Setup the DNS configuration of a device. SET ICSP PORT Sets the IP port listened to for ICSP connections. SET ICSP TCP TIMEOUT Sets the timeout period for ICSP and i!-WebControl TCP connections. SET IP Setup the IP configuration of a device. SET TELNET PORT Sets the IP port listened to for Telnet connections. SET THRESHOLD Sets the Master's internal message thresholds.
NetLinx Security with a Terminal Connection The password is case sensitive. The password must be entered with the exact combination of upper and lower case letters as was assigned to them by the security administrator. The password must be at least 4 characters long and no more than 20 characters. Any combination of letters, numbers, or other characters may be used.
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 For example: STRUCTURE DEV { INTEGER Number // Device number INTEGER Port // Port on device INTEGER System // System the device belongs to } The D:P:S notation is used to explicitly represent a device number, port and system. For example, 128:1:0 represents the first port on device 128 on this system. If the system and Port specifications are omitted, (e.g. 128), system 0 (indicating this system) and port 1 (the first port) is assumed.
Programming Program Port Commands (Cont.) GET IP Displays the Master Card's D:P:S, Host Name, Type (DHCP or Static), IP Address, Subnet Mask, Gateway IP, and MAC Address. MEM Displays the largest free block of Master Card memory. MSG OFF MSG OFF disables the MSG ON display (see below). MSG ON MSG On sets the terminal program to display all messages generated by the Master Card. OFF Turns off a channel on a device. The device can be on any system the Master you are connected to can reach.
Programming Program Port Commands (Cont.) SET IP Prompts you to enter a Host Name, Type (DHCP or Fixed), IP address, Subnet Mask, and Gateway IP address. Enter Y (yes) to approve/store the information in the Master Card. Entering N (no) cancels the operation. SET TIME Prompts you to enter the new time for the Master Card. When the time is set on the Master Card, the new time will be reflected on all devices in the system that have clocks (i.e. touch panels).
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 Linux Telnet client The Linux Telnet client has three anomalies that are known at this time: A null (\00) character is sent after a carriage return. If an ALT 255 is entered, two 255 characters are sent (per the Telnet RAFT). If the code to go back to command mode is entered (ALT 29 which is ^]), the character is not sent, but Telnet command mode is entered. LED Disable/Enable Send_Commands The following commands enable or disable the LEDs on the Integrated Controller.
Programming RS-232/422/485 Send_Commands (Cont.) B9MON This command works in conjunction with the B9MOFF command. Overrides and sets the communication settings on the RS-232 port to nine data bits and one stop bit. Syntax: SEND_COMMAND ,'B9MON' Example: SEND_COMMAND RS232_1,'B9MON' Resets the RS-232 port's communication parameters to nine data bits, one stop bit, and locks-in the baud rate. CHARD Sets the delay time between transmitted characters in 100 microsecond increments.
Programming RS-232/422/485 Send_Commands (Cont.) HSON Syntax: Enables RTS (ready-to-send) SEND_COMMAND ,'HSON' and CTS (clear-to-send) Example: hardware handshaking. SEND_COMMAND RS232_1,'HSON' Enables hardware handshaking on the RS232_1 device. RXCLR Clears all characters in the receive buffer waiting to be sent to the Master Card.
Programming RS-232/422/485 Send_Commands (Cont.) TXCLR Syntax: Stops and clears all characters waiting in the transmit buffer. Example: SEND_COMMAND ,'TXCLR' SEND_COMMAND RS232_1,'TXCLR' Clears and stops all characters waiting in the RS232_1 device's transmit buffer. XOFF Disables software handshaking (default). Syntax: SEND_COMMAND ,'XOFF' Example: SEND_COMMAND RS232_1,'XOFF' Disables software handshaking on the RS232_1 device. XON Enables software handshaking.
Programming RS-232/422/485 Send_String Escape Sequences (Cont.) 27,20,0 Syntax: Sets the RTS hardware handshake's output to high. Example: SEND_STRING ,"27,20,0" SEND_STRING RS232_1,"27,20,0" Sets the RTS hardware handshake's output high on the RS232_1 device. 27,20,1 Syntax: Sets the RTS hardware handshake's output to low. SEND_STRING ,"27,20,1" Example: SEND_STRING RS232_1,"27,20,1" Sets the RTS hardware handshake's output low on the RS232_1 device.
Programming IR/Serial Send_Commands (Cont.) CH Sends IR pulses to select a channel. All channels below 100 are transmitted as two digits. If the IR code for ENTER (#21) is loaded, an Enter will follow the number. If the channel is greater than or equal to 100, the IR function 127 is generated for the one hundred digit.
Programming IR/Serial Send_Commands (Cont.) GET MODE Syntax: Polls the IR/Serial ports and reports the active mode settings to the device requesting the information. Example: SEND_COMMAND , 'GET MODE' SEND_COMMAND IR_1,'GET MODE' System response example: PORT 4 IR,CARRIER,IO LINK 0 IROFF Halts and clears all IR output on the designated port. Syntax: SEND_COMMAND ,'IROFF' Example: SEND_COMMAND IR_1,'IROFF' Immediately halts and clears all IR output signals on the IR_1 port.
Programming IR/Serial Send_Commands (Cont.) PTOF Syntax: Sets the time between power pulses in .10-second increments, and is stored in permanent memory. Variable: SEND_COMMAND ," 'PTOF',
Programming IR/Serial Send_Commands (Cont.) XCHM Syntax: Changes the IR output pattern for the XCH command. Variable: SEND_COMMAND ,'XCHM-' 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. SEND_COMMAND IR_1, 'XCH 343' Transmits the IR code as 3-4-3-enter.
Programming Input/Output Send_Commands The following Send_Commands program the I/O ports on the Integrated Controller. I/O SEND_COMMANDS GET INPUT Gets the input channels 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. Syntax: SEND_COMMAND ,'GET INPUT ' Variable: CHAN = 1-8 Example: SEND_COMMAND IO,'GET INPUT 1' Gets the I/O port's active state.
Programming 124 NetLinx Integrated Controllers
Troubleshooting Troubleshooting This section describes the solutions to possible hardware/firmware issues that could arise during the common operation of a Modero touch panel. 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 Program Port using a DB9 cable. A DB9 cable is used for Serial communication between the PC and the Master. • Verify the DB9 connectors are securely inserted into their respective ports on both the rear Program Port (on the NI) and the COM Port (on the PC). • The NI-series of Integrated Controllers comes factory defaulted to a communication Baud Rate of 38400.
Troubleshooting Troubleshooting Information (Cont.) Symptom Solution During the firmware upgrade process, NetLinx Studio failed to install the last component. This occurs when initially upgrading the on-board Master from a previous firmware (build 117 or lower), to the new Web Security firmware (build 130 or higher). • Only upon the initial installation of the new build there will be a failure of the last component to successfully download.
ARGENTINA • AUSTRALIA • BELGIUM • BRAZIL • CANADA • CHINA • ENGLAND • FRANCE • GERMANY • GREECE • HONG KONG • INDIA • INDONESIA • ITALY • JAPAN LEBANON • MALAYSIA • MEXICO • NETHERLANDS • NEW ZEALAND • PHILIPPINES • PORTUGAL • RUSSIA • SINGAPORE • SPAIN • SWITZERLAND • THAILAND • TURKEY • USA ATLANTA • BOSTON • CHICAGO • CLEVELAND • DALLAS • DENVER • INDIANAPOLIS • LOS ANGELES • MINNEAPOLIS • PHILADELPHIA • PHOENIX • PORTLAND • SPOKANE • TAMPA 3000 RESEARCH DRIVE, RICHARDSON, TX 75082 USA • 800.222.
