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 textual representation entities for Fronius status codes #94155

Merged
merged 9 commits into from Nov 27, 2023

Conversation

farmio
Copy link
Contributor

@farmio farmio commented Jun 7, 2023

Proposed change

Refactorings to make it possible to have multiple entities for a single API response field:

  • optionally decouple EntityDescription.key from API response key
  • Add optional value_fn to EntityDescriptions eg. to be able to map a API response value to a different value (status_code -> message)

New entities:

  • Inverter staus_message is a textual, translatable representation of "status_code" integer
  • Meter meter_location_description is a textual, translatable representation of "meter_location" integer

Changed features:

  • OhmPilots status_message entity state is now translatable (this was previously hardcoded english in the lib pyfronius)

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

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:
  • Link to documentation pull request:

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 Black (black --fast 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

home-assistant bot commented Jun 7, 2023

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

Code owner commands

Code owners of fronius 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 fronius Removes the current integration label and assignees on the pull request, add the integration domain after the command.

@farmio farmio changed the title Fronius status message Add textual representation entities for Fronius status codes Jun 7, 2023
@rorso
Copy link

rorso commented Jun 13, 2023

In case this gets adopted and there is a commitment to try this with the error codes too - these are part of the user manual.
They cover a bunch of additional devices that talk to the inverter - which serves as the general data mediator.

I assume they would be quite universal within the Fronius Ecosphere, at least for all "Symo" variants. Not all error codes may apply for all devices. If you do not have a hybrid model, "battery" errors do not apply. I have a different model than the listed document, but at least I successfully could match a handful of error numbers with this document. 306, 307 are to expected, 461 may happen occasionally.

I was not able not verify this in detail however. Fortunately most of those errors are not that common. 😬

https://www.fronius.com/~/downloads/Solar%20Energy/Operating%20Instructions/42,0426,0222,DE.pdf
https://www.fronius.com/~/downloads/Solar%20Energy/Operating%20Instructions/42,0426,0222,EN.pdf

I cannot help with the coding, but I could help with the boring stuff like translating the PDF-doc into a suitable table.

Copy link
Contributor

@weitzelb weitzelb left a comment

Choose a reason for hiding this comment

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

I'd suggest on having a look at handling invalid error code responses in the same way.

Not exposing the complexity and simplify use through a generic function is probably helpful for future expandability (should there be a need/thought to do so). Not crucial in my opinion though.

homeassistant/components/fronius/const.py Show resolved Hide resolved
homeassistant/components/fronius/sensor.py Show resolved Hide resolved
Copy link
Contributor

@weitzelb weitzelb left a comment

Choose a reason for hiding this comment

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

Looks good to me. For those edge cases not covered by the test, they could be added later as well. Looks in working order.

Copy link
Contributor

@emontnemery emontnemery left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @farmio 👍

@emontnemery emontnemery merged commit 5550dcb into dev Nov 27, 2023
23 checks passed
@emontnemery emontnemery deleted the fronius-status-message branch November 27, 2023 12:59
@github-actions github-actions bot locked and limited conversation to collaborators Nov 28, 2023
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

4 participants