Instruction Manual NXB-KNX KNX Communications Gateway NetLinx Interface Controllers L a s t R e v is e d : 4 / 2 8 / 2 0 1 4
AMX Limited Warranty and Disclaimer This Limited Warranty and Disclaimer extends only to products purchased directly from AMX or an AMX Authorized Partner which include AMX Dealers, Distributors, VIP’s or other AMX authorized entity.
Table of Contents Table of Contents NXB-KNX KNX Communications Gateway .........................................................1 Overview .................................................................................................................. 1 Product Specifications ............................................................................................. 1 Installation ..........................................................................................................
Table of Contents Data Types ................................................................................................................... 18 Feedback ................................................................................................................ 19 Runtime ......................................................................................................................... 19 Debugging ..............................................................................................
Table of Contents VAL= ...................................................................................................................................... VERSION ................................................................................................................................ WATCH .................................................................................................................................. WATCH OFF......................................................................
Table of Contents Appendix B: Troubleshooting ...........................................................................55 Overview ................................................................................................................
NXB-KNX KNX Communications Gateway NXB-KNX KNX Communications Gateway Overview The NXB-KNX KNX Communications Gateway (FG2031-01) allows AMX NetLinx Integrated Controllers the ability to control, integrate and communicate with homes and buildings that utilize the KNX communication protocol. KNX is the world’s first open, royalty-free, and platform independent standard for home and commercial building control. (front) (rear) FIG.
NXB-KNX KNX Communications Gateway NXB-KNX Specifications (Cont.
Installation Installation Wiring and Connections To avoid any damage to the electronic component, installation must be performed in an ESD safe environment. Do not connect power to the NXB-KNX until the wiring is complete. The NXB-KNX is installed between the NetLinx Master and the KNX control bus, and passes NetLinx control commands to the KNX control bus via 2-wire twisted pair cabling, as indicated in FIG.
Installation PoE (Power Over Ethernet) The NXB-KNX uses CAT5/CAT6 wire via the Ethernet port for PoE power. Use the PS-POE-AF Power over Ethernet Injector (FG423-80) to simplify wiring and installation by eliminating the need for an AC outlet at each point of installation. The NXB-KNX can be placed up to approximately 330’ (100 meters) from PoE Injector.
Configuration Configuration Overview NXB-KNX units have a built-in WebConsole that allows you to make various configuration settings via a web browser on any PC that has access to the NXB-KNX device. The web console consists of a series of web pages that are collectively called the "NXB-KNX Configuration Manager" (FIG. 5). Click here to log in Hover mouse here to access the Admin drop-down menu FIG. 5 NXB-KNX Configuration Manager - IP Settings Page (initial view) The NXB-KNX is set to DHCP by default.
Configuration Accessing the NXB-KNX WebConsole via Zero-Config Assuming that the NXB-KNX resides on the same LAN as the PC running NetLinx Studio, and the NetLinx Master to which the NXB-KNX is connected, you can access the NXB-KNX via the Zero-Config feature in Netlinx Studio, as described below: 1. In NetLinx Studio (version 3.0 or higher), right-click inside the Zero-Config tab of the Workspace Bar to access the Zero-Config context menu (FIG. 7). FIG. 7 NetLinx Studio - Zero-Config context menu 2.
Configuration Admin Menu There are several configuration pages included in the Configuration Manager, all of which are accessed via the Admin drop-down menu (FIG. 9): FIG.
Configuration 1. Enter a Device Number for this NXB-KNX unit in the Device Number text field. 2. Click Accept to save your changes. 3. Press Reboot to reboot the NXB-KNX and apply the new Device Number assignment. Master Connection tab The options in the Master Connection tab allow you to view and edit connection details for the NetLinx Master to which this NXB-KNX unit will be connected (FIG. 11).
Configuration Select Security Settings from the Admin menu to open the Security Settings page (FIG. 12). Use the options on the page to specify security options and login information for this NXB-KNX unit. FIG. 12 Security Settings page Enable / Disable Security Settings Web Security: Click this checkbox to enable Web Security. When Web security is enabled, a username and password are required to access any system Web pages.
Configuration Login is only required if the Web and/or Admin security options have been enabled on the unit. 1. Click the Login link in the upper-right corner of the initial page (FIG. 5). This invokes the Login popup page (FIG. 13). FIG. 13 NXB-KNX Configuration Manager - Login popup page Enter the default login information: Username = administrator Password = password 2. Click the Login button.
Configuration Select Port Settings from the Admin drop-down menu to open the Port Settings page (FIG. 15). Use the options on the page to specify various Port settings for this NXB-KNX unit. FIG. 15 Port Settings page The options on this page provide inputs for enabling and disabling of HTTP, HTTPS, Telnet, SSH and FTP ports, and allow you to change each port number from its standard default assignment.
Configuration FIG. 16 Clock Manager sub-menu Each of the options listed in the sub-menu are also accessible via options on the Clock Manager page (FIG. 17). FIG. 17 Clock Manager options Clock Manager - Mode Manager Select the main Clock Manager entry in the Admin Menu, or select Mode from the Clock Manager sub-menu, and the Mode Manager page will be displayed (FIG. 18): FIG.
Configuration Time: Manually enter the current time (hh:mm:ss). Click Accept to save your changes. Note that changes on this page take effect immediately. Click Cancel to cancel any changes. Clock Manager - Daylight Savings Select Daylight Savings from the Clock Manager sub-menu (or from the main Clock Manager page), and the Daylight Savings Manager page will be displayed (FIG. 19): FIG.
Configuration Select NIST Servers from the Clock Manager sub-menu (or from the main Clock Manager page), and the NIST Server Manager page will be displayed (FIG. 20): FIG. 20 Clock Manager - NIST Server Manager page Note that this tab is enabled only if Network Time is selected (on the Mode Manager page). The options on this page allow you to select the NIST server that will be queried at each clock synchronization, and allow you to add more NIST servers to the list.
NetLinx Programming NetLinx Programming Overview It is important to understand that the NXB-KNX cannot configure a KNX system. The NXB-KNX serves a functioning KNX system, and can only access bus elements with permitted use. For a successful connection to a KNX system, expert KNX knowledge and access to a knowledgeable KNX installer is crucial. A wrongly set reading flag in an actuator or restrictively programmed line coupler are difficult to find without the right analysis tools.
NetLinx Programming KNX Bus Diagram The NXB-KNX is a transparent KNX device and can be connected at any location with the KNX. In contrast to simple actuators and sensors, the NXB-KNX may be responsible for up to 3,000 Destination Addresses (where a normal dimmer only responds to four Destination Addresses). FIG.
NetLinx Programming User Data (DPT) Specifications and Requirements KNX defines the User data in different Telegrams as Data Point Types (or "DPT"s) KNX defines DPT IDs numerically, in the form major.minor (for example: DPT 1.001 or DPT 1.002), where the major ID is designated a data length in bits or bytes (8-bit octets), and the minor ID defines format and encoding. The same data length may be reused in several DPT major IDs.
NetLinx Programming Integrating with NetLinx The NXB-KNX is a native ICSP device in NetLinx. The NXB-KNX associates each actuator (actor number) with a corresponding Channel and Level mapping. For example the value of actor 1 will map to Channel 1 / Level 1, and actor 52 will map to Channel 52 / Level 52. These Channels and Levels are associated with the NXB-KNX device. The default number of Channels and Levels supported by the NXB-KNX is 256.
NetLinx Programming Feedback Runtime All actuators/sensors can be configured to feedback to channels and levels via the ICSP command. In addition feedback is generated in a readable ASCII display - depending on flags - meaning, the raw data are output as time string, date string, floating point display etc. Example: Feedback of a 2Byte value, converted according to EIS5 standard (i.e. temperature value). The corresponding actuator was entered in the filter table with flag "EIS5".
NetLinx Programming AMX_NXB_MOD Module The AMX_NXB_MOD module is provided to facilitate remote logging from NXB-KNX as well as the "List Save" and "List Load" functions. The AMX_NXB_MOD module is integrated with the source code as follows: DEFINE_MODULE 'AMX_NXB_MOD' nxbMod(dvKNX) The parameters are as follows: dvKNX - the physical interface for NXB-KNX, as a NetLinx D:P:S address AMX_KNX_Updater Module The AMX_KNX_Updater module is optional, and is provided to support implementations (e.g.
NetLinx Programming Analyzing Feedback Data feedback is analyzed in a DATA_EVENT: The feedback is always in STRING format One DATA_EVENT is actuated per feedback (exactly one feedback in the DATA.TEXT) In cases of multiple feedback, the corresponding number of events is actuated. Channel feedback is analyzed in a CHANNEL_EVENT. Level feedback is analyzed in a LEVEL_EVENT. NetLinx SEND_COMMANDs Commands to the module always take place per SEND_COMMAND to the device. KNX_Tools.
NetLinx Programming NetLinx SEND_COMMANDs (Cont.) Command Description BIND= Definition of Bind trigger. Syntax: BIND=: Note: BIND= will send instruction to only if is changing its value • When is changed, is updated with the same value. • No telegrams are sent on the KNX bus. • The updated actor sends its new value to the master using Set= or Val= and Channel and Level events. • Typical use is to bind a feedback address to a control address.
NetLinx Programming NetLinx SEND_COMMANDs (Cont.) Command Description DEBUGOFF Deactivate debug reports Syntax: DEBUGOFF Example: SEND_COMMAND dvKNX,'DEBUGOFF' DEL Delete Actuator from Table Syntax: DEL Parameters: = AMX Number of Actuator (range = 1 - 3000) Example: SEND_COMMAND dvKNX,'DEL 3' EIS5= Setting an EIS5 value. Converts a floating-point value mapped in ASCII into 2Byte EIS5 value before transfer.
NetLinx Programming NetLinx SEND_COMMANDs (Cont.) Command Description GET= Request Value of Actuator stored in the module GET? Note: Creates no Telegram on KNX (use for synchronization of master-to-master connection.
NetLinx Programming NetLinx SEND_COMMANDs (Cont.
NetLinx Programming NetLinx SEND_COMMANDs (Cont.) Command Description LIST LOAD Reads the entries in table written with LIST SAVE from CF and back. • The current table is replaced with the read one. • File name is optional. • If no file name is specified, the default file name is used. • Default file name: KNXTableNX.TXT Note: In terminal connection with master the already available files on CF can be listed by entering "List" (no SEND_COMMAND to device).
NetLinx Programming NetLinx SEND_COMMANDs (Cont.) Command Description POLLDELAY= Set pause between (automatic) value requests Syntax: POLLDELAY= Parameters: • = 0-2 (default = 1) Note: 0 stands for very fast and should not be used, because otherwise the NXB-KNX would create a high bus load. For installations with slow bus couplers (BCU1), the value 2 should be selected. Example: SEND_COMMAND dvKNX,'POLLDELAY=2' POLLSTART Triggers the pollstart action.
NetLinx Programming NetLinx SEND_COMMANDs (Cont.) Command Description SET= Set Actuator Syntax: SET=: Note: Observe actuator type in value range! The module limits the value range automatically to max valid range of the accessed actuator.
NetLinx Programming NetLinx SEND_COMMANDs (Cont.) Command Description TIME? Request of time Note: Only valid for 3 Byte Actuators Syntax: TIME? Parameters: • = AMX Number of Actuator (range = 1 - 3000) Example: SEND_COMMAND dvKNX,'TIME?8' Returns: Feedback of Time TIME=: Note: Is transmitted as ADDITIONAL feedback, if in actuator the time flag is set.
NetLinx Programming Sample Program KNX Table All actuators to be switched/set/controlled need to be provisioned on the NXB-KNX. In this example it is achieved with the use of the KNX_Table.axi file. All provisioning commands are listed in the 'ONLINE' for the NXB-KNX device. Other options are possible however this method is preferred. The method will guarantee that actuators will be synchronized between the master and the NXB-KNX Recommendation: Use the version with help function (example 1, see below).
NetLinx Programming { SWITCH(Counter) //Send config command in groups. //Caution avoid sending large quantities of config commands without //intermittent wait intervals.
NetLinx Programming DEFAULT: Counter = 0 }// Switch IF (Counter) { Counter ++ }// IF (Counter) }// WAIT Example 2 - Structure of KNX-Table with SEND_COMMANDS MODULE_NAME='KNX_Table_NXB_A'(DEV dvNxbKnx) DEFINE_VARIABLE integer counter float waitVal DEFINE_START Counter=0 waitVal = .2 #INCLUDE 'KNX_Tools.axi' DEFINE_EVENT DATA_EVENT [dvNxbKnx] { ONLINE: //Start configuration upload when NXB-KNX comes online.
NetLinx Programming SEND_COMMAND DATA.DEVICE,"'status'" //report log from NXB-KNX with current status of actors } DEFAULT: Counter = 0 } IF (Counter) { Counter ++ } } // Switch // IF (Counter) // WAIT Example 3 - Load Configuration from File The configuration can be read and generated from/to a file on the master file system. The reading of the file can for instance be started in the ONLINE section of the interface. ... DATA_EVENT[dvKNX] { ONLINE : { SEND_COMMAND dvKNX,'LIST LOAD MyTable.txt' } } ...
NetLinx Programming Example 4 - Main Program DEFINE_DEVICE dvKNX = 13001:1:0 dvTP = 10002:1:0 DEFINE_CONSTANT ... DEFINE_VARIABLE VOLATILE LONG lKNX_Value[5000] // Feedback array ... DEFINE_START ... #INCLUDE 'KNX_Tools.axi' #INCLUDE 'KNX_Table.
NetLinx Programming KNX_Tools.axi We recommend not to use the send commands directly, but always use the functions of this include file. The compiler has the opportunity to avoid typing errors already during compiling. Additional typing is avoided.
NetLinx Programming 36 NXB-KNX KNX Communications Gateway
Cross-Line Communication Cross-Line Communication Overview In many cases cross-line communication is required. In order to enable cross line communication a KNX programmer will need to utilize the AMX NXB-KNX Virtual Device. This ETS device entry will serve as the NXB-KNX device in ETS3. The NXB-KNX is not a native KNX device and so it cannot be directly programmed from within ETS3.
Cross-Line Communication FIG. 24 Selective Import dialog 4. Verify that NXB-KNX is selected, and click Import. Adding the Virtual Device to the ETS3 Project Once the import procedure is complete, the virtual device must be added to the ETS3 project: 1. Identify the appropriate Area and Line at which the physical NXB-KNX will be connected, and right-click on the Line name (heading) to access the context menu (FIG. 25): FIG. 25 ETS3 - Topology in Default Project - context menu 2.
Cross-Line Communication 3. In the Product Finder dialog: a. Select AMX from the Manufacturer drop down. b. Click Find. c. The NXB-KNX Virtual Device will appear in the search results. d. Select NXB-KNX and click Insert. e. Close the Product Finder dialog. 4. The NXB-KNX Virtual Device is indicated in the appropriate line (FIG. 27): FIG.
Cross-Line Communication 40 NXB-KNX KNX Communications Gateway
NetLinx Firmware Upgrades NetLinx Firmware Upgrades Overview The NetLinx Studio software application (available for free download from www.amx.com) provides the ability to transfer KIT firmware files to a NetLinx device such as the NXB-KNX. To send firmware files, select Tools > Firmware Transfers, then select Send to NetLinx Device from the sub-menu. Before You Start 1. Establish the Firmware and device Application versions currently loaded on your NXB-KNX.
NetLinx Firmware Upgrades 2. Verify you have the latest version of NetLinx Studio on your PC. Use the Web Update option in NetLinx Studio’s Help menu to obtain the latest version. Alternatively, go to www.amx.com and login as a Dealer to download the latest version. 3. Go to www.amx.com and download the latest Firmware file. Firmware files are available to download from www.amx.com - on the product’s page in the online catalog. 4.
NetLinx Firmware Upgrades FIG. 31 Browse For Folder dialog (NetLinx Studio) The selected directory path is displayed in the Send To NetLinx Device dialog (Location text box). Assuming that the specified target directory contains one or more KIT files, the KIT files in the selected directory are displayed in the Files list box, with the file's last modified date and time (FIG. 32). 5600 FIG. 32 Send To NetLinx Device dialog (NetLinx Studio) 3. Select the appropriate *.KIT file from the Files list.
NetLinx Firmware Upgrades If for any reason your Kit file transfer should fail, continue to retry the transfer until you are successful. DO NOT reboot the NXB-KNX, or change connections until the transfer is complete. Failure to complete this operation successfully may require a factory repair of the NXB-KNX. Additional Documentation For additional information on using NetLinx Studio, refer to the NetLinx Studio online help and Operation/Reference Guide (available at www.amx.com).
One-Time Upgrade of the NXB-KNX to a Native NetLinx Device One-Time Upgrade of the NXB-KNX to a Native NetLinx Device Overview This section describes the process of upgrading an older NXB-KNX to the latest version of NetLinx Firmware. The initial release of the NXB-KNX operated as an IP Device (as opposed to a native NetLinx device).
One-Time Upgrade of the NXB-KNX to a Native NetLinx Device Determining the Current Firmware Version Of the NXB-KNX Select Firmware Upgrade from the Admin menu to open the Firmware Upgrade Manager page (FIG. 34). Use the options on the page to upgrade the firmware on this NXB-KNX unit. FIG. 34 Firmware Upgrade Manager page This page allows you view information on the firmware version currently loaded on this unit, and to upload a firmware .JAR file to the unit.
One-Time Upgrade of the NXB-KNX to a Native NetLinx Device Determining the Current Application Version Of the NXB-KNX Information on the current application version loaded on the device is displayed in the Application Upgrade Manager page (FIG. 35). FIG. 35 Application Upgrade Manager page If Current Application Version Is Lower Than v2.0.15 1. Select Application Upgrade from the Admin drop-down menu to open the Application Upgrade page (FIG. 35 on page 47). 2. Click Browse, and select the file XXXX2.0.
One-Time Upgrade of the NXB-KNX to a Native NetLinx Device 48 NXB-KNX KNX Communications Gateway
Appendix A: Telnet Commands Appendix A: Telnet Commands Overview The NXB-KNX supports Telnet communications. This type of terminal communication can be accessed remotely, via TCP/IP. Telnet is an insecure form of terminal communication, since it does not require a physical connection to the device to connect. Further, the Telnet interface exposes information to the network (which could be intercepted by an unauthorized network client).
Appendix A: Telnet Commands Terminal Commands The Terminal commands listed in the following table can be sent directly to the NXB-KNX via Telnet terminal session. In your terminal program, type "Help" or a question mark ("?") and to access the Help Menu, and display the Program port commands described below: Terminal Commands Command Description ----- Help ----- (Extended diag messages are OFF) ? or Help Displays this list of commands. DATE Displays the current date and day of the week.
Appendix A: Telnet Commands Terminal Commands (Cont.) Command MSG ON|OFF Description Enables/Disables extended diagnostic messages. • MSG On sets the terminal program to display all messages generated by the NXBKNX. • MSG OFF disables the display. Example: > MSG ON Extended diagnostic information messages turned on. > MSG OFF Extended diagnostic information messages turned off.
Appendix A: Telnet Commands Terminal Commands (Cont.) Command SET JAVA HEAP Description Set the amount of memory allocated for the Java pool. This is the current Java memory heap size as measured in Megabytes. • Valid values = 5M - 35M • Recommended default = 32M Note: This setting does not take effect until the next reboot. SET ETHERNET MODE This command sets the current Ethernet configuration settings - auto OR speed = 10 | 100, duplex = full | half.
Appendix A: Telnet Commands Terminal Commands (Cont.) Command SET IP Description Sets the IP configuration. Enter a Host Name, Type (DHCP or Fixed), IP Address, Subnet Mask, and Gateway IP Address. Note: For NetLinx Central Controllers, the "Host Name" can only consist of alphanumeric characters. • Enter Y (yes) to approve/store the information into the NXB-KNX. • Enter N (no) to cancel the operation. Note: The device must be rebooted to enable new settings.
Appendix A: Telnet Commands Terminal Commands (Cont.) Command SET TIME Description Sets the current time. Example: >SET TIME Enter Date: (hh:mm:ss) -> Note: Due to the absence of a battery-backed real-time clock, setting the current time is only valid for the life of the current run. When the unit is rebooted, the time will be lost. SHOW LOG Displays the log of messages stored in the NXB-KNX's memory. The NXB-KNX logs all internal messages and keeps the most recent messages.
Appendix B: Troubleshooting Appendix B: Troubleshooting Overview AMX recommends activating debugging mode during diagnostics to display additional error messages. This is activated with monitor command "DEBUGON". The following table provides tips for error definition, in case it does not work. This serves a quick error analysis ON SITE. Troubleshooting Error Proposed solution / error definition No controls possible, no feedback Ensure NXB-KNX is detected in Netlinx Studio online tree.
Appendix B: Troubleshooting Troubleshooting Error Proposed solution / error definition Responses to interactive commands, e.g. 'list', are not displayed. Responses to interactive commands are displayed only when the NXB-KNX log level is debug. Confirm the NXB-KNX log level is debug. • Establish a telnet session with the NXB-KNX. • Enable display of diagnostic messages by typing 'msg on all'. • The NXB-KNX status banner will refresh every 15 minutes.
Appendix B: Troubleshooting NXB-KNX KNX Communications Gateway 57
4/14 ©2014 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.
