> ## 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.

# Carma

> Connect Carma to KODE OS for meters data

> Connect Carma to KODE OS for meters data integration

## Overview

Use this integration to connect your Carma submetering account to KODE OS. You can discover water meters and their points, then pull historical readings for consumption, daily use, and registered reads so billing-aligned utility data appears alongside the rest of your portfolio.

| Property            | Value      |
| ------------------- | ---------- |
| **System Type**     | Meters     |
| **Communication**   | REST       |
| **Collection**      | Pull       |
| **Collection Mode** | HISTORICAL |

## Supported Capabilities

* Discover Devices & Points
* Collect Sensor Data
* Collect Historical Data

## Prerequisites

To integrate with the Carma API, ensure you have the following details:

* An active account in [https://carmaplus.ca](https://carmaplus.ca) with the appropriate access permissions.
* Valid username and password credentials for the Atlas platform.
  Password\*
  API Building ID\*
  Generated in Step 2
  Fields marked with an asterisk \* are mandatory for completing the integration.

## Generate API Credentials

* Log in to the [https://carmaplus.ca/app](https://carmaplus.ca/app) using your username and password
* Choose your building
* In the URL, you’ll find the Building ID. For example:
* [https://carmaplus.ca/app/GraphIt/GraphIt2.aspx?buildingID=818](https://carmaplus.ca/app/GraphIt/GraphIt2.aspx?buildingID=818)
* Building ID: 818
  After completing the steps above, your Building ID will be used in the next step.

## Configure Connector in KODE OS

1. Navigate to **Data Sources** in your building
2. Click **API Catalog** and search for **Carma**
3. Click **+ Add Datasource**
4. Complete the three-page setup flow using the credential prerequisites for this integration

<Note>
  Connector field metadata is not exposed in code for this integration. Configure the connector using your standard credentials and endpoint details shown in the prerequisites and vendor onboarding references.
</Note>

## Discover Devices and Points

After configuring the connector, click **Discover** on the connector detail page. KODE OS will query the Carma 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 Carma, KODE OS maps them to the following device types and data points:

### Water Meter

Canonical Type: `waterMeter`

| # | Point                      | Description                                                           | Unit | Writable | Ontology Field      | Collection |
| - | -------------------------- | --------------------------------------------------------------------- | ---- | -------- | ------------------- | ---------- |
| 1 | `Connection Status`        | **True** -- device is connected / **False** -- device is disconnected | --   | No       | `connection_status` | Polling    |
| 2 | `Current Value`            | Current meter reading                                                 | --   | No       | --                  | Polling    |
| 3 | `Calculated Current Value` | Calculated current consumption value                                  | --   | No       | --                  | Polling    |
| 4 | `Registered Reading`       | Registered meter reading                                              | --   | No       | --                  | Polling    |
| 5 | `Daily Consumption`        | Daily water consumption                                               | --   | No       | --                  | Polling    |

## What Data You Get

### Point History

Time-series readings including Connection Status, Current Value, Calculated Current Value, Registered Reading, Daily Consumption, collected at regular intervals from connected devices

### Polling Schedule

* **Point History** -- Default polling: 15 minutes (min: 15 minutes, max: 1 hours)

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

## Use Cases

Once connected, this integration enables you to:

* Aggregate utility consumption data (electricity, gas, water, steam) in a unified dashboard
* Detect abnormal consumption patterns and potential waste or leaks
* Generate utility cost reports and benchmark buildings in your portfolio

## 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. Double-check all credential fields match the values from the Carma platform.
  </Accordion>

  <Accordion title="Discovery returns no devices">
    Verify the connector credentials have sufficient permissions in the Carma 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 Carma API.
  </Accordion>
</AccordionGroup>