v0.2.0

Frequenz Assets API Client Release Notes

Summary

This release adds support for retrieving microgrid electrical component connections through a new client method and CLI command.

Upgrading

• The get_microgrid and list_microgrid_electrical_components methods now expect an argument of type MicrogridId, instead of an int.
• The PvInverter type has been renamed to SolarInverter, to be compatible with the microgrid api client.

New Features

• This exposes the abstract Battery, EvCharger and Inverter types.

Component Connections API

• New ComponentConnection class: Introduced to represent connections between electrical components in a microgrid
• New client method: Added method to retrieve microgrid electrical component connections
• CLI command extension: Added component-connections command to list component connections

Bug Fixes

What's Changed

• feat(assets): Add Support for Electrical Component Connections by @eduardiazf in #50
• Update release notes by @eduardiazf in #54
• Merge tag v0.1.0 into v0.x.x by @llucax in #56
• Improve identifier typing by @shsms in #55

New Contributors

• @shsms made their first contribution in #55

Full Changelog: v0.1.0...v0.2.0

v0.1.0

Frequenz Assets API Client Release Notes

Summary

This release adds support for retrieving microgrid electrical component connections through a new client method and CLI command.

Upgrading

No migration required. This is a backward-compatible feature addition.

New Features

Component Connections API

• New ComponentConnection class: Introduced to represent connections between electrical components in a microgrid
• New client method: Added method to retrieve microgrid electrical component connections
• CLI command extension: Added component-connections command to list component connections

Bug Fixes

What's Changed

• Reset release notes by @cwasicki in #46
• Bump mkdocstrings-python from 1.17.0 to 1.18.2 by @dependabot[bot] in #45
• Bump the minor group across 1 directory with 9 updates by @dependabot[bot] in #47
• fix(deps): Update dependency version for frequenz-api-assets in pyproject.toml by @eduardiazf in #49
• Bump the compatible group with 2 updates by @dependabot[bot] in #39
• Bump actions/labeler from 5.0.0 to 6.0.1 by @dependabot[bot] in #40
• Bump pytest-asyncio from 1.1.0 to 1.2.0 by @dependabot[bot] in #43
• Bump pydoclint from 0.6.10 to 0.7.6 by @dependabot[bot] in #51
• Bump the patch group across 1 directory with 7 updates by @dependabot[bot] in #52

New Contributors

• @cwasicki made their first contribution in #46

Full Changelog: v0.0.1...v0.1.0

v0.0.2

Frequenz Assets API Client Release Notes

Summary

This release updates the frequenz-api-assets dependency to use a version range instead of a specific Git reference, providing more flexibility for dependency updates while maintaining compatibility.

Changes

Dependency Updates

• Updated frequenz-api-assets dependency:
  • Changed from Git reference (@ git+https://github.com/frequenz-floss/[email protected]) to version range (>= 0.1.0, < 0.2.0)
  • Enables automatic updates within the specified version range
  • Maintains backward compatibility while reducing maintenance overhead

Benefits

• Improved dependency management: Version ranges allow for automatic updates within the specified range
• Better compatibility: Ensures compatibility with the project while allowing for patch and minor version updates
• Reduced maintenance overhead: Eliminates the need to manually update Git references for compatible versions

Migration Notes

No migration required. This is a transparent dependency update that maintains full backward compatibility.

Files Changed

• pyproject.toml: Updated the frequenz-api-assets dependency specification

Type of Change

• Dependency update

What's Changed

• Reset release notes by @cwasicki in #46
• Bump mkdocstrings-python from 1.17.0 to 1.18.2 by @dependabot[bot] in #45
• Bump the minor group across 1 directory with 9 updates by @dependabot[bot] in #47
• fix(deps): Update dependency version for frequenz-api-assets in pyproject.toml by @eduardiazf in #49

New Contributors

• @cwasicki made their first contribution in #46

Full Changelog: v0.0.1...v0.0.2

v0.0.1

Frequenz Assets API Client Release Notes

Summary

This release introduces a Assets API client with CLI support for interacting with Frequenz microgrid assets. It provides comprehensive electrical components functionality including batteries, EV chargers, inverters, and grid connection points, with enhanced type safety and error handling.

New Features

• Assets API Client:

  • list_electrical_components() method for retrieving electrical components in a microgrid

• Electrical Components Support: Comprehensive data classes for electrical components

  • ElectricalComponent with category-specific information for batteries, EV chargers, inverters, grid connection points, and power transformers
  • Battery types: Li-ion, Na-ion with proper enum mapping
  • EV charger types: AC, DC, Hybrid charging support
  • Operational lifetime tracking and metric configuration bounds

• Command-Line Interface:

  • assets-cli electrical-components <microgrid-id> command

• Type System: Enhanced data classes with protobuf integration

  • Microgrid, DeliveryArea, Location, and comprehensive electrical component types
  • Proper enum mapping: BatteryType, EvChargerType, InverterType, Metric

Bug Fixes

What's Changed

• Bump docker/build-push-action from 5 to 6 by @dependabot[bot] in #2
• Bump actions/setup-python from 4 to 5 by @dependabot[bot] in #3
• Bump actions/cache from 3 to 4 by @dependabot[bot] in #4
• Bump the required group with 3 updates by @dependabot[bot] in #5
• Bump nox from 2024.10.9 to 2025.2.9 by @dependabot[bot] in #6
• Bump the required group with 10 updates by @dependabot[bot] in #8
• Bump the required group with 11 updates by @dependabot[bot] in #9
• Bump types-markdown from 3.7.0.20241204 to 3.7.0.20250322 by @dependabot[bot] in #10
• Bump setuptools from 75.8.2 to 78.1.0 by @dependabot[bot] in #11
• Update runner to ubuntu-24.04 by @flora-hofmann-frequenz in #16
• Bump setuptools from 78.1.0 to 80.1.0 by @dependabot[bot] in #13
• Bump the required group across 1 directory with 14 updates by @dependabot[bot] in #17
• Bump pytest-asyncio from 0.26.0 to 1.0.0 by @dependabot[bot] in #18
• Implement initial Assets API client with CLI support by @eduardiazf in #21
• Bring project files up to date by @llucax in #22
• Bump pydoclint from 0.6.6 to 0.6.10 by @dependabot[bot] in #32
• Add missing workflow to test PRs by @llucax in #35
• Bump actions/download-artifact from 4 to 5 in the artifacts group by @dependabot[bot] in #29
• Bump the compatible group with 2 updates by @dependabot[bot] in #24
• Move documentation from class to Attributes by @llucax in #37
• Bump types-markdown from 3.8.0.20250415 to 3.8.0.20250809 by @dependabot[bot] in #34
• Bump the minor group with 2 updates by @dependabot[bot] in #27
• Bump actions/checkout from 4 to 5 by @dependabot[bot] in #25
• Bump async-solipsism from 0.7 to 0.8 by @dependabot[bot] in #30
• Bump the patch group with 3 updates by @dependabot[bot] in #26
• Bump pytest-asyncio from 1.0.0 to 1.1.0 by @dependabot[bot] in #33
• Bump the mkdocstrings group with 2 updates by @dependabot[bot] in #28
• Bump setuptools-scm[toml] from 8.3.1 to 9.2.0 by @dependabot[bot] in #36
• feat: ElectricalComponent by @eduardiazf in #38

New Contributors

• @dependabot[bot] made their first contribution in #2
• @flora-hofmann-frequenz made their first contribution in #16
• @eduardiazf made their first contribution in #21
• @llucax made their first contribution in #22

Full Changelog: https://github.com/frequenz-floss/frequenz-client-assets-python/commits/v0.0.1