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

# Freespace Utilization (V2)

> Connect Freespace Utilization (V2) to KODE OS for occupancy data

> Connect Freespace Utilization (V2) to KODE OS for occupancy data integration

## Overview

Use this integration to connect the Freespace Utilization API (V2) to KODE OS. You can discover spaces and counters, then ingest historical occupancy and people-count trends for portfolio-wide utilization analytics.

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

## Supported Capabilities

* Discover Devices & Points
* Collect Sensor Data

## Prerequisites

* An active account with Freespace Utilization (V2) and access to their API or developer portal
* Username and password credentials for the Freespace Utilization (V2) 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 **Freespace Utilization (V2)**
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        |
| **External URL** | Yes      | text     | An additional external URL for the integration           |
| **Username**     | Yes      | password | 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 Freespace Utilization (V2) 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 Freespace Utilization (V2), KODE OS maps them to the following device types and data points:

### Occupancy Sensor

Canonical Type: `default`

| # | Point             | Description                                     | Unit | Writable | Collection |
| - | ----------------- | ----------------------------------------------- | ---- | -------- | ---------- |
| 1 | `spaceCount`      | Cumulative count of events                      | --   | No       | Polling    |
| 2 | `maxOccupied`     | Peak number of occupied spaces                  | --   | No       | Polling    |
| 3 | `averageOccupied` | Average number of occupied spaces               | --   | No       | Polling    |
| 4 | `minFree`         | Minimum number of free spaces during the period | --   | No       | Polling    |
| 5 | `unused`          | Number of spaces that went unused               | --   | No       | Polling    |
| 6 | `utilisation`     | Space utilization rate (%)                      | %    | No       | Polling    |
| 7 | `efficiency`      | Space usage efficiency (%)                      | %    | No       | Polling    |
| 8 | `averageLoad`     | Average load/occupancy level                    | --   | No       | Polling    |
| 9 | `maxLoad`         | Maximum load/occupancy level                    | --   | No       | Polling    |

## What Data You Get

### Point History

Time-series readings including spaceCount, maxOccupied, averageOccupied, minFree, unused, utilisation, efficiency, averageLoad, and 1 more, collected at regular intervals from connected devices

### Polling Schedule

* **Point History** -- Default polling: 30 minutes (min: 30 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. Verify the username and password are correct and the account has not been locked in the Freespace Utilization (V2) system.
  </Accordion>

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