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

# Sapient

> Connect Sapient to KODE OS for meters, lighting data

> Connect Sapient to KODE OS for meters, lighting data integration

## Overview

Use this integration to connect Sapient to KODE OS. You can discover meters and lighting-related assets, collect electricity usage on a schedule, and ingest non-sensor records so efficiency and performance data sits beside the rest of your building telemetry.

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

## Supported Capabilities

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

## Prerequisites

* An active account with Sapient and access to their API or developer portal
* Username and password credentials for the Sapient 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 **Sapient**
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        |
| **Email**           | Yes      | text     | The email address associated with the vendor account     |
| **Password**        | Yes      | password | The password for authenticating with the external system |
| **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 Sapient 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 Sapient, KODE OS maps them to the following device types and data points:

### Electric Meter

Canonical Type: `electricMeter`

| # | Point    | Description                         | Unit            | Writable | Ontology Field                             | Collection |
| - | -------- | ----------------------------------- | --------------- | -------- | ------------------------------------------ | ---------- |
| 1 | `energy` | Cumulative energy consumption (kWh) | kilowattPerHour | No       | `differential_electric_energy_accumulator` | Polling    |
| 2 | `power`  | Current power reading (W)           | watts           | No       | `average_power_sensor`                     | Polling    |

## What Data You Get

### Point History

Time-series readings including energy, power, 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
* Monitor lighting system status, energy usage, and occupancy-driven behavior

## 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 Sapient system.
  </Accordion>

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