Danfoss Ally Cloud

Supported device types and versions
Literature
Document revisions

Supported device types and versions

The Danfoss Ally Cloud protocol enables communication with Danfoss Ally cloud services (https://developer.danfoss.com) using the Danfoss Ally API (https://developer.danfoss.com/catalog/danfoss-ally-api/danfoss-allytm-api).

The Danfoss Ally Cloud protocol is implemented as an ESL script (E.Danfoss_Cloud) using the unit E.Danfoss_Cloud.unit and the curl utility to communicate with the cloud. Subsequently, the data is parsed in the ESL script and stored in structured variables:

• SV.Danfoss_Ally_Gateway - "Danfoss Ally™ Gateway" type devices
• SV.Danfoss_Ally_Radiator_Thermostat - "Danfoss Ally™ Radiator Thermostat" type devices
• SV.Danfoss_Icon_RT - "Icon RT" type devices (Room Thermostat)
• SV.Danfoss_Icon_Zigbee_Module - "Icon Zigbee Module" type devices
• SV.Danfoss_Zigbee_Repeater - "Danfoss Zigbee Repeater" type devices

When a new device is found (unique identifiers are found in the "id" columns), the corresponding structured variable is automatically resized and the new device is inserted into the added row.
Note: we recommend increasing the size of the mentioned structured variables in advance according to the approximate number of individual types of devices so that the system is not burdened by the constant gradual increase of their size when parsing the data for the first time.

The script is extensible and it is possible to implement the parsing of other types of devices and other attributes of existing devices.

Working with multiple user accounts is supported. Each Danfoss device is registered to a specific user account and the structured variables mentioned above contain the first column idCred, in which the account ID is listed for each device (index into the structured variable SV.Danfoss_Credentials with accounts).

Danfoss_cloud_1.4.zip

Danfoss cloud configuration and access rights to devices

• In the Danfoss Ally mobile application (https://www.danfoss.com/sk-sk/campaigns/dhs/smart-heating/danfoss-ally) it is possible to connect devices to a registered Danfoss account. Registration is done when installing the mobile application and the account is identified by an e-mail address (e.g. ipesoft@ipesoft.sk).
  Note: apparently only the owner (Home Owner) and an administrator (Administrator) roles have the right to access devices via the "Danfoss Ally API" interface. Other roles do not have this right.
• Subsequently, creating a user account (for the same e-mail address) at https://developer.danfoss.com is necessary.
• After logging in to the account, it is necessary to create an application by clicking the Apps item (https://developer.danfoss.com/user/apps) and clicking the "Add app" button.
• The "Danfoss Ally API" interface must be added when creating the application,
• After creating the application, the situation is as follows:
  
• The items "Consumer Key" and "Consumer Secret" must be copied and the string Consumer Key:Consumer Secret must be created and converted to BASE64, e.g. using https://www.base64encode.org
  Example: if "Consumer Key" is M2i51jpJrgGpKr4TfwnI0XMLDD1nKMU9G and "Consumer Secret" is 1VT80QedtXJE3Xcu72LUjIvMwyvgVWziQ3NHEg, then the following string must be converted
  M2i51jpJrgGpKr4TfwnI0XMLDD1nKMU9G:1VT80QedtXJE3Xcu72LUjIvMwyvgVWziQ3NHEg and the BASE64 result is
  TTJpNTFqcEpyZ0dwS3I0VGZ3bkkwWE1MREQxbktNVTlHOjFWVDgwUWVkdFhKRTNYY3U3MkxVakl2TXd5dmdWV3ppUTNOSEVn
• The result must be inserted into the structured variable SV.Danfoss_Credentials in the access_key column. So this structured variable will have as many rows as user accounts. We recommend entering the identification of individual user accounts (e.g. e-mails) in the account column.
• Subsequently, in the E.Danfoss_Cloud script, it is possible to set a different trigger for starting the reading than the Min object used:
  

  ON CHANGE Min GOTO TriggerChanged   ; this trigger can be replaced e.g. by a custom evaluated tag
  
  

• The test of writing (increasing the temperature setpoint for the first "Room Thermostat" / "Radiator Thermostat" devices by 0.1°C and then setting the original temperature) is in the E.Danfoss_TestWrite script.

Literature

• Danfoss Ally
• Danfoss Ally API

Document revisions

• Ver. 1.0 - March 25th, 2024 - Document creation.