DOCSEARCHbyAlgolia
Submit Docs

Clevergy Documentation

website·Indexed 34 days ago

https://docs.clever.gy

Documentation for the Clevergy platform and Connect API, covering energy contract management, solar inverter integrations (including Enphase, Huawei, and SolarEdge), battery management, and a catalog of microfrontends for energy monitoring and smart device control.

Tokens
26.6K
Snippets
39
Records
206
Agent score
56%

What's inside Clevergy

  1. Overview of Clevergy Integration Options

    Clevergy provides two primary ways to integrate its platform into external applications: the Connect API and Microfrontends. The Connect API is used for managing users, retrieving supply and consumption data, and accessing insights and recommendations. Microfrontends are pre-built HTML, CSS, and JavaScript components that can be embedded directly into a website or application to provide Clevergy functionality.

  2. Overview of Clevergy Inverter Integration Types

    Clevergy supports two primary methods for integrating inverter brands to provide real-time and historical data:

    1. Installer credentials (Portal Setup): Requires API credentials issued by the manufacturer. Once configured by an administrator in the portal, it applies to all installations linked to those credentials.
    2. User credentials (App Setup): End users log in directly with their manufacturer platform account via the app, requiring no prior credential requests.

  3. Overview of the Maintenance Workspace

    The Maintenance workspace is used for operational management of all installations. It is divided into two primary functional areas:

    1. Alerts: A centralized view for reviewing and managing active operational alerts.
    2. Prevention: A performance overview of all installations used to detect underperformance before it becomes a critical issue.

    Note: Feature availability within the Maintenance workspace may vary based on the contracted plan.

  4. Overview of the Clevergy Operations Portal

    The Clevergy Operations Portal (https://portal.clever.gy) serves as the primary interface for managing users, installations, and operational activities. Users can access their profile, role, and company information by clicking their username in the top-right corner of the portal.

  5. Implement the Solar Amortization microfrontend

    The <clevergy-solar-amortization> microfrontend visualizes the financial return on investment for solar installations. It tracks when a system will pay for itself and monitors ongoing savings based on self-consumption and surplus energy exported to the grid.
    <clevergy-solar-amortization></clevergy-solar-amortization>

  6. Retrieve electricity consumption data using Datadis integration

    The Datadis integration allows users to access and monitor electricity consumption data based on the supply points associated with their account. It specifically provides access to energy consumption and historical energy data.

  7. Implement smart device linking with clevergy-integration-smart-devices

    The <clevergy-integration-smart-devices> microfrontend allows end users to link supported smart devices to a home. This enables the monitoring and management of energy usage directly within your website or application.

  8. Implement the Invoice Estimation microfrontend

    The <clevergy-invoice-estimation> microfrontend displays the accumulated cost (in euros) for the current billing period and provides an estimated total for the next electricity bill. This module replaces the deprecated 'Consumption cumulative' module.

    How it calculates costs:

    • Current billing period: Calculates accumulated cost from the end date of the last invoice to the current date (or from the contract start date for new users).
    • Estimated bill amount: For the first 30 days of a billing period, it projects the final bill based on current spending. After 30 days, it displays the actual accumulated cost.

    Requirements for display:

    • Active Electricity Contract: User must have an active supply contract.
    • Configured Contract Prices: Power and consumption prices must be configured. If prices are missing for the period (including dynamic tariffs), the module will show a 'not yet available' message.

  9. Understand Smart Alerts for solar installations

    Smart alerts are rule-based checks executed daily to detect abnormal solar installation behavior that may not trigger a native inverter error. Unlike standard inverter alerts, smart alerts can combine production data, external data sources (such as weather information), and installation context across all inverter brands to automate operational checks for energy retailers.

  10. Implement the Energy Chart microfrontend

    The <clevergy-energy-chart> microfrontend provides interactive visualizations of energy consumption and production. It supports several views including daily, weekly, and monthly patterns, solar production efficiency, and energy community shares. For gas consumption, the chart displays data for the last 14 months based on uploaded invoices.

    Requirements for display:

    • Configured Integration: A connection to data via FTP, Datadis, solar inverter, or the connect API.
    • Available Energy Data: The linked energy source must be returning valid data.

  11. Manage battery systems via Connect API

    The Connect API allows for monitoring and controlling battery systems linked to a supply point.

    Capabilities:

    • Monitoring: Real-time battery power (kW), historical power data, total capacity (kWh), maximum charging/discharging power, and State of Charge (SOC) history.
    • Control: Program scheduled actions for charging or discharging. Actions execute at a specific time and end when the target SOC is reached or a new action begins.

    Constraint: While battery information is available to all users, control actions require the user to have connected their system and granted permission via Huawei OAuth integration.

  12. Use the Maintenance workspace

    The Maintenance workspace is used by operations teams for installation-related operational management. It provides a centralized view to monitor active alerts, review installation-level issues, access technical information, and take operational actions.