Fix availableEnergyCapacity display unit in periodic_requests example#21
Merged
Fix availableEnergyCapacity display unit in periodic_requests example#21
Conversation
…s example
The availableEnergyCapacity field represents energy in Watt-hours (Wh),
not a percentage. Updated the display format from '{value}%' to '{value} Wh'.
This prevents confusing output like 'Available Energy: 709.0%' which
doesn't make sense for a percentage value.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The
periodic_requests.pyexample was incorrectly displayingavailableEnergyCapacityas a percentage (e.g., "Available Energy: 709.0%"), which doesn't make sense since 709% is not a valid percentage value.Root Cause
According to the documentation in
docs/DEVICE_STATUS_FIELDS.rst, theavailableEnergyCapacityfield represents:This is an energy measurement, not a percentage.
Solution
Changed the display format in the
on_device_statuscallback from:To:
Results
Before:
Available Energy: 709.0%(confusing)After:
Available Energy: 709 Wh(correct)Verification
dhwChargePer) are correctly usedType of Change
This is a minor correction that improves example accuracy and user understanding.