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

# Utilivisor

> Connect Utilivisor to KODE OS for meters data

> Connect Utilivisor to KODE OS for meters data integration

## Overview

Use this integration to connect Utilivisor utility metering to KODE OS. You can discover meters, poll sensor and non-sensor values on a schedule, and backfill historical intervals for submetering, recharge, and plant-level monitoring in one place.

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

## Supported Capabilities

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

## Prerequisites

* An active account with Utilivisor and access to their API or developer portal
* Username and password credentials for the Utilivisor 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 **Utilivisor**
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 |

## Discover Devices and Points

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

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

### Tenant Invoices

Tenant utility invoicing data including consumption-based billing

### Polling Schedule

* **Point History** -- Default polling: 1 days (min: 1 days, max: 1 days)
* **TenantInvoice** -- Default polling: 1 days (min: 1 days, max: 1 days)

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. Verify the username and password are correct and the account has not been locked in the Utilivisor system.
  </Accordion>

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