Updated the Weheat data rate documentation #37715
Conversation
home-assistant
bot
added
current
|
It seems that this PR is targeted against an incorrect branch since it has a parent PR on one of our codebases. Documentation that needs to be updated for an upcoming release should target the |
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
SteveDiks
requested review from
dmulcahey,
Adminiuga,
puddly,
TheJulianJES and
a team
as code owners
home-assistant
bot
removed
needs-rebase
📝 WalkthroughWalkthroughThe update revises the polling mechanism in the Weheat integration. Data logs are now retrieved every 120 seconds for a single heat pump, with the interval increasing proportionally when additional pumps are present (e.g., 240 seconds for two pumps). Additionally, energy logs are set to be fetched every 1800 seconds. No changes were made to the exported or public entities. Changes
Sequence Diagram(s)sequenceDiagram
participant Timer
participant Integration as WeheatIntegration
participant Device as HeatPump
Timer->>Integration: Trigger Data Logs retrieval (120s for 1 pump, scales for more)
Integration->>Device: Request Data Logs
Device-->>Integration: Return Data Logs
Timer->>Integration: Trigger Energy Logs retrieval (1800s)
Integration->>Device: Request Energy Logs
Device-->>Integration: Return Energy Logs
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
source/_integrations/weheat.markdown (1)
70-70: Enhanced polling interval details.
The updated text now specifies that the integration retrieves data logs every 120 seconds for a single heat pump—with the interval doubling for two pumps (e.g. 240 seconds)—and that energy logs are fetched every 1800 seconds. This additional detail improves clarity over the previous documentation. Consider including a brief note on whether this scaling is linear for cases with more than two heat pumps.source/_integrations/number.markdown (1)
54-54: New device class: Duration.
Adding a duration entry with units in days, hours, minutes, seconds, or milliseconds expands the documentation’s versatility. Consider adding an example or two elsewhere in the docs to guide users in selecting the appropriate unit.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
Gemfile.lockis excluded by!**/*.lock
📒 Files selected for processing (3)
source/_integrations/number.markdown(1 hunks)source/_integrations/weheat.markdown(1 hunks)source/_integrations/zha.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/number.markdown
[duplication] ~76-~76: Possible typo: you repeated a word.
Context: ...on_intensity**: Precipitation intensity in in/d, in/h, mm/d or mm/h - pressure: P...
(ENGLISH_WORD_REPEAT_RULE)
🔇 Additional comments (14)
source/_integrations/zha.markdown (2)
111-112: Clarifying non‐recommended hardware listing.
The introductory sentence now clearly indicates that the following hardware, while supported, is not recommended. This improves guidance for users when choosing Zigbee radio adapters.
115-125: Updated caution block formatting.
Replacing the old warning block with a{% caution %}block enhances readability and focus. The consolidated advice regarding running a coordinator via Serial‑Proxy‑Server over Wi‑Fi, WAN, or VPN is now more prominent. Please verify that this formatting is consistent with similar caution sections in other integration documents.source/_integrations/number.markdown (12)
45-45: Enhanced atmospheric pressure units.
The updated device class now includes a comprehensive list of units—such as mmHg and inHg—that will benefit users in different regions.
46-46: Clarified battery measurement.
Specifying that the battery level is expressed as a percentage (“%”) adds useful clarity.
47-47: Blood glucose concentration units reviewed.
The blood glucose concentration entry now lists “mg/dL” and “mmol/L”, which are standard units. No further changes are needed.
48-48: Updated carbon dioxide measurement details.
Expressing carbon dioxide levels in ppm is clear and aligns with common sensor output conventions.
49-49: Updated carbon monoxide measurement details.
Stating that carbon monoxide is measured in ppm provides a concise and clear description.
51-51: Verified data rate unit specification.
The list of units for data rate is comprehensive and should support a wide range of sensor outputs with various performance metrics.
52-52: Comprehensive data size units.
The extensive list of data size units will help ensure compatibility across different applications.
53-53: Improved distance measurement details.
Including “nmi” (nautical miles) as an option enhances the applicability of the distance device class for maritime or aviation contexts.
63-63: Clarified moisture measurements.
The moisture device class now unambiguously states that values are provided in percentages, which is excellent for clarity.
64-64: Expanded monetary description.
The addition of a reference to ISO 4217 increases the precision of how monetary values should be interpreted.
73-73: Enhanced pressure measurement details.
The pressure device class now offers a comprehensive set of units, ensuring it can represent a wide range of sensor outputs reliably.
85-85: New device class: volatile_organic_compounds_parts.
Introducing this new entry—with specified units in ppm or ppb—provides a valuable option for documenting ratios of volatile organic compounds. Please ensure consistency with related sensor integrations.
source/_integrations/number.markdown
Outdated
| - **pm25**: Concentration of particulate matter less than 2.5 micrometers in µg/m³ | ||
| - **power_factor**: Power factor(unitless), unit may be `None` or % | ||
| - **pm10**: Concentration of particulate matter less than 10 micrometers in µg/m³ |
There was a problem hiding this comment.
Updated precipitation intensity details and potential typo.
The entry for precipitation intensity now lists multiple unit options; however, the phrase “in in/d” appears to have a duplicated “in”. It should likely read “in/d”. Please correct this typo to avoid confusion.
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
SteveDiks
force-pushed
the
Weheat-update-data-rate
branch
from
cf509e0 to
27ee5fb
Compare
SteveDiks
force-pushed
the
Weheat-update-data-rate
branch
from
27ee5fb to
a248bfa
Compare
Proposed change
This branch updates the information about the working of the data rate in the Weheat integration.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit