afBelimoCloudExt

The Belimo Cloud Extension for SkySpark is a connector for the Belimo Cloud API.

The Belimo Cloud is a great place to store and monitor all your Belimo Energy Value data. The Belimo Cloud extension shows how easy it is to connect to the Belmio Cloud API to retrieve and and analyse your device data.

Like all good SkySpark connectors, the Belimo Cloud extension provides:

• Learn functionality - browse and bind Belimo devices and datapoints from within the SkySpark Connector and Builder applications
• Current values - poll the Belimo Cloud API for datapoint current values
• Point write - write new datapoint values to the Belimo Cloud
• History sync - download datapoint history data in bulk

This connector has been developed for SkySpark v3.1 (or later), the Belimo Cloud Client-API v3, and makes use of the SkySpark v3 connector framework. For compatibility with SkySpark v3.0, download Belimo Cloud Extension v1.0.2.

• Quick Start
• Belimo Cloud Connector Walkthrough
• Belimo Cloud API Credentials
• Your First Belimo Cloud Connector
• Acknowledgement
• Licensing
• Disclaimer
• Release Notes

Quick Start

1. Install afBelimoCloudExt (use SkySpark's Install Manager)
2. Create an instance of the "afBelimoCloud" connector
3. Set your Belimo Cloud username and password
4. Set your Belimo Cloud Client (ID and Secret) Credentials with the Axon function:
   • afBelimoCloudSetClientCredentials(connectorId, "<clientId>", "<clientSecret>")
5. Bind your Belimo data points

Belimo Cloud Connector Walkthrough

Links to various sections in the video (they take you to the YouTube website).

• 0:44 - Installation and Connector creation
• 2:14 - Project setup and Point binding
• 2:55 - Current value and History Sync
• 3:39 - Write Point Values
• 4:32 - Support

Belimo Cloud API Credentials

The Belimo Cloud Extension has been developed according to the Belimo Cloud Developer Space directions. To use the Belimo Cloud extension, you must acquire TWO sets of credentials:

1. A Client ID and a Client Secret.

   This defines the realm of Belimo devices accessible to you. Facilities managers will receive their own unique credentials.

   Developer Client Secrets rotate on 60 day basis. Belimo provides also a static set of credentials on request.

2. A Username and Password.

   This identifies you as an individual.

Both sets of credentials are required by the Belimo Cloud extension, you can obtain them following the instructions at https://www.belimo.com/iot/developers.

Note, if you change any credentials - all affected Belimo Connectors need to be disabled and then re-enabled for the changes to take effect.

Your First Belimo Cloud Connector

Belimo Cloud connectors are created in the usual way with the SkySpark connector application. On creating a new Belimo Cloud connector you will be prompted to enter your username and password.

To complete your connector setup, and before it can be enabled, you must first set your client credentials on the connector. Do this by running the following (Admin) Axon command:

read(afBelimoCloudConn).afBelimoCloudSetClientCredentials("<clientId>", "<clientSecret>")

You should then be able to enable your connector and successfully ping the Belimo Cloud API.

Acknowledgement

Fantom Factory acknowledges the gracious support of Belimo in the creation of this SkySpark connector.

Licensing

The Belimo Cloud extension for SkySpark is not open source, but it is free to download and use.

Users of the Belimo Cloud API (through this extension) accept the Terms of Use of the Belimo Cloud Services

Users of the Belimo Cloud extension accept the Fantom Factory Terms of Service.

Neither Fantom Factory Ltd nor Belimo guarantees the the compatibility of this software with future versions of SkySpark or the Belimo Cloud API.

The developer, and owner of this software is Fantom Factory, who is free to discontinue the support or upgrade of the connector at any time. Any support or upgrades offered by Fantom Factory will be on a best endeavours basis.

Disclaimer

The software is provided "AS IS" and the author disclaims all warranties with regard to this software including all implied warranties of merchantability and fitness. In no event shall the author be liable for any special, direct, indirect, or consequential damages or any damages whatsoever resulting from loss of use, data or profits, whether in an action of contract, negligence or other tortious action, arising out of or in connection with the use or performance of this software.

Release Notes

v1.1.4

• Chg: Updated to verify compatibility with SkySpark version 3.1.10.

v1.1.2

• Chg: Updated to be compatible with Belimo v4 Energy Valves.

v1.1.0

• New: Updated for SkySpark v3.1.
• Chg: Removed NumWorkers - just create moar connectors instead!
• Chg: Now uses Fantom Factory's internal EasyConn framework!

v1.0.2

• New: Updated the connector to use of the new SkySpark v3 connector framework.
• New: Updated the connector to use Belimo's new Auth0 authentication.

v1.0.0

• New: HTTP optimisation - use the new afBelimoCloudNumWorkers tag to control the number of concurrent HTTP requests a connector can make to the BelimoCloud API.
• New: Tag documentation.
• Chg: Belimo units that are incompatible with Project Haystack units no longer cause errors.

v0.1.2 Beta

• New: Initial public release.