bOS Server - Manual - ComfortClick bOS"

Icon

bOS Server

About

bOS Server application is the heart of ComfortClick building automation system. bOS Server connects to devices, runs logic tasks and provides access for bOS Configurator and bOS Client applications. You can use bOS Server with your own hardware or pre installed on ComfortClick Controllers.

System Requirements

Supported Operating Systems

  • Windows 10
  • Windows 8, 8.1
  • Windows 7 SP1 (requires manual installation of .NET Framework 4.5)
  • Linux (with ComfortClick controllers only).

Supported Architectures

  • x86
  • x64
  • ARM

Requirements

Hardware requirements depend on the size of the configuration.

  • Minimum: 800 MHz CPU, 1 GB RAM, 1GB disk space.
  • Medium: 1.0 GHz or higher CPU, 4 GB RAM or more, 64GB disk space.
  • Large: 2.0 GHz or higher CPU, 16 GB RAM or more, 2TB disk space.

Installation

It is recommended that the computer running bOS Server is using a fixed LAN IP address.

The bOS Server offers three types of services:

  • HTTP service on port 80 for bOS Client application (unsecure connection http).
  • HTTPS service on port 443 for bOS Client (secure connection https).
  • Event service on port 16100 for for bOS Configurator application.

Installation steps:

  1. Before installing bOS Server disable all programs that use ports 80, 443 (e.g. IIS, other web servers and also Skype) and 16100.

  2. Download bOS Server installer package (BOSServerSetup.msi).

  3. Run the installer package and install the bOS Server by confirming all steps of the installation process.

Installation

Picture 1: bOS Server installation

bOS Server is installed as Windows system service. After successful installation, the bOS Server is started automatically. bOS Service Monitor can be used to monitor the operation of the bOS server. Operation of the bOS Server can also be checked in Windows Control Panel\All Control Panel Items\Administrative Tools\Services. The "ComfortClick bOS Service" should be running after the installation of bOS Server. If the service is not running please check the Windows Event log for errors.

Operation of the bOS Server can also be checked in Windows Control Panel\All Control Panel Items\Administrative Tools\Services. The "ComfortClick bOS Service" should be running after the installation of bOS Server. If the service is not running please check the Windows Event log for errors.

bOS Service Monitor

Server Monitor

Picture 2: BOS Service monitor

The bOS Service Monitor application displays the current state of the bOS Server. For normal operation th message bOS Service Running is displayed.

The application also displays the current server addresses for three types of server services:

  • HTTP service on port 80 for bOS Client application (unsecure connection http).
  • HTTPS service on port 443 for bOS Client (secure connection https).
  • Event service on port 16100 for for bOS Configurator application.

Addresses are used for accessing the server over the network. Multiple addresses for each network adapter installed on the system are displayed. Make sure that all three services have addresses listed. If error message is displayed instead of the address, make sure no other program is using the service's port.

To change the default service ports the BOSService.exe.config file can be edited in the text editor. When changing the default ports, the firewall exceptions in Windows OS need to be changed manually.

After the successful installation please check if the web server is running by entering the HTTP (e.g. http://192.168.1.2) and HTTPS (e.g. https://192.168.1.2) server address into your web browser. A bOS Server login page should be displayed. When connecting from other computers make sure you use the address of the correct network adapter (the adapter connected to the same network as your client machine).

The bOS Service Monitor can also be used to manually start or stop the bOS Server for maintenance purposes.

Internet Access

To access your controller from the internet, port forwarding should be enabled on your router (Picture 3). A static WAN IP address is needed to access your network and should be obtained from your internet provider. If you don’t have a static WAN IP address, use a dynamic DNS service. On your router setup page enable port forwarding (NAT) to the local IP address of your controller. It is recommended to only forward the port 443 for secure https connection. Your controller can then be accessed from internet at: https://YourWANIP/.

Port forwarding

Picture 3: Port forwarding example on a DD-WRT compatible router

Connecting to bOS Server

You can connect to the bOS Server with bOS Configurator, bOS Clients and web browsers. When bOS server is installed for the first time empty configuration is created with the default user (Username: User, Password: Pass).

Connecting to the Server for the fist time:

  1. Run bOS Config.
  2. Create the connection profile.
  3. Connect to the server.
  4. Register controller.
  5. Create your configuration.
  6. Change the default username and password.
  7. Connect with bOS Client or web browser.

Updates

bOS Server can be updated:

Manually by downloading the latest version of BOSServerSetup.msi package from Download section on our web page. Via bOS Configurator and bOS Client applications.

After the upgrade is finished, bOS Server will start automatically. Connecting bOS Clients might be asked to install the new version of bOS Client.

WARNING: Tasks running on server will be terminated on update. This may lead to unexpected behavior of the system.

RPC Service (beta)

bOS Offers a JSON RPC Service for integration of bOS Server with other systems. The RPC service can be enabled by editing the BOSService.exe.config file. Value "EnableRPC" should be set to "True". Service port can be changed in the "RPCServiceUri" parameter. The firewall exeptions must be set manually in Windows OS.

To call a RPC Service a HTTP POST call must be preformed with data content-type = "application/json";

Service offers the following commands:

  • http://localhost:81/SetValue

    POST data example (Turn ON a light): {"objectName":"Devices\\EIB\\Light 1","valueName":"Value","value":"true"}

  • http://localhost:81/GetValue

    POST data example (Get light status): {"objectName":"Devices\\EIB\\Light 1","valueName":"Value"}

  • http://localhost:81/CallFunction

    POST data example (Send alert to user):
    {"objectName":"Building\\General\\Users\\User","functionName":"SendAlert","value":["'Hello'"]}

.NET C# Sample code to call the bOS Service can be downloaded here.

WARNING: RPC Service is used for beta purposes. The service provides no security. It should be used on secured networks behind firewall only.

;