ML Gateway - Bang &

ML Gateway
Installation and setting up guide for ML Gateway
From software 1.50a
English
2
Contents
Contents
Introduction . ........................................................................................ 3
Installation overview ............................................................................. 4
Preparing setup .................................................................................... 6
Setting up ML Gateway ........................................................................ 9
Programming . .................................................................................... 13
Router setup - port forwarding ........................................................... 21
Supported devices .............................................................................. 24
Appendix . .......................................................................................... 32
Troubleshooting . ................................................................................ 36
Technical specifications ....................................................................... 41
Introduction
3
Introduction
General
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.
But other scenarioes are also possible, such as giving the customer the opportunity
to switch on several Bang & Olufsen products on a defined radio or tv channel by
only pressing one switch of the home automation system.
This product is the gateway between Bang & Olufsen products and the home
automation systems.
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).
Depending on the customer’s network settings, it may be necessary to change the
IP address in order to fit the network range.
Please note
This 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
Dynalite
KNX / EIB
IHC - Lauritz Knudsen (LK), Schneider, LexControl, ELKO Living Systems
Lutron Grafik Eye
Lutron Grafik QS
Lutron HomeWorks
Lutron Radio RA
Lutron Radio RA 2
Scheduler
3rd part drivers to AMX / Creston (more in the future)
! When installing ML Gateway on the Chinese market, please read the information
regarding RoHS directive (appendix -> technical specifications).
4
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)
Internet
Internet
Router / switch
ML Gateway
Ethernet
Master Link
Ethernet
Energy
control
Heat
control
Sensors
(( ))
Alarm
IHC
Modem
Controller
Operation
switches
Room 1
Phone
Bang & Oluf
sen
Lighting
Room 2
(( ))
Room 3
RS232 connection
Example with RS232 connection (KNX)
Router / switch
Ethernet
Energy
control
RS 232
Sensors
6
5
1
5
1
Environment
control
Internet
6
9
9
Data
Interface
Operation
switch
Master Link
Lighting
Room 1
Room 2
...
Room 3
Bang & Oluf
sen
ML Gateway
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.
Default values will be suggested when available.
Direct RS232 connection:
- 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. A notice will
appear if the interface has already been reserved for another system.
(The message RS232 port in use by MLGW 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 external system. This last recommendation also applies in
case of interference or ground-loop problems.
- For information regarding the RS232 connector pin assignment, please refer to the
appendix -> technical specification.
Using RS232 to Ethernet interfaces:
- For systems with an RS232 interface, it is also possible to use an RS232 to Ethernet
interface. This way, the network installation can be used instead of having to run a
long RS232 cable between the system and ML Gateway.
- You should configure the interface for the correct RS232 parameters (bit rate, flow
control, etc.).
- Parameters to configure on ML Gateway are the IP address and TCP port number
of the interface.
Ethernet connection (RJ45)
-
-
-
-
-
LK IHC (Intelligent House Control, Viewer models only)
Lutron: Grafik Eye (GRX), Grafix QS (QSE), Radio RA, Home Works Interactive
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.2)
Conson Concept XP (converter from RS 485 to RS 232 is needed)
Crestron
RS232 connection (D9SUB)
! For RS232 connectivity, check that the RS232 protocol is not already reserved by
MLGW Protocol (see page 11) when setting up the product.
! Do not use RS232 cables that exceed a length of 10 meters. It is recommended to
use a cable between 2-5 meters.
6
Preparing setup
Preparing setup
Configuration of IP address
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).
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). To do this it is necessary to access the customer’s router.
- Connect the ML Gateway with an ethernet patch cable to a computer with ethernet
connection and web browser. On old computer models, it might be necessary to
use a cross-wired ethernet patch cable.
- Set the IP address on the computer to a static 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.
- 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 choose Properties -> click Manage Network
connections -> right click on Local Area Connection and choose Properties (if a
security message appears choose continue) -> choose Internet Protocol Version 4
(TCP/IPv4) and click Properties.
- MAC:
Click on System Preferences -> click Network -> click Advanced -> click TCP/IP.
- Open the web browser and enter http://192.168.1.10 in the address field.
- Access the web-based user interface by typing the IP address defined earlier
(during Configuration of IP address) for ML Gateway in the address field of the
web browser. Now the Bang & Olufsen welcome screen 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).
Preparing setup
7
Now the web-based user interface appears on the screen.
- Click the tab System and then Network.
- 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).
- If the network is a DHCP setup, this can be selected, but it is recommended to use
a static IP address for ML Gateway.
- If the network is a non-DHCP setup, the IP address must be defined manually in
order to fit the IP range in the router. This means that the first 3 'octets' must be
the 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 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 page 32).
If the computer supports Multicast DNS (default on Mac/Linux, utility required for
Windows), ML Gateway can be found by typing mlgw.local in the browser’s
address field.
The next step is to mount ML Gateway in the installation setup. It is recommended
to use the angle bracket for a rack-mout solution (see next page).
8
Preparing setup
Installation and connection
- A rack-mount installation is preferred if possible. In this case mount the two angle
brackets as shown.
Max. 10mm
Max. 10mm
ML
RS232
Alternatively ML Gateway can be placed on its feet on a stable surface.
- 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).
- Mount mains cable and the wire holder with screw to fasten the mains cable as
illustrated below.
RS232
ML
- Mount ML Gateway in the rack system or place 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 given to installing the equipment in an
environment compatible with the maximum ambient temperature specified for the
product (see specifications on page 41).
Reduced air flow
Installation of the equipment in a rack should be such that the amount of airflow
required for safe operation of the equipment is not compromised.
Setting up ML Gateway
9
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. 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 contents.
Login
- Switch the ML Gateway on by means of the switch on the front panel (information
about the front panel indicator and the setup button can be found on page 32).
- Connect the service computer with an ethernet cable to the network connection
(to a free port in the router/switch).
- Access the web-based user interface by typing the IP address defined earlier
(during Configuration of IP address) for ML Gateway in the address field of the
web browser. Now the Bang & Olufsen welcome screen appears.
- Click the Setup button to access ML Gateway setup funtions.
- 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).
10
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.
System
Date & Time
ML Gateway can get its system time from the BeoLink, 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. 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 settings to apply settings immediately.
Text size (optional)
The web-based user interface may be too wide for low resolution screens such as
those of mobile Internet devices, subcompact laptop computers, or old laptop
computers.
In this case, a more compact style for the user interface can be selected.
Note that most web browsers have text size and screen zoom options, which
allow for further adjustment of the interface.
- Click Switch to .... to toggle between low and high screen resolution.
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.
This requires an execution of service function 2 (described on page 32) .
- Fill in the fields for current and new passwords, and click Update password to
save the new password.
! If the default password is not changed, this notification is displayed on the right
side of the screen. This will disappear when the password is changed.
! It is highly recommended to change it to a unique password.
Setting up ML Gateway
11
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 on the network connection.
- Authentication required on TCP (Ethernet). Can be ticked if it is required that the
connected Home Automation has to start logging in with Username and Password.
- Availability and bit rate on RS232 port.
! If the RS232 port is already configured for another device, a message is shown
and selection is disabled. If RS232 is enabled for MLGW protocol, the product can
not be used with eg. Conson and KNX installation.
The default Master Link Gateway Protocol settings are:


Enable MLGW protocol over ethernet
IP port
9000
Authentication required on TCP (Ethernet)
Enable MLGW protocol over RS232
RS232 bit rate
9600 bps
(not checkmarked)
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)
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.
An explanation for this section will follow later in the guide.
Basic setup done
The basic setup is now completed for ML Gateway, but before continuing to the
programming part, it is recommended to check for software updates.
Please follow the procedure on the next page.
12
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 on-line button to check for the latest available software. The online
version will be displayed together with the currently running version. Internet
access of ML Gateway requires two conditions:
- The installation network has direct access to Internet (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 install the
new software.
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. Click Update
software.
! Do not switch off ML Gateway during the installation of new software, as
this may result in a corrupted system.
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. 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.
If you suspect that the failure is inherent to the latest 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
13
Programming
Additional information
The programming section provides the opportunity to define how BeoLink products
and the home automation systems interact.
The programming section in ML Gateway consists of two main elements:
- Devices (including Resources for BeoLink, Virtual buttons, Home automation
system)
- Macros
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. Each device contain individual Resources which can be:
- Setup and settings for BeoLink rooms / BeoLink 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
Internet
Internet
1
2
2
Router / switch
ML Gateway
1
1
2
2
Energy
control
2
Home automation system
- Connection
- Project
2
Sensors
Master Link
- Rooms
- Products
(( ))
Alarm
Room 1
Heat
control
Mobil device
- Virtual buttons
- Scenes
IHC
Controller
Operation
switches
Modem
Bang & Oluf
sen
Phone
Lighting
Room 2
(( ))
Room 3
Follow the procedure on the next page to define the supported device (home
automation system).
14
Programming
Device - Home automation system
Use the devices screen to specify the devices connected to ML Gateway. For
information regarding supported devices please refer to page 24, and then follow
the procedure below:
- Click on the tab Programming and then Devices.
- Click in the field for Add new device. The following options are available:
-
-
-
-
-
-
-
-
--
-
-
-
Clipsal
Conson XP
Custom strings
Dynalite
KNX / EIB
Lauritz Knudsen, IHC, Schneider, LexControl, ELKO Living Systems* (up to 4
controllers - see appendix for further information)
Lutron Grafik Eye
Lutron Grafik QS
Lutron HomeWorks
Lutron Radio RA
Lutron Radio RA 2
Scheduler** (see page 24)
- 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. The options may vary between the following:
Connection method
IP address
IP Port
Login
Password
Bit rate
Hardware flow control:
Data bits
Parity
Stop bits
RS232 / RS232 over ethernet / Ethernet
xxx.xxx.xxx.xxx
xxxx
xxxx
xxxxxxxx
9600 / 19200 / 38400 / 57600 / 115200
x
7 bits / 8 bits
No parity / Odd / Even
1 bit / 2 bit
! 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. For this connection type it is necessary to disable MLGW
protocol over RS232, under System -> MLGW Protocol.
- Click the Save settings button to apply the settings.
Programming
15
Resource - Home automation system
The purpose of resources here is to identify the configuration (components) of the
home automation system. All resources tables contain an empty last row. Use this
row to define a new resource. Most drivers allow automatically detecting resources
(follow the procedure below):
Click the Test button to start testing the configuration.
Activate one or more of the resources (e.g. press a button on a keypad).
Click the Cancel button to stop testing the configuration.
Click the Show detected button that appears below the resources table (a new
list will appear with the resources detected during the test).
- Select the resources to add to the resource tables and press Apply changes.
-
-
-
-
! Drivers that do not have a Show detected button do not have this feature, e.g.
IHC - Lauritz Knudsen (LK), Schneider, ELKO and LexControl. In this case follow the
procedure below:
IHC:
- Click the Add resources... button in the Resources section.
- Click the Browse button, choose the definition file from the project and click Open.
- Click the Load button and the project file is loaded to the Resource section.
-
-
-
-
KNX / EIB:
Click the Browse button in the Resources section.
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 and the project file is loaded to the
Resource section.
- Select the desired resources (with checkmarks in the boxes).
- To finish the selection click the Add selected resources button
Now the configuration and resource screen appears on the screen, where the
selected resources are now visible.
16
Programming
Device - 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.
Changes made to ML Gateway must be saved either by selecting the corresponding
Apply button, or by pressing Enter.
For removing resources, select the Delete check marks before applying changes.
Auto setup of rooms and products
If there is a Beo5 project available 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 project file.
- Click Open.
- Click Load resources from Beo5 project file... (rooms and products will
automatically be appended to the current list).
BeoLink rooms
Rooms are needed for receiving LIGHT and CONTROL events from Beo4/Beo5.
These events are associated with rooms, where more than one product could
possible receive the same remote control command. The purpose of the table
under the BeoLink rooms section is to define the rooms from which you need to
receive light and control events, and to dedicate a room number to each room.
- Name the desired rooms for programming in the table and give each one a specific
number (the sequence has no significance).
BeoLink products
BeoLink products have no fixed address, so you provide an address yourself in the
column MLN (Master Link Node). Once you finish addressing each product, you
need to associate that address with the actual products.
This procedure is called product assignment. It is recommended to use continuous
numbers starting with 1 (this will simplify the product assignment process).
! AudioMasters in Option 0 should not be included in the list because they are
controlled through the VideoMaster.
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. The assignment af the products can be made in two ways:
- All product assignment
- Assign single product
If BeoLink products are added or replaced, then the procedure must be repeated
so that ML Gateway can identify the new products. Follow the procedure on the
next page.
Programming
17
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 to be ready for product
assignment. When the text ‘Please wait‘ changes to ‘0 product activations so
far’, the ML Gateway is ready (the front panel indicator will flash red rapidly).
- Activate the product, by selecting a source, to switch on the product. Remember:
Main products can be activated by selecting any source.
Link products must be activated by selecting a source from the main room (do
not use local sources).
! Allow at least 20 seconds and no more than 5 minutes between product activation.
In setups that includes a BeoSystem 3, all tasks performed by external equipment
(such as projector lifting, automated doors etc.) must be finalized before proceeding.
Product marked to be skipped must be activated in order to get to the correct
MLN values assigned.
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... button
- Activate the product, by selecting a source, to switch on the product. Remember:
- Main products can be activated by selecting any source
- Link products must be activated by selecting a source from the main room
(do not use local sources)
To abort, click the Abort product assignment button, 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.
During product activation, main products in link rooms (i.e. in Options 5 or 6)
must be activated using a source from the main room (not a source local to the
product). Otherwise ML Gateway will not receive feedback from that product.
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 page 32), without
using the web interface. This can be useful for ML Gateway protocol-only
installations where no further setup is needed.
- When the product assignment procedure is completed, continue to setting up
sources on the next page.
18
Programming
Device - 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).
Resources - Virtual buttons
Labels for special rooms
Beside the defined BeoLink rooms earlier, 3 extra rooms are shown as options:
- One for actions that affect the residence as a whole (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 virtual buttons. Each time a button has been
defined and applied, the option for a new button will appear immediately below.
Name: A name for the virtual button, used for
monitoring and macro programming.
Id: This is a numeric value in the range 1 to
255. This is the identifier for the virtual
button to be used on MLGW Protocol.
Room: A room with which to associate the
button (see below).
Presentation hints:
Directives on how this button should be presented to the user by a mobile
application 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.
- 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.
! By default, virtual buttons are hidden: they can be activated by MLGW Protocol,
but they will not be published for mobile applications to show.
- Before the configuration of virtual buttons 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 virtual buttons.
TIP!
Click here to see more information about configurations of ML Gateway.
Programming
19
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).
- Navigate to Programming and click the tab Sources.
A list of sources can be defined for each product. The information to provide for
each source is the following:
- Source: This is the actual Beo4 command for selecting the source.
- Name: This is an optional label to show with the source. Try to use a short label
(no more than 5 or 6 characters) so that it can fit on less space on the 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).
- Link: In the case of a link product having local sources, sources from the main
products are selected using the LINK modifier (just as with Beo4). This may also be
necessary for products in OPTION 4.
Important: Many BeoLink products do not support this modifier.
Click here to see survey of compatible products.
- UI type: This is an indication to the mobile application on what type of user
interface is needed for operating the product. Choose the type that most suits
your specific source or set-top box.
Click here to see survey of default UI types.
- 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 sources.
TIP!
Click here to see more information about configurations of ML Gateway.
20
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. Fill in the options).
• User name / password:
User name and password are free text values. If using more than one word, or
international characters, please check that there are no encoding incompatibilities
when accessing ML Gateway.
There is no default password for users, so a new password must be supplied at
least once. When modifying user properties, leaving the password 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 MGLW. When this flag is set for a user, it will
not appear on the web panel user management page.
• User management flag:
Indicates whether this user can set up and configure other user accounts by means
of the web panel. The usual case is to give the home owner access to user
management.
A user manager will have an extra option on the web panel for managing users,
very similar to the user setup screen for the installer. The differences are that users
with hidden flag will not show, and the hidden property will not be available.
It is important to have at least one user manager (e.g. the home owner) to avoid
service calls for setting up users.
• 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.
• 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
on the main bedroom, or scenes accessible from outside the house (Global, Away).
Router setup - port forwarding
21
Router setup - port forwarding
To ensure that users can access ML Gateway (to control home automation functions)
from a web panel/iPhone 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. The ports
used for web panel access and mobile devices are:
Application:
Web panel
MLGW Telnet
IHC
SSH Server
Port range:
80
23
443
2824
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 example below).
! Be aware of that setup layout and names of menues in the router may vary
between types/brands of network routers, compared to the example shown.
- Save settings and leave the router setup.
22
Programming
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.
- Click the Add macro button appering on the macro list.
- Define a name for the new macro and click Update name.
Copying macro definitions
A complete macro can be duplicated using the Clone button. This will make an
exact new copy of a macro.
Also, selected events or commands can be copied from one macro to 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 command to the end of the command list.
2 Select the commands between the added commands and the wanted insertion
point.
3 Copy, Remove and Paste the commands.
Orphan commands and events
If commands and events are already defined for a resource, and that resource is
modified to another address, the events and commands become orphan (without
an associated resource).
Orphan events or commands still works, and refers to the original addressing of
the resource.
The macro screen signals the presence of orphan commands or events, and a
report is available listing them all.
Programming
23
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. All
device settings, resources and macros modified by the user do not become active,
but only change this edited configuration.
The user can test if the modifications being made work as expected by selecting
the Test button in the web-based user interface. This will momentarily stop the
active configuration and run a copy of the edited configuration.
If everything runs as expected during the test, the configuration can be accepted
by selecting the Save button. This way the configuration being tested becomes
the active 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
saved as the previous configuration. Use the Previous button to return to this
saved configuration (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. It is strongly recommended that you accept changes to the
configuration after testing, so that these changes are not lost.
Tip!
Click here to see more information about configurations of ML Gateway.
Done
When the test is successful, the installation of ML Gateway is completed!
24
Supported devices
Supported devices
On the following 8 pages, devices/resources for all supported systems are described.
IHC Control: Lauritz Knudsen (LK), Schneider LexControl and ELKO Living system
IHC/LexControl programming model consists 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) 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.
Resources available for generating events on ML Gateway are physical input signals
and function block outputs.
Commands are always a logical pulse (True followed by False) on function block
inputs. This way, all programming (scenarios, etc.) is implemented by means of
function blocks that can be executed by ML Gateway.
The Visual project file is absolutely necessary, since there is no way to inspect all of
the events occurring on the controller. Therefore, monitoring information will only
be available for already defined resources.
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.
- Wait time:
This is the number of seconds since the scheduler was started (it is not relative to
the previous row).
Schedulers accept 2 commands: start and stop. Starting a scheduler will start to
produce events at the set times. Once the last event is generated, 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.
Supported devices
25
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 permissions granted.
For RS232, hardware flow control is recommended. Be sure to use a fully wired
RS232 cable in this case.
Defining HomeWorks resources
Resources on HomeWorks are keypads (both physical and phantom keypads).
Keypads are identified by processor number, link number and keypad address. Use
the monitor tool to verify keypad addresses and button numbering.
Events and commands
Events from HomeWorks include button activity and LED activity. Usually you should
only use the keyboard button press. The other options are provided for advanced
use and need special care.
Commands to HomeWorks are keypad button presses. This is general since all buttons
on HomeWorks are completely programmable.
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. ML Gateway can act
on any keypad (physical or phantom), but it is recommended to channel commands
from ML Gateway to HomeWorks via phantom keypads, so the special function
for integration is not mixed with standard keypad function.
LED feedback
Advanced use only: ML Gateway can generate events from keypad LED 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 purpose.
- Set the button type to ‘conditional’.
Set the LED behaviour to ‘conditional’, on (for example) Preset 5, type scene.
- 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.
For example, use the ‘Time of Day’ variable with value ‘Day’. The LED going ON
will generate an event on sunrise, and the LED going off will generate an event at
sunset on ML Gateway.
26
Supported devices
Lutron Grafik Eye
Connecting to a Grafik Eye system
All Grafik Eye interfaces are supported: GRX-RS232, GRX-CI-RS232, and GRX-CINWK-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.
The default password for this interface is ‘nwk’.
! Make sure that you enable scene status feedback and raw feedback on the Lutron
interfaces. This is done by setting the DIP switches 6 and 7 to ON on the interface
itself.
Defining Grafik Eye resources
The resources you must to define are control units and accessory controls (e.g.
keypads) with which you need to interact. Each is determined by an address in the
range 1 to 8 for control units, or 1 to 16 for accessory controls.
You can use the monitoring facilities to identify addresses.
Grafik Eye events and commands
Events from a Grafik Eye system can be lighting scene changes or individual key
presses.
Possible commands are scene changes on control units.
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’.
Defining Grafik QS resources
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.
Grafik QS events and commands
Events from a Grafik QS system can be lighting scene changes on control units, or
key presses.
Possible commands are scene changes on control units.
Supported devices
27
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.
The only connection setting available is the TCP port number and IP address in
case you connect via Ethernet.
Defining Radio RA resources
On the resources screen, you must identify all of the buttons with which you need
to interact. This includes:
- Buttons on Master Control units.
- Phantom buttons on the Radio RA RS232 interface.
Use the monitoring facilities or the display 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 buttons.
! Bridged installations are not supported. All interaction will be related to the section
where the RS232 interface is located.
Radio RA events and commands
You can define events for button presses on Master Control buttons.
For commands you can execute a button press on a Phantom button.
Also, you can set the LED state on a Master Control button. Note that setting the
LED state only works if that button has not been assigned to lighting control. If
the button has lighting assigned to it, the LED will always show the lighting scene
status regardless of any state change command sent by ML Gateway. Use this
feature to provide feedback on Master Control keypads.
28
Supported devices
Lutron Radio RA2
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.
-
-
-
-
-
Connection to the RS232 interface can be done directly using a 3-wire RS232
cable and it is fixed at:
Bits per second
9600
Data bits
8
Parity
none
Stop bits
1
Flow control none
-
-
-
-
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 Radio RA2 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 components and not the individual buttons
within them. Each Radio RA2 resource has a name and an ID. The ID field
corresponds to the identification number in the Radio RA2 system and ranges
from 1 to 100. Use the monitoring facilities or the Radio RA2 telnet terminal in
order to obtain the component IDs.
Radio RA2 events and commands
An event corresponds to a button press, release, hold, or multi-tap on one of the
device buttons.
Supported commands are button presses, button holds and button releases.
Supported devices
29
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. The IP tunneling interface must provide bus monitor mode.
! 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.
Group addresses
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 used to track
for events.
KNX resources
On the resources definition screen, you must add all necessary group addresses.
Group addresses have the form a/b/c (3 level address) or a/b (2 level). The default
is the 3 level addresses, but both formats are accepted.
Select one of the supported datapoint types for each group address:
Datapoint type:
Boolean 1 Byte unsigned integer 1 Byte signed integer 2 Bytes unsigned integer 2 Bytes signed integer 3 bit Controlled Range:
0 .. 1
0 .. 255
-128 .. 127
0 .. 65535
-32768 .. 32767
0 .. 15
Boolean values are coded as 0 for FALSE and 1 for TRUE.
3-bit Controlled values are coded from 0 (corresponding to 0000b) to 15
(corresponding to 1111b).
Continues on the next page ...
30
Supported devices
continued ...
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. An event can be defined for a
specific value set to the group address.
If any of the bits is 1, then a TRUE event will be generated. Otherwise, a FALSE
event will be issued. For the common datapoint types:
- Boolean: TRUE or FALSE event, depending on the value received.
- Integer (1 or 2 Bytes): TRUE event if the value received is not 0, FALSE if 0.
! Commands can write any of the possible values to a group address.
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.
Events and commands
Events occurring on the Conson bus are changes on a module’s input. This is
signalled as a circuit make or break event.
Similarly, ML Gateway can send circuit make, break, or pulse (make followed by
break) to any input of a module.
Supported devices
31
Clipsal
The Clipsal programming model defines trigger groups and trigger actions as a
way to call lighting scenes. Any scene defined by a trigger group/action pair can
be called from ML Gateway.
Clipsal resources
Resources correspond to trigger groups. Usually a trigger group is shared by a set
of mutually exclusive scenes, each identified by a trigger action within the group.
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).
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.
Events and commands
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.
The available commands are
- Preset selection
- Switch area off
- Area fade UP / DOWN / STOP.
The parameters for preset selection are area number and preset number. For area
off and area fading, the only parameter is the area number.
32
Appendix
Appendix
Service functions
General
This section describes the front panel indicator and the service functions of the
setup button on ML Gateway.
Front panel indicator
Front panel indicator (LED)
Setup button
The front panel indicator provides feedback on 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.
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.
During software update of any of the two processor modules, the front panel
indicator will flash green.
Setup button
The setup button 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 default.
Function 4: Erase entire configuration, network and password to factory defaults.
Function 5: BeoLink product assignment on the active configuration.
To select a function, press and hold the setup button. This will cycle through all
available functions, and the front panel indicator blinks RED showing the current
function. Release the button at the desired function number in order to execute it.
Holding the button past the last function to return to normal operation.
Also the setup button can be used during system power up to recall the original
factory-installed software as described in the section ‘Troubleshooting’.
Appendix
33
*IHC - Lauritz Knudsen (LK), Schneider, ELKO and LexControl
! If the selected device is an IHC-controller, it has to be a viewer version and it is
necessary to patch new API firmware into the IHC-controller to ensure compatibility.
To order the firmware please contact Lauritz Knudsen on phone (+45) 44207200
or kundeservice@lk.dk.
The following information must be included in the request:
-
-
-
-
Serial number on the IHC-controller.
Installation contractor (name and address).
Bang & Olufsen store (name and address).
Customer (name, address and e-mail).
When the above-mentioned information is given to the Lauritz Knudsen customer
service, the API-patch is delivered to the customer by e-mail.
The serial number is easy to find on the barcode label placed on the front of the
IHC-controller. If the serial number for some reason is difficult to find, the LK IHC
Visual software can be a great help. Follow the procedure below:
- Install the IHC Visual software.
- Connect the IHC-controller with an USB cable to a computer and access the IHC
Visual software.
- Navigate to Controller -> Settings to open the information box. The serial
number is now shown in the LK IHC controller information field (see below).
34
Appendix
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.
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.
Configure your telnet client for UTF-8 encoding to correctly show international
characters.
On connection, you will get a log-in 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.
- Arguments separated by a vertical bar ( ‘c’ ) are mutually exclusive.
- Command names and arguments are case insensitive, except for passwords which
are case sensitive.
- Arguments shown in uppercase indicate a literal value.
- Arguments shown in lowercase indicate values you should supply.
HELP [ command ]
- Provides usage information for a command.
- With no arguments, provides help on using the command line interface.
LOGOUT [ ALL | OTHER ]
- Terminates the CLI session. Ctrl-D can be used equivalently.
- With an argument, terminates all, or all other CLI sessions.
- The INFO command shows the number of active CLI sessions.
Appendix
35
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.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 settings switches to manual IP configuration.
New settings apply immediately.
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.
ALLSTANDBY
- Sends all BeoLink products to stand-by. Use to check BeoLink connectivity.
COUNTERS
- Displays service counters.
36
Troubleshooting
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. In particular, check the ML outlet dedicated to ML Gateway
as you probably never used this outlet before.
- Connect all products to Master Link and make the correct Option programming. It
is particularly important not to have more than one Video Master, and 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 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.
Click here for information about CLI command.
Product assignment
A product does not switch on:
If you are unable to switch a product on using Beo4, be aware that some products
can be configured in Option 0, 1, 4 or 5, so selecting a source on Beo4 will not
necessarily activate such products.
Troubleshooting
37
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.
- In order to determine which other product is involved in the addressing conflict,
power down other 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.
Possible causes of system error include:
- Software fault
- Internal communication error
- 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.
38
Troubleshooting
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.
- The unit automatically reboots every minute or so (check for system boot indication
on the front panel or critical error indication).
If the application seems to be running, but you cannot connect either via web or
via telnet (command line interface), first check that the network is working as usual;
then try resetting the network settings through the front panel.
Click here for information about CLI command.
- Restarting ML Gateway with 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. 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 can manually download an earlier software
version from BeoWise to you computer, and perform a software update from that
file.
- Erasing entire configuration before application start
If the application fails to start even if restarting on factory-installed software, there
is a method for erasing the entire configuration from ML Gateway before the
application starts up. This may be useful in case of a corrupt configuration, or a
configuration which causes the factory-installed software to fail.
The entire configuration is erased if the setup button is pressed when the
application starts (front panel indicator goes from red to green) and is released
within 1 second. The procedure for this is to power up ML Gateway with the setup
button pressed, and release is as soon as the front panel indicator goes from red
to green (approximately 40 seconds after power-up).
Troubleshooting�������
39
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.MEM
DVD B&O
DVD B&O
Selection-only
DTV
PC
Selection-only
A.MEM
CD
N.RADIO
N.MUSIC
Generic
40
Troubleshooting
Survey of configuration versions
All edits
Save
Load
configuration
configuration
Test
Edit
version
Power ON
Discard
Cancel
2
Current active
version
Disk
storage
Running
version
2
Previous
1
1
Save
Backup/
Previous
version
- 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.
- Use the Test button to test changes made in Edit version. This will copy the Edit
version to the Running version.
- Continue to Edit and Test until configuration works as expected.
- Use the Save button when configuration works as expected. This will (1) save
previous Current active version in Backup version and (2) save Edited = Running
version in Current active version.
- Use the Cancel button if you 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, Configuration, Save configuration to make disk copies of Edit, Current
active or Backup versions.
- Use the Tools, Configuration, Load configuration to load one of the saved versions
into the Edit version. Remember to use the Test and Save buttons to make it the
Current active version.
Technical specifications
Technical specifications
41
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., 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 Zealand,
Nigeria, Norway, Oman, Pakistan, Panama, Peru, Philippines, Poland, Portugal, Qatar, Romania, Russia,
Saudi Arabia, Serbia, Singapore, Slovak Rep., Slovenia, South Africa, Spain, St. Martin, Sweden, Switzerland, Taiwan, Thailand, Turkey, UK, Ukraine, Uruguay, United Arab Emirates, USA, Uzbekistan, Vietnam
All
1701, 1799
China (for information regarding RoHS directive please see next page)*
CN
1702, 1798
Power supply
Power consumption
Operating conditions
100 ~ 230 V AC, 50/60 Hz
Typical 2.5 Watts, standby not possible
-10 to +50 degrees celcius
Dimensions
Weight
35.5 x 4.5 x 15 cm (W x H x D)
48.3 x 4.5 x 15 cm (W x H x D - including bracket for rack-mount)
1.63 kg
Connections
Mains inlet
Too see the different types of mains leads see exploded view in the
Retail Ordering System
Live
Neutral
MASTER LINK 9
3
13
1
11
5
7
15
16
8
10
12
14
2
4
6
Pin 1
Pin 2
Pin 3
Pin 4-8 Pin 9 Pin 10 Pin 11 Pin 12 Pin 13 Pin 14 Pin 15 Pin 16 Data- -0.4V ±0.1V
Data+ +0.4V ±0.1V
ML sense
N.C.
ATI transmit (N.C.)
ATI receive (N.C.)
N.C.
+supply voltage +7V to +15V (in St By +3V to +15V)
N.C.
N.C.
N.C.
N.C.
RS232 port, DSUB9 male
1
6
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_D3RX_D2BI_D4+
BI_D4-
Ethernet , RJ45 socket, 10/100 Mbit/s
Subject to change without notice
5
9
5
9
42
Technical specifications
* 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
X
Indicates all homogeneous materials’ hazardous substances content are below ST/T 11363-2006 MCV limit.
Indicates that the hazardous substance content contained in any of the homogeneous materials of the part
exceeded the MCV limits specified in the standard SJ/T 11363-206.