Skip to main content

Frequenz gRPC API for monitoring and control of microgrids

Project description

Frequenz Microgrid API

Build Status PyPI Package Docs

Introduction

The Frequenz Microgrid API is an service for operating and monitoring electrical components and sensors within a microgrid. It offers various functionalities related to microgrid management, including metadata retrieval, component listing, setting power levels, and controlling the state of components. The API is structured around the concept of a microgrid, which is a localized energy system composed of various interconnected components and auxiliary sensors. Microgrids are typically connected to the main grid, but can also operate independently, in which case they are referred to as islanded microgrids.

The API supports different categories of electrical components and sensors. The list of supported electrical component categories cam be found here. The list of supported sensor categories cam be found here. Note that each of these categories could have their own types, e.g., inverters could belong to the type "battery" or "PV". This information is stored in the metadata of each component and sensor, and is exposed by the API.

The API streams data from the microgrid in real-time, allowing users to retrieve the status and performance of components and sensors. It also allows users to control the microgrid by setting power levels and controlling the state of components.

Objective

The objective of this API is to provide a standardized interface for monitoring and controlling components and sensors within a microgrid. The API is designed to be vendor-agnostic, allowing users to interact with components from various vendors using the same API.

Key Features

  • Metadata Retrieval: The API allows users to retrieve metadata about the microgrid, providing information about the microgrid's unique identifier (ID) and geographical coordinates.

  • Component Listing: Users can list components in the microgrid, optionally filtered by component IDs and categories.

  • Component Graphs: The API provides a way to list electrical connections between components. Connections are represented as pairs of component IDs that are directly connected. The connections can be visualized as a directed graph, where the nodes are components, the edges are connections between components, and the edge direction represents the direction of power flow in Passive Sign Convention.

  • Power Level Control: Users can set the active and reactive power levels of components that support it.

  • Component State Control: For components that support it, the API supports starting, stopping, and transitioning components between these and the standby states.

  • Bounds Management: Users can set exclusion and inclusion bounds for specific metrics of a component. These bounds define the acceptable and unacceptable ranges of metric values. E.g., one could set the inclusion bounds for a battery's DC power to be between -100kW and 100 kW, and the exclusion bounds to be between -50kW and 50kW. This would allow the battery to operate between -100kW and 100kW, but would prevent it from operating between -50kW and 50kW.

Example Use Cases:

This API is designed for use in microgrid management and control systems. It can be applied in various scenarios, including:

  • Microgrid Monitoring: Monitoring the status and performance of components in a microgrid, allowing operators to ensure efficient energy distribution.

  • Optimizing Energy Storage: Managing the charge and discharge power of storage systems and generators, e.g., batteries, CHPs, etc., to optimize energy storage and consumption within the microgrid.

  • Flexibility Management: Managing the flexibility of components in the microgrid, e.g., by controlling the state and power draw of electrical components, to ensure that the microgrid can respond to changes in energy demand.

  • Performance Enhancements: Setting exclusion bounds for metrics to enhance system performance and prevent extreme values in battery SoCs or power output.

Target Audience:

This API is designed for application developers in the energy sector who focus on the tasks of optimizing microgrid electricity flows. Its design aims to be as developer-friendly as possible, requiring no prior knowledge of any specific hardware implementation.

Contributing

If you want to know how to build this project and contribute to it, please check out the Contributing Guide.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

frequenz-api-microgrid-0.17.2.tar.gz (101.8 kB view details)

Uploaded Source

Built Distribution

frequenz_api_microgrid-0.17.2-py3-none-any.whl (22.7 kB view details)

Uploaded Python 3

File details

Details for the file frequenz-api-microgrid-0.17.2.tar.gz.

File metadata

  • Download URL: frequenz-api-microgrid-0.17.2.tar.gz
  • Upload date:
  • Size: 101.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for frequenz-api-microgrid-0.17.2.tar.gz
Algorithm Hash digest
SHA256 570f5cf63d6b44b7545a9b20f51367bb55b9d964431da31ec6391f3061d611d0
MD5 a5ca290dbbcaf5881d957a5bc3b3c47f
BLAKE2b-256 e31f6365ef342ac1e261b52255ad913f7c16a0339e0c2e9bebcb178068db7b07

See more details on using hashes here.

Provenance

The following attestation bundles were made for frequenz-api-microgrid-0.17.2.tar.gz:

Publisher: ci.yaml on frequenz-floss/frequenz-api-microgrid

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file frequenz_api_microgrid-0.17.2-py3-none-any.whl.

File metadata

File hashes

Hashes for frequenz_api_microgrid-0.17.2-py3-none-any.whl
Algorithm Hash digest
SHA256 474d8634dffee1d3fd44c729b0c5d610e64a85189ffa2327c8c0c80dd3c27402
MD5 848bc8df1f153e9735949062b26b639c
BLAKE2b-256 3199d7cf9837bc8785d4ef2f6c80f618672f40576efc97c0b735063f56cca373

See more details on using hashes here.

Provenance

The following attestation bundles were made for frequenz_api_microgrid-0.17.2-py3-none-any.whl:

Publisher: ci.yaml on frequenz-floss/frequenz-api-microgrid

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page