Bang & Olufsen ML Gateway, Installation Manual

Page 1: ...ML Gateway Installation Guide for installation and setup of ML Gateway English From software version 1 90e SETUP BANG OLUFSEN ON OFF ...

Page 2: ...How to navigate this guide When the guide is opened it automatically opens in Full Screen Mode can be left as desired see below This is primarily done to optimize the usability of screen reading There are several ways to navigate when using the guide see the survey of keys shortcuts and hotkeys below arrow keys on the keyboard navigates to the next page arrow keys on the keyboard navigates to the ...

Page 3: ... installation guide is designed to give the installer the opportunity to understand and follow an installation process in the relevant situation It will ensure a correct setup of ML Gateway and thereby a smooth operation This installation guide describes the setup procedure for the different supported devices and the currently defined list contains Clipsal Conson XP Custom strings up to 4 drivers ...

Page 4: ...ction LK IHC RS232 connection example with RS232 connection KNX IHC Controller Alarm Heat control Lighting Operation switches Sensors Energy control Modem Phone Router switch Bang Olufsen Room 1 Room 2 Room 3 ML Gateway Internet Home automation system Ethernet Master Link system Router switch Bang Olufsen Room 1 Room 2 Room 3 ML Gateway Internet Home automa tion system RS 232 Master Link system Da...

Page 5: ...GW Protocol appears on the screen Some devices may require hardware flow control In this case verify that you are using a fully wired cable Examples are Lutron HomeWorks processors and Lutron Radio RA interface Make sure to use high quality cables with proper shielding to avoid interference If the distance to cover is excessive use a lower bit rate or use an RS232 to Ethernet interface next to the...

Page 6: ...nection D9SUB Clipsal Dynalite Lutron Grafik Eye GRX Lutron Grafix QS QSE Lutron Radio RA Lutron Home Works Interactive KNX FT 1 2 Conson Concept XP converter from RS 485 to RS 232 is needed Crestron For RS232 connectivity check that the RS232 protocol is not already reserved by MLGW Protocol see link when setting up the product Do not use RS232 cables that exceed a length of 10 meters It is recom...

Page 7: ...tatic value in the same IP address range as the default value eg 192 168 1 11 and the subnet mask to 255 255 255 0 for information about how to access settings refer to the desired OS below Windows XP Start Settings Network Connections right click on Local Area Connections and choose Properties choose Internet Protocol TCP IP and click Properties Windows Vista Start right click on Network and choo...

Page 8: ...face 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 ...

Page 9: ... same as the network setup in the router configuration Choose Static connection and fill in the fields for IP address Subnet mask Gateway DNS server Tip An easy way find the addresses for Gateway and for DNS server is to PC Open a command prompt cmd in Windows and type ipconfig all Mac Click System Preferences and then Network Router Gateway Click Apply settings to apply settings immediately After...

Page 10: ...it on a stable surface Now ML Gateway is ready for further setup Press the mains switch on the front to switch on the product Rack mount warnings When installing ML Gateway in a rack installation the following precautions must be considered Operating temperatures The operating ambient temperature of the rack installation may be higher than room ambient temperature Therefore consideration should be...

Page 11: ... Application Port range MLGW Web panel 80 MLGW Telnet 23 MLGW Protocol 9000 To define the port forwarding rules in the network router follow the procedure below Open a web browser and enter the IP address of the network router Choose Admin as user and type in the password to login Go to the port forwarding section typical named Applications Gaming Type in the previously stated port settings see ex...

Page 12: ... Also note that changing to another screen does not save the modifications you have made There are Apply or Save buttons next to most controls and data fields On line help All screens on the web interface have a link to the on line help Clicking on this link will open a new browser window showing the relevant section of the help file At the top of each help page there is a link to the table of con...

Page 13: ...roduct Alternatively the date and time can be set manually Note that ML Gateway will loose its time setting if powered down for several hours System time is useful for monitoring events and for examining the system and error logs but correct time setting is not critical to the system Click on the tab System and then Date Time Choose the preferred option for time and date Click Apply date and time ...

Page 14: ... to change it to a unique password 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 The options available are Availability and TCP port number ...

Page 15: ...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 An explanation for this section will follow later in the guide see link Basic setup done The basic setup is now completed for ML Gateway but before continuing to the programming part it is...

Page 16: ...et no proxies The network settings for ML Gateway are correctly set up If the network has a DHCP server connect via DHCP in order to get all these settings automatically You can revert to static IP address later if needed while keeping the other settings provided by the DHCP server Most DSL routers nowadays are DHCP servers by default Select the Update from on line version button to download and i...

Page 17: ...t software installed and not a failure during the flash process you can manually download an earlier software version from BeoWise to your computer and perform a software update from that file Software update complete When it is confirmed that ML Gateway has the latest software the next step is to define devices and resources Please follow the procedure on the next page Programming Additional info...

Page 18: ...k products Setup and settings for scenes with virtual buttons Configuration and definitions for home automation systems Survey of Devices and Resources in a ML Gateway setup Devices Resources Follow the procedure on the next page to define the supported device home automation system Devices Resources IHC Controller Alarm Heat control Lighting Operation switches Sensors Energy control Modem Phone R...

Page 19: ...utron Radio RA Scheduler see link SmartHouse Vantage Choose the relevant supported device and click the Add button The Configuration box and Resource box for the chosen device now appars on the screen Fill in the empty configuration fields which are necessary for ML Gateway to communicate with the supported device The number of options may vary depending on the device Refer to the next page regard...

Page 20: ... testing the configuration Activate one or more of the resources e g press a button on a keypad This must be done for each button to be used in the configuration When all resources have been added the configuration click the Cancel button to stop the test function Click the Show detected button that appears below the resources table a new list will appear with the resources detected during the tes...

Page 21: ... from the service PC and the ML Gateway The next step is to load the IHC definition file to the ML Gateway Reconnect the Service PC to the network and access the web based user interface by typing the IP address for ML Gateway in a web browser Go to Programming Devices IHC LexControl Type an optional description and the IP address for the controller Click the Add resources button in the Resources ...

Page 22: ...e IP port for the controller Click Save settings Enter the Group address for the resource Choose the Data type Boolean is default Click Apply changes Click the Browse button in the Resources section a pop up box for choose destination file appears Choose the definition file from the project and click Open Choose replace or append according to the situation Click the Upload CSV resource file button...

Page 23: ...vailable in the customer setup and it contains all rooms in whitch you need to receive LIGHT and CONTROL events it can be downloaded and automatically added to the list of rooms and products if not skip this step Click on the Browse button and choose the Beo5 6 project file Click Open Click Load resources from Beo5 project file rooms and products will automatically be appended to the current list ...

Page 24: ... identify the new products The assignment af the products can be made in two ways All product assignment or Assign single product All products assignment Navigate to Programming Devices Beolink products Click the All product assignment button a new window with a survey of link rooms and products appears example Click the Start product assignment button Wait approximately 1 5 minutes for ML Gateway...

Page 25: ...n or press and hold the setup button on the front panel for 3 seconds Note There are limitations to BeoLink Wireless products ML Gateway has no way of distinguishing between different units in a wireless setup therefore you cannot identify them individually If more products are activated during product assignment than have been defined on the Resources screen these are added as new resources autom...

Page 26: ... global One for actions that are relevant near the residence nearby One for actions only relevant from a remote location away The name for each of these 3 rooms can be configured on this same section Click on the tab Programming and then Virtual buttons The name of each extra room is predefined but these can be change to whatever desired Virtual buttons Fill in the required fields to define the vi...

Page 27: ...er 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 By default virtual buttons are hidden they can be activated by MLGW Protocol but they will not be published for mobile applications to show Saving the sources configuration Before the configuration ...

Page 28: ...he user interface The recommendation is to leave this field empty unless you need a specific description for this source e g name of a set top box or DTV service Dst This is equivalent to the A V button on Beo4 or the Destination field for BeoLink commands in macros This field should be filled in automatically depending on the source you can also select AUTO in order to retrieve the default settin...

Page 29: ...l be published to the mobile application 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 Click the Save button to activate and save the settings for s...

Page 30: ...ord field empty means no password change Hidden user flag When an external controller is interacting with ML Gateway a user can be assigned for authentication However this is setup during installation of both systems ML Gateway and controller and the users should not be able to modify these settings For example if the user name or password are changed the controller will no longer interact with MG...

Page 31: ...dicates 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 List of rooms to access Indicates which rooms the user will have access to on the web panel or on the mobile application For example children should not have access to scenes sources...

Page 32: ...o another Select a group of events or commands using the check boxes and use the Copy buttons These copied events or commands can later be pasted into another macro Copied events and commands are stored independently so you can copy both events and commands and then paste them into another macro ML Gateway does not support inserting events or commands in existing lists Workaround 1 Add the missing...

Page 33: ...tive configuration Otherwise the Cancel button restarts the original active configuration Use the Discard button to delete all your edits and start over again with a new copy of Current active version During testing the monitor and system log screens are useful to see if the new modifications are working as expected When accepting a configuration the previously active configuration is not lost but...

Page 34: ...rigger group Conson XP Connection to a Conson system is made via an XP130 gateway module This module provides an RS485 interface so a RS232 to RS485 converter is needed for connecting to ML Gateway Conson resources On the resource screen define the modules you need to interact with A module is identified by a module type and a link number Use the monitoring tool to analyse the events on the bus Ev...

Page 35: ...aracters are interpreted as Unicode UTF 8 byte sequences Backslash is used as an escape character which gives special meaning to the character o characters that follow double backslash is interpreted as a single backslash r is interpreted as a carriage return character 0x0D It will be immediately redisplayed as 0D n is interpreted as a newline character 0x0A It will be immediately redisplayed as 0...

Page 36: ...l becomes idle then all partial matches will be discarded Also whenever the channel is connected or reconnected a special CONNECT event will be generated in case some session setup is needed Commands are all resources marked as output or both input output that can be transmitted to the channel TCP connection maintenance read this section if you experience periodic TCP reconnections In order to rap...

Page 37: ...ns Any IP camera able to stream MJPEG should be supported Resources cameras For each camera a name a room a high and a low resolution URLs should be provided The name is for identification The room indicates the mobile application where to display the camera and if Global is selected it will display the camera on every room The high resolution URL is for displaying the MJPEG in full size and the l...

Page 38: ...esses All interactions between KNX and ML Gateway take place by means of group addresses Group addresses have an associated datapoint type which identifies the type of data it holds e g boolean signed integer etc It is therefore necessary to define all the necessary group addresses required for integration with ML Gateway If this information is not readily available the monitoring tools can be use...

Page 39: ...onsists of physical input and output devices plus function blocks Function blocks implement the programming of the system and the interface between the programming and the actual components is made by linking physical input signals to function block inputs and function block outputs to actuators dimmers shade controllers etc The web based user interface for the controller LK IHC Visual software sa...

Page 40: ...CI NWK E Connection to the RS232 interfaces can be done directly using a 3 wire RS232 cable or via an Ethernet to RS232 interface If you use an Ethernet to RS232 interface set it up for 9600 bps no parity no flow control 1 stop bit Connection parameters are TCP port and IP address in case of using a network interface The password is only needed if using a direct network connection to GRX CI NWK E ...

Page 41: ... Lutron HomeWorks Interactive Connecting to a HomeWorks processor Connections to a HomeWorks processor can be done directly on Ethernet RS232 or indirectly with a RS232 to Ethernet interface This last option is only relevant for older HomeWorks generations without network interface For Ethernet connection make sure that the HomeWorks project has a telnet user defined with username password and all...

Page 42: ...D state changes This is provided only for advanced use where you want to generate ML Gateway events as a consequence of conditional time clock or other non user generated actions on HomeWorks Define a state variable or True False variable which you will use in your conditions or time clock events to signal ML Gateway Define a phantom keypad on the HomeWorks project and choose a button for this pur...

Page 43: ...s QS Processor Connection settings for Ethernet consist of IP address of the Main Repeater 192 168 1 50 default Login lutron default Password integration default Telnet IP port 23 default Defining resources On the device setup screen you should identify all the components with which you need to interact These include Master Control units Keypads Interfaces Note that resources are the entire compon...

Page 44: ...on the Radio RA interface to identify individual buttons Master Control buttons that you intend only for integration and not for lighting control have a special behaviour Until they have been activated once they will not produce a radio event Therefore you may not find monitoring information for these buttons Once you define them in the project and Test the configuration ML Gateway activates these...

Page 45: ...ted the scheduler automatically restarts only if the option Continuous is selected Be careful to provide other ways of stopping a scheduler For example events from Beo5 or from a keypad Smart House Connection to a Smart House system Connection to a Smart House system is made via an Ethernet connection to a Smart House controller Both the IP address and the TCP port must be configured on MLGW Defin...

Page 46: ...ion Dim Controller and its telnet port Defining Vantage resources To program the InFusion Dim Controller the PC tool Design Center is needed It lets you define all components of your Vantage system where each one has an address called VID Vantage Identification Number On MLGW you can define as resources either a button on any control or a task To define a resource you need to know the Button or Ta...

Page 47: ...on on the front panel provides several functions Each function is dedicated a specific number of blinks These can be accessed by choise through a cycle of available functions One blink function 1 two blinks function 2 etc Survey of functions Function 1 Optional user event can be used as a trigger to a macro Function 2 Reset password to factory default Function 3 Reset network settings to factory d...

Page 48: ... prompt Type the ML Gateway password to proceed Several CLI connections may be active simultaneously Use the TAB key to check for available commands automatically complete the commands and getting help for a command Use the Esc key to cancel a command and get a new prompt Available commands Commands have optional arguments with the following properties Arguments between brackets and are optional A...

Page 49: ...e 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 xxx xxx DNS xxx xxx xxx xxx NETCONFIG DHCP Without arguments shows current network setup With DHCP argument gets configuration from DHCP server Providing one or more of the manual set...

Page 50: ...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 ALLSTANDBY Sends all BeoLink products to stand by Use to check BeoLink connectivity COUNTERS Displays service counters ...

Page 51: ...d no more than one Audio Master in the network Master products are configured in Options 0 1 or 2 The rest of the products must be configured as link products Options 4 5 or 6 possibly 0 ML Gateway itself has no Option programming Check that all products are working and that you can get audio from the Master products to all link products and between the Master products Connect ML Gateway to the ne...

Page 52: ...her products one by one and repeat the configuration Start with Link products BL Passive BL Active and then proceed to new products Once the two conflicting products are identified take note of type number item number and serial number of each and contact Shared Service Center for assistance System error ML Gateway may report a system error by alternately flashing red green on the front panel LED ...

Page 53: ...ing 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 the software If you suspect that the failure is inherent to the latest software installed and not a failure during the flash process you...

Page 54: ...er should then adjust the UI type on special cases only The default UI type adopted by ML Gateway on import is listed below Source Default UI type TV TV RADIO RADIO DTV2 DTV A AUX Selection only V MEM V MEM DVD2 DVD B O DVD DVD B O CAMERA Selection only DTV DTV PC PC V AUX2 Selection only A MEM A MEM CD CD N RADIO N RADIO N MUSIC N MUSIC JOIN Generic ...

Page 55: ... want to pause your Edit Test and return to the Current active version Use the Discard button to delete all your edits and start over again with a new copy of Current active version Use the Previous button to return to the last Backup version and make it Running version Note Current active version and Backup Previous version are swapped which makes it easy to test both versions Use the Tools Confi...

Page 56: ...t Variant Type number Albania Argentina Australia Austria Azerbaijan Bahrain Belgium Botswana Brazil Bulgaria Caribbean Islands of the Dominican Repub Canada Chile Croatia Czech 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 Leban...

Page 57: ...n 3 RX_D2 Pin 4 BI_D3 Pin 5 BI_D3 Pin 6 RX_D2 Pin 7 BI_D4 Pin 8 BI_D4 Information regarding RoHS directive Hazardous Substance Component name Lead Pb Mercury Hg Cadmium Cd Chrome VI Cr VI Polybrominated Biphenyl PBB Polybrominated Diphenyl Ether PBDE PCBA X O O O O O Legend O Indicates all homogeneous materials hazardous substances content are below ST T 11363 2006 MCV limit X Indicates that the h...

Page 58: ...em 20 Devices BeoLink 23 Resources BeoLink 23 BeoLink products 24 Devices Virtual buttons 26 Resources Virtual buttons 26 Setting up Sources 26 Setting up Users 30 Macros 30 Supported Devices 34 Appendix 47 Service functions 47 Troubleshooting 51 Technical specifications 57 Version 1 9 03 2012 Introduction Information Installation overview Survey of connection types Preparing setup Router setup po...