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

# Carrot

> Connect Carrot to KODE OS for waste metering data

> Connect Carrot to KODE OS for waste metering data integration

## Overview

Use this integration to connect Carrot waste tracking to KODE OS. You discover assets, collect sensor and operational waste data, and retain historical readings for sustainability reporting.

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

## Supported Capabilities

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

## Prerequisites

* An active account with Carrot and access to their API or developer portal
* OAuth client credentials (Client ID and Client Secret) from the Carrot developer portal
* KODE OS environment with access to Data Sources

## Generate API Credentials

1. Log in to the Carrot developer portal or admin console
2. Navigate to the API or developer settings section
3. Create a new API application or client
4. Note the **Client ID** and **Client Secret** -- you will need these when configuring the connector in KODE OS
5. Note the **Auth URL** for OAuth token exchange

## Configure Connector in KODE OS

1. Navigate to **Data Sources** in your building
2. Click **API Catalog** and search for **Carrot**
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          |
| **Auth URL**        | Yes      | text     | The OAuth authorization URL for token exchange             |
| **Client ID**       | Yes      | text     | The OAuth client ID from the vendor's developer portal     |
| **Client Secret**   | Yes      | password | The OAuth client secret from the vendor's developer portal |
| **API Building ID** | Yes      | text     | The building or source identifier in the external system   |

## Discover Devices and Points

After configuring the connector, click **Discover** on the connector detail page. KODE OS will query the Carrot 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

| Point          | Display Name |
| -------------- | ------------ |
| `status`       | status       |
| `access_point` | access point |

## What Data You Get

### Point History

Time-series sensor readings such as temperature, humidity, CO2, occupancy counts, energy consumption, light levels, and other measurable values from physical sensors

### Event Logs

System and security event records with timestamps, event types, and associated devices

KODE OS maps Carrot data to these standard fields:

| KODE Field       | Source Field           | Notes       |
| ---------------- | ---------------------- | ----------- |
| **id**           | `useEvent.id`          | --          |
| **name**         | `type`                 | --          |
| **status**       | `useEvent.result.code` | --          |
| **location**     | `accessPoint`          | transformed |
| **deviceId**     | `accessPoint.id`       | --          |
| **deviceName**   | `accessPoint.name`     | --          |
| **createdAt**    | `useEvent.createdAt`   | transformed |
| **updatedAt**    | `useEvent.updatedAt`   | transformed |
| **customFields** | `(custom fields)`      | --          |

### Polling Schedule

* **Point History** -- Default polling: 5 minutes (min: 5 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:

* Centralize Carrot data in your building operations dashboard
* Correlate data from this system with other building systems for comprehensive analytics

## 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. Ensure the Client ID and Client Secret match the values from the Carrot developer portal.
  </Accordion>

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