# CoffeeCloud

## Configure App

<div data-full-width="false"><figure><img src="https://3489494878-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9GvUpaatBiReR43XFSMg%2Fuploads%2F1YJa3SkpZiKXxOVpNA7o%2FDocs%20-%20CoffeeCloud%20aktivieren.png?alt=media&#x26;token=45ec615f-3574-43a0-bd78-22cb868b2af4" alt=""><figcaption></figcaption></figure></div>

1. Click on **Settings \[A]**
2. Click on **Apps \[B]**
3. Navigate to the **CoffeeCloud App \[C]**
4. Click on **\[D]** ▷ The app frontend opens
5. Paste the .json template below into the **Request \[E]** window
6. ▷ Fill the .json template with correct data
7. Under **Endpoint \[F]**, select the */configs* option ▷ The *Method* option appears
8. Under **Method \[G]**, select the *POST* option
9. Click on **Send \[H]**

Under ↗ Assets, assets are created for all devices that are present in your CoffeeCloud account.

{% hint style="warning" %}
All machines within a group are displayed. However, subgroups are not considered.

If you have placed coffee machines in subgroups in your CoffeeCloud account, this structure is NOT adopted in BuildingPro Suites. The machines themselves will, however, appear in BuildingPro Suites.
{% endhint %}

### .json Template

```json
{
    "id": 1,
    "username": "Geben Sie hier Ihren Benutzernamen ein",
    "password": "Gegeb Sie hier Ihr Passwort ein",
    "apiKey": "Geben Sie hier Ihren API Key ein",
    "url": "https://coffeecloud.scanomat.com",
    "enable": true,
    "refreshInterval": 113600,
    "requestTimeout": 120,
    "active" false,
    "tenantIDs": [
        "10"
    ]
}
```

### Generate API Key

<div data-full-width="false"><figure><img src="https://3489494878-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9GvUpaatBiReR43XFSMg%2Fuploads%2F3hB4fPTXGKEyveuTQ7Yz%2FCoffeeCloud%20API%20generieren.png?alt=media&#x26;token=9bf0ebd4-e972-48ed-a8dc-6afdbc40ca16" alt=""><figcaption></figcaption></figure></div>

To generate the API key, log in to your CoffeeCloud account with your data. The API key can be generated under "Settings."

## Generated Asset Types

3 asset types are created:

1. CoffeeCloud
2. CoffeeCloud group
3. CoffeeCloud coffee machine

### CoffeeCloud

A root directory for coffee machines

### CoffeeCloud group

A group for coffee machines.

### CoffeeCloud coffee machine

An asset type for a single coffee machine, including various attributes.

## CoffeeCloud Dashboard

The CoffeeCloud App comes with a ↗ Dashboard Template.

### Description

<div data-full-width="false"><figure><img src="https://3489494878-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F9GvUpaatBiReR43XFSMg%2Fuploads%2Fq3J2G2GCaOTKZsaDjKyc%2FCoffeeCLoud%20Dashboard.png?alt=media&#x26;token=f76935c7-2fd4-408a-b25b-69e39e3018da" alt=""><figcaption></figcaption></figure></div>

The CoffeeCloud Dashboard shows a list of connected CoffeeCloud coffee machines and associated status messages.

### Activate Dashboard Template

See ↗ here

## Known Limitations

### Maximum Update Interval

The API is limited to about 20 to 30 requests per hour. If more requests are made in a period, no data may be sent.

We recommend performing about 1 request per hour.

### Only the Root Folder is Considered

If you have placed coffee machines in subfolders in your CoffeeCloud account, these subfolders are NOT adopted in BuildingPro Suites!

However, the machines themselves will appear in BuildingPro Suites.

You can [↗ manually place the machines](https://docs.buildings.ability.abb/collection/mandatory-base/assets/structuring-assets) in folders, if desired.