Frequenz-client-microgrid

Frequenz Microgrid API Client Release Notes

Upgrading

- Now component and microgrid IDs are wrapped in new classes: `ComponentId` and `MicrogridId` respectively.

These classes provide type safety and prevent accidental errors by:

- Making it impossible to mix up microgrid and component IDs (equality comparisons between different ID types always return false).
- Preventing accidental math operations on IDs.
- Providing clear string representations for debugging (MID42, CID42).
- Ensuring proper hash behavior in collections.

To migrate you just need to wrap your `int` IDs with the appropriate class: `0` -> `ComponentId(0)` / `MicrogridId(0)`.


What's Changed
* Clear release notes by shsms in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/117
* Bump nox from 2024.10.9 to 2025.2.9 by dependabot in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/119
* Bump types-protobuf from 5.29.1.20241207 to 5.29.1.20250208 by dependabot in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/120
* Bump the required group across 1 directory with 12 updates by dependabot in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/121
* Add ID wrapper classes by llucax in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/122
* Prepare for release v0.7.0 by llucax in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/123


**Full Changelog**: https://github.com/frequenz-floss/frequenz-client-microgrid-python/compare/v0.6.1...v0.7.0

Frequenz Microgrid API Client Release Notes

Upgrading

- Widen `frequenz-client-base` dependency to allow `v0.9.0`.


What's Changed
* Clear release notes by llucax in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/102
* Bump setuptools-scm[toml] from 7.1.0 to 8.1.0 by dependabot in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/105
* Bump setuptools from 68.1.0 to 75.6.0 by dependabot in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/104
* Bump the required group across 1 directory with 6 updates by dependabot in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/106
* Bump types-markdown from 3.7.0.20240822 to 3.7.0.20241204 by dependabot in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/108
* Bump the required group across 1 directory with 7 updates by dependabot in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/109
* Bump black from 24.10.0 to 25.1.0 by dependabot in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/111
* Bump the required group across 1 directory with 7 updates by dependabot in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/114
* Revert "Enable autorefs plugin option to resolve closest references" by llucax in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/115
* Bump isort from 5.13.2 to 6.0.0 by dependabot in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/112
* Widen `frequenz-client-base` dependency to allow `v0.9.0` by shsms in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/116


**Full Changelog**: https://github.com/frequenz-floss/frequenz-client-microgrid-python/compare/v0.6.0...v0.6.1

Frequenz Microgrid API Client Release Notes

Upgrading

- `ApiClient`:

* The class was renamed to `MicrogridApiClient`.
* The `api` attribute was renamed to `stub`.
* The constructor parameter `channel_options` was renamed to `channels_defaults` to match the name used in `BaseApiClient`.
* The constructor now accepts a `connect` parameter, which is `True` by default. If set to `False`, the client will not connect to the server upon instantiation. You can connect later by calling the `connect()` method.

* The `frequenz-client-base` dependency was bumped to v0.8.0.

New Features

- The client now inherits from `frequenz.client.base.BaseApiClient`, so it provides a few new features, like `disconnect()`ing or using it as a context manager. Please refer to the [`BaseApiClient` documentation](https://frequenz-floss.github.io/frequenz-client-base-python/latest/reference/frequenz/client/base/client/#frequenz.client.base.client.BaseApiClient) for more information on these features.
- The client now supports setting reactive power for components through the new `set_reactive_power` method.


What's Changed
* Clear release notes by llucax in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/87
* Inherit from `BaseApiClient` by llucax in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/88
* Use `call_stub_method()` to call stub methods by llucax in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/89
* Remove duplicated `show_symbol_type_toc` key in `mkdocs.yml` by llucax in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/90
* Bump mkdocstrings dependencies by llucax in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/91
* Bump the required group with 5 updates by dependabot in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/92
* Bump the required group with 7 updates by dependabot in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/95
* Bump types-protobuf from 4.21.0.7 to 5.28.3.20241030 by dependabot in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/97
* Add the `set_reactive_power` method by shsms in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/99
* Update the `client-base` dependency to v0.8.0 by llucax in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/100
* Prepare for the v0.6.0 release by llucax in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/101


**Full Changelog**: https://github.com/frequenz-floss/frequenz-client-microgrid-python/compare/v0.5.1...v0.6.0

Frequenz Microgrid API Client Release Notes

New Features

- The client now supports setting reactive power for components through the new `set_reactive_power` method.


What's Changed
* Add the `set_reactive_power` method by shsms in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/99


**Full Changelog**: https://github.com/frequenz-floss/frequenz-client-microgrid-python/compare/v0.5.1...v0.5.2

Frequenz Microgrid API Client Release Notes

Bug Fixes

- Fix a bug where SSL was enabled by default. It is now disabled by default as in previous versions.


What's Changed
* Clear release notes by llucax in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/83
* Disable SSL by default by llucax in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/85
* Bump the required group across 1 directory with 4 updates by dependabot in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/86


**Full Changelog**: https://github.com/frequenz-floss/frequenz-client-microgrid-python/compare/v0.5.0...v0.5.1

Frequenz Microgrid API Client Release Notes

Upgrading

- This release stops using `betterproto` and `grpclib` as backend for gRPC and goes back to using Google's `grpcio` and `protobuf`.

If your code was using `betterproto` and `grpclib`, it now needs to be ported to use `grpcio` and `protobuf` too. Remember to also remove any `betterproto` and `grpclib` dependencies from your project.

- We are now using base-client v0.6.0.



What's Changed
* Clear release notes by llucax in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/56
* Bump the required group with 14 updates by dependabot in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/57
* Bump docker/build-push-action from 5 to 6 by dependabot in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/58
* Bump brettcannon/check-for-changed-files from 1.2.0 to 1.2.1 by dependabot in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/59
* Configure dependabot to have separate minor updates for in-devel deps by llucax in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/61
* Bump mike from 2.1.1 to 2.1.2 by dependabot in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/65
* Bump pytest from 8.2.1 to 8.2.2 by dependabot in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/67
* Bump pydoclint from 0.4.1 to 0.5.3 by dependabot in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/63
* Fix patterns in dependabot.yml by llucax in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/70
* Bump the required group with 4 updates by dependabot in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/72
* Group GitHub action dependabot updates by llucax in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/71
* Bump the required group across 1 directory with 15 updates by dependabot in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/78
* Drop `betterproto`/`grpclib` (and upgrade `client-base`) by llucax in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/80
* Disable` pylint`s `no-name-in-module` check by llucax in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/81
* Prepare readme for release by Marenz in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/82

New Contributors
* Marenz made their first contribution in https://github.com/frequenz-floss/frequenz-client-microgrid-python/pull/82

**Full Changelog**: https://github.com/frequenz-floss/frequenz-client-microgrid-python/compare/v0.4.0...v0.5.0