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

# Vecos

> Connect Vecos to KODE OS for smart locker data

> Connect Vecos to KODE OS for smart locker data integration

## Overview

Use this integration to connect Vecos smart locker systems to KODE OS. You discover lockers and collect availability, access, and operational status over REST.

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

## Supported Capabilities

* Discover Devices & Points
* Collect Sensor Data

## Prerequisites

* An active account with Vecos and access to their API or developer portal
* API key or token from the Vecos platform
* KODE OS environment with access to Data Sources

## Generate API Credentials

1. Log in to the Vecos platform or admin console
2. Navigate to the API settings, developer section, or account settings
3. Generate a new API key or token
4. Copy the key and store it securely -- you will need it when configuring the connector in KODE OS

## Configure Connector in KODE OS

1. Navigate to **Data Sources** in your building
2. Click **API Catalog** and search for **Vecos**
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        |
| **Auth URL** | Yes      | text     | The OAuth authorization URL for token exchange           |
| **Username** | Yes      | text     | The username for authenticating with the external system |
| **Password** | Yes      | password | The password for authenticating with the external system |
| **API Key**  | Yes      | password | The API key for authenticating with the external system  |
| **User Key** | Yes      | password | The user-specific key from the vendor platform           |

## Discover Devices and Points

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

### smartLocker

Canonical Type: `smartLocker`

| # | Point             | Description                  | Unit | Writable | Collection |
| - | ----------------- | ---------------------------- | ---- | -------- | ---------- |
| 1 | `nrOfAllocations` | Number of locker allocations | --   | No       | Polling    |

## What Data You Get

### Point History

Time-series readings including nrOfAllocations, 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 locker availability and assignment status across facilities
* Track parcel delivery and pickup events for tenant services

## 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 Vecos platform.
  </Accordion>

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