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

# Pharos

> Connect Pharos to KODE OS for lighting data

> Connect Pharos to KODE OS for lighting data integration

## Overview

Use this integration to connect Pharos to KODE OS. You can discover lighting control devices and points, pull snapshot data over REST, and track dynamic and architectural lighting state from Data Sources.

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

## Supported Capabilities

* Discover Devices & Points
* Collect Sensor Data

## Prerequisites

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

## Discover Devices and Points

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

### Lighting Fixture

Canonical Type: `lighting`

| # | Point    | Description                                                                           | Unit | Writable | Ontology Field | Collection |
| - | -------- | ------------------------------------------------------------------------------------- | ---- | -------- | -------------- | ---------- |
| 1 | `Online` | **True** -- device is connected and reporting / **False** -- device is not responding | --   | No       | `run_status`   | Polling    |
| 2 | `none`   | **none** / **running** / **paused** / **holding\_at\_end** / **released**             | --   | Yes      | --             | Polling    |

## What Data You Get

### Point History

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

### Polling Schedule

* **Point History** -- Default polling: 5 minutes (min: 5 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 lighting system status, energy usage, and occupancy-driven behavior
* Coordinate lighting schedules with HVAC and building automation systems
* Track lighting energy consumption and identify optimization opportunities

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

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