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

# OSISoft PI

> Connect OSISoft PI to KODE OS for controller data

> Connect OSISoft PI to KODE OS for controller data integration

## Overview

Use this integration to connect OSIsoft PI (PI System) to KODE OS. You can discover assets and points, collect operational sensor data, and bring PI historical series into KODE OS for validation and analytics.

| Property            | Value      |
| ------------------- | ---------- |
| **System Type**     | Controller |
| **Communication**   | REST       |
| **Collection**      | Pull       |
| **Collection Mode** | SNAPSHOT   |

## Supported Capabilities

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

## Prerequisites

* An active account with OSISoft PI and access to their API or developer portal
* Username and password credentials for the OSISoft PI 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 **OSISoft PI**
3. Click **+ Add Datasource**
4. Fill in the fields below and complete the three-page setup flow

| Field        | Required | Type     | Description                                                               |
| ------------ | -------- | -------- | ------------------------------------------------------------------------- |
| **Room**     | No       | text     | The specific room this connector is associated with                       |
| **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                  |
| **Web IDs**  | Yes      | text     | Comma-separated list of web IDs for PI asset framework elements           |
| **Version**  | No       | dropdown | The API or firmware version to use                                        |
| **File**     | No       | file     | An upload file used during discovery (e.g., device whitelist spreadsheet) |

## Discover Devices and Points

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

### Polling Schedule

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

* 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 OSISoft PI system.
  </Accordion>

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