Skip to content

Commit

Permalink
Extend documentation of duration (#200)
Browse files Browse the repository at this point in the history
  • Loading branch information
Marenz authored Sep 26, 2024
2 parents ab65375 + bf92a47 commit aaaba54
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 3 deletions.
4 changes: 4 additions & 0 deletions proto/frequenz/api/dispatch/v1/dispatch.proto
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,10 @@ message DispatchData {
google.protobuf.Timestamp start_time = 2;

// Duration in seconds
// The duration of the dispatch in seconds. If the duration is not set, the dispatch
// will be considered to have an infinite duration.
// A duration of 0 seconds is also valid, indicating a dispatch that
// immediately starts and ends, e.g. switching a component on and off.
optional uint32 duration = 3;

// Dispatch microgrid component selector
Expand Down
20 changes: 17 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,13 @@ requires = [
"setuptools == 68.1.0",
"setuptools_scm[toml] == 7.1.0",
"frequenz-repo-config[api] == 0.10.0",
# We need to pin the protobuf, grpcio and grpcio-tools dependencies to make
# sure the code is generated using the minimum supported versions, as older
# versions can't work with code that was generated with newer versions.
# https://protobuf.dev/support/cross-version-runtime-guarantee/#backwards
"protobuf == 5.28.0",
"grpcio-tools == 1.66.1",
"grpcio == 1.66.1",
]
build-backend = "setuptools.build_meta"

Expand All @@ -27,8 +34,15 @@ classifiers = [
requires-python = ">= 3.11, < 4"
dependencies = [
"frequenz-api-common >= 0.5.4, < 0.7",
"googleapis-common-protos >= 1.56.4, < 2",
"grpcio >= 1.54.2, < 2",
"googleapis-common-protos >= 1.65.0, < 2",
# We can't widen beyond the current value unless we bump the minimum
# requirements too because of protobuf cross-version runtime guarantees:
# https://protobuf.dev/support/cross-version-runtime-guarantee/#major
"protobuf >= 5.28.0, < 7", # Do not widen beyond 7!
# We couldn't find any document with a spec about the cross-version runtime
# guarantee for grpcio, so unless we find one in the future, we'll assume
# major version jumps are not compatible
"grpcio >= 1.66.1, < 2", # Do not widen beyond 2!
]
dynamic = ["version"]

Expand All @@ -54,7 +68,7 @@ dev-mkdocs = [
"mkdocs-macros-plugin == 1.0.5",
"mkdocs-material == 9.5.30",
"mkdocstrings[python] == 0.25.2",
"mkdocstrings-python == 1.9.2",
"mkdocstrings-python == 1.10.8",
"frequenz-repo-config[api] == 0.10.0",
]
dev-mypy = [
Expand Down

0 comments on commit aaaba54

Please sign in to comment.