Harman NXB-KNX Instruction Manual
Harman NXB-KNX Instruction Manual

Harman NXB-KNX Instruction Manual

Knx communications gateway
Table of Contents

Advertisement

Quick Links

IN STR U CT IO N MAN U AL
N X B - K N X
KNX COMMUNICATIONS GATEWAY

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the NXB-KNX and is the answer not in the manual?

Questions and answers

Summary of Contents for Harman NXB-KNX

  • Page 1 IN STR U CT IO N MAN U AL N X B - K N X KNX COMMUNICATIONS GATEWAY...
  • Page 2: Important Safety Instructions

    IMPORTANT SAFETY INSTRUCTIONS READ these instructions. KEEP these instructions. HEED all warnings. FOLLOW all instructions. DO NOT use this apparatus near water. CLEAN ONLY with dry cloth. DO NOT block any ventilation openings. Install in accordance with the manufacturer's instructions. DO NOT install near any heat sources such as radiators, heat registers, stoves, or other apparatus (including amplifiers) that produce heat.
  • Page 3: Table Of Contents

    KNX Connector ......................... 7 Configuration ....................8 Overview ..........................8 Determining the IP Address of the NXB-KNX ..............8 NetLinx Studio (featuring Zero-Config functionality) ................8 Accessing the NXB-KNX WebConsole via Zero-Config ................9 Accessing the WebConsole via Web Browser..................9 Admin Menu........................
  • Page 4 Sample Program......................27 KNX Table.............................. 27 Notes For Programming ........................27 VAL= ...................................... 27 VERSION ....................................27 WATCH....................................27 WATCH OFF .................................... 27 WHEN=....................................27 Example 1 - Structure of KNX Table With Functions From KNX_Tools.axi ........... 28 NXB-KNX - Instruction Manual...
  • Page 5 KNXString2Array ..................................33 KNXArray2String ..................................33 Cross-Line Communication ................34 Overview ......................... 34 Integrating the NXB-KNX Virtual Device Into An ETS3 Project ............34 Adding the Virtual Device to the ETS3 Project..................34 NetLinx Firmware Upgrades ................37 Overview ......................... 37 Before You Start ......................37 Sending a Firmware (*.KIT) File To the NXB-KNX ................
  • Page 6: 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.
  • Page 7: Installation

    NOTE: 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. 2:...
  • Page 8: 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"...
  • Page 9: Accessing The Nxb-Knx Webconsole Via Zero-Config

    Accessing the NXB-KNX WebConsole via Zero-Conf ig 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: In NetLinx Studio (version 3.0 or higher), right-click inside the Zero-Conf ig tab of the Workspace Bar to access the Zero-...
  • Page 10: Device Configuration

    Authentication enabled). Press Accept to save changes. Press Reboot to reboot the NXB-KNX. Once rebooted, the NXB-KNX should be in communication with the Specified NetLinx Master (indicated by a steady blink on the NXB-KNX Status LED). NXB-KNX - Instruction Manual...
  • Page 11: Security Settings

    Configuration Security Settings Select Security Settings from the Admin menu to open the Security Settings page (FIG. 11). Use the options on the page to specify security options and login information for this NXB-KNX unit. Security Settings page FIG. 11...
  • Page 12: Ip Settings

    IP Settings changes only take effect after a reboot. Port Settings Select Port Settings from the Admin drop-down menu to open the Port Settings page (FIG. 14). Use the options on the page to specify various Port settings for this NXB-KNX unit. Port Settings page FIG. 14 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.
  • Page 13: Clock 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. 17): Clock Manager - Mode Manager page FIG. 17 The options on the Mode Manager page provide inputs for selecting the current mode of the system time: NXB-KNX - Instruction Manual...
  • Page 14: Clock Manager - Daylight Savings

    • Select Occurrence to end daylight savings at a specified occurrence (additional fields for Week of the Month, and Day of the Week are provided). Click Accept to save your changes. Note that changes on this page take effect immediately.  Click Cancel to cancel any changes.  NXB-KNX - Instruction Manual...
  • Page 15: Clock Manager - Nist Servers

    To add a NIST server, enter the NIST Server Name, IP Address and Location in the fields provided. To remove a NIST server from the list, click the Remove button. Click Accept to save your changes. Note that changes on this page take effect immediately.  Click Cancel to cancel any changes.  NXB-KNX - Instruction Manual...
  • Page 16: 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. NOTE: 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 diff icult to f ind without the right analysis tools.
  • Page 17: Notes On Line Couplers

    ID defines format and encoding. The same data length may be reused in several DPT major IDs. For example, DPT 5s and DPT 6s are 1-Byte in data length, while DPT 7s, DPT 8s and DPT 9s are 2-Bytes in data length. In essence, the NXB-KNX supports User Data (DPTs) simply in terms of data length, thereby supporting most DPTs.
  • Page 18: Integrating With Netlinx

    "date" for economy (relative to the lengthier 8-Byte combined format) and for more flexible use. The module application is responsible for interpreting User Data per each KNX device's definitions. The NXB-KNX recognizes the most commonly used User Data formats, and translates User Data to simplify most module application responsibilities.
  • Page 19: Data Types

    VAL=15:3175' String 2 from device:  EIS5=15:22.54' Debugging Example Status feedback: ********************************************************************** NXB-KNX: AMX NXB-KNX SN#xxxxxx IP xxx.xxx.xxx.xxx Version AmxKnxApp v2.0.15-KNX service unavailable Running since Jun 18, 2009 2:24:02 PM Servlet started Total Mem: 22369792 Used Mem: 11975492 Free Mem: 10394300...
  • Page 20: Amx_Nxb_Mod Module

    * LogLevel: Info ********************************************************************** 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)
  • Page 21: Analyzing Feedback

    NetLinx SEND_COMMANDs Commands to the module always take place per SEND_COMMAND to the device. NOTE: KNX_Tools.axi provides convenience function equivalents (See the Functions Available In KNX_Tools.axi table on page 33). The NXB-KNX supports the following NetLinx commands: NetLinx SEND_COMMANDs Command...
  • Page 22: Date

    Note: Is transmitted as ADDITIONAL feedback, if in actuator <No> the EIS5 flag is set. • <No> = AMX Number of Actuator • <Value> = Floating Point Value (String), converted according to EIS Specification Example: EIS5=12:20.25 NXB-KNX - Instruction Manual...
  • Page 23: Errorm

    • <No> = AMX Number of Actuator (range = 1 - 3000) Example: SEND_COMMAND dvKNX,'EIS5?12' ERRORM= Error message from NXB-KNX and/or bus. Note: The messages are only for information. (Feedback Only) Each message may reflect an actual command, followed by the error condition encountered.
  • Page 24: List

    Note: In terminal connection with master the already available f iles on CF can be listed by entering "List" (no SEND_COMMAND to device). Syntax: LIST LOAD [<Filename>] Examples: SEND_COMMAND dvKNX,'LIST LOAD' SEND_COMMAND dvKNX,'LIST LOAD MyTable.txt' LIST POLL List all poll triggers with AMX number and KNX group address Syntax: LIST POLL Example: SEND_COMMAND dvKNX,'LIST POLL' NXB-KNX - Instruction Manual...
  • Page 25: List Save

    • <Value> = 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.
  • Page 26: Senddelay

    Returns: Feedback of Time TIME=<No>:<Value> Note: Is transmitted as ADDITIONAL feedback, if in actuator <No> the time flag is set. • <No> = AMX Number of Actuator • <Value> = Time string (format = hh:mm:ss) Example feedback: Time=18:09:55:30 NXB-KNX - Instruction Manual...
  • Page 27: 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.
  • Page 28: Example 1 - Structure Of Knx Table With Functions From Knx_Tools.axi

    DEFINE_START Counter=0 waitVal = .2 #INCLUDE 'KNX_Tools.axi' DEFINE_EVENT DATA_EVENT [dvNxbKnx] ONLINE: //Start configuration upload when NXB-KNX comes online. wait 10 //1 second delay counter = 1 DEFINE_PROGRAM WAIT waitVal SWITCH(Counter) //Send config command in groups. //Caution avoid sending large quantities of config commands without //intermittent wait intervals.
  • Page 29 // Polltrigger KNXWhenPoll(dvNxbKnx, 26, 6) // Polltrigger SEND_COMMAND dvNxbKnx,"'pollstart'" //Indicates to NXB-KNX that configuration is complete SEND_COMMAND dvNxbKnx,"'status'" //report log from NXB-KNX with current status of actors DEFAULT: Counter = 0 }// Switch IF (Counter) Counter ++ }// IF (Counter)
  • Page 30: Example 2 - Structure Of Knx-Table With Send_Commands

    DEFINE_START Counter=0 waitVal = .2 #INCLUDE 'KNX_Tools.axi' DEFINE_EVENT DATA_EVENT [dvNxbKnx] ONLINE: //Start configuration upload when NXB-KNX comes online. wait 10 //1 second delay counter = 1 DEFINE_PROGRAM WAIT waitVal SWITCH(Counter) //Send config command in groups. //Caution avoid sending large quantities of config commands //without intermittent wait intervals.
  • Page 31: Example 3 - Load Configuration From File

    // Time, poll on Start ADD=18:3Byte:1/0/206:Date,PS // Date, poll on Start // ------------- // Polltrigger : // ------------- WHEN=1:2 // Polltrigger WHEN=1:3 // Polltrigger WHEN=11:14 // Polltrigger WHEN=12:14 // Polltrigger WHEN=13:14 // Polltrigger WHEN=14:11 // Polltrigger NXB-KNX - Instruction Manual...
  • Page 32: Example 4 - Main Program

    // Ballast to 50% Light 2 KNXSet(dvKNX,12,10) // Dimmer up Light 3 RELEASE: KNXSet(dvKNX,12,0) // Dimmer Stop Light 3 CHANNEL_EVENT [dvKNX, 2] // Feedback Light 1 ON[dvTp,31] OFF: OFF[dvTp,31] LEVEL_EVENT[dvKNX,21] //Feedback Level light 2 SEND_LEVEL dvTP,1,LEVEL.VALUE DEFINE_PROGRAM NXB-KNX - Instruction Manual...
  • Page 33: Knx_Tools.axi

    Function Description KNXSet Sets actuator <actor No> to <Value>. Syntax: KNXSet (<NXB-KNX Device >,<actor No>,<Value>) Note: The module limits the value range automatically to the maximum range of the selected actuator type. Example: KNXSet (dvKNX,13,1) KNXGet Gets the value of actuator <actor No> to <Value> stored in module.
  • Page 34: Cross-Line Communication

    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. The AMX NXB-KNX Virtual Device will allow a programmer to configure cross line communication between KNX devices and the NXB-KNX.
  • Page 35 NXB-KNX Virtual Device. For example, FIG. 27 indicates Light G, Light E and Light A (which are all of type 1 Bit) are linked with the NXB-KNX Virtual Device 1 Bit communication object.
  • Page 36 FIG. 27 Create this linkage for all group addresses which do not originate within the line at which the NXB-KNX is physically attached. Repeat this process starting with the Adding the Virtual Device to the ETS3 Project for all additional NXB-KNX units in your installation.
  • Page 37: Netlinx Firmware Upgrades

    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.
  • Page 38: Sending A Firmware (*.Kit) File To The Nxb-Knx

    NetLinx Firmware Upgrades Sending a Firmware (*.KIT) File To the NXB-KNX Use the Firmware Transfers options in the Tools menu to update the firmware in the NXB-KNX. NetLinx Devices such as the NXB- KNX use KIT files for firmware upgrades.
  • Page 39: Additional Documentation

    Click the Send button. You can watch the progress of the transfer in the Send to NetLinx Device dialog. NetLinx Studio transfers the files to the NXB-KNX and then tells it to reboot. After it reboots, the NXB-KNX actually goes through the upgrade process.
  • Page 40: One-Time Upgrade Of The Nxb-Knx To A Native Netlinx Device

    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). As an IP device, the process of upgrading the unit to the latest firmware involves upgrading both the device Application and the Firmware, via options in the Firmware Upgrade Manager (see FIG.
  • Page 41: Determining The Current Firmware Version Of The Nxb-Knx

    NOTE: Another method of determining the current f irmware version is to establish a telnet session to the NXB-KNX. See Establishing a Terminal Connection Via Telnet section on page 43.The Welcome banner in item 4 indicates the current f irmware version.
  • Page 42: Determining The Current Application Version Of The Nxb-Knx

    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. 34). Application Upgrade Manager page FIG.
  • Page 43: 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.
  • Page 44: Terminal 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 <Enter> to access the Help Menu, and display the Program port...
  • Page 45 Sets up the DNS configuration. This command prompts you to enter a Domain Name, DNS IP #1, DNS IP SET DNS #2, and DNS IP #3. Then, enter Y (yes) to approve/store the information in the NXB-KNX. Entering N (no) cancels the operation.
  • Page 46 Enter new HTTP port number (Usually 80) (0=disable HTTP): Setting HTTP port number to New HTTP port number set, reboot the NXB-KNX for the change to take affect. Sets the NXB-KNX’s IP port listened to for HTTPS connections. SET HTTPS PORT Note: The device must be rebooted to enable new settings.
  • Page 47 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. Displays the log of messages stored in the NXB-KNX's memory. The NXB-KNX logs all internal messages SHOW LOG and keeps the most recent messages.
  • Page 48: Appendix B: Troubleshooting

    • Or, use the 'show log' command to display the message log. Use the NXB-KNX 'debugon' command to set the log level to debug. • It is recommended to return the NXB-KNX to its operational log level of info when the interactive session is completed.
  • Page 49 © 2016 Harman. All rights reserved. NetLinx, AMX, AV FOR AN IT WORLD, HARMAN, and their respective logos are registered trademarks of HARMAN. Last Revised: Oracle, Java and any other company or brand name referenced may be trademarks/registered trademarks of their respective companies.

Table of Contents