/
Quick Start Guide - Smart Building Manager

Quick Start Guide - Smart Building Manager

Owned by Thomas Maya (Unlicensed)
Last updated: Apr 02, 2020


Summary

In this document you will learn how to install, configure and use the Smart Building Manager (SBM) for room automation on Windows systems.
For further information about Smart Office facilities, standards, parameters and options please refer to the chapters “Apps” and “SmartOffice” in [1] (see “Bibliography”).
For detailed information on using Smart Building Manager please refer to [2] (see “Bibliography”).

Information available from the MICROSENS Website

Registered users can find the latest firmware versions as well as further information on our web site:

  • Registration: www.microsens.de > Login > Follow the link ‟Not registered?‟ > Fill in the opening email form and submit it to MICROSENS.
    o You will receive an email from MICROSENS with a user name and a password

  • Login: www.microsens.de > Login > Enter user name and password > Click the ‟Login‟ button
    o Firmware images: Navigate to the device and select the tab ‟Services‟
    o For further information select one of the other tabs

Note: Make sure the browser allows the execution of scripts.

Note: After updating the firmware either by Web Manager or CLI be sure to clear the cache of the browser you are using to open the Web Manager of the respective device. This will force the browser to reload the device‟s updated web GUI data instead of using the outdated data from its cache.

Bibliography

[1] Product Manual Firmware Generation 6
This manual is included in each software archive containing Firmware G6. It can also be downloaded from the link “Documentation” in the firmwares‟ Web Manager navigation bar.
[2] User Manual Smart Building Manager
This user manual is included in SBM Server and SBM Client via help menu. It describes in detail on how to use Smart Building Manager properly.

Before you begin

In case of questions please contact your sales representative to make sure that you received the latest version of Smart Building Manager Software including a valid licensing key file.
Also please check if the computer system where SBM will be installed matches the system requirements.

Note: Quick Step Quide can be downloaded at the and of the article

Summary Steps

This document will guide you through the following steps to properly install the MICROSENS Smart Building Manager:

Check Prerequisites

System Requirements

SBM is designed to run on dedicated servers with the following minimum requirements:

  • Microsoft Windows® 8 operating system or newer,

  • RAM: 4GB (server component), 2GB (client component),

  • Free installation disk space: 2GB (server component), 1GB (client component),

  • Disk space for SBM data: min. 10 GB per 1000 managed objects,

  • Display resolution of at least 1280*1024,

  • For network access a network interface with TCP/IP stack must be installed and configured.

Using the Browser based User Interface

A user interface is provided through a Web browser that runs on a user‟s local computer or workstation with all operating systems (Microsoft Windows®) and connects to a server as necessary. The minimum display resolution is 1280*1024.
Supported web browsers are:

  • Mozilla Firefox 3 (72.0.2) and newer

  • Chrome 80.0.3987 and newer

Note: Support for JavaScript has to be enabled at the web browser. There is no need to install any additional plug-ins.

Install the SBM Software

This section describes the installation process of MICROSENS Smart Building Manager.

Note: You need administrative rights as a prerequisite to install the server component of SBM.

Note: To use the server component a valid licence key file is required.
In order to install SBM, start the provided installer utility and follow the steps described below.

Note: The language for the installation process depends on the language setting of the operation system. It has no influence on the language setting of the management application.

Note: The following steps describe the installation process on a Microsoft Windows® based system.

Run the Install Executable

The naming convention of the installer is as follows:

  • MICROSENS_SBM_Installer_v2.x.y_win64.exe

On the welcome screen click the button Next in order to enter the licence agreement dialogue.
After reading the licence agreement click the button I Agree to go to the product selection dialogue.
Note: It is necessary to scroll down the licence agreement to the end to enable the button I Agree.

Choose Components

With SBM there are two components available for selection:

  • Server: Installs the server component of SBM and its respective supplements.

  • Client: Installs the client component of SBM and its respective supplements.

Figure 1: Choose SBM Components


Check or uncheck the components and their respective supplements for installation and hit the button Next.
Note: The installation of the client component is mandatory to access the server. For separate installations of clients on respective computers uncheck the option “Server”.

Choose Users

On the user selection screen, select the group of users who are to use this software:

Figure 2: Choose Users

  • Install for anyone using this computer: Every registered user on this computer is able to use the management application after installation. This should be enabled in exceptional cases if it is ensured that only the responsible network administrator have access to this computer.

  • Install just for me: Only the user logged in can use the management application, whereas other users can‟t (default option for security reasons).

Hit the button Next to go to the components selection screen.

Choose Install Location

On the respective installation location screens determine the destination folders for SBM Server and SBM Client (if SBM Client installation was previously selected).

Figure 3: Choose Install Folder

Hit the button Next (for SBM Client installation folder, if applicable) and the button Install to start the installation process on the system.
When the installation process is finished successfully click the button Finish.
MICROSENS Smart Building Manager is ready to be started.

Start the Server and Apply a Licence Key File

Insert USB Licence Dongle

The full version of MICROSENS Smart Building Manager is shipped with a licence USB dongle (hardware USB key). Please connect the USB dongle to a free USB port of the computer on which the server component is installed.

Start SBM Server

In order to start the server component use one of the links provided in the Microsoft Windows® Start menu:

  • Start > MICROSENS > MICROSENS SBM Server

Select Licence Key File for SBM Server

Note: Running SBM server component does not require any login but a valid licence key file. The licence file is necessary to use the server.
If no licence has been selected (especially after installation of the software) the following dialogue prompts to select the licence key file.

Figure 4: SBM Licence Key Selection

Note: The evaluation or trial licence of SBM does not include a USB dongle. When starting the server with an evaluation or trial licence please confirm the respective error message reporting a missing hardware USB key.
If you do not have a valid licence file please contact MICROSENS.

Configure SBM Server

Configure the Server Communication Settings

Figure 5: SBM Server - Tabbed Server Configuration Panel - Server Settings

The most important settings for first configuration are marked in Figure 5:

  • Configure Server data directory path: Configure the directory where SBM Server will save all necessary configuration files and database data. The default folder is: $USER_HOME\SBM Server. In the selected destination folder a new folder „SBM Server‟ will be created.

  • IPv4 Interface for device communication: The IPv4 address of the network interface that will be used for communication with the managed devices. In a more complex network infrastructure where the server hardware has more than one network adapter, it is possible to use one interface (accessible exclusively from secured local network) for device communication and another one (accessible from external network) for client access. Thanks to this function the clients do not have direct access to managed devices. The devices can be accessed exclusively through SBM Server.

  • IPv6 Interface for device communication: The IPv6 address of the network interface that will be used for communication with the managed devices.

  • Interface for client-server communication: The IPv4 address of the network interface that will be used for client access (SBM Client). If the HTTP server is enabled for Web Client access, the interface is also used by the built-in HTTP server.

  • Enable HTTP Web Server: Enables or disables the built-in HTTP server that is used for Web Client access.Figure 5: SBM Server - Tabbed Server Configuration Panel - Server Settings

  • Enable secured http connections (https): SBM Server offers secured HTTP connections for web access. The https connections are encrypted so the communication between clients and server is safe. It is recommended to enable HTTPS for all installations.

  • Port for incoming http(s) connections: The port that will be used for the HTTP(S) server. On default SBM Server uses the „8443‟ for HTTPS connections.

Start SBM Server Process

Click on the button Start Server to start the SBM Server process

Figure 6: SBM Server - Start Server Process


If server was started successfully then you should see a message in the Status field as follows:

Figure 7: SBM Server - Status Field

Start the SBM Client

In order to start SBM Client use one of the links which are provided in the Microsoft Windows® Start menu:

  • Start > MICROSENS > MICROSENS SBM Client

Login via SBM Client

At the very first time please login as “Super Administrator” with the following credentials:

  • Login: Super Admin

  • Password: Super Admin

Change Password for User “Super Admin”

Note: For safety reasons it is strongly recommended to change the password for all users, especially the user “Super Admin”!

Switch to User Management Perspective

Figure 8: SBM Client - Window - Switch Perspective - User Administration

Change to the menu entry Window > Switch Perspective and click on the entry User Administration.

Unlock User List

Click on the key lock icon right below the main menu bar on the upper left:

Figure 9: SBM Client - User Administration - Unlock User List

Now the lock icon changes to an “open lock” symbol.

Open User Properties Dialogue

On the tab User manager select the user with the name “Super Admin” and click the edit icon.

Figure 10: SBM Client - User Administration - Select User

The user properties dialogue opens up.

Figure 11: SBM Client - User Administration - Edit User

Set the new password, retype it and click on the button Apply.
Finally click on the “open lock” icon on the upper left to submit the changes to SBM Server. The lock icon changes to a “closed lock” symbol.

Create additional Admin Users

It is recommended to add additional users with Smart Building Administrator access rights.
Therefore you need to unlock the users list again as you did in the previous step.
Click on the key lock icon right below the main menu bar on the upper left:

Figure 12: SBM Client - User Administration - Unlock User List

The lock icon again changes to an “open lock” symbol. Hit the button + to add a user. The user properties dialogue opens, where you can enter the new users data and credentials.

Figure 13: SBM Client - User Administration - Add New User

  • Enter name, last name and e-mail address.

  • Enter credentials (login name and password).

  • From the drop down list select the entry „Smart Office Admin“ as access level.

Hit the button Add to create the new user.
Finally click on the “open lock” icon on the upper left to submit the changes to SBM Server. The lock icon changes to a “closed lock” symbol.

Create Building Topology

Switch to Perspective “Building Administration”

Change to the menu entry Window > Switch Perspective and click on the entry Building Administration.

Figure 14: SBM Client - Window - Switch Perspective - Buidling Administration

Create the Building Topology for Room Automation

Click on the key lock icon right below the main menu bar on the upper left:

Figure 15: SBM Client - Building Administration - Unlock Smart Office Configuration

With a fresh SBM Client installation the building structure is empty. The following steps will guide you to create a building structure with the following hierarchical structure:

  • Location

    • Building

      • Room Automation

        • Floor

          • Room

Hit the icon + to add a location.

In the opening dialogue enter the name of the new location. Select the created location and hit the icon add a building.

Select the created location and hit the + icon to add a building. In the opening dialogue enter the name of the new building.

After the building was created expand the building node and select the node with the name “Room automation”. Hit the icon + to add a floor. In the opening dialogue enter the name of the new floor.

After the building was created expand the building node and select the node with the name “Room automation”. Hit the icon + to add a floor. In the opening dialogue enter the name of the new floor.
After the new floor was created the building structure should look like this.

Select the floor and hit the icon + to add one or more rooms. In the opening dialogue enter the name of
the new room. The resulting building topology tree now should look like this.

Finally click on the “open lock” icon on the upper left to submit the changes to SBM Server.
The lock icon changes to a “closed lock” symbol.


Discover Devices for Room Automation

Switch to Perspective “Network Administration”

Change to the menu entry Window > Switch Perspective and click on the entry Network Administration.

Figure 17: SBM Client - Window - Switch Perspective - Network Administration

Click on the key lock icon right below the main menu bar on the upper left:

Figure 18: SBM Client - Network Administration - Unlock Configuration

Start Auto Discovery

Change to the menu entry Window > Discovery and click on the entry Device auto discovery.

Figure 19: SBM Client - Network Administration - Discovery - Device Auto Discovery

SMB Client starts to search for devices in the corporate network.
Note: Discovery takes some time. As long as the discovery is running you will see the green progress bar.
After the discovery scan is finished you will see a separate dialogue which contains the list of the detected devices.

Figure 20: SBM Client - Network Administration - Device Auto Discovery - Results

Review the list of detected devices. Check all devices in the column Add to list that should be part of your device list. Afterwards hit the button Add to list.
Hit the button Close to close the dialogue. All checked devices are now part of the device list. You will find the discovered devices in the building structure under the node “Scan results” > “Device auto-discovery”.
Finally click on the “open lock” icon on the upper left to submit the changes to SBM Server. The lock icon changes to a “closed lock” symbol.

Adjust Communication Parameters for Polling Rate

Click on the key lock icon right below the main menu bar on the upper left:

Figure 21: SBM Client - Network Administration - Unlock Configuration

Select the building structure node “Devices”, open the context menu with a left mouse click and select the menu item Add new Subgroup.

Figure 22: SBM Client - Network Administration - Devices Context Menu - New Subgroup

Define the name of the new device group. This device group is used as a container which contains all devices in which you are interested on.
Afterwards use drag & drop to assign a device from the “Device auto-discovery” group to your new group.

Select the node name of your group and do a right mouse click to open the context menu.

Figure 23: SBM Client - Network Administration - Devices Context Menu - Communication
Parameters

Click on the menu item Communication parameters to open the configuration dialogue.
At the bottom of the dialogue you see the parameter setting for the polling.
Please set the parameters as shown in Figure 24 and hit the button Apply.

Figure 24: SBM Client - Network Administration - Devices - Communication Parameters

Finally click on the “open lock” icon on the upper left to submit the changes to SBM Server.
The lock icon changes to a “closed lock” symbol.

Assign Devices to the Corresponding Node of Building Topology Tree

Switch to Perspective “Building Administration”

Change to the menu entry Window > Switch Perspective and click on the entry Building Administration.

Figure 25: SBM Client - Window - Switch Perspective - Building Administration

Assign Devices to building nodes

Note: This step is important because you need to add a context to each device. This means that you need to define which device is responsible for which building part.
Click on the key lock icon right below the main menu bar on the upper left:

Figure 26: SBM Client - Building Administration - Unlock Configuration

All devices found in the previous step are listed in the section “Devices” below the section “Building Structure”.

From this list select a device and assign this device to a building node using “drag and drop”
with a left mouse click.

Figure 27: SBM Client - Device List

If you drop the device (release the left mouse button) on a building node the device will be
assigned. The assigned device is shown as a sub-node of the building node:

Figure 28: SBM Client - Device Addigned to Node

Continue until all needed devices are assigned to their specific building node.
Note: A node can contain multiple devices but a device can only be assigned to one node.
Finally click on the “open lock” icon on the upper left to submit the changes to SBM Server.
The lock icon changes to a “closed lock” symbol.

Define Data Points per Device for History Data Charts

Unlock the key lock for the building structure

Click on the key lock icon right below the main menu bar on the upper left:

Figure 29: SBM Client - Building Administration - Unlock Configuration

Select a Device for Monitoring History Data

Select the device of a building tree node where you want to see history data charts

Figure 30: SBM Client - Select Device for Monitoring History Data

Select Data Points for History Saving

Go to the Tab “Data points” at the right hand side to see a list of all data points of a single device. You should see a list like in Figure 31.

Figure 31: SBM Client - Building Administration - Data Points

To mark specific data points for history data double-click the respective checkbox in the column Save history.
Click on the “open lock” icon on the upper left to submit the changes to SBM Server. The lock icon changes to a “closed lock” symbol.
To close SBM Client change to the menu entry File and click on the menu item Exit.

Start WEB UI

Prerequisites

After starting SBM Server and enabling the required HTTP service a web browser can be used to access the server with one of the following URL addresses.

  • for standard HTTP connections: <http://<server_ip_address>:<http_server_port>/sbm>

  • for secured HTTP connections, if the secured HTTP was configured on SBM Server: <https://<server_ip_address>:<https_server_port>/sbm>

Note: You will find the URL also on the bottom of the SBM Server window:

Figure 32: SBM Server - Web Server IP Address

Login as Valid User

The very first step is to log in to use the UI. Therefore you will get a login screen before accessing the WEB UI of the SBM product.

Figure 33: SBM WEB UI - Login Screen

Review Building Summary

After login you see the main navigation bar on the left hand side of the WEB UI. If it is not already active click on the menu item “Building Status”.

Figure 34: SBM WEB UI - Building Status Icon

Right of the main navigation bar there is a navigation column to navigate through your building structure for the room automation. In addition on the right hand pane there is a summary page which shows the most relevant data points as defined for a room. A click on the “Info button” near the top right corner will open a legend containing information about the different icons and colour codes used in the summary screen.

Figure 35: SBM WEB UI - Building Structure Navigation and Summary Screen

Review Inventory

Select the node “Inventory” in the main navigation bar on the left hand pane to get an overview about the managed devices.

Figure 36: SBM WEB UI - Inventory Screen

This page shows all devices, sensors and actors which are installed. When navigating through the buidling structure nodes the inventory page updates to the components available for this specific node.

Review History Charts

Click on the node “Charts” in the main navigation bar.

Figure 37: SBM WEB UI - Charts Screen

The charts screen shows the history data charts for the data points which are defined by SBM client depending on the node which is selected under the Node “Room Automation”.

Logout from SBM WEB UI

Click on the user icon on the top right corner once. A scroll down menu appears. Click again on the menu item Sign out to logout from the SBM WEB UI.

Figure 38: SBM WEB UI - Sign Out

Disclaimer

All information in this document is provided ‟as is‟ and subject to change without notice.
MICROSENS GmbH & Co. KG disclaims any liability for the correctness, completeness or quality of the information provided, fitness for a particular purpose or consecutive damage.
Any product names mentioned herein may be trademarks and/or registered trademarks of their respective companies.
©2020 MICROSENS GmbH & Co. KG, Kueferstr. 16, 59067 Hamm, Germany.
All rights reserved. This document in whole or in part may not be duplicated, reproduced, stored or retransmitted without prior written permission of MICROSENS GmbH & Co. KG.
Document ID: QSG-20008_Smart_Building_Manager_2020-03-25

 

MICROSENS GmbH & Co. KG