AMX NXB-KNX, Instruction Manual

Page 1: ...Instruction Manual NetLinx Interface Controllers NXB KNX KNX Communications Gateway Last Revised 4 28 2014 ...

Page 2: ...rked on the outside of each box The RMA is valid for a 30 day period After the 30 day period the RMA will be cancelled Any shipments received not consistent with the RMA or after the RMA is cancelled will be refused 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 incl...

Page 3: ...g 6 Accessing the WebConsole via Web Browser 6 Admin Menu 7 Device Configuration 7 Device Configuration tab 7 Changing the Device Number 7 Master Connection tab 8 Security Settings 8 Enable Disable Security Settings 9 Login Information 9 Logging Into the Configuration Manager With Security Enabled 9 IP Settings 10 Port Settings 10 Clock Manager 11 Clock Manager Mode Manager 12 Clock Manager Daylig...

Page 4: ...e 20 Analyzing Feedback 21 NetLinx SEND_COMMANDs 21 ADD 21 ADR 21 BIND 22 DATE 22 DATE 22 DEBUGON 22 DEBUGON 22 DEBUGOFF 23 DEL 23 EIS5 23 EIS5 23 ERRORM 23 GET 24 GET 24 HELP or 24 ICSP 24 LIST 24 LIST No 24 LIST No No2 25 LIST Type 25 LIST BIND 25 LIST FLAGS 25 LIST GAPS 25 LIST LOAD 26 LIST POLL 26 LIST SAVE 26 LIST SUM 26 LIST WATCH 26 POLL 26 POLL 26 POLLDELAY 27 POLLSTART 27 SEARCH 27 SENDDE...

Page 5: ...ation 37 Overview 37 Integrating the NXB KNX Virtual Device Into An ETS3 Project 37 Adding the Virtual Device to the ETS3 Project 38 NetLinx Firmware Upgrades 41 Overview 41 Before You Start 41 Sending a Firmware KIT File To the NXB KNX 42 Additional Documentation 44 One Time Upgrade of the NXB KNX to a Native NetLinx Device 45 Overview 45 Determining the Current Firmware Version Of the NXB KNX 46...

Page 6: ...iv NXB KNX KNX Communications Gateway Table of Contents Appendix B Troubleshooting 55 Overview 55 ...

Page 7: ... and the unit is connected to the KNX bus Output red Lights to indicate traffic from the NXB KNX to the KNX bus Input yellow Lights to indicate traffic from the KNX bus to the NXB KNX Rear Panel Connectors KNX 2 pin captive wire connector optically isolated Ethernet Port 10 100 Ethernet with PoE LEDs show communication activity connection status speeds and mode information SPD speed Yellow LED lig...

Page 8: ...g Temperature 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 screws Other AMX Equipment AC DIN CS3 DIN Rail Mounting Bracket FG532 01 PS POE AF PoE Injector FG423 80 Certifications FCC Class B CE IEC60950 RoHS ...

Page 9: ... Base T connector and cable FIG 3 diagrams the RJ 45 pinouts and signals for the Ethernet RJ 45 connector and cable 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 FIG 2 NXB KNX installation Ethernet Pinouts and Signals Pin Signals Connections Pairing Color 1 TX 1 1 1 2 White ...

Page 10: ...onal PS POE AF Power over Ethernet PoE power supply is required to provide power to the NXB KNX If the NXB KNX is used with a PoE capable Ethernet switch such as the NXA ENET24PoE then no PoE Injectors are required KNX Connector The KNX connector on the rear panel is a 2 pin captive wire connector optically isolated that provides communication between the NXB KNX and the KNX control system via 2 w...

Page 11: ...address via NetLinx Studio v3 0 or higher or a similar zero configuration client Zero configuration or Zero Config technology provides a general method to discover services on a local area network In essence it allows you to set up a network without any configuration as described below NetLinx Studio featuring Zero Config functionality NetLinx Studio v3 0 or higher features a Zero Config tab in th...

Page 12: ...the plus symbol to expand any device in the Zero Config list The device s current IP Address is listed below the device name FIG 8 4 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 5 The unit s IP Address can be edited IP Settings page see the IP Settings on page 10 Accessing the...

Page 13: ...0 The current device number assigned to this NXB KNX unit is displayed in the Device Number field The version of the device Application currently loaded on this unit is displayed under Current Application Information Changing the Device Number FIG 9 NXB KNX Configuration Manager Admin menu If you see the additional entries Application Upgrade and Firmware Upgrade in the Admin menu it is an indicat...

Page 14: ...tly from the Admin Menu select Master Connection To establish communication between the NXB KNX and a specific NetLinx Master 1 Enter the Master s IP URL in the Master IP URL text field 2 The default Master Port Number assignment is 1319 do not change this number 3 Under Authentication Settings enter the NetLinx Master s Username and Password only required if the target NetLinx Master has Authenti...

Page 15: ...system Web pages Default disabled Telnet Security Click this checkbox to enable Telnet Security With Telnet Security enabled a username and password are required to establish a Telnet or SSH connection Default disabled Admin Security Click this checkbox to enable Admin Security With Admin Security enabled a username and password are required to modify any system configuration item Default disabled...

Page 16: ...ort Settings FIG 13 NXB KNX Configuration Manager Login popup page FIG 14 IP Settings page Hostname Enter a Hostname for this unit enabled only if DHCP is disabled DHCP Click to toggle DHCP on this unit default enabled Note that DHCP must be enabled in order for the zero configuration client i e Bonjour for Windows to detect the NXB KNX on the network See the NetLinx Studio featuring Zero Config f...

Page 17: ...nment Clock Manager Hover the cursor over the Clock Manager option in the Admin menu to open the Clock Manager sub menu FIG 16 FIG 15 Port Settings page Restore Factory Defaults Click to restore all Port settings to the factory defaults HTTP Port Number Default enabled Default port number 80 HTTPS Port Number Default enabled Default port number 443 Telnet Port Number Default enabled Default port n...

Page 18: ... options FIG 18 Clock Manager Mode Manager page Time Sync Use the radio buttons to select either Network Time or StandAlone Note If using StandAlone mode the time will be valid only until the unit is rebooted Once the unit is rebooted the time will be lost and will have to be reset Note that the Daylight Savings and NIST Servers tabs are enabled only if Network Time is selected as the mode Re Sync...

Page 19: ... Use these radio buttons to turn daylight savings time on and off default Off Offset Use these drop down menus to specify the amount of time to offset the clock for daylight savings Starts These options allow you to specify when to start using daylight savings time Select a month and time to start from the drop down menus Select Fixed to start daylight savings at a specific Day Month and Time an a...

Page 20: ...low 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 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 ca...

Page 21: ...ame time There is a basic difference between Source IDs and Destination Addresses A Source ID is the hardware address of the device transmitting the Telegram A Destination Address is a group address characterizing a function Thus each device connected to KNX has exactly one Source ID but may have several Destination Addresses Furthermore it is common for several Source IDs devices to respond to th...

Page 22: ...ill require a certain amount of time between receiving Telegrams The situation with the NXB KNX is different the NXB KNX can read all Telegrams even with high bus load Therefore it is crucial that activated Actuators are given sufficient time to respond Notes on Line Couplers Telegrams must be intelligently sent across KNX lines by line couplers Line couplers prevent Telegrams within a line from a...

Page 23: ...ically use 3 Byte DPT 10 time and 3 Byte DPT 11 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 The supported User ...

Page 24: ... SEND_COMMANDs section on page 21 Channels and Levels All addresses are available as channels The current value is mapped to the corresponding channels of the device All addresses are available as levels For every value change the current value is transmitted as level to the program for instance to control a bargraph Data Types Channels Channel Description 1 n 0 n 3000 Mapping of values irrespecti...

Page 25: ...lue change or as answer to a poll command String 1 from device value change SET 15 3175 String 2 from device EIS5 15 22 54 or 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 Tota...

Page 26: ...le axi file included This include file maps the Destination Address type poll conjunction and additional features to an actor number between 1 and 3000 Communication with the actuators is accomplished via this actor number KNX_Table axi Include File The KNX_Table axi file contains the definition of all actuators on the KNX bus that will be controlled or monitored by the NetLinx system and is integ...

Page 27: ...te Flags are optional Parameters No AMX Number of Actuator range 1 3000 Type Actuator Type Switch Control Dim4 1Byte 2Byte 3Byte 4Byte Text HexText GrpAdr KNX group address in 2 or 3 grouped display Flags EIS5 Value is reported additionally as ASCII Float Value The KNX Value is converted according to EIS5 Standard only valid for 2Byte Actuators Time Value is reported additionally as ASCII Time hh ...

Page 28: ...valid for 3Byte Actuators Syntax DATE No Datum Parameters No AMX Number of Actuator range 1 3000 Date date format MM DD YY Example SEND_COMMAND dvKNX DATE 17 14 08 06 Returns DATE No Value Note Is transmitted as ADDITIONAL feedback if in actuator No the DATE flag is set No AMX Number of Actuator Value Date string in format MM DD YY AMX display Example DATE 17 08 14 06 DATE Request Date Note Only v...

Page 29: ...ND_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 EIS5 No Value 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 EIS5 Request EIS5 value Converts the 2Byte...

Page 30: ...her and in any order Use this command to override the default number of channels and or levels Default for Channels and Levels 256 Note Caution is advised when expanding resources since the Central Controller s resources need to be considered Examples SEND_COMMAND dvKNX icsp ch 128 SEND_COMMAND dvKNX icsp lv 512 SEND_COMMAND dvKNX icsp ch 256 lv 384 LIST List all entered actuators Lists all entere...

Page 31: ...l feedback values Also provides a sum of all actuators of one Type Syntax LIST Type Parameters Type Data Type where SW or SWITCH 1Bit Actuators CO or CONTROL 2Bit Actuators D4 or DIM4 4Bit Actuators 1B or 1BYTE 1Byte Actuators 2B or 2BYTE 2Byte Actuators 3B or 3BYTE 3Byte Actuators 4B or 4BYTE 4Byte Actuators Example SEND_COMMAND dvKNX LIST 1B LIST BIND List all bind triggers with AMX number and K...

Page 32: ...d with the structure of the regular table Thus a table can be buffered modified i e delete or add actuators and finally reconstructed with LOAD see above File name is optional If no file name is specified the default file name is used Default file name KNXTableNX TXT Note In monitor connection with master the already available files on CF can be listed by entering list no SEND_COMMAND to device Sy...

Page 33: ... are affected The POLLDELAY setting affects the rate poll commands are sent to the KNX bus This command is typically sent at the completion of the NXB KNX configuration 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 POLLS...

Page 34: ...e With the NXB_KNX_Updater module the feedback array type LONG is automatically updated unchanged values are reported as VAL see below Nr AMX Number of Actuator Value new Value of Actuator raw data Example feedback SET 8 1 STATE Output of current module status in terminal Example SEND_COMMAND dvKNX STATE STATUS List general status information for AMX hardware KNX bus status Active KNX table Syntax...

Page 35: ...o AMX Number of Actuator Value Value of Actuator VERSION Output of current module version in Terminal Example SEND_COMMAND dvKNX VERSION WATCH Activate observation function for actuator All value changes are recorded on monitor with KNX group address current value set flags and resulting additional feedback values Syntax WATCH No Parameters No AMX Number of Actuator range 0 3000 0 deactivation of ...

Page 36: ...26 Refer to Example 3 Load Configuration from File on page 33 Notes For Programming Predefined functions are available for control to generate the SEND_COMMANDs for the NXB KNX These functions are in the KNX_Tools axi include file see the KNX_Tools axi section on page 35 Example 1 Structure of KNX Table With Functions From KNX_Tools axi MODULE_NAME KNX_Table_NXB_A DEV dvNxbKnx DEFINE_VARIABLE inte...

Page 37: ...relative light 6 KNXAdd dvNxbKnx 25 knx1Byte 1 1 25 Dimmer absolute light 6 KNXAdd dvNxbKnx 26 knx1Byte 1 1 45 knxPollstart Dimmer feedback light 6 CASE 4 KNXAdd dvNxbKnx 27 knx2Byte 1 3 4 knxEIS5 knxPollstart Temp Actual KNXAdd dvNxbKnx 28 knx2Byte 1 3 5 knxEIS5 knxPollstart Temp Setpoint readable KNXAdd dvNxbKnx 29 knx2Byte 1 3 6 knxEIS5 Temp Setpoint writeable KNXAdd dvNxbKnx 31 knx3Byte 1 4 0 ...

Page 38: ... DATA DEVICE ADD 12 Switch 1 1 35 PS Light 6 status SEND_COMMAND DATA DEVICE ADD 20 Dim4 1 1 14 Dimmer relative light 5 SEND_COMMAND DATA DEVICE ADD 21 1Byte 1 1 24 Dimmer relative light 5 SEND_COMMAND DATA DEVICE ADD 22 1Byte 1 1 44 PS Dimmer feedback light 5 SEND_COMMAND DATA DEVICE ADD 24 Dim4 1 1 15 Dimmer relative light 6 SEND_COMMAND DATA DEVICE ADD 25 1Byte 1 1 25 Dimmer absolute light 6 SE...

Page 39: ...2 PS Light 2 Status poll on Start ADD 6 Switch 1 0 13 PS Light 3 Status poll on Start ADD 7 Switch 1 0 21 Scene 1 2 ADD 8 Switch 1 0 22 Scene 3 4 ADD 9 Switch 1 0 31 Blinds up down ADD 10 Switch 1 0 32 Blinds shutter ADD 11 Switch 1 0 111 Dimmer On Off ADD 12 Dim4 1 0 112 Dimmer relative ADD 13 1Byte 1 0 113 Dimmer absolute ADD 14 1Byte 1 0 114 PS Dimmer read Value poll on Start ADD 15 2Byte 1 0 2...

Page 40: ...control DEFINE_MODULE AMX_NXB_MOD nxbMod dvKNX Module handles remote logging from NXB KNX as well as facilitates List Save and List Load functions DEFINE_EVENT DATA_EVENT dvKNX ONLINE SEND_COMMAND dvKNX LIST LOAD MyTable txt BUTTON_EVENT dvTP 1 PUSH KNXSet dvKNX 1 1 Light 1 ON KNXSet dvKNX 16 128 Ballast to 50 Light 2 KNXSet dvKNX 12 10 Dimmer up Light 3 RELEASE KNXSet dvKNX 12 0 Dimmer Stop Light...

Page 41: ...utomatically 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 Syntax KNXGet NXB KNX Device actor No Example nVAL KNXGet dvKNX 13 KNXPoll Polls the actuator actor No Syntax KNXPoll NXB KNX Device actor No Example KNXPoll dvKNX 13 KNXAdd Adds entry to KNX table description of parameters see above Syntax ...

Page 42: ...NetLinx Programming 36 NXB KNX KNX Communications Gateway ...

Page 43: ...e will allow a programmer to configure cross line communication between KNX devices and the NXB KNX The AMX NXB KNX Virtual Device once configured as desired will allow ETS3 to calculate the appropriate routing tables for line and area couplers Integrating the NXB KNX Virtual Device Into An ETS3 Project The following are the basic steps for integrating the NXB KNX Virtual Device into an existing E...

Page 44: ...te 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 2 Select Add Devices to invoke the Product Finder dialog FIG 26 FIG 24 Selective Import dialog FIG 25 ETS3 Topology in Default Project context menu FIG 26 Product Finder dialog ...

Page 45: ...ce 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 1 Create this linkage for all group addresses which do not originate within the line at which the NXB KNX is physical...

Page 46: ...Cross Line Communication 40 NXB KNX KNX Communications Gateway ...

Page 47: ...les in order to allow the NXB KNX to function as a native NetLinx Device Firmware version 1 0 36 or higher Application version 2 0 15 or higher Refer to the One Time Upgrade of the NXB KNX to a Native NetLinx Device section on page 45 for directions on upgrading the Firmware and Application versions to these base minimum versions Once the unit has been upgraded the NXB KNX will function as a nativ...

Page 48: ... open the Online Device Tree 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 The Online Device Tree Online Tree tab of the Workspace Window displays information about each online device including the current firmware version Before attempting...

Page 49: ... Number assigned to the NXB KNX is 0 Use the Online Device Tree to determine the device s assigned ID if it has been changed 5 Review the File Connection Address and Target Device information before you send 6 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 r...

Page 50: ...Linx Studio online help and Operation Reference Guide available at www amx com 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 ...

Page 51: ...ow them to function as a native NetLinx device Older NXB KNX units that are using the initial Application and Firmware versions feature two Configuration pages that are not included in the current version the Application Upgrade Manager page and the Firmware Upgrade Manager page FIG 33 If these options do not appear in the Admin Menu then your NXB KNX unit is already a NetLinx device and the direc...

Page 52: ...iate the download of the selected JAR file to the unit If the download fails for any reason an error message is displayed indicating the failure If the download is successful a message is displayed Click the Reboot button to initiate a system reboot Firmware changes only take effect after a reboot If Current Firmware Version Is Lower Than v1 0 36 1 Select Firmware Upgrade from the Admin drop down ...

Page 53: ...cation 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 15 jar 3 Click Accept 4 When the upgrade is complete reboot the NXB KNX FIG 35 Application Upgrade Manager page Once the Application upgrade is performed all subsequent upgrades will be performed via Netlin...

Page 54: ...One Time Upgrade of the NXB KNX to a Native NetLinx Device 48 NXB KNX KNX Communications Gateway ...

Page 55: ...xample telnet XXX XXX XXX XXX 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 5 Enter your username to be prompted for a password If the password is correct you will see the welc...

Page 56: ...d Entry 1 192 168 20 5 Entry 2 12 18 110 8 Entry 3 12 18 110 7 ECHO ON OFF Enables Disables echo display of typed characters GET JAVA HEAP Display the amount of memory allocated for Java pool This is the current Java memory heap size as measured in Megabytes Example a value of 5M 5 MB GET ETHERNET MODE Displays the current ethernet configuration setting Settings are either auto in which the ethern...

Page 57: ... be rebooted to acquire a new DHCP lease Example RELEASE DHCP SECURITY SETUP Modify system security settings SET DATE Prompts you to enter the new date for the NXB KNX Example SET DATE Enter Date mm dd yyyy Note Due to the absence of a battery backed real time clock setting the current date is only valid for the life of the current run When the unit is rebooted the date will be lost SET DNS Sets u...

Page 58: ... Example SET FTP PORT FTP is enabled Do you want to enable e or disable d FTP enter e or d FTP enabled reboot the NXB KNX for the change to take affect SET HTTP PORT Sets the NXB KNX s IP port listened to for HTTP connections Note The device must be rebooted to enable new settings Example SET HTTP PORT Current HTTP port number 80 Enter new HTTP port number Usually 80 0 disable HTTP Setting HTTP po...

Page 59: ...e device must be rebooted to enable new settings Example SET LOG COUNT Current log count 1000 Enter new log count between 50 10000 Once you enter a value and press the ENTER key you get the following message Setting log count to New log count set reboot the NXB KNX for the change to take affect SET SSH PORT Sets the NXB KNX s IP port listened to for SSH connections Note The device must be rebooted...

Page 60: ...g for System 50 Version v2 10 75 Entry Date Time Object Text 1 11 01 2001 THU 14 14 49 ConnectionManager Memory Available 11436804 26572 2 11 01 2001 THU 14 12 14 ConnectionManager Memory Available 11463376 65544 3 11 01 2001 THU 14 10 21 ConnectionManager Memory Available 11528920 11512 4 11 01 2001 THU 14 10 21 TelnetSvr Accepted Telnet connection socket 14 addr 192 168 16 110 port 2979 5 11 01 ...

Page 61: ... client like Internet Explorer s Bonjour or NetLinx Studio s Zero Config tab to access the NXB KNX Configuration Manager Check the NXB KNX IP Settings match your network configuration Check the NXB KNX Master Connection settings match your AMX Master controller configuration Confirm the current NXB KNX connection status by viewing the NXB KNX status banner Obtain the NXB KNX ip address using a zer...

Page 62: ...XB 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 Use the NXB KNX debugoff command to return the log level to info Control and or feedback is not working Confirm the NXB KNX configuration by using the list interactive command Do all expected actors appear in the list Do all exp...

Page 63: ...Appendix B Troubleshooting 57 NXB KNX KNX Communications Gateway ...

Page 64: ...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 com ...