Document and clarify upstream devices and hierachies #38574
Merged
Conversation
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
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
📝 WalkthroughWalkthroughA new section titled "Upstream devices and hierarchies" has been added to the energy documentation. This section explains the concept of designating upstream devices to create hierarchical relationships among energy-consuming devices, which helps prevent double-counting energy usage. The documentation clarifies that only devices already added as individual devices can be selected as upstream devices, and provides instructions for establishing these relationships. An important note is included to address user confusion regarding the selection of upstream devices. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant EnergyDashboard
User->>EnergyDashboard: Add energy consumption entity as individual device
User->>EnergyDashboard: Select individual device as upstream device for another device
EnergyDashboard-->>User: Establish parent-child device hierarchy
Assessment against linked issues
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
🪧 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 (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
source/_docs/energy/individual-devices.markdown (1)
26-40: Clarify the example sentence about double-counting.The new section is clear and well-structured, but the example sentence about double-counting could be misread as contradictory. For maximum clarity, consider rewording it as follows (adapting the suggestion from the past review):
-For example, imagine having a breaker monitoring the total energy consumption of a circuit, but also separately tracking individual devices connected to that circuit. Without setting the device hierarchies, Home Assistant might double-count this usage. By setting the hierarchy, it understands these relationships and accurately shows the individual device usage without duplication. +For example, imagine having a breaker monitoring the total energy consumption of a circuit, but also separately tracking individual devices connected to that circuit. Without setting the device hierarchies, Home Assistant might double-count this usage. By setting the hierarchy, Home Assistant understands these relationships and accurately shows the individual device usage without duplication.This makes it clear that the hierarchy prevents double-counting, not causes it.
Otherwise, the section is a valuable and well-written addition!
Co-authored-by: Abílio Costa <abmantis@users.noreply.github.com>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Proposed change
Add some context to device hierarchy in the energy dashboard + fixes feedback from #38567
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit