> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kodelabs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Framery

> Connect Framery smart pods and sensor-equipped spaces to KODE OS for occupancy, status, and usage sessions

> Connect Framery smart pods and sensor-equipped spaces to KODE OS

## Overview

Use this integration to monitor Framery pod occupancy and connection status. You can also collect usage sessions with duration, capacity, and people-count details.

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

## Supported capabilities

* Discover devices and points
* Collect current occupancy and connection status
* Collect usage sessions
* Collect up to 12 months of session history

## Prerequisites

* Access to the [Framery developer platform](https://developers.framery.com/)
* A Framery API key
* The Framery workspace ID
* KODE OS access to `Data Sources`

## Configure the connector in KODE OS

1. Open `Data Sources` for your building.
2. Select `API Catalog`, then search for `Framery`.
3. Select `+ Add Datasource`.
4. Complete the connector fields.

| Field            | Required | Type     | Description                                     |
| ---------------- | -------- | -------- | ----------------------------------------------- |
| **Name**         | Yes      | text     | Name that identifies this connection in KODE OS |
| **Area**         | No       | object   | Area associated with the connection             |
| **URL**          | Yes      | text     | Framery API base URL                            |
| **API Key**      | Yes      | password | API key sent with each request                  |
| **Workspace ID** | Yes      | text     | Framery workspace to collect                    |
| **Notes**        | No       | text     | Additional connection details                   |

## Discover devices and points

After you save the connector, select `Discover`. KODE OS retrieves Framery spaces in pages of up to 200 records.

Review the returned spaces and points, then save the records you want in KODE OS.

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

## Devices and points

Each Framery space becomes an occupancy device.

| Point       | Description              | Values                  | Writable | Collection |
| ----------- | ------------------------ | ----------------------- | -------- | ---------- |
| `occupancy` | Current occupancy state  | `occupied`, `available` | No       | Snapshot   |
| `status`    | Current connection state | `online`, `offline`     | No       | Snapshot   |

### Polling schedule

* **Occupancy and status** — Every 30 seconds
* **Usage sessions** — Every 10 minutes

## What data you get

### Usage sessions

| KODE field              | Framery field                  |
| ----------------------- | ------------------------------ |
| `location`              | `buildingName` and `floorName` |
| `createdAt`             | `start`                        |
| `updatedAt`             | `end`                          |
| `deviceId`              | `spaceId`                      |
| `deviceName`            | `spaceName`                    |
| `duration`              | `durationSeconds`              |
| `space_capacity`        | `spaceCapacity`                |
| `people_count_median`   | `peopleCountMedian`            |
| `people_count_accuracy` | `peopleCountAccuracy`          |

KODE OS runs a daily sync for the previous 24 hours to capture sessions that were still open during normal collection.

### Historical collection

You can collect up to 12 months of previous session data. Each historical task covers up to 30 days.

## Use cases

Once connected, you can:

* Monitor pod availability and connection health
* Analyze usage duration and people counts
* Compare utilization across pods, floors, and buildings

## Troubleshooting

<AccordionGroup>
  <Accordion title="Authentication or connection error">
    Verify the API URL, API key, and workspace ID. Confirm the credentials pass Framery's authenticated health check.
  </Accordion>

  <Accordion title="Discovery stops before all spaces load">
    Review the connector logs for pagination errors. Framery returns a maximum of 200 spaces per page.
  </Accordion>

  <Accordion title="Recent sessions are missing an end time">
    A session may remain open while the space is occupied. The daily sync reviews the previous 24 hours and captures completed session details.
  </Accordion>
</AccordionGroup>