Skip to content

request

frequenz.sdk.actor.power_distributing.request ¤

Definition of the user request.

Classes¤

frequenz.sdk.actor.power_distributing.request.Request dataclass ¤

Request to set power to the PowerDistributingActor.

Source code in frequenz/sdk/actor/power_distributing/request.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
@dataclasses.dataclass
class Request:
    """Request to set power to the `PowerDistributingActor`."""

    namespace: str
    """The namespace of the request.

    This will be used to identify the channel for sending the response into, in the
    channel registry.
    """

    power: Power
    """The requested power."""

    batteries: abc.Set[int]
    """The component ids of the batteries to be used for this request."""

    request_timeout: timedelta = timedelta(seconds=5.0)
    """The maximum amount of time to wait for the request to be fulfilled."""

    adjust_power: bool = True
    """Whether to adjust the power to match the bounds.

    If `True`, the power will be adjusted (lowered) to match the bounds, so
    only the reduced power will be set.

    If `False` and the power is outside the batteries' bounds, the request will
    fail and be replied to with an `OutOfBound` result.
    """

    include_broken_batteries: bool = False
    """Whether to use all batteries included in the batteries set regardless the status.

    If set to `True`, the power distribution algorithm will consider all batteries,
    including the broken ones, when distributing power.  In such cases, any remaining
    power after distributing among the available batteries will be distributed equally
    among the unavailable (broken) batteries.  If all batteries in the set are
    unavailable, the power will be equally distributed among all the unavailable
    batteries in the request.

    If set to `False`, the power distribution will only take into account the available
    batteries, excluding any broken ones.
    """
Attributes¤
adjust_power: bool = True class-attribute instance-attribute ¤

Whether to adjust the power to match the bounds.

If True, the power will be adjusted (lowered) to match the bounds, so only the reduced power will be set.

If False and the power is outside the batteries' bounds, the request will fail and be replied to with an OutOfBound result.

batteries: abc.Set[int] instance-attribute ¤

The component ids of the batteries to be used for this request.

include_broken_batteries: bool = False class-attribute instance-attribute ¤

Whether to use all batteries included in the batteries set regardless the status.

If set to True, the power distribution algorithm will consider all batteries, including the broken ones, when distributing power. In such cases, any remaining power after distributing among the available batteries will be distributed equally among the unavailable (broken) batteries. If all batteries in the set are unavailable, the power will be equally distributed among all the unavailable batteries in the request.

If set to False, the power distribution will only take into account the available batteries, excluding any broken ones.

namespace: str instance-attribute ¤

The namespace of the request.

This will be used to identify the channel for sending the response into, in the channel registry.

power: Power instance-attribute ¤

The requested power.

request_timeout: timedelta = timedelta(seconds=5.0) class-attribute instance-attribute ¤

The maximum amount of time to wait for the request to be fulfilled.