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

# SHM Aphex Meter Online

> Connect SHM Aphex Meter Online to KODE OS for meters data

> Connect SHM Aphex Meter Online to KODE OS for meters data integration

## Overview

Use this integration to connect SHM Aphex Meter Online to KODE OS. You can complete file-assisted discovery, register the meters you need, and pull historical point data on the connector’s polling schedule for ongoing metering visibility.

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

## Supported Capabilities

* Discover Devices & Points
* Collect Sensor Data
* File Validation

## Prerequisites

* An active account with SHM Aphex Meter Online and access to their API or developer portal
* Username and password credentials for the SHM Aphex Meter Online 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 **SHM Aphex Meter Online**
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                         |
| **Username** | Yes      | text     | The username for authenticating with the external system                  |
| **Password** | Yes      | password | The password for authenticating with the external system                  |
| **File**     | Yes      | file     | An upload file used during discovery (e.g., device whitelist spreadsheet) |

## Discover Devices and Points

After configuring the connector, click **Discover** on the connector detail page. KODE OS will query the SHM Aphex Meter Online 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).

## What Data You Get

### Point History

Time-series sensor readings such as temperature, humidity, CO2, occupancy counts, energy consumption, light levels, and other measurable values from physical sensors

### Polling Schedule

* **Point History** -- Default polling: 1 days (min: 1 days, max: 1 days)

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. Verify the username and password are correct and the account has not been locked in the SHM Aphex Meter Online system.
  </Accordion>

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