AMX NetLinx Interface NXB-KNX manual

Operation/Reference Guide Control System Accessories NXB-KNX KNX Communications Gateway Last Revised: 4/15/2010[...]

AMX Limited Warranty and Disclaimer This Limited W arranty and Disclaimer extends only to products purchased directly from AMX or an AMX Authorized Partn er which include AMX Dealers, Distributors, VIP’s or other AMX authorized entity . AMX warrants its products to be free of defects in material and workmanship under normal use for three (3) ye a[...]

Table of Contents i NXB-KNX Operation/Reference Guide Table of Contents Overview ...................... ...................................................................... ................ 1 Product Specifications ........................................... .................... .................... .......... 1 Installation .............. ......[...]

ii NXB-KNX Operation/Reference Guid e Table of Contents Feedback ..................... .................... .................... ........................ .................... ....... 21 Runtime ........ ................ ............. ............. ................ ............. ............. ................ ............ . 2 1 Debugging ......... .[...]

Table of Contents iii NXB-KNX Operation/Reference Guide Sample Program ........................ .................... ........................ .................... ............. 32 KNX Table ........ ............. ............. ................ ............. ............. ................ ............. ............ 32 Notes For Programming ... .....[...]

iv NXB-KNX Operation/Reference Guid e Table of Contents[...]

Overview 1 NXB-KNX Operation/Referen ce Guide Overview The NetLinx NXB-KNX interface (FG2031-01) allo ws AM X NetLinx Integrated Con trollers the ability to control, integrate and communicate with homes and building s that utilize the KNX communication protocol. KNX is the world’ s first open, royalt y-free, and platform independent standard fo r[...]

Overview 2 NXB-KNX Operation/Reference Guide NXB-KNX Specifications (Cont.) Operating Environment: • Operating T emperature: 32°F - 104°F (0°C - 40°C) • Relative Humidity: 5% to 85% non-condensing • Intended for indoor use only Included Accessories: • Rubber feet • Green 2-Pin 5mm Phoenix connector with captive screw s Other AMX Equip[...]

Installation 3 NXB-KNX Operation/Referen ce Guide Installation Wiring and Connections The NXB-KNX is installed be tween the NetLinx Ma ster and the KNX control bus, and passes NetLinx control commands to the KNX control b us via 2-wire twisted pair cabli ng, as indicated in FIG. 2: After you ha ve completed the installatio n, consult the Conf igura[...]

Installation 4 NXB-KNX Operation/Reference Guide PoE (Power Ov er Ethernet) The NXB-KNX uses CA T5/CA T6 wire vi a the Ethernet port for PoE po wer . Use the PS-POE-AF Power ov er Ethernet Injector (FG423-80) to simplify wiring and installation by eliminating t he need for a n A C out let at each point of installation.  If used with a non PoE-ca[...]

Configuration 5 NXB-KNX Operation/Referen ce Guide Configuration Overview NXB-KNX units hav e a built-in W ebConsole that allows you to make v arious configur ation settings via a web browser on any PC that has access to the NXB-KNX d evice . The web console consists of a series of web pages that are collectiv ely ca lled the "NXB-KNX Configur[...]

Configuration 6 NXB-KNX Operation/Reference Guide Refer to the NetLinx Studio online he lp for details on using Zero-Config. Accessing the NXB-KNX WebC onsole 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 th[...]

Configuration 7 NXB-KNX Operation/Referen ce Guide 4. Y ou can access any device in the Zero-Conf ig list simply by double-clicking on it's entry . The selected dev ice's W ebConsole (HTML) is di splayed in a NetLinx Studio windo w . 5. The unit’ s IP Address can be edited IP Settings page (see the IP Settings section on page 11). Acces[...]

Configuration 8 NXB-KNX Operation/Reference Guide Device Configuration Select Device Conf iguration from the Admin menu to open the Device Conf iguration page. Use the options on the page to specify a De vice Number and def i ne connection info rmation for the NetLinx Master . This page contains two tabs: De vice Configuration , and Master Connecti[...]

Configuration 9 NXB-KNX Operation/Referen ce Guide T o establish communication between the NXB-KNX and a specif ic NetLinx Master: 1. Enter the Master’ s IP/URL in the Master IP/URL te xt field. 2. The defau lt Master P ort Number assignment is 1319 - do not change this number . 3. Under Authe ntication Settings , ente r the NetLinx Master’ s U[...]

Configuration 10 NXB-KNX Operation/Reference Guide Login Information Use this set of options to specify a Username and Password. These will be req uired only if one or more of the Security Settings are enabled.  Click Accept to sa ve your changes. Note that change s on this page tak e effect immediately .  Click Cancel to cancel an y changes.[...]

Configuration 11 NXB-KNX Operation/Referen ce Guide IP Settings Select IP Settings from the Admin drop-do wn 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 pa ge Hostname: Enter a Hostname for this unit (enab led only if DHCP is disable d). DHCP: Cli[...]

Configuration 12 NXB-KNX Operation/Reference Guide Port Settings Select Port Settings from the Admin drop-do wn menu to open the P ort Settings page (FIG. 15). Use the options on the page to specify various Port settings for this NXB-KNX unit. The options on this page provide inputs for enabling and disabling of HTTP , HT TPS, T elnet, SSH a nd FTP[...]

Configuration 13 NXB-KNX Operation/Referen ce Guide Clock Manager Hov er the cursor over the Clock Ma nager option in the Admin menu to op en the Clock Manager sub-menu (FIG. 16). Each of the options listed in the s ubmenu are also accessible via options on the Cloc k Manager page (FIG. 17). Clock Manager - Mode Manager Select the main Cl ock Manag[...]

Configuration 14 NXB-KNX Operation/Reference Guide The options on the Mode Manager page provide inputs for selecting the cu rrent mode of th e system time:  Click Accept to sa ve your changes. Note that change s on this page tak e effect immediately .  Click Cancel to cancel an y changes. Clock Manager - D aylight Savings Select Daylight Savi[...]

Configuration 15 NXB-KNX Operation/Referen ce Guide The options on this page allow you to enable and disabl e daylight sa vings, and specify daylight savings start and end times.  Click Accept to sav e your changes. Note that change s on this page take ef fect immediately .  Click Cancel to cancel an y changes. Clock Manager - NIST Serv ers S[...]

Configuration 16 NXB-KNX Operation/Reference Guide The options on this page allow you to select the NIST serv er that will be queried at each clock synchronization, and allow you to add more NIST servers to the list. T o add a NIST server , enter the NIST Server Name , IP Addr ess and Location in the fi elds prov ided. T o remove a NIST serv er fro[...]

NetLinx Programming 17 NXB-KNX Operation/Referen ce Guide NetLinx Programming Overview It is important to understand that the NXB-KNX cann ot configure a KNX system . The NXB-KNX serves a functioning KNX system, and can only acce ss bus elements with permitted use. Understanding the KNX Bus KNX is a bus system: all components ar e connected to the [...]

NetLinx Programming 18 NXB-KNX Operation/Reference Guide KNX Bus Diagram The NXB-KNX is a trans parent KNX device and can be connected at any location with the KNX. In contrast to simple actuators and sensors, the NXB-KNX may be re sponsible for up to 3,000 Destination Addresses (where a normal dimmer only responds to f our Destination Addresses) .[...]

NetLinx Programming 19 NXB-KNX Operation/Referen ce Guide Notes on Line Couplers T elegrams must be intelligently sent across KNX lines by line couplers.  Line couplers pre vent T elegrams within a li ne from adding traf fic load outside its line.  Line couplers al so filte r out cross-line T elegrams if its line is not the destination line. [...]

NetLinx Programming 20 NXB-KNX Operation/Reference Guide Integrating with NetLinx The NXB-KNX is a nati ve ICSP de vice in NetLinx. The NXB-KNX associat es each actuator (actor number) with a corresponding Channel and Le vel mapping. For example the v alue of actor 1 will map t o Channel 1 / Lev el 1, and actor 52 will map to Channel 52 / Level 52.[...]

NetLinx Programming 21 NXB-KNX Operation/Referen ce Guide Feedback Runtime All actuators/sensors can be config ured to feedback to channels and le vels via the ICSP command. In addition feedback is gene rated in a readable ASCII display - dependi ng o n flags - meaning, the raw data are output as time string, date stri ng, floating point display et[...]

NetLinx Programming 22 NXB-KNX Operation/Reference Guide AMX_NXB_MOD Module The AMX_NXB_MOD module is provided to facilitate remo te logging from NXB-KNX as well as the "List Sa ve" and "List Loa d" functions. The AMX_NXB_MOD module is integrated w ith the source code as follo w s: DEFINE_MODULE 'AMX_NXB_MOD' nxbMod(dv[...]

NetLinx Programming 23 NXB-KNX Operation/Referen ce Guide Analyzing Feedback Data feedback i s anal yzed in a D A T A_EVENT :  The feedback is always in STRING format  One D A T A_EVENT is actuated per feedback (exactly one feedback in the D A T A.TEXT) NetLinx Send_Commands Commands to the module alw a ys take place per SEND_COMMAND to the d[...]

NetLinx Programming 24 NXB-KNX Operation/Reference Guide NetLinx Send_Commands (Cont.) Command Description BIND= Definition of Bind trigger Syntax: BIND=<No>:<No2> Note : The trigger is fired w hen the first address is addressed, not just a change in value of the first address. • When <No> is changed, <No2> is updated with[...]

NetLinx Programming 25 NXB-KNX Operation/Referen ce Guide NetLinx Send_Commands (Cont.) Command Description DEBUGOFF Deactivate debug reports Syntax: DEBUGOFF Example: SEND_COMMAND dvKNX,‘DEBUGOFF‘ DEL Delete Actuator from Ta b l e Syntax: DEL <Value> Parameters: <V alue> = AMX Number of Actuator (range = 1 - 3000) Example: SEND_COM[...]

NetLinx Programming 26 NXB-KNX Operation/Reference Guide NetLinx Send_Commands (Cont.) Command Description GET= GET? Request V alue of Actuator stored in the module Note : Creates no T e legram on KNX (use for synchro nization of master-to-master connection. Syntax: GET=<No> GET?<No> Parameters: • <No> = AMX Number of Actuator ([...]

NetLinx Programming 27 NXB-KNX Operation/Referen ce Guide NetLinx Send_Commands (Cont.) Command Description LIST <No> <No2> List actuators in the range of <No> to <No2>. List actuators in the range of <No> to <No2> (AMX numbers) with KNX gr oup address, current value, set flags (if applicable) and resulting addit[...]

NetLinx Programming 28 NXB-KNX Operation/Reference Guide NetLinx Send_Commands (Cont.) Command Description LIST LO AD Reads the entries in table written with LIST SA VE. Reads the entries in table written with LIST SA VE from CF and back. • The current table is replaced with the read one. • File name is optional. • If no file name is specifie[...]

NetLinx Programming 29 NXB-KNX Operation/Referen ce Guide NetLinx Send_Commands (Cont.) Command Description POLL= POLL? Request current value of actuator . Note : Creates a T elegr am on KNX (For synchronization of master-to-master connection, only use GET command). Syntax: POLL=<No> POLL?<No> Parameters: • <No> = AMX Number of [...]

NetLinx Programming 30 NXB-KNX Operation/Reference Guide NetLinx Send_Commands (Cont.) Command Description SENDDELA Y= Delay between commands to KNX. V alue is the time in 1/10 sec. The value 0 deactivated the delay . Syntax: SENDDELAY=<Value> Examples: SEND_COMMAND dvKNX,‘SENDDELAY=0‘ SEND_COMMAND dvKNX,‘SENDDELAY=2‘ SET= Set Actuato[...]

NetLinx Programming 31 NXB-KNX Operation/Referen ce Guide NetLinx Send_Commands (Cont.) Command Description TIME? Request of time Note : Only valid for 3 Byte Act uators Syntax: TIME?<No> Parameters: • <No> = AMX Number of Actuator (range = 1 - 3000) Example: SEND_COMMAND dvKNX,‘TIME?8‘ Returns: Feedback of Time TIME=<No>:&l[...]

NetLinx Programming 32 NXB-KNX Operation/Reference Guide Sample Program KNX Table All actuators to be switched/set/con trolled need to be provisione d on the NXB- KNX. In this e xample it is achiev ed with the use of the KNX_T abl e.axi file. All pro visioning commands are listed in the 'ONLINE' for the NXB-KNX de vice. Other options are [...]

NetLinx Programming 33 NXB-KNX Operation/Referen ce Guide { SWITCH(Counter) //Send config comm and in groups. //Caution avoid sending large quant ities of config commands without intermittent wait intervals. { CASE 1: { KNXAdd(dvNxbKnx, 1, knxSWITC H, '1/1/0', "") // Light 1 switch KNXAdd(dvNxbKnx, 2, knxSWITC H, '1/1/1&apo[...]

NetLinx Programming 34 NXB-KNX Operation/Reference Guide Example 2 - Structure of KNX-T able with SE ND_COMMAND S MODULE_NAME='KNX_Table_NXB_A'(DEV dvNxb Knx) DEFINE_VARIABLE integer counter float waitVal DEFINE_START Counter=0 waitVal = .2 #INCLUDE 'KNX_Tools.axi' DEFINE_EVENT DATA_EVENT [dvNxbKnx] { ONLINE: //Start configurati[...]

NetLinx Programming 35 NXB-KNX Operation/Referen ce Guide Example 3 - Loa d Configuration from File The configuratio n can be read and gene rated from/to a f ile on the master file system. The re ading of the f ile can for instance be started in the ONLINE section of the interf ace. ... DATA_EVENT[dvKNX] { ONLINE : { SEND_COMMAND dvKNX,'LIST L[...]

NetLinx Programming 36 NXB-KNX Operation/Reference Guide DEFINE_MODULE 'AMX_KNX_Updater' Updater (dvKNX, lKNX_Value) //Module hand les update //of array fo r feedback control DEFINE_MODULE 'AMX_NXB_MOD' nxbMod(dvKN X) //Module hand les remote //logging fro m NXB-KNX //as well as facilitates //List Save a nd //List Load f unction[...]

NetLinx Programming 37 NXB-KNX Operation/Referen ce Guide KNX_Tools.axi W e recommend not to use the send comm ands directly , but always use the fu nctions of this inclu de file. The compiler has the opportunity to av oid typing errors al ready during compiling. A dditional typing is av oided. This fi le also pro vides absolute ter ms for relati v[...]

NetLinx Programming 38 NXB-KNX Operation/Reference Guide Functions Available In KNX_Tools.axi (Cont.) Function Description KNXString2Array Syntax : KNXString2Array (<CHAR sArray[]>) Function: Converts comma separated Feedback from 14 Byte Hex into Integer Array with 14 chars. Example: nArray = KNXString2Array (sArray) KNXArray2String Syntax :[...]

Cross-Line Communication 39 NXB-KNX Operation/Referen ce Guide Cross-Line Communication Overview In many cases cross-line communicati on is required. In order to enab le cross line communication a KNX programmer will need to utilize the AMX NXB-KNX V irtual Device. This ETS device entry will serve as the NXB-KNX device in ETS3. The NXB-KNX is not a[...]

Cross-Line Communication 40 NXB-KNX Operation/Reference Guide 4. V erify that NXB-KNX is selec ted, and click Import . Adding the Virtual Device to the ETS3 Project Once the import procedure is complete, the virtua l device must be adde d to the ETS3 project: 1. Identify the ap propriate Ar ea and Line at which the physical NXB- KNX will be connect[...]

Cross-Line Communication 41 NXB-KNX Operation/Referen ce Guide 3. In the Pr oduct F inder dialog: a. Sele ct AMX from the Manufacturer drop do wn. b. Click Find . c. The NXB-KNX V irtual Device will appear in the search results. d. Select NXB-KNX and click Insert . e. Close the Pr oduct Fi nder dialog. 4. The NXB-KNX V irtual Device is indicate d i[...]

Cross-Line Communication 42 NXB-KNX Operation/Reference Guide T o facilitate cross-line and cross-area communica tion, all group addresses which do not originate from a de vice that is located on the immedi ate line mus t be linked with the appropriate communication object on the NXB-KNX V irtual Device. For e xample, FIG. 28 indicates Light G , Li[...]

NetLinx Firmware Upgrades 43 NXB-KNX Operation/Reference Guide NetLinx Firmware Upgrades Overview The NetLinx Studio software application (av ailable for free download from www .amx.com) provides the ability to transfer KIT firmwa re files to a NetLinx device such as the NXB-KNX. T o send firmw are fi les, select T ools > Firmware T ransfers, th[...]

NetLinx Firm ware Upgrad es 44 NXB-KNX Operation/Reference Guide Once the unit has been upgraded, the NXB-KNX will function as a na tive NetLinx de vice, and all subsequent Firmware upgrades are handled via NetLin x Studio, using KIT files (lik e any other nati ve NetLinx de vice). 2. V erify you have the latest ve rsion of NetLinx Studio on your P[...]

NetLinx Firmware Upgrades 45 NXB-KNX Operation/Reference Guide 2. Click the Br owse (...) b utton to navig ate to the target directory in the Br owse F or F older dialog (FIG. 31).  The selected directory path is displayed in the Send T o NetLinx Device dialog ( Location te xt box).  Assuming that the specified tar get directory contai ns one[...]

NetLinx Firm ware Upgrad es 46 NXB-KNX Operation/Reference Guide 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 p rocess.  During the upgrade process, the Status LE D blinks, and the NXB-KNX stays of fline.  Once the upgrade is complete, the LED wi[...]

One-Time Upgrade of the NXB-KNX to a Nat ive NetLinx Device 47 NXB-KNX Operation/Referen ce Guide 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 ope rated as an IP Device (as opposed to [...]

One-Time Upgrade of the NXB-KNX to a Nat ive NetLinx Device 48 NXB-KNX Operation/Reference Guide Determining the Current Firmwa re Version Of the NXB-KNX Select Firmware Upgrade from the Admin menu to open the F irmware Upgr ade Manager p age (FIG. 34). Use the options on the page to upgrad e the firmw are on this NXB-KNX unit. This page allows you[...]

One-Time Upgrade of the NXB-KNX to a Nat ive NetLinx Device 49 NXB-KNX Operation/Referen ce Guide Determining the Current Applic ation Ve rsion Of the NXB- KNX Information on the current appl ication v ersion loaded on the device is displayed in the Application Upgr ade Manager page (FIG. 35). If Current Applicati on Version Is Lower Tha n v2.0.15 [...]

One-Time Upgrade of the NXB-KNX to a Nat ive NetLinx Device 50 NXB-KNX Operation/Reference Guide[...]

Appendix A: Telnet Commands 51 NXB-KNX Operation/Referen ce Guide Appendix A: Telnet Commands Overview The NXB-KNX supports T elnet communications. This ty pe of terminal communi cation can be accessed remotely , vi a TCP/IP . T elnet is an insecure form of terminal communication, since it does not require a physical connection to the dev ice to co[...]

Appendix A: Telnet Commands 52 NXB-KNX Operation/Reference Guide Terminal Commands The T erminal comman ds listed in the following table can be sent directly to the NXB-KNX via T e lnet terminal session. In your terminal program, type " Help " or a question mark (" ? ") and < Enter > to access the H elp Menu, and display t[...]

Appendix A: Telnet Commands 53 NXB-KNX Operation/Referen ce Guide Terminal Commands (Cont.) Command Description MEM Displays the largest free block of the NXB-KNX’s memory . Example: >MEM The largest free block of memory is 1 1442776 bytes. MSG ON|OFF Enables/Disables ext ended diagnostic messages. • MSG On sets the terminal program to displ[...]

Appendix A: Telnet Commands 54 NXB-KNX Operation/Reference Guide Terminal Commands (Cont.) Command Description SET DNS Sets up the DNS configuration. This command prompts you to enter a Domain Name, DNS IP #1, DNS IP #2, and DNS IP #3. Then, enter Y (yes) to approve/store the information in t he NXB-KNX. Entering N (no) cancels the operation. Note [...]

Appendix A: Telnet Commands 55 NXB-KNX Operation/Referen ce Guide Terminal Commands (Cont.) Command Description SET HTTPS PORT Sets the NXB-KNX’ s IP port listened to for HTTPS conne ctions. Note : The NXB-KNX must be rebooted to enable new settings. Example: >SET HTTPS PORT Current HTTPS port number = 443 Enter new HTTPS port number (Usually [...]

Appendix A: Telnet Commands 56 NXB-KNX Operation/Reference Guide Terminal Commands (Cont.) Command Description SET TELNET PORT Sets the NXB-KNX’s IP port listened to for T elnet 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 numbe r (Usual[...]

Appendix A: Telnet Commands 57 NXB-KNX Operation/Referen ce Guide Terminal Commands (Cont.) Command Description SHOW HEAP Displays heap usage statistics. SHOW MEM Displays the memory usage for all memory types. TIME Displays the current time on the NXB-KNX. Example: >TIME 13:42:04[...]

Appendix A: Telnet Commands 58 NXB-KNX Operation/Reference Guide[...]

Appendix B: Troubleshooting 59 NXB-KNX Operation/Referen ce Guide Appendix B: Troubleshooting Overview AMX recommends activ ating debugging mode during diagnostics to display additional error messages. This is acti vated with moni tor command "DEBUGON". The following table pro vides tips for error def inition, in case it does not work. Th[...]

Appendix B: Troubleshooting 60 NXB-KNX Operation/Reference Guide Er ror Proposed solution / er r or definition Responses to interactive commands, e.g. 'list', are not displayed. Responses to interactiv e commands are displayed only when the NXB-KNX log level is debug. Confirm the NXB-KNX log level is debug. • Establish a telnet session [...]

Programming - Telnet Comm ands 61 NXB-KNX Operation/Reference Gu ide[...]

4/10 © 2010 AMX. All rights reserved. AMX and the AM X logo are register ed trademarks of AMX. AMX reserves the right to alter specifica tions without notice at any time. It’s Your World - Take Con trol™ 3000 RESEARCH DRIVE, RICHARDSON, TX 75082 USA • 800.222.0193 • 469.624.8000 • 469-624-7153 fax • 800.932.6993 technical support • w[...]