Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Please also refer to [examples](https://github.com/frequenz-floss/frequenz-clien

```bash
# Choose the version you want to install
VERSION=0.8.0
VERSION=0.9.0
pip install frequenz-client-reporting==$VERSION
```

Expand Down Expand Up @@ -92,6 +92,8 @@ data = [
start_dt=datetime.fromisoformat("2024-05-01T00:00:00"),
end_dt=datetime.fromisoformat("2024-05-02T00:00:00"),
resolution=1,
states=False, # Set to True to include state data
bounds=False, # Set to True to include metric bounds data
)
]
```
Expand All @@ -116,6 +118,8 @@ reporting-cli \
--metrics AC_ACTIVE_POWER AC_REACTIVE_POWER \
--start 2024-05-01T00:00:00 \
--end 2024-05-02T00:00:00 \
--format csv
--format csv \
--states \
--bounds
```
In addition to the default CSV format the data can be output as individual samples or in `dict` format.
10 changes: 0 additions & 10 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,9 @@

## Upgrading

* Update and fix readme to make use of newest release version 0.8.0
* Updates the base client to version 0.6.

## New Features

* States can now be requested via the client and are provided through the flat iterator.
They can be identified via their category `state`, `warning` and `error`, respectively.
Each individual state is provided as its own sample.
* Bounds can now be requested via the client and are provided through the flat iterator.
They can be identified via their category `metric_bound[i]_{upper,lower}`.
Each individual bound is provided as its own sample.

* Support for states and bound is also added to the CLI tool via the `--states` and `--bounds` flag, respectively.

## Bug Fixes

Expand Down
Loading