Summary of Contents for AMX NetLinx Interface NXB-KNX
Page 1
Operation/Reference Guide NXB-KNX KNX Communications Gateway C o n t r o l S y s t e m A c c e s s o r i e s L a s t R e v i s e d : 4 / 1 5 / 2 0 1 0...
Page 2
AMX is not responsible for products returned without a valid RMA number. AMX is not liable for any damages caused by its products or for the failure of its products to perform. This includes any lost profits, lost savings, incidental damages, or consequential damages.
Table of Contents Overview ...1 Product Specifications ... 1 Installation ...3 Wiring and Connections... 3 Ethernet 10/100 Base-T RJ-45 Wiring Configuration ... 3 PoE (Power Over Ethernet) ... 4 KNX Connector... 4 Configuration ...5 Overview ... 5 Determining the IP Address of the NXB-KNX... 5 NetLinx Studio v3.0 (featuring Zero-Config functionality)...
Page 4
Table of Contents Feedback ... 21 Runtime ... 21 Debugging ... 21 AMX_NXB_MOD Module... 22 AMX_KNX_Updater Module ... 22 Accessing Actuators On the KNX Bus... 22 KNX_Table.axi Include File ... 22 KNX_Tools.axi Include File ... 22 Analyzing Feedback ... 23 NetLinx Send_Commands ...
Page 5
Sample Program ... 32 KNX Table ... 32 Notes For Programming... 32 Example 1 - Structure of KNX Table With Functions From KNX_Tools.axi... 32 Example 2 - Structure of KNX-Table with SEND_COMMANDS... 34 Example 3 - Load Configuration from File... 35 Example 4 - Main Program ...
Page 6
Table of Contents NXB-KNX Operation/Reference Guide...
Overview The NetLinx NXB-KNX interface (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 8
Overview NXB-KNX Specifications (Cont.) Operating Environment: Included Accessories: • Rubber feet Other AMX Equipment: Certifications: • Operating Temperature: 32°F - 104°F (0°C - 40°C) • Relative Humidity: 5% to 85% non-condensing • Intended for indoor use only • Green 2-Pin 5mm Phoenix connector with captive screws •...
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’...
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"...
Configuration FIG. 6 Workspace Bar - Zero-Config tab Refer to the NetLinx Studio online help for details on using Zero-Config. 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: In NetLinx Studio (version 3.0 or higher), right-click inside the Zero-Config tab of the Workspace Bar to...
You can access any device in the Zero-Config list simply by double-clicking on it's entry. The selected device's WebConsole (HTML) is displayed in a NetLinx Studio window. The unit’s IP Address can be edited IP Settings page (see the IP Settings section on page 11). Accessing the WebConsole via Web Browser From any PC that has access to the LAN that the NXB-KNX resides on: Open a web browser and type the IP Address of the target NXB-KNX unit in the Address Bar.
Configuration Device Configuration Select Device Configuration from the Admin menu to open the Device Configuration page. Use the options on the page to specify a Device Number and define connection information for the NetLinx Master. This page contains two tabs: Device Configuration, and Master Connection. Device Configuration tab The initial view of this page is the Device Configuration tab (FIG.
To establish communication between the NXB-KNX and a specific NetLinx Master: Enter the Master’s IP/URL in the Master IP/URL text field. The default Master Port Number assignment is 1319 - do not change this number. Under Authentication Settings, enter the NetLinx Master’s Username and Password (only required if the target NetLinx Master has Authentication enabled).
Configuration Login Information Use this set of options to specify a Username and Password. These will be required only if one or more of the Security Settings are enabled. Username: New Password: Confirm Password: Restore Factory Defaults: Click to restore the login information to the factory defaults: Click Accept to save your changes.
IP Settings Select IP Settings from the Admin drop-down menu to open the IP Settings page (FIG. 14). Use the options on the page to specify network/IP settings for this NXB-KNX unit. FIG. 14 IP Settings page Hostname: DHCP: IP Address: Subnet Mask: Gateway: Domain Suffix: Enter the Domain Suffix for this unit.
Configuration Port Settings 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.
Clock Manager Hover the cursor over the Clock Manager option in the Admin menu to open the Clock Manager sub-menu (FIG. 16). FIG. 16 Clock Manager sub-menu Each of the options listed in the submenu are also accessible via options on the Clock Manager page (FIG. 17). FIG.
Configuration The options on the Mode Manager page provide inputs for selecting the current mode of the system time: Time Sync: Re Sync Period: Select the desired re-synch period for the clock from this drop-down menu. Re- Timezone: Date: Time: Click Accept to save your changes.
The options on this page allow you to enable and disable daylight savings, and specify daylight savings start and end times. Daylight Savings: Use these radio buttons to turn daylight savings time on and off Offset: Starts: Ends: Click Accept to save your changes. Note that changes on this page take effect immediately. Click Cancel to cancel any changes.
Page 22
Configuration 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. Only one NIST server is selectable at any given time. To add a NIST server, enter the NIST Server Name, IP Address and Location in the fields provided.
KNX bus is a 2-core wire, providing 24V power as well as data transfer between devices. In contrast to AMX, the KNX system is organized peripherally - there is no "Master" or "Central Controller" controlling communication. Rather, every device may transmit data to any other device. The KNX protocol ensures that only one device transmits at a time, to avoid collisions as much as possible.
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. 22 provides a basic diagram of a KNX Bus: Line Coupler Actuator...
Notes on Line Couplers Telegrams must be intelligently sent across KNX lines by line couplers. Line couplers prevent Telegrams within a line from adding traffic load outside its line. Line couplers also filter out cross-line Telegrams if its line is not the destination line. 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...
NetLinx Programming The character sets supported by KNX are ASCII and ISO 8859-1. 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.
String 1 from device (no value change): 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...
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.
• Typical use is to bind a feedback address to a control address. Parameters: • <No>= AMX Number of Actuator (range = 1 - 3000) • <No2>= AMX Number of Actuator to be updated (range = 1 - 3000) Example: SEND_COMMAND dvKNX, 'BIND=24:11'...
Note: Only valid for 2Byte Actuators Syntax: EIS5=<No>:<floating point value> Parameters: • <No> = AMX Number of Actuator (range = 1 - 3000) • <Floating Point Value> = Number (range = –671088.64 - 670760.96) Example: SEND_COMMAND dvKNX,‘EIS5=12:24.3‘ Returns: Feedback of a value in ASCII floating point display. The actuator value to be coded according to EIS5.
List sum of individual Types, sum of all actuators. Syntax: LIST Example: SEND_COMMAND dvKNX,'LIST' List one actuator (AMX number) with KNX group address, current value, set flags (if applicable) and resulting additional feedback values. Syntax: LIST <No> Parameters: • <No> = AMX Number of Actuator (range = 1 - 3000)
LIST GAPS List free (unused) AMX numbers NXB-KNX Operation/Reference Guide Description List actuators in the range of <No> to <No2> (AMX numbers) with KNX group address, current value, set flags (if applicable) and resulting additional feedback values Syntax: LIST <No>-<No2>...
"List" (no SEND_COMMAND to device). Syntax: LIST LOAD [<Filename>] Examples: SEND_COMMAND dvKNX,'LIST LOAD' SEND_COMMAND dvKNX,'LIST LOAD MyTable.txt' List all poll triggers with AMX number and KNX group address Syntax: LIST POLL Example: SEND_COMMAND dvKNX,'LIST POLL' This file can be edited with simple text editor.
• This command is automatically executed by the NXB-KNX when the KNX bus is connected. Syntax: POLLSTART [<No>-<No2>] Parameters: • <No> = AMX Number of Actuator (range = 1 - 3000) (Start) • <No2> = AMX Number of Actuator (range = 1 - 3000) (End) Example: POLLSTART POLLSTART 25-75 Syntax: SEARCH <Groupaddress>...
Note: Observe actuator type in value range! The module limits the value range auto- matically to max valid range of the accessed actuator. Parameters: • <No> = AMX Number of Actuator (range = 1 - 3000) • <Value> = Value to be set Example: SEND_COMMAND dvKNX,‘SET=5:1‘...
Note: The trigger is fired when the first address is addressed, not just a change in value of the first address. Parameters: • <No> = AMX Number of Actuator (range = 1 - 3000) • <No2> = AMX Number of Actuator to be polled (range = 1 - 3000) Example: SEND_COMMAND dvKNX,‘WHEN=32:12‘ NetLinx Programming...
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.
Page 39
SWITCH(Counter) //Caution avoid sending large quantities of config commands without intermittent wait intervals. CASE KNXAdd(dvNxbKnx, KNXAdd(dvNxbKnx, KNXAdd(dvNxbKnx, KNXAdd(dvNxbKnx, KNXAdd(dvNxbKnx, KNXAdd(dvNxbKnx, CASE KNXAdd(dvNxbKnx, KNXAdd(dvNxbKnx, KNXAdd(dvNxbKnx, KNXAdd(dvNxbKnx, 10, eibSwitch, '1/1/33', "eibPollstart") // Light 4 status KNXAdd(dvNxbKnx, 11, knxSWITCH, '1/1/34', "knxPollstart") // Light 5 status KNXAdd(dvNxbKnx, 12, knxSWITCH, '1/1/35', "knxPollstart") // Light 6 status CASE 3: KNXAdd(dvNxbKnx, 20, knxDim4,...
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' Comments at the end of a line must be separated by at least one space and are...
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. This file also provides absolute terms for relative dimming and blinds control: // Constants for dimming Lights KNX_DIM_UP //Brighter...
NetLinx Programming Functions Available In KNX_Tools.axi (Cont.) Function Description KNXString2Array Syntax: Function: Converts comma separated Feedback from 14 Byte Hex into Integer Array with 14 chars. Example: KNXArray2String Syntax: Function: Converts Integer arrays with 14 chars to comma separated Array for 14 Byte Hex Type.
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. The AMX NXB-KNX Virtual Device will allow a programmer to configure cross line communication between KNX devices and the NXB-KNX.
Cross-Line Communication FIG. 24 Selective Import dialog 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: 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.
Page 47
FIG. 26 Product Finder dialog In the Product Finder dialog: Select AMX from the Manufacturer drop down. Click Find. The NXB-KNX Virtual Device will appear in the search results. Select NXB-KNX and click Insert. Close the Product Finder dialog. The NXB-KNX Virtual Device is indicated in the appropriate line (FIG. 27): FIG.
Page 48
Cross-Line Communication To facilitate cross-line and cross-area communication, all group addresses which do not originate from a device that is located on the immediate line must be linked with the appropriate communication object on the NXB-KNX Virtual Device. For example, FIG. 28 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.
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.
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.
Page 51
Click the Browse (...) button to navigate to the target directory in the Browse For Folder dialog (FIG. 31). 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.
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). NXB-KNX Operation/Reference Guide...
NetLinx device, the process of upgrading the unit is the same as for any typical NetLinx device: the latest NetLinx firmware KIT file is downloaded from www.amx.com, and transferred to the NXB-KNX via the NetLinx Master, using NetLinx Studio. See the NetLinx Firmware Upgrades section on page 43 for details.
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.
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 Select Application Upgrade from the Admin drop-down menu to open the Application Upgrade page (FIG.
Page 56
One-Time Upgrade of the NXB-KNX to a Native NetLinx Device NXB-KNX Operation/Reference Guide...
4. Press Enter. Unless Telnet security is enabled, a session will begin with a welcome banner: Welcome to AMX v1.0.36 Copyright AMX LLC 2008 > If Telnet security is enabled, type in the word login to be prompted for a Username and Password before gaining access to the NXB-KNX.
Displays the DNS configuration of a specific device including: • Domain suffix· • Configured DNS IP Information Example: >DNS LIST [0:1:0] Domain suffix:amx.com The following DNS IPs are configured Entry 1-192.168.20.5 Entry 2-12.18.110.8 Entry 3-12.18.110.7 Enables/Disables echo (display) of typed characters.
Page 59
Terminal Commands (Cont.) Command MSG ON|OFF PING [ADDRESS] REBOOT RELEASE DHCP SECURITY SETUP SET DATE NXB-KNX Operation/Reference Guide Appendix A: Telnet Commands Description Displays the largest free block of the NXB-KNX’s memory. Example: >MEM The largest free block of memory is 11442776 bytes. Enables/Disables extended diagnostic messages.
Page 60
Enter DNS Entry 2 : 12.18.110.8 Enter DNS Entry 3 : 12.18.110.7 You have entered: Domain Name: amx.com DNS Entry 1: 192.168.20.5 DNS Entry 2: 12.18.110.8 DNS Entry 3: 12.18.110.7 Is this correct? Type Y or N and Enter -> Y Settings written.
Page 61
Terminal Commands (Cont.) Command SET HTTPS PORT SET IP SET LOG COUNT SET SSH PORT NXB-KNX Operation/Reference Guide Appendix A: Telnet Commands Description Sets the NXB-KNX’s IP port listened to for HTTPS connections. Note: The NXB-KNX must be rebooted to enable new settings. Example: >SET HTTPS PORT Current HTTPS port number = 443...
Page 62
Appendix A: Telnet Commands Terminal Commands (Cont.) Command SET TELNET PORT SET TIME SHOW LOG Description Sets the NXB-KNX’s IP port listened to for Telnet connections. Note: The NXB-KNX must be rebooted to enable new settings. Example: >SET TELNET PORT Current telnet port number = 23 Enter new telnet port number (Usually 23)(0=disable Telnet): Once you enter a value and press the ENTER key, you get the follow-...
Page 63
Terminal Commands (Cont.) Command SHOW HEAP SHOW MEM TIME NXB-KNX Operation/Reference Guide Appendix A: Telnet Commands Description Displays heap usage statistics. Displays the memory usage for all memory types. Displays the current time on the NXB-KNX. Example: >TIME 13:42:04...
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.
Page 66
Appendix B: Troubleshooting Error Responses to interactive commands, e.g. 'list', are not displayed. Control and/or feedback is not working Proposed solution / error definition Responses to interactive commands are displayed only when the NXB-KNX log level is debug. Confirm the NXB-KNX log level is debug. •...
Page 68
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.com...