ML Gateway Installation Guide for installation and setup of ML Gateway English – From software version 1.
Introduction 2 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.
Information 3 Information There is no need for a special ServiceTool as known from other Bang & Olufsen products, when maintaining or servicing the ML Gateway. All types of service or adjustments take place from a web-based user interface. 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).
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.
Installation overview 5 Survey of connection types Direct Ethernet connection: Use this option for systems with a network interface, and provide the IP address of the system. The IP address has to be in the form xxx.xxx.xxx.xxx (for example: 192.168.1.200). Some systems requires a TCP port number on which it expects incoming connections. Port 23 (Telnet port) is the most common default value. Depending on the system, login and password information may be required.
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 - Clipsal Dynalite Lutron Grafik Eye (GRX), Lutron Grafix QS (QSE), Lutron Radio RA Lutron Home Works Interactive KNX (FT 1.
Preparing setup 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).
Preparing setup - 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. (Username is always ‘admin’. The password can be changed by the user later). Now the web-based user interface appears on the screen. - Click the tab System and then Network.
Preparing setup In Network Settings it is possible to define the connection possibilities of ML Gateway. The aim here is to fit the network settings which was observed in the router before. The default Hostname is ‘mlgw’. This can be changed, eg. to ‘mlgw1’ or ‘mlgw2’ (if there is more than one mlgw in the installation). ! It is important that the hostname is defined, otherwise ML Gateway can not be found using Multicast DNS (also known as mDNS or Bonjour).
Preparing setup 10 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 ML - Connect the Master Link cable from the installation to the ML socket on ML Gateway. - Connect either the RS232 cable or the ethernet cable (depending on the communication type).
Router setup - port forwarding 11 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.
Setting up ML Gateway 12 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. Please avoid using the browser’s back and forward navigation buttons, as you may loose the information you are entering. Also note that changing to another screen does not save the modifications you have made.
Setting up ML Gateway Info The first picture that appears on the screen after a successful login is the Info screen. This section, called Project information, provides the opportunity to enter information regarding the project. It is recommended to fill in the fields in order to make it easier for future service. Follow the procedure below: - Fill in the four fields for Project name, Customer, Programmer and Programmer contact info. - Click Update information to save the information.
Setting up ML Gateway 14 Password The system password is used for accessing both the web user interface and the command line interface (CLI). Logging in to the web interface requires entering ‘admin’ for both the user name, and the password. The factory default password is also ‘admin’. Logging into the CLI requires only entering the password. The password can be changed here to avoid unwanted access. If the modified password is forgotten, it can always be reset to the default value.
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. The list of available rooms is taken from the active configuration, therefore it is important to make sure that rooms are defined and testet before setting up users.
Setting up ML Gateway Software update There are two methods for updating ML Gateway software. One for Internet access and one for no Internet access: Internet access When ML Gateway is configured to have Internet access, it provides the opportunity to check for new software on-line and download the most recent version. - Click on the Tools tab and choose Software Update. Use the Check available software online button to check for the latest available software.
Setting up ML Gateway / Programming 17 Restarting ML Gateway on factory-installed software If a software update causes ML Gateway to fail (for example due to power failure during flash update), the unit can be restarted using the original factory-installed software. To do this, switch ML Gateway off, and while pressing the setup button, switch it back on. Release the setup button after 5 seconds.
Programming 18 Devices - setting up resources The next step is setting up resources for each device. Devices is the basic elements which ML Gateway looks into. 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.
Programming 19 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. - Click in the field for Add new device.
Programming 20 ! 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. If RS232 is the preferred connection type, and if the message RS232 port in use by ML Gateway Protocol appears on the screen, it is because MLGW protocol over RS232 in enabled.
Programming 21 - Refer to the System information window and confirm that the software version is 2.7.166 or higher ! If the software version is older than version 2.7.166 the IHC controller must be updated to the newest version. Contact the home automation installer to update the IHC controller. - Choose Access control from the LK IHC Administrator menu - Put a checkmark in the box for Open for third party products The IHC controller is now ready to commnuicate with ML Gateway.
Programming 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).
Programming 23 Devices - BeoLink - Click on the tab Programming and then Devices. - Click in the field for BeoLink. The following resources are now available: BeoLink rooms BeoLink products 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.
Programming BeoLink products BeoLink products have no fixed address. Therefore, it is necessary to manually assign an address in the column MLN (Master Link Node) according to a room number. Once you finish addressing each product, you need to associate that address with the actual products. Click this link to see a full list of compatible BeoLink products: http://mlgw.bang-olufsen.dk/source/documents/MLGW product compatibility.doc This procedure is called product assignment.
Programming 25 To terminate product assignment click the End product assignment button, or press the setup button on the front panel (or wait for 5 minutes timeout). To abort, click the Abort product assignment button, or press and hold the setup button on the front panel for 3 seconds. Assign single product: - Navigate to Programming -> Devices -> Beolink products - Use the drop down box to choose the product to assign - Click the Assign single product...
Programming 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. If there is no need for setting up virtual buttons, this section can be skipped (continue on the next page).
Programming 27 Presentation hints: Here is an explanation for how the virtual buttons are presented to the user on a mobile application (graphical user interface): - Always visible: this is a higher priority button that should always be on-screen, whereas other buttons could scroll off-screen on the mobile user interface. - Require confirmation: ask the user for confirmation to avoid accidentally calling this action.
Programming 28 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.
Programming Support for HDMI matrix MLGW provides support for unconventional source selection commands where source selection is a sequence of more than one commands. HDMI matrix sources 01 to 32 can be selected on the source drop-down menu. These whole sequence of commands will be published to the mobile application. ! Note that an updated version of the mobile applications must be used that fully support source selection sequences.
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). To add new users follow the procedure below: - Navigate to System and click on the tab Users. - Click the Add user button on the left side of the screen (a new window with user rights and available rooms now opens.
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. Disable this property for external controllers which only use MLGW Protocol.
Programming 32 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. This means that all the commands in that macro will be executed in order. To define a new macro: - Select Programming - Macros.
Programming 33 Testing and accepting a configuration ML Gateway keeps three independent versions of the configuration. Each configuration consists of the set of devices, connection settings, resources and macros. At all times, the active configuration is running. The user cannot modify this configuration directly, as it could disrupt the behaviour of the installation. Instead the user can change the ‘edit’ configuration from the user interface.
Supported devices 34 Supported devices On the following pages, devices and resources for all supported systems are described. Click on the preferred system to be linked direcly to it.
Supported devices 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. Therefore resources are generic strings used for matching and for sending to the system.
Supported devices 36 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. - Each valid line corresponds to one resource. - Lines must have at least 2 quoted fields.
Supported devices 37 Dynalite Connection to Dynalite systems can be made via the RS232 interfaces, either using MLGW RS232 port or via a Ethernet to RS232 interface. Native Dynalite Ethernet interfaces are not supported in the current software. Dynalite resources The resources for a Dynalite system correspond to areas in the Dynalite protocol and programming model. Add all the necessary areas in the resources section of the GUI.
Supported devices 38 KNX / EIB ML Gateway can interact with KNX systems by means of shared variables (group addresses). The KNX bus supported is twisted pair. Connection to a KNX system ML Gateway can connect to a KNX system by means of KNX data interfaces. The supported interfaces are: - PEI type 10 (BCU2, with FT 1.2 protocol) over RS232 connection. - IP tunneling over Ethernet connection. PEI type 16 serial interfacing is not supported. PEI 10 bit rate is fixed at the default 19200 bps.
Supported devices 39 For datapoint type 3.007 (Control Dimmer), the coding is: - 0: Decrease break. 1 .. 7: Decrease with step 1 to 7. 8: Increase break. 9 .. 15: Increase with step 1 to 7. For datapoint type 3.008 (Control Blinds), the coding is similar but with Up and Down instead of Decrease and Increase. KNX events and commands ML Gateway generates an event whenever a group address is written to, provided the datapoint type written is 2 Bytes or less in size.
Supported devices 40 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. Defining Resources Interaction between MLGW and BTicino is implemented via button presses and scenario selection.
Supported devices 41 Lutron Grafik QS Connecting to a Grafik QS system Connection to a Grafik QS system is done via a QSE-CI-NWK-E interface, which allows for Ethernet and RS232 connect. For RS232 communications, set the same bit rate on the QSE-CI-NWK-E interface and on ML Gateway connection settings. Connection settings for Ethernet are the IP address of the interface and the password. The default password is ‘nwk’.
Supported devices 42 Setup on the HomeWorks project For direct network access, a network account must be defined in the addressing section. This account is identified by a user/password. Be sure to enable the necessary permissions for interaction with ML Gateway. ML Gateway will need full keypad monitoring and executing button presses. Define phantom keypads for integration with ML Gateway.
Supported devices 43 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’). This device provides both RS232 and Ethernet interfaces.
Supported devices 44 Lutron Radio RA Connection to a Radio RA system Communication with Radio RA is done via the Radio RA RS232 interface. Use a full RS232 cable between Radio RA and ML Gateway. Hardware flow control is used, so a 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.
Supported devices 45 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. Use the same name more than once if you want the same event to be produced at different times.
Supported devices 46 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. Connection settings for Ethernet are the IP address of the InFusion Dim Controller and its telnet port.
Appendix 47 Appendix Service functions Front panel indicator The front panel indicator indicate the state of the system, and is also used for setup button operation and BeoLink product assignment. The normal start-up sequence displays like this: - GREEN: - RED: - Blinking RED: - GREEN: System power up, approx. 2 seconds. System boot, approx. 1 minute. Application running, and BeoLink products detection in progress, approx. 1 minute. ML Gateway application is now running.
Appendix 48 Command line interface In addition to the web-based interface, ML Gateway contains a command-line based interface (CLI). Use CLI for: - Monitoring for events / macros / commands in real time, and without occupying the web-based interface. Basic setup of ML Gateway: network settings, MLGW protocol availability, time and date settings. Obtaining service information. Automating configuration of multiple ML Gateway units. To access the CLI, use any Telnet client to connect to ML Gateway.
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. - With BEOLINK argument, system date is set to that of BeoLink products. - For manual date setup, provide the 5 numeric values. NETCONFIG [IP xxx.xxx.xxx.xxx] [GATEWAY xxx.xxx.xxx.xxx] [MASK xxx.xxx.
Appendix PASSWORD old_password new_password - Changes the system password. MAC - 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. Use the space bar to stop and resume monitoring. Q quits the monitor application. Any other key inserts a mark in the output.
Troubleshooting 51 Troubleshooting Previous checks Before setting up Master Link Gateway, it is necessary to have the entire Master Link installation working and correctly configured. Setting up and troubleshooting a Master Link network is covered in the Master Link Handbook. Below is a brief checklist for basic troubleshooting of Master Link: - Before connecting any products to Master Link, verify electrical conductivity using the Master Link Tester.
Troubleshooting 52 A product does not switch back to standby If, during product assignment, a product does not automatically switch back to standby, there may be an internal address conflict between two products, although this is highly unlikely. - First of all, double check that all products are working properly, respond to Beo4, and can access sources through BeoLink. - Then, repeat the configuration procedure, and verify that this same product still does not switch back to standby.
Troubleshooting 53 After software update ML Gateway not working after software update Detecting if ML Gateway is running The following are signs that the ML Gateway application is not running: - The front panel indicator does not turn green approximately 1 minute after being switched on. - Briefly pressing the setup button produces no visible feedback on the front panel indicator.
Troubleshooting Default UI types 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: Source TV RADIO DTV2 A.AUX V.MEM DVD2 DVD CAMERA DTV PC V.AUX2 A.MEM CD N.RADIO N.MUSIC JOIN Default UI type TV RADIO DTV Selection-only V.
Troubleshooting 55 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.
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 Repub.
Technical specifications RS232 port, DSUB9 male 5 1 6 Ethernet , RJ45 socket, 10/100 Mbit/s 9 5 9 Pin 1 Pin 2 Pin 3 Pin 4 Pin 5 Pin 6 Pin 7 Pin 8 Pin 9 DCD (Data Carrier Detect - input) RXD (Received Data - input) TXD (Transmitted Data - output) DTR1 (Data Terminal Ready - output) GND (signal ground) DSR (Data Set Ready - input) 6 RTS ( Request To Send - output) CTS (Clear To Send - input) RI (Ring Indicator - input) Pin 1 Pin 2 Pin 3 Pin 4 Pin 5 Pin 6 Pin 7 Pin 8 TX_D1+ TX_D1RX_D2+ BI_D3+ BI_D3
Contents Contents Introduction ....................................................................................... 2 How to navigate this guide ............................................................. 2 Introduction Information ........................................................................................ 3 Access ............................................................................................ 3 Information Installation overview ...........................................
