AMX NXB-KNX Instruction Manual
AMX NXB-KNX Instruction Manual

AMX NXB-KNX Instruction Manual

Amx nxb-knx communications gateway
Hide thumbs Also See for NXB-KNX:
Table of Contents

Advertisement

I n s t r u c t i o n M a n u a l
NXB-KNX
KNX Communications Gateway
N e t L i n x I n t e r f a c e C o n t r o l l e r s
L a s t R e v is e d : 4 / 2 8 / 2 0 1 4

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 AMX NXB-KNX

  • Page 1 I n s t r u c t i o n M a n u a l NXB-KNX KNX Communications Gateway N e t L i n x I n t e r f a c e C o n t r o l l e r s...
  • 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.
  • Page 3: Table Of Contents

    PoE (Power Over Ethernet) ..................... 4 KNX Connector......................4 Configuration ......................5 Overview ........................5 Determining the IP Address of the NXB-KNX............5 NetLinx Studio (featuring Zero-Config functionality)............5 Accessing the NXB-KNX WebConsole via Zero-Config ........... 6 Accessing the WebConsole via Web Browser ..............6 Admin Menu ......................
  • Page 4 LIST SAVE..........................26 LIST SUM..........................26 LIST WATCH........................... 26 POLL= ............................ 26 POLL?............................. 26 POLLDELAY= ......................... 27 POLLSTART ..........................27 SEARCH..........................27 SENDDELAY= ........................27 SET=............................28 STATE? ........................... 28 STATUS ..........................28 TIME=............................. 28 TIME? ............................. 29 NXB-KNX KNX Communications Gateway...
  • Page 5 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 Browse For the New Firmware Upload File..............
  • Page 6 Table of Contents Appendix B: Troubleshooting ................55 Overview ........................ 55 NXB-KNX KNX Communications Gateway...
  • Page 7: Nxb-Knx Knx Communications Gateway

    • KNX (green): Solid on indicates power is on 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.
  • Page 8 NXB-KNX KNX Communications Gateway NXB-KNX Specifications (Cont.) Operating Environment: • Operating 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: •...
  • Page 9: Installation

    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 10: Poe (Power Over Ethernet)

    If used with a non PoE-capable Ethernet switch (such as the NXA-ENET24), then an optional 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-wire shielded twisted pair cabling (FIG.
  • Page 11: Configuration

    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 12: Accessing The Nxb-Knx Webconsole Via 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 access the...
  • Page 13: Admin Menu

    Device Configuration page - Device Configuration tab 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.
  • Page 14: 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). Note that the Master Connection options can also be accessed directly from the Admin Menu (select Master Connection).
  • Page 15: Enable / Disable Security Settings

    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.
  • Page 16: Ip Settings

    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: Enter a Hostname for this unit (enabled only if DHCP is disabled).
  • Page 17: Clock Manager

    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.
  • Page 18: Clock Manager - Mode Manager

    Re-sync period options include 5 minutes, 15 minutes, 1, 2 and 4 hours (default = 1 hour). Timezone: Select the appropriate Time Zone from the drop-down menu. Date: Use these fields to manually enter today’s date (mm/dd/yyyy). NXB-KNX KNX Communications Gateway...
  • Page 19: Clock Manager - Daylight Savings

    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. Clock Manager - NIST Servers NXB-KNX KNX Communications Gateway...
  • Page 20 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 KNX Communications Gateway...
  • Page 21: 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.
  • Page 22: Knx Bus Diagram

    Sensor FIG. 22 KNX Bus Diagram It is important to ensure that the NXB-KNX can respond to all bus Telegrams in question. When using line couplers, careful planning is necessary. The following should be considered:  Bus Telegrams have to reach the NXB-KNX. If line couplers are inserted between NXB-KNX and the component to be controlled, then the filter tables of the line couplers must be programmed to pass on all relevant Telegrams.
  • Page 23: User Data (Dpt) Specifications And Requirements

    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. The supported data lengths are:...
  • Page 24: Integrating With Netlinx

    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.
  • Page 25: Feedback

    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 26: Amx_Nxb_Mod Module

    Accessing Actuators On the KNX Bus To access actuators on the bus, KNX Destination Addresses must be configured on the NXB-KNX. This is done via the KNX_Table.axi file (included). This include file maps the Destination Address, type, poll conjunction and additional features to an actor number between 1 and 3000.
  • Page 27: Analyzing Feedback

    Note: 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 •...
  • Page 28: Bind

    • 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' DATE= Setting the Date.
  • Page 29: Debugoff

    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.
  • Page 30: Get

    SEND_COMMAND dvKNX, 'icsp ch=256,lv=384' LIST List all entered actuators. • Lists all entered actuators with AMX number, KNX group address, current value, set flags (if applicable) and resulting additional feedback values. • Lists sum of individual Types, sum of all actuators.
  • Page 31: List

    NetLinx Programming NetLinx SEND_COMMANDs (Cont.) Command Description LIST <No> <No2> 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> Parameters: •...
  • Page 32: List Load

    Note: Creates a Telegram on KNX (For synchronization of master-to-master connection, only use POLL? GET command). Syntax: POLL=<No> POLL?<No> Parameters: • <No> = AMX Number of Actuator (range = 1 - 3000) Examples: SEND_COMMAND dvKNX,'POLL=17' SEND_COMMAND dvKNX,'POLL?17' NXB-KNX KNX Communications Gateway...
  • Page 33: Polldelay

    • <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 34: Set

    Note: Observe actuator type in value range! The module limits the value range automatically to max valid range of the accessed actuator. Parameters: • <No> = AMX Number of Actuator (range = 1 - 3000) • <Value> = Value to be set Example:...
  • Page 35: Time

    Note: WHEN= will send instruction to <No2> only if <No> is changing its value. 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'...
  • Page 36: Sample Program

    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 37 // Polltrigger KNXWhenPoll(dvNxbKnx, 24, 26) // Polltrigger KNXWhenPoll(dvNxbKnx, 25, 26) // 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 NXB-KNX KNX Communications Gateway...
  • Page 38: 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 39: Example 3 - Load Configuration From File

    NetLinx Programming SEND_COMMAND DATA.DEVICE,"'status'" //report log from NXB-KNX with current status of actors DEFAULT: Counter = 0 // Switch IF (Counter) Counter ++ // 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.
  • Page 40: 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 KNX Communications Gateway...
  • Page 41: Knx_Tools.axi

    Functions Available In 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>...
  • Page 42 NetLinx Programming NXB-KNX KNX Communications Gateway...
  • Page 43: Cross-Line Communication

    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 44: 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. 25): FIG.
  • Page 45 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.
  • Page 46 Cross-Line Communication NXB-KNX KNX Communications Gateway...
  • Page 47: Netlinx Firmware Upgrades

     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 native NetLinx device, and all subsequent Firmware upgrades are handled via NetLinx Studio, using KIT files (like any other native NetLinx device).
  • Page 48: Sending A Firmware (*.Kit) File To The Nxb-Knx

    Launch NetLinx Studio and 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.
  • Page 49 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 50: Additional Documentation

    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: 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 52: Determining The Current Firmware Version Of The Nxb-Knx

    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...
  • Page 53: 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. 35). FIG. 35 Application Upgrade Manager page If Current Application Version Is Lower Than v2.0.15...
  • Page 54 One-Time Upgrade of the NXB-KNX to a Native NetLinx Device NXB-KNX KNX Communications Gateway...
  • Page 55: Appendix A: Telnet Commands

    In your Windows taskbar, go to Start > Run to open the Run dialog. Type cmd in the Open field and click OK to open an instance of the Windows command interpreter (Cmd.exe). In the CMD (command), type "telnet" followed by a space and the NXB-KNX’s IP Address info. Example: >telnet XXX.XXX.XXX.XXX...
  • Page 56: 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...
  • Page 57 Example: >REBOOT Rebooting... Releases the current DHCP lease for the NXB-KNX. RELEASE DHCP Note: The NXB-KNX must be rebooted to acquire a new DHCP lease. Example: >RELEASE DHCP Modify system security settings. SECURITY SETUP Prompts you to enter the new date for the NXB-KNX.
  • Page 58 Current HTTP port number = 80 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.
  • Page 59 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. Sets the NXB-KNX’s IP port listened to for SSH connections. SET SSH PORT Note: The device must be rebooted to enable new settings.
  • Page 60 When the unit is rebooted, the time will be lost. Displays the log of messages stored in the NXB-KNX's memory. SHOW LOG The NXB-KNX logs all internal messages and keeps the most recent messages. The log contains:· • Entries starting with first specified or most recent •...
  • Page 61: 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.
  • Page 62 • 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 63 Appendix B: Troubleshooting NXB-KNX KNX Communications Gateway...
  • Page 64 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...

Table of Contents