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

# Salient

> Connect Salient to KODE OS for camera, video frames data

> Connect Salient to KODE OS for camera, video frames data integration

## Overview

Use this integration to connect Salient to KODE OS. You can discover cameras and devices and use video streaming so live views and frame-oriented video data stay available alongside your building data.

| Property            | Value                |
| ------------------- | -------------------- |
| **System Type**     | Camera, Video Frames |
| **Communication**   | REST                 |
| **Collection**      | Pull                 |
| **Collection Mode** | SNAPSHOT             |

## Supported Capabilities

* Discover Devices & Points
* Video Streaming

## Prerequisites

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

## Discover Devices and Points

After configuring the connector, click **Discover** on the connector detail page. KODE OS will query the Salient 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 Salient, KODE OS maps them to the following device types and data points:

### Camera

Canonical Type: `camera`

| # | Point   | Description                    | Unit | Writable | Ontology Field | Collection |
| - | ------- | ------------------------------ | ---- | -------- | -------------- | ---------- |
| 1 | `state` | Current camera operating state | --   | No       | `run_status`   | Polling    |

## What Data You Get

### Point History

Time-series readings including state, collected at regular intervals from connected devices

### Event Logs

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

KODE OS maps Salient data to these standard fields:

| KODE Field       | Source Field           | Notes                |
| ---------------- | ---------------------- | -------------------- |
| **category**     | `EventCategory.CAMERA` | --                   |
| **id**           | `UUID.randomUUID(`     | --                   |
| **name**         | `eventTypeName`        | --                   |
| **description**  | `description`          | --                   |
| **deviceId**     | `camera`               | --                   |
| **createdAt**    | `time`                 | --                   |
| **customFields** | `(custom fields)`      | custom fields object |

### Polling Schedule

* **Point History** -- Default polling: 1 minutes (min: 1 minutes, max: 1 hours)
* **EventLog** -- Default polling: 15 minutes (min: 15 minutes, 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:

* Integrate video surveillance feeds into the building operations dashboard
* Correlate camera events with access control and alarm data for incident review
* Monitor high-traffic areas and verify occupancy data against video feeds

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

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