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

# Greenworld Solutions

> Connect Greenworld Solutions to KODE OS for meters data

> Connect Greenworld Solutions to KODE OS for meters data integration

## Overview

Use this integration to connect Greenworld Solutions metering to KODE OS. You can discover meters and points, then pull historical energy measurements on a schedule for monitoring, benchmarking, and optimization workflows.

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

## Supported Capabilities

* Discover Devices & Points
* Collect Sensor Data

## Prerequisites

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

## Generate API Credentials

1. Log in to the Greenworld Solutions 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 **Greenworld Solutions**
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 |
| **Site ID** | Yes      | text     | The site 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 Greenworld Solutions 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 Greenworld Solutions, KODE OS maps them to the following device types and data points:

### Electric Meter

Canonical Type: `electricMeter`

| # | Point     | Description           | Unit | Writable | Collection |
| - | --------- | --------------------- | ---- | -------- | ---------- |
| 1 | `reading` | Current meter reading | --   | No       | Polling    |

## What Data You Get

### Point History

Time-series readings including reading, collected at regular intervals from connected devices

### Polling Schedule

* **Point History** -- Default polling: 1 hours (min: 1 hours, max: 3 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:

* Aggregate utility consumption data (electricity, gas, water, steam) in a unified dashboard
* Detect abnormal consumption patterns and potential waste or leaks
* Generate utility cost reports and benchmark buildings in your portfolio

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

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