dispatch_pb2_grpc
frequenz.api.dispatch.v1.dispatch_pb2_grpc ¤
Client and server classes corresponding to protobuf-defined services.
Classes¤
frequenz.api.dispatch.v1.dispatch_pb2_grpc.MicrogridDispatchService ¤
Bases: object
Service providing operations related to dispatching microgrid components.
Overview¤
The API serves to automate the process of electricity dispatches for microgrids. In the context of the energy industry, a 'dispatch' refers to the act of routing electrical power between different components within a microgrid or between a microgrid and the main grid. This could be for the purpose of supply (sending electricity to the grid or components within the microgrid), or demand (drawing electricity from the grid or from other components like batteries and solar arrays).
Objective¤
The primary objective of this API is to streamline and automate the complex task of electricity dispatching, making it easier to manage local electricity supply and demand efficiently.
Key Features¤
- Dispatching Electricity: Comprehensive CRUD operations for dispatching microgrid components.
- Automation: Support for one-time as well as recurring dispatches based on flexible recurrence rules.
- Fine-grained control: Dispatch individual microgrid components or entire component categories.
Example Use Cases¤
- Charging or discharging a battery based on optimal time-of-use rates.
- Limiting the output of a Photovoltaic (PV) array during periods of low demand.
- Invoking Frequency Containment Reserves (FCR) or Automatic Frequency Restoration Reserves (aFRR) to support grid operations.
- Adjusting the output of electric vehicle charging stations to match grid availability or to avoid peak pricing.
Target Audience¤
This API is designed for application developers in the energy sector who focus on the tasks of optimizing microgrid electricity flows. Its design aims to be as developer-friendly as possible, requiring no prior knowledge in electrical engineering and systems.
Source code in frequenz/api/dispatch/v1/dispatch_pb2_grpc.py
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 |
|
frequenz.api.dispatch.v1.dispatch_pb2_grpc.MicrogridDispatchServiceAsyncStub ¤
Service providing operations related to dispatching microgrid components.
Overview¤
The API serves to automate the process of electricity dispatches for microgrids. In the context of the energy industry, a 'dispatch' refers to the act of routing electrical power between different components within a microgrid or between a microgrid and the main grid. This could be for the purpose of supply (sending electricity to the grid or components within the microgrid), or demand (drawing electricity from the grid or from other components like batteries and solar arrays).
Objective¤
The primary objective of this API is to streamline and automate the complex task of electricity dispatching, making it easier to manage local electricity supply and demand efficiently.
Key Features¤
- Dispatching Electricity: Comprehensive CRUD operations for dispatching microgrid components.
- Automation: Support for one-time as well as recurring dispatches based on flexible recurrence rules.
- Fine-grained control: Dispatch individual microgrid components or entire component categories.
Example Use Cases¤
- Charging or discharging a battery based on optimal time-of-use rates.
- Limiting the output of a Photovoltaic (PV) array during periods of low demand.
- Invoking Frequency Containment Reserves (FCR) or Automatic Frequency Restoration Reserves (aFRR) to support grid operations.
- Adjusting the output of electric vehicle charging stations to match grid availability or to avoid peak pricing.
Target Audience¤
This API is designed for application developers in the energy sector who focus on the tasks of optimizing microgrid electricity flows. Its design aims to be as developer-friendly as possible, requiring no prior knowledge in electrical engineering and systems.
Source code in frequenz/api/dispatch/v1/dispatch_pb2_grpc.py
Attributes¤
CreateMicrogridDispatch
instance-attribute
¤
CreateMicrogridDispatch: UnaryUnaryMultiCallable[
DispatchCreateRequest, Empty
]
Create a new dispatch
DeleteMicrogridDispatch
instance-attribute
¤
DeleteMicrogridDispatch: UnaryUnaryMultiCallable[
DispatchDeleteRequest, Empty
]
Delete a given dispatch
GetMicrogridDispatch
instance-attribute
¤
GetMicrogridDispatch: UnaryUnaryMultiCallable[
DispatchGetRequest, Dispatch
]
Get a single dispatch
ListMicrogridDispatches
instance-attribute
¤
ListMicrogridDispatches: UnaryUnaryMultiCallable[
DispatchListRequest, DispatchList
]
Returns a list of all dispatches
UpdateMicrogridDispatch
instance-attribute
¤
UpdateMicrogridDispatch: UnaryUnaryMultiCallable[
DispatchUpdateRequest, Empty
]
Update a dispatch
frequenz.api.dispatch.v1.dispatch_pb2_grpc.MicrogridDispatchServiceServicer ¤
Bases: object
Service providing operations related to dispatching microgrid components.
Overview¤
The API serves to automate the process of electricity dispatches for microgrids. In the context of the energy industry, a 'dispatch' refers to the act of routing electrical power between different components within a microgrid or between a microgrid and the main grid. This could be for the purpose of supply (sending electricity to the grid or components within the microgrid), or demand (drawing electricity from the grid or from other components like batteries and solar arrays).
Objective¤
The primary objective of this API is to streamline and automate the complex task of electricity dispatching, making it easier to manage local electricity supply and demand efficiently.
Key Features¤
- Dispatching Electricity: Comprehensive CRUD operations for dispatching microgrid components.
- Automation: Support for one-time as well as recurring dispatches based on flexible recurrence rules.
- Fine-grained control: Dispatch individual microgrid components or entire component categories.
Example Use Cases¤
- Charging or discharging a battery based on optimal time-of-use rates.
- Limiting the output of a Photovoltaic (PV) array during periods of low demand.
- Invoking Frequency Containment Reserves (FCR) or Automatic Frequency Restoration Reserves (aFRR) to support grid operations.
- Adjusting the output of electric vehicle charging stations to match grid availability or to avoid peak pricing.
Target Audience¤
This API is designed for application developers in the energy sector who focus on the tasks of optimizing microgrid electricity flows. Its design aims to be as developer-friendly as possible, requiring no prior knowledge in electrical engineering and systems.
Source code in frequenz/api/dispatch/v1/dispatch_pb2_grpc.py
Functions¤
CreateMicrogridDispatch ¤
CreateMicrogridDispatch(
request: DispatchCreateRequest,
context: _ServicerContext,
) -> Union[Empty, Awaitable[Empty]]
Create a new dispatch
Source code in frequenz/api/dispatch/v1/dispatch_pb2_grpc.py
DeleteMicrogridDispatch ¤
DeleteMicrogridDispatch(
request: DispatchDeleteRequest,
context: _ServicerContext,
) -> Union[Empty, Awaitable[Empty]]
Delete a given dispatch
Source code in frequenz/api/dispatch/v1/dispatch_pb2_grpc.py
GetMicrogridDispatch ¤
GetMicrogridDispatch(
request: DispatchGetRequest, context: _ServicerContext
) -> Union[Dispatch, Awaitable[Dispatch]]
Get a single dispatch
Source code in frequenz/api/dispatch/v1/dispatch_pb2_grpc.py
ListMicrogridDispatches ¤
ListMicrogridDispatches(
request: DispatchListRequest, context: _ServicerContext
) -> Union[DispatchList, Awaitable[DispatchList]]
Returns a list of all dispatches
Source code in frequenz/api/dispatch/v1/dispatch_pb2_grpc.py
UpdateMicrogridDispatch ¤
UpdateMicrogridDispatch(
request: DispatchUpdateRequest,
context: _ServicerContext,
) -> Union[Empty, Awaitable[Empty]]
Update a dispatch
Source code in frequenz/api/dispatch/v1/dispatch_pb2_grpc.py
frequenz.api.dispatch.v1.dispatch_pb2_grpc.MicrogridDispatchServiceStub ¤
Bases: object
Service providing operations related to dispatching microgrid components.
Overview¤
The API serves to automate the process of electricity dispatches for microgrids. In the context of the energy industry, a 'dispatch' refers to the act of routing electrical power between different components within a microgrid or between a microgrid and the main grid. This could be for the purpose of supply (sending electricity to the grid or components within the microgrid), or demand (drawing electricity from the grid or from other components like batteries and solar arrays).
Objective¤
The primary objective of this API is to streamline and automate the complex task of electricity dispatching, making it easier to manage local electricity supply and demand efficiently.
Key Features¤
- Dispatching Electricity: Comprehensive CRUD operations for dispatching microgrid components.
- Automation: Support for one-time as well as recurring dispatches based on flexible recurrence rules.
- Fine-grained control: Dispatch individual microgrid components or entire component categories.
Example Use Cases¤
- Charging or discharging a battery based on optimal time-of-use rates.
- Limiting the output of a Photovoltaic (PV) array during periods of low demand.
- Invoking Frequency Containment Reserves (FCR) or Automatic Frequency Restoration Reserves (aFRR) to support grid operations.
- Adjusting the output of electric vehicle charging stations to match grid availability or to avoid peak pricing.
Target Audience¤
This API is designed for application developers in the energy sector who focus on the tasks of optimizing microgrid electricity flows. Its design aims to be as developer-friendly as possible, requiring no prior knowledge in electrical engineering and systems.
Source code in frequenz/api/dispatch/v1/dispatch_pb2_grpc.py
Attributes¤
CreateMicrogridDispatch
instance-attribute
¤
CreateMicrogridDispatch: UnaryUnaryMultiCallable[
DispatchCreateRequest, Empty
] = unary_unary(
"/frequenz.api.dispatch.v1.MicrogridDispatchService/CreateMicrogridDispatch",
request_serializer=SerializeToString,
response_deserializer=FromString,
)
Create a new dispatch
DeleteMicrogridDispatch
instance-attribute
¤
DeleteMicrogridDispatch: UnaryUnaryMultiCallable[
DispatchDeleteRequest, Empty
] = unary_unary(
"/frequenz.api.dispatch.v1.MicrogridDispatchService/DeleteMicrogridDispatch",
request_serializer=SerializeToString,
response_deserializer=FromString,
)
Delete a given dispatch
GetMicrogridDispatch
instance-attribute
¤
GetMicrogridDispatch: UnaryUnaryMultiCallable[
DispatchGetRequest, Dispatch
] = unary_unary(
"/frequenz.api.dispatch.v1.MicrogridDispatchService/GetMicrogridDispatch",
request_serializer=SerializeToString,
response_deserializer=FromString,
)
Get a single dispatch
ListMicrogridDispatches
instance-attribute
¤
ListMicrogridDispatches: UnaryUnaryMultiCallable[
DispatchListRequest, DispatchList
] = unary_unary(
"/frequenz.api.dispatch.v1.MicrogridDispatchService/ListMicrogridDispatches",
request_serializer=SerializeToString,
response_deserializer=FromString,
)
Returns a list of all dispatches
UpdateMicrogridDispatch
instance-attribute
¤
UpdateMicrogridDispatch: UnaryUnaryMultiCallable[
DispatchUpdateRequest, Empty
] = unary_unary(
"/frequenz.api.dispatch.v1.MicrogridDispatchService/UpdateMicrogridDispatch",
request_serializer=SerializeToString,
response_deserializer=FromString,
)
Update a dispatch
Functions¤
__init__ ¤
Constructor.
PARAMETER | DESCRIPTION |
---|---|
channel |
A grpc.Channel. |