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

# Enlighted People Counting

> Connect Enlighted People Counting to KODE OS for occupancy data

> Connect Enlighted People Counting to KODE OS for occupancy data integration

## Overview

Use this integration to connect Enlighted people counting to KODE OS. You can discover entrance and exit counters on the Enlighted network, then pull historical in/out counts and utilization metrics for floors, rooms, and shared spaces.

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

## Supported Capabilities

* Discover Devices & Points
* Collect Sensor Data

## Prerequisites

To integrate with the Enlighted API, ensure you have the following details:

* An active account in [https://accessmanager.dsp.enlightedinc.com](https://accessmanager.dsp.enlightedinc.com) with the appropriate access permissions.
* Valid username and password credentials for the Enlighted platform.

## Generate API Credentials

* Log in to [https://accessmanager.dsp.enlightedinc.com](https://accessmanager.dsp.enlightedinc.com) using your username and password, or via Google Single Sign-On (SSO).
* On the Enlighted People Counting dashboard, click the Security tab.
* Under the API Key section, select your preferred expiration period, then click Generate New API Key.
* The API Key will appear below the expiration settings.
* Warning: This is a one-time view only. Be sure to copy the API Key immediately and store it securely. If lost, a new key will need to be generated.
  After completing the steps above, your API Key will be used in the next step.

## Configure Connector in KODE OS

1. Navigate to **Data Sources** in your building
2. Click **API Catalog** and search for **Enlighted People Counting**
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        |
| **API Key**         | Yes      | password | The API key for authenticating with the external system  |
| **API Building ID** | Yes      | text     | 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 Enlighted People Counting 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 Enlighted People Counting, KODE OS maps them to the following device types and data points:

### Traffic Counter

Canonical Type: `trafficCounter`

| #  | Point                 | Description                                         | Unit  | Writable | Ontology Field              | Collection |
| -- | --------------------- | --------------------------------------------------- | ----- | -------- | --------------------------- | ---------- |
| 1  | `new_entries`         | Cumulative count of people entering                 | count | No       | `people_entering_counter`   | Polling    |
| 2  | `new_exits`           | Cumulative count of people exiting                  | count | No       | `people_leaving_counter`    | Polling    |
| 3  | `space_capacity`      | Maximum people capacity threshold                   | count | No       | `threshold_people_capacity` | Polling    |
| 4  | `space_availability`  | Number of currently available spaces                | count | No       | `total_unoccupied_count`    | Polling    |
| 5  | `occupancy_ratio`     | Current occupancy ratio (occupied / capacity)       | --    | No       | --                          | Polling    |
| 6  | `occupancy_ratio_avg` | Average occupancy ratio for the period              | --    | No       | --                          | Polling    |
| 7  | `occupancy_ratio_max` | Maximum occupancy ratio for the period              | --    | No       | --                          | Polling    |
| 8  | `occupancy_ratio_min` | Minimum occupancy ratio for the period              | --    | No       | --                          | Polling    |
| 9  | `people_count`        | Number of people currently detected in the space    | count | No       | `occupancy_count`           | Polling    |
| 10 | `people_count_avg`    | Average number of people detected during the period | count | No       | --                          | Polling    |
| 11 | `people_count_max`    | Maximum number of people detected during the period | count | No       | --                          | Polling    |
| 12 | `people_count_min`    | Number of people currently detected in the space    | count | No       | --                          | Polling    |
| 13 | `reset_point`         | Counter reset reference value                       | count | No       | --                          | Polling    |
| 14 | `total_entries`       | Cumulative count of people entering                 | count | No       | `people_entering_counter`   | Polling    |
| 15 | `total_exits`         | Cumulative count of people exiting                  | count | No       | `people_leaving_counter`    | Polling    |

## What Data You Get

### Point History

Time-series readings including new\_entries, new\_exits, space\_capacity, space\_availability, occupancy\_ratio, occupancy\_ratio\_avg, occupancy\_ratio\_max, occupancy\_ratio\_min, and 7 more, 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:

* Track real-time space utilization rates across floors and zones
* Optimize HVAC and lighting schedules based on actual occupancy patterns
* Generate utilization reports to inform space planning and real estate decisions

## 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. Ensure the API key or token is valid and has not been revoked or expired in the Enlighted People Counting platform.
  </Accordion>

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