Bang & Olufsen ML Gateway Installation Manual
  1. Manuals
  2. Brands
  3. Bang & Olufsen Manuals
  4. Gateway
  5. ML Gateway
  6. Installation manual

Bang & Olufsen ML Gateway Installation Manual

Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
ML Gateway
Installation Guide for installation and setup of ML Gateway
English – From software version 1.90e
BANG & OLUFSEN
ON
OFF
SETUP

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the ML Gateway and is the answer not in the manual?

Questions and answers

Related Manuals for Bang & Olufsen ML Gateway

Summary of Contents for Bang & Olufsen ML Gateway

  • Page 1 ML Gateway Installation Guide for installation and setup of ML Gateway English – From software version 1.90e BANG & OLUFSEN SETUP...

  • Page 2: Introduction

    Introduction ML Gateway is developed with the purpose to integrate Bang & Olufsen Master Link products with home automation systems (supported devices). This provides a new world of opportunities for the customer to control comfortable home functions with, for example, a Beo5 in his/her hand.

  • Page 3: Information

    Access To access the web-based user interface, enter the IP address for ML Gateway. When ML Gateway is delivered, the IP address is set to a static value. The default IP address for ML Gateway is 192.168.1.10 (factory default).

  • Page 4: Installation Overview

    Installation overview Installation overview Basically there are two different types of connections between ML Gateway and the supported device (home automation systems). Ethernet or RS232 connection. The connection types are illustrated in two examples below: Ethernet connection - Example with ethernet connection (LK IHC)

  • Page 5: Survey Of Connection Types

    - ML Gateway has one RS232 interface for connecting to external systems. Only one system can be connected to the interface at a time, so when configuring ML Gateway, only one system is allowed to be set up on RS232.
  • Page 6 Installation overview Ethernet connection (RJ45) - LK IHC (Intelligent House Control, Viewer models only) - Lutron: Grafik Eye (GRX), Grafix QS (QSE), Home Works, Home Works QS, Home Works Radio Ra2, Radio RA, - KNXnet (IP tunneling) - Crestron - Clipsal RS232 connection (D9SUB) - Clipsal - Dynalite...

  • Page 7: Preparing Setup

    Configuration of IP address When ML Gateway is delivered, the IP address is set to a static value. The IP address for ML Gateway is 192.168.1.10 (factory default). Depending on the customer’s network settings, it may be necessary to change the IP address in order to fit the network range. Follow the procedure below: - The first step is to determine the network setup in the installation (IP address range, DHCP/non-DHCP).
  • Page 8 - Open a web browser and enter http://192.168.1.10 in the address field. Now the ML Gatway web interface appears. - Click the Setup button to access ML Gateway setup functions. Now the login box appears on the screen. - Type admin in both fields and click OK.
  • Page 9 - Click Apply settings to apply settings immediately. ! After applying new settings, it is necessary to reconnect the web browser to the new address. In case of problems finding ML Gateway, the IP address can be reset to default using the setup button on the front panel (see link).
  • Page 10 Preparing setup Installation and connection A rack-mount installation is preferred if possible. In this case mount the two angle brackets as shown. Alternatively ML Gateway can be placed on its feet on a stable surface. Max. 10mm Max. 10mm RS232 - Connect the Master Link cable from the installation to the ML socket on ML Gateway.

  • Page 11: Router Setup / Port Forwarding

    Router setup - port forwarding To ensure that users can access ML Gateway (to control home automation functions) from a web panel/smart phone on the wide area network (WAN), the network router must be configured to allow data traffic from specific ports. In the most common routers this feature is called port forwarding.

  • Page 12: Setting Up Ml Gateway

    Setting up ML Gateway Additional information To set up ML Gateway it is necessary to access a web-based user interface. The web interface is organised into a series of screens which can be selected by means of the navigation bars.
  • Page 13 System Date & Time ML Gateway can get its system time from the BeoLink sysrem, and this is the recommended option. In this case the time will be constantly synchronised to the clock of the main BeoLink product. Alternatively, the date and time can be set manually.
  • Page 14 Master Link Gateway Protocol settings The ML Gateway protocol is available on RS232 connections and as TCP socket connections (ethernet RJ45). This is a proprietary protocol for communication with general-purpose home automation controllers. Multiple simultaneous ML Gateway protocol connections are supported.
  • Page 15 Setting up ML Gateway Users ML Gateway keeps a list of users that, individually (depending on the access level), can access the external interfaces and services such as: - ML Gateway Protocol access - Web Panel access - Publishing service access (mobile applications) - Room access control Defining users is important but this can not be made yet.

  • Page 16: Software Update

    No Internet access If ML Gateway has no direct Internet access, it is possible to upload and install a software image file from a location stored on your computer. - Navigate to the Load new software.. section and click Browse..When the navigation box appears, choose the destination and software file.

  • Page 17: Programming

    To do this, switch ML Gateway off, and while pressing the setup button, switch it back on. Release the setup button after 5 seconds. This will start the system using the original factory software, but will not fix nor replace the ‘broken’ software. You need to log into the system and perform a software upgrade to fix the broken software.
  • Page 18 Devices can be: - BeoLink - Virtual buttons - Home automation systems The resources area is where you identify all the necessary components with which ML Gateway will interact. Each device contain individual Resources which can be: ➀ Devices ➁ Resources...

  • Page 19: Devices - Home Automation System

    Programming Devices - Home automation system Use the Devices tab to specify the devices connected to ML Gateway. For information regarding supported devices please refer to page 34, and then follow the procedure below: - Click on the tab Programming and then Devices.

  • Page 20: Resources - Home Automation System

    ! RS232: Only one system can be connected to the interface at a time, so when configuring ML Gateway, only one system on RS232 is allowed to be set up. It is very important that the RS232 settings fit the settings for the connected device.
  • Page 21 - Put a checkmark in the box for Open for third party products The IHC controller is now ready to commnuicate with ML Gateway. Disconnect the USB cable from the service PC and the ML Gateway. The next step is to load the IHC definition file to the ML Gateway.
  • Page 22 KNX / EIB: The KNX controller only supports one user on the system (web interface) at a time. This means that the ML Gateway must be disconnected from the network when web interface is accessed (e.g. when the definition file is transferred to the service PC or when programming the device).

  • Page 23: Devices - Beolink

    Resources - BeoLink rooms / BeoLink products The resources screen is where you identify all the necessary components with which ML Gateway will interact. The aim is to define BeoLink rooms, BeoLink products, events for the schedulers, and keypads or buttons for external systems.

  • Page 24: Beolink Products

    The purpose of the table under the BeoLink products section is to define which product each room has, and what MLN (Master Link Node) each product is dedicated. If BeoLink products are added or replaced, the procedure must be repeated so ML Gateway can identify the new products.
  • Page 25 - If more products are activated during product assignment than have been defined on the Resources screen, these are added as new resources automatically. - Product assignment can be started from the front panel (see link), without using the web interface. This can be useful for ML Gateway protocol- only installations where no further setup is needed.

  • Page 26: Devices - Virtual Buttons

    External applications and the web panel can generate events on ML Gateway by means of virtual buttons. Virtual buttons are called via ML Gateway Protocol and generate events on ML Gateway that can be used for macro programming just like any other event.
  • Page 27 - Compact: the mobile application could represent this button using a smaller screen area (for example, side by side with other buttons). Room selection and presentation hints are only relevant for mobile applications which obtain their configuration automatically from ML Gateway.

  • Page 28: Setting Up Sources

    Programming Setting up Sources The Sources section allows to define sources for each BeoLink product. This information will be used by mobile applications for generating a user interface where each product contains the relevant sources. This section is only relevant for supporting mobile applications, and has no effect on macro programming. ! If BeoLink resources have been uploaded from a Beo5 project file, the sources screen should automatically contain most information necessary (with a default UI type field according to the source).
  • Page 29 ! Note that an updated version of the mobile applications must be used that fully support source selection sequences. Saving the sources configuration - Before the configuration of sources can be saved, ML Gateway must be in test mode. Click the Test button and the greyed out Save button becomes visible.

  • Page 30: Setting Up Users

    Programming Setting up users Users ML Gateway keeps a list of users that, individually (depending on the access level), can access the external interfaces and services such as: - ML Gateway Protocol access - Web Panel access - Publishing service access (mobile applications).
  • Page 31 Programming MLGW Protocol access flag: Indicates whether the user can establish a MLGW Protocol connection (provided MLGW Protocol authentication is enabled). This property is needed for mobile applications and external controllers. Web panel / publishing service access flag: Indicates if the user can access the web panel, and if a mobile application can get configuration information by means of the publishing service.

  • Page 32: Macros

    Macros Macro programming The interaction between the different devices connected to ML Gateway is defined by means of macros. A macro consists of a set of events and a list of commands. Whenever any of the events defined in a macro occurs (for example, a key press on a keypad, or a Control command on Beo5), the macro is triggered.
  • Page 33 (current active version and Backup/Previous version are swapped). All three versions of the configuration can be downloaded from ML Gateway for reference, backup, or uploading to another ML Gateway unit. Note that the edit configuration may not to be recovered in the latest version in case of a power failure. The active and previous configurations are always stored in permanent memory.

  • Page 34: Supported Devices

    Events and commands Whenever a trigger group is set to a new action value, an event is generated on ML Gateway. Similarly, commands on ML Gateway are setting an action value to a resource (trigger group). Conson XP Connection to a Conson system is made via an XP130 gateway module.
  • Page 35 Custom strings The Custom strings driver is intended to enable limited communication with unsupported home automation systems. Use of this driver requires knowledge of the protocol for the external system. ML Gateway supports up to 4 custom strings drivers. Resources This driver is based on matching incoming byte strings from the external system, and sending back byte strings to it.
  • Page 36 Supported devices The format for the text file is specified below. This format is compatible with the standard CSV or TSV (comma / tab separated values) formatting, so it can be processed by spreadsheet software, text editors or command-line utilities. - Lines starting with # will not be interpreted.
  • Page 37 A preset selection can be detected by ML Gateway as an event. The parameters for the event are the Preset number and the Bank number. For setting up a Dynalite control to affect only ML Gateway, this control must be assigned an area number not used by any dimmer or actuator.
  • Page 38 ! Note on IP tunelling: It is usually necessary to disconnect the ETS software from the IP tunelling interface before ML Gateway can connect to the system. Also, after disconnecting ETS, the interface can take several minutes before it accepts a new connection from ML Gateway. The same considerations apply when switching back to ETS.
  • Page 39 The web-based user interface for the controller (LK IHC Visual software) saves all programming and setup in an XML file with the extension .VIS. This file must be provided to ML Gateway in order to define the list of resources. Once this file is loaded into ML Gateway, all relevant resources are selectable.
  • Page 40 Supported devices BTicino Connection to a BTicino system Connection to a BTicino My Home system is made via an Ethernet connection to a My Home Gateway interface. Both the IP address and the TCP port must be configured on MLGW. Note that in order to establish a communication, MLGW must reside in an allowed IP range defined in the My Home project.
  • Page 41 The resources you need to define are control units and accessory controls (e.g. keypads) with which you need to interact. Each is defined by a serial number which can be found on a label on each product, or from the control units bus status information, or by inspecting ML Gateway monitoring information.
  • Page 42 - On Preset 5, add the state variable with a desired value. - Configure ML Gateway to respond to the LED of that button going ON or OFF, which will be an indication that the state variable has the specified value.
  • Page 43 Supported devices Lutron HomeWorks QS / Radio Ra2 This driver is used to communicate with both Lutron Homewoks QS and Lutron Radio RA2 systems. Connection to a Radio RA2 system Communications with Radio RA2 is done via the Radio RA2 Main Repeater, which allows interaction with the system via 100 programmable virtual buttons (‘phantom buttons’).
  • Page 44 3-wire connection will not work. Alternatively, you can use an Ethernet to RS232 interface and connect via the ML Gateway network port. In this case, it is important to configure the Ethernet to RS232 interface to use hardware flow control, 9600 bps, no parity, 1 stop bit.
  • Page 45 Supported devices Scheduler A scheduler generates a timed sequence of events. It is possible to define more than one scheduler for the project. On the resources screen a series of events for the scheduler must be defined with the following information: - Event name: This is the name of the event that will be generated.
  • Page 46 Supported devices Vantage Connection to a Vantage system Communication with a Vantage system is done through an InFusion Dim Controller. This device has both RS232 and Ethernet interfaces. Connection to the RS232 interface can be done directly using a fully wired RS232 cable and it is fixed at no parity, 1 stop bit, 8 data bits. Make sure to configure bit rate and flow control as needed.

  • Page 47: Appendix

    ML Gateway application is now running. If ML Gateway encounters an unrecoverable internal error, it will signal a critical error condition. In this case, the front panel indicator will keep flashing alternating red and green. The application is still running, but the error and system logs must be checked for diagnosis.
  • Page 48 - Automating configuration of multiple ML Gateway units. To access the CLI, use any Telnet client to connect to ML Gateway. The IP address or host name to use is the same as for the web-based interface: use the IP address of ML Gateway, or the host name mlgw.local if your system implements multicast DNS.
  • Page 49 Appendix INFO - Displays product and status information of ML Gateway: - Serial number - Type number - MAC address - Network configuration - Software version - Hardware version - Number of CLI opened sessions - System time DATE [ yyyy mm dd hh mm ] DATE BEOLINK - Without arguments, displays the current system date and time.
  • Page 50 Appendix PASSWORD old_password new_password - Changes the system password. - Displays the Ethernet MAC address. MLGWPROTO RS232 [ bitrate | OFF ] MLGWPROTO IP [ port | OFF ] - Sets up MLGW protocol on RS232 or IP. MONITOR - Starts a real-time monitoring application. - Use keys M, E, C, to toggle the display of macros, events and commands respectively.

  • Page 51: Troubleshooting

    - Connect ML Gateway to the network, switch it on and wait for startup (this takes less than 2 minutes). - Switch some products on. Issue an ALL STANDBY command on ML Gateway using the CLI command ALL STANDBY. Check that the products switch to standby.
  • Page 52 - H8 module error ! In case of system error, always try to solve the problem by updating the software. If this does not solve the problem, ML Gateway must be serviced. It is recommended to use the backup file (if it exists) for ML Gateway, so programmed data can be uploaded to the replaced module.
  • Page 53 To do this, switch ML Gateway off, and while pressing the setup button, switch it back on. Release the setup button after 5 seconds. This will start the system using the original factory software, but will not fix or replace the ‘broken’ software. You must to log into the system and perform a software upgrade to ‘repair’...
  • Page 54 When importing a Beo5 XML project file, ML Gateway will assign a default UI type according to the source. The installer should then adjust the UI type on special cases only. The default UI type adopted by ML Gateway on import is listed below:...
  • Page 55 Troubleshooting Survey of configuration versions All edits are done in the Edit version (in non volatile memory which is deleted at power off). When you are editing the Current active version is still running making sure your are not making black-out in the whole house. All edits Save Load...
  • Page 56 Technical specifications Technical specifications Master Link Gateway Type survey Market Variant Type number Albania, Argentina, Australia, Austria, Azerbaijan, Bahrain, Belgium, Botswana, Brazil, Bulgaria, Caribbean Islands of the Dominican Repub., Canada, Chile, Croatia, Czech 1701, 1799 Repub., Denmark, Dubai, Egypt, Estonia, Faroe Islands, Finland, France, Georgia, Germany, Ghana, Greece, Greenland, Holland, Hong Kong, Hungary, Iceland, India, Indonesia, Ireland, Israel, Italy, Japan, Jordan, Kazakhstan, Korea, Kuwait, Latvia, Lebanon, Liechtenstein, Lithuania, Luxembourg, Malaysia, Mexico, Morocco, New Zea- land, Nigeria, Norway, Oman, Pakistan, Panama, Peru, Philippines, Poland, Portugal, Qatar, Romania, Russia, Saudi Arabia, Serbia, Singapore, Slovak Rep., Slovenia, South Africa, Spain, St.

  • Page 57: Technical Specifications

    Technical specifications RS232 port, DSUB9 male Pin 1 DCD (Data Carrier Detect - input) Pin 2 RXD (Received Data - input) Pin 3 TXD (Transmitted Data - output) Pin 4 DTR (Data Terminal Ready - output) Pin 5 GND (signal ground) Pin 6 DSR (Data Set Ready - input) Pin 7...

  • Page 58: Table Of Contents

    Installation overview Preparing setup ................7 Survey of connection Router setup / port forwarding ............11 types Setting up ML Gateway ..............Software update ................Preparing setup Programming .................. 17 Devices - Home automation system ..........Router setup / port forwarding Resources - Home automation system ..........

Table of Contents