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

# Tridium Niagara

> Connect Tridium Niagara to KODE OS for controller data

> Connect Tridium Niagara to KODE OS for controller data integration

## Overview

Use this integration to connect your Tridium Niagara building automation system to KODE OS. You can discover BAS devices and points, collect sensor data with delta collection, manage schedules, and run supported actions from a centralized platform.

| Property            | Value      |
| ------------------- | ---------- |
| **System Type**     | Controller |
| **Communication**   | REST       |
| **Collection**      | Pull       |
| **Collection Mode** | DELTA      |
| **Schedules**       | Supported  |
| **Actions**         | Supported  |

## Supported Capabilities

* Discover Devices & Points
* Collect Sensor Data
* Collect Non-Sensor Data
* Discover Schedules
* Create Schedules
* Update Schedules
* Delete Schedules

## Prerequisites

* An active account with Tridium Niagara and access to their API or developer portal
* Username and password credentials for the Tridium Niagara system
* KODE OS environment with access to Data Sources

### Vendor Onboarding References

Use these official vendor resources to verify API access, credentials, and permission prerequisites:

* [Tridium developer program](https://www.tridium.com/us/en/purchase/developer-program)
* [Tridium documents library](https://www.tridium.com/content/tridium/language-masters/en/services-support/library.html)

## Configure Connector in KODE OS

1. Navigate to **Data Sources** in your building
2. Click **API Catalog** and search for **Tridium Niagara**
3. Click **+ Add Datasource**
4. Fill in the fields below and complete the three-page setup flow

| Field                                              | Required    | Type     | Description                                                                                         |
| -------------------------------------------------- | ----------- | -------- | --------------------------------------------------------------------------------------------------- |
| **Auth Type**                                      | Yes         | dropdown | The authentication method to use                                                                    |
| **Username**                                       | Yes         | text     | The username for authenticating with the external system                                            |
| **Password**                                       | Yes         | password | The password for authenticating with the external system                                            |
| **URL**                                            | Yes         | text     | The base URL or IP address of the external system                                                   |
| **Auth URL**                                       | Conditional | text     | The OAuth authorization URL for token exchange                                                      |
| **Driver Version**                                 | Yes         | dropdown | The driver or API version for communication                                                         |
| **Room**                                           | No          | text     | The specific room this connector is associated with                                                 |
| **Model**                                          | Yes         | dropdown | The hardware or software model of the system. Options: `Vykon`, `Honeywell`, `FX`, `Distech`, `KMC` |
| **Module Version**                                 | No          | text     |                                                                                                     |
| **Niagara Version**                                | No          | text     |                                                                                                     |
| **Module Name**                                    | No          | text     |                                                                                                     |
| **Folder(Leave it blank to discover all devices)** | No          | text     |                                                                                                     |
| **devicesRootSlot**                                | No          | text     |                                                                                                     |
| **Local IP**                                       | No          | password | The local network IP address of the on-site system                                                  |

## Discover Devices and Points

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

### Alarms

Alert and fault notifications including alarm name, priority, status, timestamps, device association, and acknowledgment state

KODE OS maps Tridium Niagara data to these standard fields:

| KODE Field       | Source Field             | Notes       |
| ---------------- | ------------------------ | ----------- |
| **id**           | `id`                     | --          |
| **name**         | `msgText`                | --          |
| **deviceId**     | `sourceSlot`             | --          |
| **priority**     | `Utils.notNullOrDefault` | --          |
| **status**       | `sourceState`            | --          |
| **createdAt**    | `DateUtils.convertToUTC` | transformed |
| **updatedAt**    | `DateUtils.convertToUTC` | transformed |
| **completedAt**  | `normalTime`             | --          |
| **customFields** | `(custom fields)`        | --          |

### Schedule Sync

Schedule state synchronization data between KODE OS and the external system's controller schedules

### Schedule Sync (Partial)

Partial schedule synchronization for incremental schedule updates

### Polling Schedule

* **Point History** -- Default polling: 30 seconds (min: 30 seconds, max: 5 minutes)

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

## Available Actions

### Ack Alarm

**Type:** Write

Acknowledges an alarm in the Tridium Niagara system

| Field        | Type   | Required | Input    | Options / Default |
| ------------ | ------ | -------- | -------- | ----------------- |
| **Alarm ID** | STRING | Yes      | Text Box | --                |
| **User**     | STRING | Yes      | Text Box | --                |

#### Example Request

```json theme={null}
{
  "id": "12345",
  "user": "example-value"
}
```

#### Expected Result

* KODE OS sends the action to the external API using the configured connector credentials
* The external system returns success (typically HTTP 2xx) and processes the requested operation

For more details on how actions work, see the [Actions guide](/products/integrations/capabilities/actions).

## Schedule Management

This integration supports discovering and managing schedules in the Tridium Niagara system. You can discover existing schedules, create new ones, and sync schedule states between KODE OS and the external system.

For more details, see the [Schedules guide](/products/integrations/capabilities/schedules).

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

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