Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add phase entities to Enphase Envoy #108725

Merged
merged 8 commits into from Jan 28, 2024

Conversation

catsmanac
Copy link
Contributor

Proposed change

Enphase Envoy metered with current transformer (CT) clamps installed on multiple phases provides data at the phase level in addition to the overall summary. This PR add entities for phase production and consumption data. Entity names are the same as the overall summary entities with phase names l1, l2 or l3 post-fixed.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New integration (thank you!)
  • New feature (which adds functionality to an existing integration)
  • Deprecation (breaking change to happen in the future)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

Checklist

  • The code change is tested and works locally.
  • Local tests pass. Your PR cannot be merged unless tests pass
  • There is no commented out code in this PR.
  • I have followed the development checklist
  • I have followed the perfect PR recommendations
  • The code has been formatted using Ruff (ruff format homeassistant tests)
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

If the code communicates with devices, web services, or third-party tools:

  • The manifest file has all fields filled out correctly.
    Updated and included derived files by running: python3 -m script.hassfest.
  • New or updated dependencies have been added to requirements_all.txt.
    Updated by running python3 -m script.gen_requirements_all.
  • For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.
  • Untested files have been added to .coveragerc.

To help with the load of incoming pull requests:

@home-assistant
Copy link

Hey there @bdraco, @cgarwood, @dgomes, @joostlek, mind taking a look at this pull request as it has been labeled with an integration (enphase_envoy) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of enphase_envoy can trigger bot actions by commenting:

  • @home-assistant close Closes the pull request.
  • @home-assistant rename Awesome new title Renames the pull request.
  • @home-assistant reopen Reopen the pull request.
  • @home-assistant unassign enphase_envoy Removes the current integration label and assignees on the pull request, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the pull request.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the pull request.

@@ -104,6 +105,7 @@ class EnvoyProductionSensorEntityDescription(
suggested_unit_of_measurement=UnitOfPower.KILO_WATT,
suggested_display_precision=3,
value_fn=lambda production: production.watts_now,
translation_placeholders={"phase_name": ""},
Copy link
Member

Choose a reason for hiding this comment

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

Can we unset these?

Suggested change
translation_placeholders={"phase_name": ""},

homeassistant/components/enphase_envoy/sensor.py Outdated Show resolved Hide resolved
homeassistant/components/enphase_envoy/sensor.py Outdated Show resolved Hide resolved
homeassistant/components/enphase_envoy/sensor.py Outdated Show resolved Hide resolved
tests/components/enphase_envoy/test_config_flow.py Outdated Show resolved Hide resolved
@home-assistant
Copy link

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@home-assistant home-assistant bot marked this pull request as draft January 25, 2024 10:37
@MartinHjelmare MartinHjelmare changed the title add phase entities to Enphase Envoy Add phase entities to Enphase Envoy Jan 25, 2024
Move device name logic to separate function.
Refactor native value for phases
Use dataclasses.replace for phase entities, add on-phase to base class as well, no need for phase entity descriptions anymore
homeassistant/components/enphase_envoy/sensor.py Outdated Show resolved Hide resolved
homeassistant/components/enphase_envoy/sensor.py Outdated Show resolved Hide resolved
homeassistant/components/enphase_envoy/sensor.py Outdated Show resolved Hide resolved
homeassistant/components/enphase_envoy/sensor.py Outdated Show resolved Hide resolved
@catsmanac catsmanac marked this pull request as ready for review January 27, 2024 21:25
@bdraco
Copy link
Member

bdraco commented Jan 28, 2024

I think its good to go from my perspective. I'll test it shortly

@bdraco
Copy link
Member

bdraco commented Jan 28, 2024

Works fine on my systems but they are all 2 phase

@bdraco
Copy link
Member

bdraco commented Jan 28, 2024

I approved it but didn't merge to give joostlek a chance top followup on his comment #108725 (comment) in case any more changes are needed

@catsmanac
Copy link
Contributor Author

Works fine on my systems but they are all 2 phase

fwiw I ran it with my envoy simulator using the 3 phase fixture files from pyenphase.

@joostlek joostlek merged commit 2b33feb into home-assistant:dev Jan 28, 2024
23 checks passed
entities.extend(
EnvoyConsumptionPhaseEntity(coordinator, description)
for use_phase, phase in envoy_data.system_consumption_phases.items()
for description in CONSUMPTION_PHASE_SENSORS[PhaseNames(use_phase)]
Copy link
Member

Choose a reason for hiding this comment

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

I think we could simplify this further and make use_phase the key to it becomes CONSUMPTION_PHASE_SENSORS[use_phase] and the dict construction above is adjusted accordingly

Sorry for missing this one the first go.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The linter didn't like the

for description in CONSUMPTION_PHASE_SENSORS[use_phase]

when the walrus was added and the PhaseNames had to be added. To optimize it we need to change the definition in the EnvoyConsumptionRequiredKeysMixin to str

    on_phase: str | None

and make sure the key is str

CONSUMPTION_PHASE_SENSORS = {
    (on_phase := str(PhaseNames(PHASENAMES[phase]))): [

Copy link
Member

Choose a reason for hiding this comment

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

No worries. Let's leave it as is

chemelli74 pushed a commit to chemelli74/core that referenced this pull request Jan 29, 2024
* add phase entities to Enphase Envoy

* Implement review feedback for translation strings

* Enphase Envoy multiphase review changes

Move device name logic to separate function.
Refactor native value for phases
Use dataclasses.replace for phase entities, add on-phase to base class as well, no need for phase entity descriptions anymore

* Enphase Envoy reviewe feedback

Move model determination to library.
Revert states test for future split to sensor test.

* Enphase_Envoy use model description from pyenphase library

* Enphase_Envoy refactor Phase Sensors

* Enphase_Envoy use walrus in phase sensor

---------

Co-authored-by: J. Nick Koston <nick@koston.org>
@catsmanac catsmanac deleted the EnphaseEnvoyPhases-2 branch January 29, 2024 21:20
Moustachauve pushed a commit to Moustachauve/HA-core that referenced this pull request Jan 30, 2024
* add phase entities to Enphase Envoy

* Implement review feedback for translation strings

* Enphase Envoy multiphase review changes

Move device name logic to separate function.
Refactor native value for phases
Use dataclasses.replace for phase entities, add on-phase to base class as well, no need for phase entity descriptions anymore

* Enphase Envoy reviewe feedback

Move model determination to library.
Revert states test for future split to sensor test.

* Enphase_Envoy use model description from pyenphase library

* Enphase_Envoy refactor Phase Sensors

* Enphase_Envoy use walrus in phase sensor

---------

Co-authored-by: J. Nick Koston <nick@koston.org>
@github-actions github-actions bot locked and limited conversation to collaborators Jan 30, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants