> ## Documentation Index
> Fetch the complete documentation index at: https://documentation.kodelabs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Desigo CC

> Connect Desigo CC to KODE OS for controller data

> Connect Desigo CC to KODE OS for controller data integration

## Overview

Use this integration to connect Siemens Desigo CC to KODE OS. You can discover devices and points, collect fire and building data with hybrid pull-and-push delivery, and run supported actions from KODE OS when your deployment allows.

| Property            | Value                |
| ------------------- | -------------------- |
| **System Type**     | Controller           |
| **Communication**   | REST                 |
| **Collection**      | Hybrid (Pull + Push) |
| **Collection Mode** | SNAPSHOT             |
| **Actions**         | Supported            |

## Supported Capabilities

* Discover Devices & Points
* Collect Sensor Data
* Collect Non-Sensor Data

## Prerequisites

* An active account with Desigo CC and access to their API or developer portal
* Username and password credentials for the Desigo CC system
* KODE OS environment with access to Data Sources

## Configure Connector in KODE OS

1. Navigate to **Data Sources** in your building
2. Click **API Catalog** and search for **Desigo CC**
3. Click **+ Add Datasource**
4. Fill in the fields below and complete the three-page setup flow

| Field               | Required    | Type     | Description                                              |
| ------------------- | ----------- | -------- | -------------------------------------------------------- |
| **URL**             | Yes         | text     | The base URL or IP address of the external system        |
| **Username**        | Yes         | text     | The username for authenticating with the external system |
| **Password**        | Yes         | password | The password for authenticating with the external system |
| **API Building ID** | Yes         | password | The building or source identifier in the external system |
| **Client Version**  | Yes         | dropdown | The version of the vendor's API client                   |
| **Auth Type**       | Yes         | dropdown | The authentication method to use                         |
| **Type IDs**        | Conditional | text     |                                                          |
| **Discipline IDs**  | Conditional | text     |                                                          |
| **External URL**    | No          | text     | An additional external URL for the integration           |
| **Local IP**        | No          | password | The local network IP address of the on-site system       |

## Discover Devices and Points

After configuring the connector, click **Discover** on the connector detail page. KODE OS will query the Desigo CC system and return a list of available devices and their data points.

Review the discovered items and select the devices you want to register in KODE OS.

For more details on the discovery process, see the [Discovery guide](/products/integrations/capabilities/discovery).

## Devices and Points

When you discover devices from Desigo CC, KODE OS maps them to the following device types and data points:

### Controller

Canonical Type: `default`

| # | Point   | Description                                                                                                    | Unit | Writable | Ontology Field | Collection |
| - | ------- | -------------------------------------------------------------------------------------------------------------- | ---- | -------- | -------------- | ---------- |
| 1 | `Quiet` | **Quiet** -- no alarm condition / **Fault** -- system fault detected / **Active** -- alarm is currently active | --   | No       | `fire_alarm`   | Polling    |

## What Data You Get

### Point History

Time-series readings including Quiet, collected at regular intervals from connected devices

### BMS Events

Desigo building management system events including controller alerts and system notifications

### Polling Schedule

* **Point History** -- Default polling: 3 minutes (min: 3 minutes, max: 1 hours)
* **DesigoEvents** -- Default polling: 30 minutes (min: 30 minutes, max: 1 hours)

For more details on collection modes, see the [Data Collection guide](/products/integrations/capabilities/data-collection).

## Available Actions

This integration supports actions that allow you to send commands to the Desigo CC system. Available actions are displayed on the device or entity detail page in KODE OS.

#### Example Request

```json theme={null}
{
  "action": "ActionName",
  "target": "entity-or-device-id",
  "parameters": {}
}
```

#### Expected Result

* KODE OS sends the action to the external API using the configured connector credentials
* The external system returns success (typically HTTP 2xx) and processes the requested operation

For more details on how actions work, see the [Actions guide](/products/integrations/capabilities/actions).

## Use Cases

Once connected, this integration enables you to:

* Monitor real-time HVAC, lighting, and building automation data from a single dashboard
* Set up automated alerts when equipment deviates from normal operating parameters
* Track energy consumption and optimize building performance with historical trend data

## Troubleshooting

<AccordionGroup>
  <Accordion title="Authentication or connection error">
    Verify that the credentials are correct and have not expired. Check that the URL is reachable from the KODE OS environment. Verify the username and password are correct and the account has not been locked in the Desigo CC system.
  </Accordion>

  <Accordion title="Discovery returns no devices">
    Verify the connector credentials have sufficient permissions in the Desigo CC system to list devices. Run a test connection first to confirm connectivity. Some systems require specific API scopes or roles for device enumeration.
  </Accordion>

  <Accordion title="Data collection stops or gaps appear">
    Check the connector status on the Data Sources page. If the status shows an error, review the error logs on the connector detail page. Common causes include expired credentials, network changes, or rate limiting by the Desigo CC API.
  </Accordion>
</AccordionGroup>