OpenBOS
The OpenBOS app enables integration and synchronization between Eliona and ABB Ability™ Building Edge (using the OpenBOS software).
Overview
This guide provides instructions for configuring, installing, and using the OpenBOS app to manage resources and synchronize data between Eliona and OpenBOS Edge.
Required steps in OpenBOS Building Edge
The complete documentation for using the Edge Editor, an integrated tool of Building Edge for configuration, is here available. It is referred to below as Edge Editor Doc and the content corresponds to revision G of the English version.
Topology and services
The building data is collected by Building Edge, assigned to assets, and sent to the ABB Ability Cloud. From there, the assets are retrieved via the Eliona app and created automatically.
Initial installation
The following configurations must be made during the initial installation:
Local configuration
As soon as Building Edge is powered on, it can be accessed via a browser through LAN port 1 or 2.
Proceed with the further steps according to the Edge Editor Doc (pages 23–32).
Cloud configuration
For the Edge to be connected to the cloud, it must be on a network with internet access. Adjust the IP address accordingly (see Edge Editor Doc, page 43).
To access the ABB Cloud, a personalized login must be created. Then follow the steps in the Edge Editor Doc (pages 33–40).
General setup
Next, check the general settings and adjust or complete them as needed according to Edge Editor Doc, pages 42–81.
Integration of field data
To retrieve data points from a bus system, a new network for the corresponding protocol must be created under "Field Network".
The Ability Cloud is accessible at: https://buildings.ability.abb
Proceed with the steps according to the Edge Editor Doc (pages 112–123).
Adding devices and data points
To add devices and data points, the CSV import can be used. It is recommended to first export an (empty) CSV file and fill it with data.
Allow access via API
For Eliona to receive updates from data points, each data point must be configured for API subscriptions:
In the Library/asset template:
Select your asset.
Click on the edit pencil icon.
Go to API subscription.
Enable the desired subscription.
Don't forget to click Save to click (top right in the bar next to "API subscription").
App registration in OpenBOS
To connect Eliona with your OpenBOS Edge, the Edge must be configured to allow API connections. Contact ABB support for more information. You must provide Eliona's public API URL:
https://{your-eliona-domain.io}/apps-public/open-bos.
Eliona requires the gateway ID, client ID, and client secret for authentication.
Installation
Install the OpenBOS app via the Eliona App Store.
Configuration
The OpenBOS app requires configuration through the Eliona settings interface. The following steps are required to configure the app.
Configuration of the OpenBOS app
Configurations can be created in Eliona under Settings > Apps > OpenBOS created, thereby opening the Generic Frontend of the app. Here you can use the \configsinterface using the POST method. Each configuration requires the following data:
gwid
The ID of the gateway device used in the API requests.
clientID
The client ID for OAuth 2.0 authentication.
clientSecret
The client secret for OAuth 2.0 authentication.
appPublicAPIURL
URL of this app's public API. Derived automatically from the request. Example: "https://{your-eliona-instance.io}/apps-public/open-bos".
enable
Flag to enable or disable polling from this API. Default: true.
refreshInterval
Interval in seconds for polling data from the API. Default: 24.
requestTimeout
Timeout for API requests in seconds. Default: 120.
active
Set by the app to true when it is running, and to false, when it is stopped. Read-only.
projectIDs
List of Eliona project IDs for data collection. For each project ID, all smart devices are automatically created as assets in Eliona, with the mappings stored in the OpenBOS app. Example: ["42", "99"].
Example of a complete configuration file in JSON format:
Some fields have default values, so a minimal configuration file can look like this:
Continuous asset creation
After configuration, the app begins continuous asset creation (CAC). Detected resources are automatically created as assets in Eliona, and the user who configured the app is notified via the Eliona notification system.
Structuring assets
After creation, the assets in Eliona are organized in the same structure as in OpenBOS. This structure remains synchronized, and changes in Eliona (e.g., renaming an asset or moving a room to another building) are overwritten during the next ontology update.
The only exception is the root assets. These are created in the top-level directory and correspond to the top level of the OpenBOS location structure. Usually there is a "Site" in this role. Another root asset is the "OpenBOS unassigned", which contains unassigned assets and data points.
You can rename or move the root assets as you wish, with the entire ontology moving along with them.
It is not possible to change GAIs in Eliona for assets.
Asset filtering
If not all assets are to be imported from OpenBOS into Eliona, an asset filter can be defined to include only certain assets. The app can filter assets by ID, name, and TemplateID (for assets and rooms). Instructions for creating filters can be found in the asset filter documentation.
asset types
Asset types are automatically created and synchronized from the OpenBOS asset templates.
Asset type
Asset template
Attribute - Input
Data point with direction "Feedback"
Attribute - Output
Data point with direction "Command" or "CommandAndFeedback"
Attribute - Info
Property
Limit values
Min/Max
Unit
Unit
Value mapping
Enums
Complex data types from OpenBOS are split into separate attributes in Eliona.
Orphaned data points
If an asset is deleted in OpenBOS but an alarm is still linked to this data point, this data point remains in the ontology. Eliona follows this behavior and assigns such data points to the "OpenBOS unassigned" asset.
Alarms
Alarms triggered in OpenBOS are synchronized with Eliona. In Eliona, they are created as alarm rules of type "External" and controlled by updates from OpenBOS. When an alarm is triggered in OpenBOS, it also appears in Eliona and is removed accordingly when it ends in OpenBOS.
External alarms are alarms that are not managed by Eliona. Alarm rules are displayed so users can tag and categorize them, but Eliona is not responsible for determining whether an alarm should be triggered. An external system (in this case OpenBOS) is responsible for alarm control.
If an alarm requires a confirmation it can be acknowledged in Eliona, and this acknowledgment is synchronized with OpenBOS.
App status monitoring
Along with asset creation, an asset named "OpenBOS app" is also created. It is used to inform users about the app's status - it indicates whether the app is running (asset status -> Active/Inactive) and what status it has - the Status attribute. If the app status is not "OK", this means the app may not be working properly. If the error status persists, let us know by submitting a bug report.
Last updated
Was this helpful?