Integrating Enlighted Energy Manager

Scenario: You want to configure Desigo CC to operate on the Enlighted lighting control system.

 

Reference: For background information, see the reference section.

 

Workflow diagram:

 

 

Prerequisites:

  • The Enlighted Energy Manager extension is installed and included in the active project. The following extension is also selected automatically:
    • SORIS Driver
  • The Enlighted adapter is running and connected to the Enlighted lighting control system. For instructions, see Installing and Starting the Enlighted Adapter.
  • System Manager is in Engineering mode.
  • System Browser is in Management View.

 

NOTICE
Licensing

This extension is covered by license. Check that the required license is available, otherwise you may not be able to configure and work with this extension.

 

Steps:

1 – Create the SORIS Driver
  1. Depending on where the driver will run, select one of the following:
  • Project > Management System > Servers > Main Server > Drivers
  • Project > Management System > FEPs > [FEP station] > [drivers folder]
    NOTE:     If the drivers folder is not available, to create it select the FEP station and click New .
  1. In the Object Configurator tab, click New and select New SORIS Driver.
  1. In the New object dialog box, enter a description and click OK.
  • The newly created SORIS driver is added to System Browser, but not started.

 

2 – Create the SORIS Network
  1. Select Project > Field Networks.
  1. In the Object Configurator tab, click New and select New SORIS Network.
  1. In the New Object dialog box, enter a name and description, and click OK.
  • The newly created SORIS network is added to System Browser.

 

3 – Associate a Driver to the SORIS Network
  1. Select Project > Field Networks > [SORIS network].
  1. In the SORIS tab, open the Network Settings expander.
  1. From the Monitored by driver drop-down list, select the driver.
  1. Click Save .
Linking the Network to the Driver

 

4 – Start the SORIS Driver

The status of a newly created driver is Stopped. To be able to connect, the driver must be started.

  1. Select Project > Management System > Servers > Main Server > Drivers > [SORIS driver].
  1. In the Extended Operation tab, click Start.

 

5 – Create the Enlighted Adapter under the Network

You can configure multiple adapters under one SORIS network. Skip this step if you want to use an existing adapter.

  1. Select Project > Field Networks > [SORIS network].
  1. In the Object Configurator tab, click New and select New SORIS Adapter.
  1. In the New Object dialog box, enter a name and description, and click OK.
  • The newly created adapter is added to System Browser. The adapter starts automatically as a Windows service.
  1. Select the newly created adapter and click the SORIS tab.
  1. In the URL field, enter the IP address of the computer from which the network adapter is run using the following format: https://<IP address>:<port number>.
    NOTE: In the executable window you can check the correctness of the IP address. The default port number is 8080.
  • In the Operation tab, the Online property indicates Connected and the property URL displays the IP address configured.

 

Enlighted Adapter URL Configuration

 

6 – Configure the Energy Manager
  1. Users must be authenticated to communicate with the energy manager. For each user, an API key is generated and provided to the user. To retrieve user name and API key, do the following:
    a. Launch Enlighted from the web browser.
    b. Select Administrator > User Management. The list of users displays in the User Management window.
    c. Click Copy API Key. The code is copied to clipboard ready to be pasted to the corresponding field in Desigo CC.
  1. In System Browser, select Project > Field Networks > [SORIS network] > [Enlighted adapter] > Configuration > Adapter Configuration.
  1. In the Operation tab, specify the following parameters:
  • Next to the Description property, enter a descriptive text for the energy manager and click Save.
  • Next to the ID property, enter the energy manager identifier and click Save.
    NOTE: This identifier must be a unique value. It is an internal identifier that can be freely assigned in Desigo CC since it is not to be taken from the energy manager.
  • Next to the Host property, enter the IP address or the Host name of the energy manager and click Save.
    NOTE: Since it is not the URL that is required, if you enter the Host name, do not include https:// in the name. For example, ENL-siemens.enlightedinc.com/ems.
  • Next to the User property, enter the user that will query the manager and click Save.
  • Next to the Delay (sec) property, enter the polling interval of time in seconds and click Save.
  • Next to the Temperature Unit property, select the appropriate unit of temperature (°F or °C) and click Save.
  • Next to the API Key property, paste the given unique API code identifier for the user in the field and click Save.
  1. Next to the Configuration property, click Create.
  • In System Browser, the energy manager is created, including its object hierarchy.