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

# Fyma

> Connect Fyma to KODE OS for occupancy data

> Connect Fyma to KODE OS for occupancy data integration

## Overview

Use this integration to connect Fyma camera-based analytics to KODE OS. You can discover vision-derived entities from your existing cameras, then pull snapshot occupancy, movement, and related utilization signals without deploying separate people-counting hardware.

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

## Supported Capabilities

* Discover Devices & Points
* Collect Sensor Data

## Prerequisites

* An active account with Fyma and access to their API or developer portal
* OAuth client credentials (Client ID and Client Secret) from the Fyma developer portal
* KODE OS environment with access to Data Sources

## Generate API Credentials

1. Log in to the Fyma developer portal or admin console
2. Navigate to the API or developer settings section
3. Create a new API application or client
4. Note the **Client ID** and **Client Secret** -- you will need these when configuring the connector in KODE OS
5. Note the **Auth URL** for OAuth token exchange

## Configure Connector in KODE OS

1. Navigate to **Data Sources** in your building
2. Click **API Catalog** and search for **Fyma**
3. Click **+ Add Datasource**
4. Fill in the fields below and complete the three-page setup flow

| Field             | Required | Type     | Description                                                |
| ----------------- | -------- | -------- | ---------------------------------------------------------- |
| **Version**       | Yes      | dropdown | The API or firmware version to use                         |
| **URL**           | Yes      | text     | The base URL or IP address of the external system          |
| **Auth URL**      | Yes      | text     | The OAuth authorization URL for token exchange             |
| **Location IDs**  | Yes      | text     | Comma-separated list of location identifiers to monitor    |
| **Client ID**     | Yes      | password | The OAuth client ID from the vendor's developer portal     |
| **Client Secret** | Yes      | password | The OAuth client secret from the vendor's developer portal |

## Discover Devices and Points

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

### Presence / Occupancy Sensor

Canonical Type: `presenceDetection`

| # | Point       | Description                                      | Unit    | Writable | Ontology Field               | Collection |
| - | ----------- | ------------------------------------------------ | ------- | -------- | ---------------------------- | ---------- |
| 1 | `occupancy` | Number of people currently detected in the space | count   | No       | `occupancy_count`            | Polling    |
| 2 | `Zone`      | Accumulated time in current occupancy state      | seconds | No       | `occupancy_time_accumulator` | Polling    |

### Traffic Counter

Canonical Type: `trafficCounter`

| # | Point  | Description                        | Unit  | Writable | Collection |
| - | ------ | ---------------------------------- | ----- | -------- | ---------- |
| 1 | `Gate` | Cumulative count of gate crossings | count | No       | Polling    |

### Camera

Canonical Type: `camera`

| # | Point        | Description                                                    | Unit | Writable | Ontology Field | Collection |
| - | ------------ | -------------------------------------------------------------- | ---- | -------- | -------------- | ---------- |
| 1 | `is Enabled` | **True** -- device is running / **False** -- device is stopped | --   | No       | `run_status`   | Polling    |

## What Data You Get

### Point History

Time-series readings including occupancy, Zone, Gate, is Enabled, collected at regular intervals from connected devices

### Polling Schedule

* **Point History** -- Default polling: 1 minutes (min: 1 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 Client ID and Client Secret match the values from the Fyma developer portal.
  </Accordion>

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