Skip to content

Conversation

@tiyash-basu-frequenz
Copy link
Contributor

@tiyash-basu-frequenz tiyash-basu-frequenz commented Apr 8, 2025

This enum is used to explicitly define whether an electrical component is intended to be active (enabled) or inactive (disabled). This intention directly determines the component's availability to downstream services and applications.

Note that this enum differs from the ElectricalComponentStatus enum, which is used to report the actual operational state of the component.

Thanks to @thomas-nicolai-frequenz for providing the original version.

@tiyash-basu-frequenz tiyash-basu-frequenz added this to the v0.7.0 milestone Apr 8, 2025
@tiyash-basu-frequenz tiyash-basu-frequenz self-assigned this Apr 8, 2025
Copilot AI review requested due to automatic review settings April 8, 2025 14:05
@tiyash-basu-frequenz tiyash-basu-frequenz requested a review from a team as a code owner April 8, 2025 14:05
@github-actions github-actions bot added the part:protobuf Affects the protocol buffer definition files label Apr 8, 2025
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.

Comments suppressed due to low confidence (1)

proto/frequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto:126

  • Consider replacing 'upstream' with 'downstream' for consistency with the PR description and to avoid confusion about the intended audience for the component's availability.
// component availability to upstream services and applications.

@tiyash-basu-frequenz tiyash-basu-frequenz force-pushed the elec_control_mode branch 3 times, most recently from 2fbcdf0 to d44aa3b Compare April 8, 2025 14:17
@github-actions github-actions bot added the part:docs Affects the documentation label Apr 8, 2025
// !!! example "Control Mode Change Impact"
// If a battery component's Control Mode is switched from ACTIVE to
// INACTIVE, it immediately becomes unavailable to downstream
// energy-management services, potentially disrupting scheduled
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets remove the "energy-management" part and just say "services and agents".

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

This enum is used to explicitly define whether an electrical component
is intended to be active (enabled) or inactive (disabled). This
intention directly determines the component's availability to downstream
services and applications.

Note that this enum differs from the `ElectricalComponentStatus` enum,
which is used to report the actual operational state of the component.

Signed-off-by: Tiyash Basu <[email protected]>

# Conflicts:
#	RELEASE_NOTES.md
#	proto/frequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto
The `ElectricalComponentStatus` enum has been removed in favour of the
`ElectricalComponentControlMode` enum.

Signed-off-by: Tiyash Basu <[email protected]>

# Conflicts:
#	proto/frequenz/api/common/v1/microgrid/electrical_components/electrical_components.proto
@tiyash-basu-frequenz tiyash-basu-frequenz added this pull request to the merge queue May 19, 2025
Merged via the queue into frequenz-floss:v0.x.x with commit c9a075d May 19, 2025
6 checks passed
@tiyash-basu-frequenz tiyash-basu-frequenz deleted the elec_control_mode branch May 19, 2025 14:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

part:docs Affects the documentation part:protobuf Affects the protocol buffer definition files

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Confusing Naming of Component State Enums: ComponentStatus and ComponentStateCode

3 participants