Add docs for Libre Hardware Monitor integration #37941
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
bfec581 to
fda7c67
Compare
📝 WalkthroughWalkthroughA new markdown file has been added to document the integration of Libre Hardware Monitor with Home Assistant. The file provides detailed instructions on prerequisites, configuration options such as host IP and port, and the configuration flow for selecting hardware devices and sensors. It also covers known limitations, troubleshooting advice for connection and sensor availability issues, reconfiguration procedures, and the removal process for the integration. Changes
Sequence Diagram(s)sequenceDiagram
participant U as User
participant HA as Home Assistant
participant LHM as Libre Hardware Monitor
U->>HA: Initiate integration setup
HA->>U: Request configuration details (host, port)
U->>HA: Provide configuration details
HA->>LHM: Connect to Libre Hardware Monitor remote server
LHM-->>HA: Return sensor data
HA->>U: Display hardware devices and sensors
U->>HA: Select devices/sensors to monitor
HA->>U: Confirm setup and start monitoring
Tip ⚡💬 Agentic Chat (Pro Plan, General Availability)
🪧 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 (6)
source/_integrations/librehardwaremonitor.markdown (6)
43-47: Good explanation of configuration options with a minor nitpick
The description is clear; however, note that line 46 contains trailing whitespace which should be removed.-All sensors will be grouped by the device they belong to. If you do not want all sensors for a device, you can disable entities via the UI after setup. +All sensors will be grouped by the device they belong to. If you do not want all sensors for a device, you can disable entities via the UI after setup.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
46-46: Trailing spaces
Expected: 0 or 2; Actual: 1(MD009, no-trailing-spaces)
62-62: Adjust heading level for consistency
The subheading "#### Problem with connection during setup" should be one level deeper than "## Troubleshooting" (i.e. use "###") to maintain a proper heading hierarchy.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
62-62: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4(MD001, heading-increment)
66-66: Align heading levels
Consider updating "#### Sensors change to "unavailable" status" to "### Sensors change to "unavailable" status" for consistent hierarchy under the "Troubleshooting" section.
68-68: Correct terminology and punctuation in troubleshooting text
Please change "behaviour" to "behavior" (per the Home Assistant terminology guidelines) and insert a comma after "e.g." for clarity.-This is expected behaviour when the computer is not reachable e.g. it is turned off. +This is expected behavior when the computer is not reachable, e.g., it is turned off.🧰 Tools
🪛 LanguageTool
[uncategorized] ~68-~68: Possible missing comma found.
Context: ...cted behaviour when the computer is not reachable e.g. it is turned off. Sensors will res...(AI_HYDRA_LEO_MISSING_COMMA)
🪛 GitHub Actions: home-assistant.io Test
[error] 68-68: Incorrect usage of the term: “behaviour”, use “behavior” instead terminology
70-70: Align heading level for consistency
Change "#### Integration stops working" to "### Integration stops working" so that it increments only one level from the parent "## Troubleshooting" heading.
74-78: Clear removal instructions with a minor formatting note
The integration removal section is well written. Please ensure the file ends with a single newline character to conform with markdownlint standards.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
78-78: Files should end with a single newline character
null(MD047, single-trailing-newline)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/librehardwaremonitor.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/librehardwaremonitor.markdown
[uncategorized] ~68-~68: Possible missing comma found.
Context: ...cted behaviour when the computer is not reachable e.g. it is turned off. Sensors will res...
(AI_HYDRA_LEO_MISSING_COMMA)
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/librehardwaremonitor.markdown
46-46: Trailing spaces
Expected: 0 or 2; Actual: 1
(MD009, no-trailing-spaces)
62-62: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
78-78: Files should end with a single newline character
null
(MD047, single-trailing-newline)
🪛 GitHub Actions: home-assistant.io Test
source/_integrations/librehardwaremonitor.markdown
[error] 68-68: Incorrect usage of the term: “behaviour”, use “behavior” instead terminology
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (7)
source/_integrations/librehardwaremonitor.markdown (7)
1-13: Great job with the YAML front matter
The metadata is clear, complete, and follows the Home Assistant documentation standards.
15-16: Clear introductory description
The introduction concisely explains the purpose of the integration.
17-31: Well-detailed prerequisites section
The step-by-step prerequisites (including the Windows port-opening instructions) are informative and clear.
32-33: Correct usage of configuration flow include
Using{% include integrations/config_flow.md %}properly injects the configuration flow documentation.
34-41: Accurate configuration block definition
The{% configuration_basic %}block clearly details the configuration options for host, port, and scan interval with appropriate defaults.
48-55: Clear and user-friendly reconfiguration instructions
The reconfiguration section is straightforward and aligns well with Home Assistant's UI flow.
56-60: Concise description of known limitations
The limitations are clearly stated, alerting users that authenticated servers are unsupported.
fda7c67 to
279dbc5
Compare
There was a problem hiding this comment.
Caution
Inline review comments failed to post. This is likely due to GitHub's limits when posting large numbers of comments. If you are seeing this consistently it is likely a permissions issue. Please check "Moderation" -> "Code review limits" under your organization settings.
Actionable comments posted: 1
🧹 Nitpick comments (3)
source/_integrations/librehardwaremonitor.markdown (3)
21-30: Windows Port Opening Steps:
The step-by-step instructions for enabling the inbound TCP port (8085) on Windows are detailed and easy to follow. Consider adding a note on the need for administrative privileges to make these changes.
43-47: Configuration Options Details:
This section effectively explains how sensors are grouped and informs the user about the ability to disable entities via the UI after setup.
Note: There appears to be trailing whitespace on line 46. Removing the extra space will help comply with markdownlint guidelines.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
46-46: Trailing spaces
Expected: 0 or 2; Actual: 1(MD009, no-trailing-spaces)
74-78: Integration Removal Instructions:
The removal instructions conform to the standard process and include the necessary template inclusion.
Reminder: Ensure that the file ends with a single newline character to satisfy the markdownlint MD047 requirement.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
78-78: Files should end with a single newline character
null(MD047, single-trailing-newline)
🛑 Comments failed to post (1)
source/_integrations/librehardwaremonitor.markdown (1)
60-68:
⚠️ Potential issueTroubleshooting for Connection Issues:
The troubleshooting steps provide practical advice for addressing connection issues.
Action Required: On line 68, change “behaviour” to “behavior” to align with Home Assistant’s documentation style guidelines.-This is expected behaviour when the computer is not reachable +This is expected behavior when the computer is not reachable📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.## Troubleshooting ### Problem with connection during setup Open a browser and navigate to `http://<IP address>:<Port>` of your Libre Hardware Monitor instance, make sure you can see and update the data there. ### Sensors change to "unavailable" status This is expected behavior when the computer is not reachable e.g. it is turned off. Sensors will resume their data readings once the computer is reachable again.🧰 Tools
🪛 GitHub Actions: home-assistant.io Test
[error] 68-68: Incorrect usage of the term: “behaviour”, use “behavior” instead terminology
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
source/_integrations/librehardwaremonitor.markdown (1)
43-47: Review: Configuration Options Clarity & Minor PunctuationThe "Configuration options" section effectively informs users about sensor grouping and customization during the configuration flow.
Nitpick: Consider adding a comma after "your CPU" in line 45 for smoother readability. For example:"... if you only want to monitor your CPU, you can deselect any other device."
🧰 Tools
🪛 LanguageTool
[uncategorized] ~45-~45: Possible missing comma found.
Context: ..., e.g. if you only want to monitor your CPU you can deselect any other device. All ...(AI_HYDRA_LEO_MISSING_COMMA)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/librehardwaremonitor.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/librehardwaremonitor.markdown
[uncategorized] ~45-~45: Possible missing comma found.
Context: ..., e.g. if you only want to monitor your CPU you can deselect any other device. All ...
(AI_HYDRA_LEO_MISSING_COMMA)
🔇 Additional comments (10)
source/_integrations/librehardwaremonitor.markdown (10)
1-13: Review: Metadata Section is CorrectThe metadata header correctly defines the integration’s title, description, category, release, IoT class, domain, platforms, integration type, and quality scale. It adheres to Home Assistant documentation standards.
15-16: Review: Introduction Paragraph ClarityThe introduction clearly explains that the integration leverages Libre Hardware Monitor to source sensor data. The provided link to the repository is effective for users seeking additional details.
17-20: Review: Prerequisites Section CompletenessThe prerequisites section concisely informs users that Libre Hardware Monitor must be running with the "Remote web server" enabled and specifies the need to open TCP port 8085. This establishes a clear context for setup.
21-30: Review: Windows Port Opening InstructionsThe step-by-step instructions to open TCP port 8085 on Windows are detailed and easy to follow, which will guide users effectively in configuring their system firewall.
32-32: Review: Inclusion of Config Flow TemplateIncluding the configuration flow snippet with
{% include integrations/config_flow.md %}is correctly placed, ensuring consistency with other integration documents.
34-41: Review: Configuration Block AccuracyThe configuration block clearly outlines the parameters (
host,port, andscan_interval) with their descriptions, default values, and allowed ranges. This information is comprehensive and well structured.
48-55: Review: Reconfiguration InstructionsThe reconfiguration steps are clearly laid out, offering users a straightforward process for modifying their integration settings after setup.
56-59: Review: Known LimitationsThe known limitations section succinctly explains that servers requiring authentication are not supported, which helps manage user expectations.
60-73: Review: Troubleshooting SectionThe troubleshooting section is thorough, addressing potential issues with connection, sensor availability, and integration functionality. The guidance provided should be helpful for resolving common problems.
74-78: Review: Integration Removal StepsThe removal instructions follow standard practices by referencing the appropriate include file for device/service removal. This ensures that the process remains consistent with other integrations.
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
279dbc5 to
8cc5542
Compare
Great feedback, thanks. I have addressed all of your suggestions. |
8cc5542 to
1c8e7b9
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
source/_integrations/librehardwaremonitor.markdown (4)
15-18: Refine Integration Description
The description is clear; however, consider revising the phrase “display that system information” to simply “display system information” for enhanced clarity.
19-25: Prerequisites Section Clarity
The prerequisites are well listed. As a minor improvement, you might explicitly mention the default port (8085) in the firewall requirement (e.g., “Make sure to open inbound port 8085 on the host system's firewall”) to avoid any ambiguity.🧰 Tools
🪛 LanguageTool
[uncategorized] ~22-~22: You might be missing the article “the” here.
Context: ...he system (host) you want to monitor. - Libre Hardware Monitor must be running during...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
26-36: Improve Windows Firewall Heading and Instructions
• Remove the trailing colon in the heading to satisfy markdown lint (e.g., change “### To open a port (on Windows Firewall):” to “### To open a port (on Windows Firewall)”).
• Consider reformatting the navigation instructions (e.g., using “Control Panel > System and Security > Windows Defender Firewall”) for improved clarity.
A suggested diff for the heading:-### To open a port (on Windows Firewall): +### To open a port (on Windows Firewall)🧰 Tools
🪛 LanguageTool
[grammar] ~28-~28: The correct preposition appears to be “on”.
Context: ... open a port (on Windows Firewall): 1. In Windows, navigate to Control Panel, Sys...(IN_WINDOWS)
🪛 markdownlint-cli2 (0.17.2)
26-26: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
39-46: Enhance Configuration Field Descriptions
The configuration block is clear and informative. For thehostfield description, consider rephrasing “The system you want to monitor” to “This is the system you want to monitor” to improve readability.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/librehardwaremonitor.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/librehardwaremonitor.markdown
[uncategorized] ~22-~22: You might be missing the article “the” here.
Context: ...he system (host) you want to monitor. - Libre Hardware Monitor must be running during...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[grammar] ~28-~28: The correct preposition appears to be “on”.
Context: ... open a port (on Windows Firewall): 1. In Windows, navigate to Control Panel, Sys...
(IN_WINDOWS)
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/librehardwaremonitor.markdown
26-26: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
🔇 Additional comments (8)
source/_integrations/librehardwaremonitor.markdown (8)
1-13: Metadata Header is Well-Formed
The YAML front matter correctly specifies the integration metadata (title, description, categories, release, etc.) and adheres to the style guidelines.
48-52: Configuration Options Explanation is Clear
The explanation regarding how to select which hardware devices to monitor is well written and user friendly.
53-60: Reconfiguration Instructions are Clear
The steps for reconfiguring an existing entry are straightforward and follow the established Home Assistant styles.
61-64: Known Limitations Section is Sufficient
The section concisely states that authentication for the Libre Hardware Monitor remote web server is not supported, which aligns with current functionality.
65-72: Troubleshooting Section is Effective
The troubleshooting instructions for connection issues are clear and actionable, guiding the user to verify the remote web server status.
73-77: Sensors “Unavailable” Behavior is Well Documented
The explanation for sensors changing to an “unavailable” status is informative and sets the right expectations for the user.
78-81: Integration Stops Working Guidance is Clear
The instructions to check the IP address and suggest setting up a static IP are practical and helpful.
82-87: Removal Process Follows Standard Practices
The removal instructions are succinct and correctly reference the standard integration removal guidelines.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
source/_integrations/librehardwaremonitor.markdown (2)
26-36: Windows Firewall Instructions: Minor Language and Formatting Suggestions
- Remove Trailing Punctuation: The heading “### To open a port (on Windows Firewall):” (line 26) ends with a colon. Removing the trailing punctuation will comply with markdown style guidelines (MD026).
- Clarify Step 1 Wording: In step 1 (line 28), consider rephrasing for enhanced clarity and alignment with standard instruction style. For example:
- Current: "1. In Windows, navigate to Control Panel, System and Security and Windows Defender Firewall."
- Suggested: "1. In Windows, open Control Panel > System and Security > Windows Defender Firewall."
🧰 Tools
🪛 LanguageTool
[grammar] ~28-~28: The correct preposition appears to be “on”.
Context: ... open a port (on Windows Firewall): 1. In Windows, navigate to Control Panel, Sys...(IN_WINDOWS)
🪛 markdownlint-cli2 (0.17.2)
26-26: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
39-46: Configuration Block: Detailed DescriptionsThe configuration block within the
{% configuration_basic %}tag offers clear and succinct descriptions for each parameter (host, port, scan_interval). For added clarity, you might consider rephrasing the host description slightly—for example, “IP address or hostname where Libre Hardware Monitor is running.”
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/librehardwaremonitor.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/librehardwaremonitor.markdown
[uncategorized] ~22-~22: You might be missing the article “the” here.
Context: ...he system (host) you want to monitor. - Libre Hardware Monitor must be running during...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[grammar] ~28-~28: The correct preposition appears to be “on”.
Context: ... open a port (on Windows Firewall): 1. In Windows, navigate to Control Panel, Sys...
(IN_WINDOWS)
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/librehardwaremonitor.markdown
26-26: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
🔇 Additional comments (11)
source/_integrations/librehardwaremonitor.markdown (11)
1-13: Metadata Block: Validate YAML Front MatterThe metadata block is well-formed and follows the Home Assistant documentation standards. All key attributes (title, description, category, release version, integration type, etc.) are clearly defined.
15-18: Integration Overview: Clear and InformativeThe overview description clearly explains that Libre Hardware Monitor serves as a source for sensor data in Home Assistant. The language is direct and the use of the term markup (
{% term integration %}) aligns with documentation conventions. If desired, you could optionally expand on the types of sensor readings available.
19-25: Prerequisites: Clear Listing of RequirementsThe prerequisites section provides a concise list of requirements, including installation and ensuring that the "Remote web server" is active. The points are straightforward and inform the user about what must be done before proceeding.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~22-~22: You might be missing the article “the” here.
Context: ...he system (host) you want to monitor. - Libre Hardware Monitor must be running during...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
37-38: Include Statement for Configuration FlowThe include statement
{% include integrations/config_flow.md %}is appropriately placed, ensuring consistency with other integration documentation.
48-52: Configuration Options: User-Focused DetailsThe section describing the configuration options provides straightforward guidance on selecting and grouping hardware sensors. This section is clear and user-friendly.
53-60: Reconfiguration Instructions: Step-by-Step ClarityThe reconfiguration section clearly outlines the steps to modify an existing integration entry, including navigating to the appropriate settings and using the UI menu. This aligns well with Home Assistant’s overall documentation patterns.
61-64: Known Limitations: Adequate DisclosureThe known limitations section succinctly informs users that authentication setup for the remote web server is currently not supported. This transparency helps manage user expectations.
65-72: Troubleshooting (Connection Issues): Clear GuidanceThe troubleshooting section for connection issues provides clear instructions for verifying that the Libre Hardware Monitor web server is running and accessible. The guidance is practical and straightforward.
73-77: Troubleshooting (Sensor Unavailability): Informative ExplanationThe explanation for sensors transitioning to an "unavailable" status is clear. It appropriately sets expectations by noting this is normal when the monitored system is unreachable.
78-81: Troubleshooting (Integration Stops Working): Practical RemindersThe steps advising users to verify that the IP address has not changed (and suggesting a static IP) are practical and helpful in resolving potential issues with the integration.
82-87: Removal Instructions: Standard ProcedureThe removal instructions are brief yet sufficient, referencing the common removal template through an include directive. This consistency avoids redundancy and aligns with established documentation practices.
2af788f to
573b94d
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
source/_integrations/librehardwaremonitor.markdown (2)
22-28: Prerequisites ClarityThe prerequisites list is easy to follow and instructs the user on what needs to be set up. As a minor suggestion for improved readability, consider adding a definite article in the second bullet. For example:
-Libre Hardware Monitor must be running during setup. +Libre Hardware Monitor must be running during the setup process.🧰 Tools
🪛 LanguageTool
[uncategorized] ~25-~25: You might be missing the article “the” here.
Context: ...he system (host) you want to monitor. - Libre Hardware Monitor must be running during...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
29-38: Windows Firewall Instructions EnhancementThe step-by-step instructions for opening a port are clear. To further align with Home Assistant’s style guidelines (which favor bold formatting for UI elements) and to improve visual clarity, consider rephrasing step 1 as follows:
-1. In Windows, navigate to Control Panel, System and Security and Windows Defender Firewall. +1. In Windows, navigate to **Control Panel** > **System and Security** > **Windows Defender Firewall**.This change makes it immediately clear that these are UI elements.
🧰 Tools
🪛 LanguageTool
[grammar] ~31-~31: The correct preposition appears to be “on”.
Context: ...o open a port (on Windows Firewall) 1. In Windows, navigate to Control Panel, Sys...(IN_WINDOWS)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/librehardwaremonitor.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/librehardwaremonitor.markdown
[uncategorized] ~25-~25: You might be missing the article “the” here.
Context: ...he system (host) you want to monitor. - Libre Hardware Monitor must be running during...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[grammar] ~31-~31: The correct preposition appears to be “on”.
Context: ...o open a port (on Windows Firewall) 1. In Windows, navigate to Control Panel, Sys...
(IN_WINDOWS)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (10)
source/_integrations/librehardwaremonitor.markdown (10)
1-16: Metadata Block VerificationThe YAML front-matter is complete and accurate—it includes all the required metadata (title, description, category, release version, config flow, codeowners, etc.) for the integration documentation.
18-21: Introduction and OverviewThe introductory paragraph clearly explains the purpose of the integration and correctly links to the Libre Hardware Monitor project. The use of the term integration via the templating tag is consistent with Home Assistant documentation standards.
40-49: Configuration Block InclusionThe configuration block using the templated include (
{% configuration_basic %}) is implemented correctly and provides clear descriptions for the host, port, and scan interval settings.
51-55: Configuration Options SectionThe section on configuration options explains how users can select which hardware devices to monitor and how sensors are grouped. The instructions are clear and helpful for end users.
56-63: Reconfiguration InstructionsThe reconfiguration guidance is straightforward and follows the standard practice in Home Assistant documentation—pointing users to the integration’s settings and the UI menu.
64-68: Known LimitationsThe limitations section clearly states that authentication for the remote web server is not currently supported. This transparency is valuable for users setting up the integration.
69-75: Troubleshooting – Connection IssuesThe troubleshooting steps for connection problems are concise. Advising users to check that the Libre Hardware Monitor remote web server is running and accessible provides actionable guidance.
76-80: Troubleshooting – Sensors UnavailableThe explanation regarding sensors changing to an "unavailable" status is clear. It properly sets the expectation that this condition is temporary if the monitored system is unreachable.
81-84: Troubleshooting – Integration StoppageThe advice to verify that the IP address has not changed—and the suggestion to use a static IP—are practical recommendations that should help users resolve connectivity issues.
85-90: Removal InstructionsThe section on removing the integration is succinct and follows the standard inclusion practice for Home Assistant removal instructions. No issues detected.
|
Updated to reflect changes done on the core PR. |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (7)
source/_integrations/librehardwaremonitor.markdown (7)
1-16: Verify frontmatter completeness
Please confirm that the frontmatter includes all required fields per our documentation guidelines (e.g.,slug,sidebar_title) so the page is properly surfaced in the sidebar and search.Consider adding:
--- title: Libre Hardware Monitor +sidebar_title: Libre Hardware Monitor +slug: librehardwaremonitor description: Instructions on how to integrate Libre Hardware Monitor within Home Assistant. ha_category: - System monitor ha_release: 2025.4 ...
18-21: Refine integration description for readability
The current intro is wordy and repeats "monitor." Splitting into two sentences and tightening phrasing will improve clarity:-The **Libre Hardware Monitor** {% term integration %} uses your [Libre Hardware Monitor](https://github.com/LibreHardwareMonitor/LibreHardwareMonitor) installation as a source for sensors to display that system information in Home Assistant. -Libre Hardware Monitor, a fork of Open Hardware Monitor, is free software that can monitor the temperature sensors, fan speeds, voltages, load and clock speeds of your computer. +The **Libre Hardware Monitor** {% term integration %} uses your [Libre Hardware Monitor](https://github.com/LibreHardwareMonitor/LibreHardwareMonitor) installation as a data source for system sensors in Home Assistant. +Libre Hardware Monitor is a free, open‑source fork of Open Hardware Monitor that tracks temperatures, fan speeds, voltages, loads, and clock speeds on your computer.
30-39: Improve UI path formatting and preposition
Use "On Windows" with “>” navigation notation and bold UI elements for consistency:-1. In Windows, navigate to Control Panel, System and Security and Windows Defender Firewall. +1. On Windows, navigate to **Control Panel** > **System and Security** > **Windows Defender Firewall**.🧰 Tools
🪛 LanguageTool
[grammar] ~32-~32: The correct preposition appears to be “on”.
Context: ...o open a port (on Windows Firewall) 1. In Windows, navigate to Control Panel, Sys...(IN_WINDOWS)
43-48: Remove extra whitespace in YAML description
Theportdescription has two spaces after the colon—use a single space for consistency:- port: - description: The port of your Libre Hardware Monitor API. Defaults to 8085. + port: + description: The port of your Libre Hardware Monitor API. Defaults to 8085.
54-57: Clarify authentication limitation
Specify that HTTP authentication is unsupported to avoid ambiguity:-Currently, setting up authentication for the Libre Hardware Monitor remote web server is not supported. +Currently, HTTP authentication for the Libre Hardware Monitor remote web server is not supported.
59-65: Refine connection troubleshooting step
Reduce repetition and clarify the alternate device example:-On a device that is **not** the device running Libre Hardware Monitor (a smartphone is sufficient), open a browser and navigate to `http://<IP address>:<Port>`. +On a separate device (for example, a smartphone) that is **not** hosting Libre Hardware Monitor, open a browser and navigate to `http://<IP address>:<Port>`.
66-69: Use inline code for status
Replace quoted status with inline code to match Home Assistant style:-### Sensors change to "unavailable" status +### Sensors change to `unavailable` status
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/librehardwaremonitor.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/librehardwaremonitor.markdown
[grammar] ~32-~32: The correct preposition appears to be “on”.
Context: ...o open a port (on Windows Firewall) 1. In Windows, navigate to Control Panel, Sys...
(IN_WINDOWS)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (5)
source/_integrations/librehardwaremonitor.markdown (5)
22-29: Prerequisites are clear and comprehensive
The prerequisites section cleanly outlines installation, running service, remote web server activation, firewall port, and device selection steps. Nice work!
41-41: Configuration flow include is correctly referenced
Includingintegrations/config_flow.mdhere injects the standard config flow documentation. Looks good.
50-53: Configuration options section is clear
The guidance on grouping sensors and disabling unwanted entities via the UI is concise and helpful.
71-74: Integration stops working troubleshooting is sufficient
The instructions to verify IP stability and use a static address are clear and actionable.
75-80: Confirm trailing line or whitespace
Line 80 appears to be a stray line number or blank line—please confirm if this should be removed or if a purposeful blank line is intended.
aab0a08 to
1fddc44
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (9)
source/_integrations/librehardwaremonitor.markdown (9)
1-16: Consider adding asidebar_titlefor concise navigation
Adding asidebar_titlefrontmatter key can improve readability in the docs sidebar without affecting the full title.--- title: Libre Hardware Monitor +sidebar_title: Libre Hardware Monitor description: Instructions on how to integrate Libre Hardware Monitor within Home Assistant. ha_category: - System monitor ha_release: 2025.4 ... ---
18-19: Clarify integration description for readability
The sentence is accurate but somewhat verbose. Consider simplifying to reduce repetition of the integration name:- The **Libre Hardware Monitor** {% term integration %} uses your [Libre Hardware Monitor](https://github.com/LibreHardwareMonitor/LibreHardwareMonitor) installation as a source for sensors to display that system information in Home Assistant. + The **Libre Hardware Monitor** {% term integration %} uses your [Libre Hardware Monitor] installation to provide sensors that display system information in Home Assistant.
20-21: Improve second paragraph grammar and flow
Refine phrasing to clearly list monitored resources:- Libre Hardware Monitor, a fork of Open Hardware Monitor, is free software that can monitor the temperature sensors, fan speeds, voltages, load and clock speeds of your computer. + Libre Hardware Monitor is a free, open source fork of Open Hardware Monitor that tracks your computer’s temperature sensors, fan speeds, voltages, load, and clock speeds.
24-29: Refine prerequisites list phrasing
- Add missing commas after introductory clauses.
- Standardize phrasing for clarity.
- - Libre Hardware Monitor is installed on the system (host) you want to monitor. - - Libre Hardware Monitor must be running during setup. + - Libre Hardware Monitor must be installed on the host system you want to monitor. + - Libre Hardware Monitor must be running during setup. - - Make sure to open the inbound port (8085 by default) on the host system's firewall. + - Ensure the inbound port (8085 by default) is open on the host system’s firewall. - - In Libre Hardware Monitor go to **File** → **Hardware** and check the devices you want to monitor. + - In Libre Hardware Monitor, go to **File** → **Hardware**, and select the devices you want to monitor.
30-32: Rephrase Windows Firewall section for clarity
Use a gerund in the heading and standardize the preposition in step 1:- ### To open a port (on Windows Firewall) + ### Opening a port on Windows Firewall - 1. In Windows, navigate to **Control Panel** → **System and Security** → **Windows Defender Firewall**. + 1. On Windows, navigate to **Control Panel** → **System and Security** → **Windows Defender Firewall**.🧰 Tools
🪛 LanguageTool
[grammar] ~32-~32: The correct preposition appears to be “on”.
Context: ...o open a port (on Windows Firewall) 1. In Windows, navigate to Control Panel ...(IN_WINDOWS)
54-57: Consistent UI string formatting in Known Limitations
Consider bolding Remote web server here to match the style used in Prerequisites:- Currently, setting up authentication for the Libre Hardware Monitor remote web server is not supported. + Currently, setting up authentication for the Libre Hardware Monitor **Remote web server** is not supported.
62-64: Clarify device selection phrasing
Make the example flow smoother:- On a device that is **not** the device running Libre Hardware Monitor (a smartphone is sufficient), open a browser and navigate to `http://<IP address>:<Port>`. + On a device other than the one running Libre Hardware Monitor (for example, a smartphone), open a browser and navigate to `http://<IP address>:<Port>`.
68-69: Merge sentences in Sensors unavailable section
Combine for clearer flow:- This is expected behavior when the system you are monitoring is not reachable. Usually, because it is turned off. - Sensors will resume their data readings once the system is reachable again. + This usually occurs when the monitored system is not reachable, such as when it is turned off. Sensors will resume their data readings once connectivity is restored.
75-79: Refine removal section phrasing
A small tweak for grammatical correctness:- This integration follows standard integration removal. + This integration follows the standard integration removal process.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/librehardwaremonitor.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/librehardwaremonitor.markdown
[grammar] ~32-~32: The correct preposition appears to be “on”.
Context: ...o open a port (on Windows Firewall) 1. In Windows, navigate to Control Panel ...
(IN_WINDOWS)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (6)
source/_integrations/librehardwaremonitor.markdown (6)
33-39: Port opening steps look good
The numbered steps are clear, follow Home Assistant style, and use consistent UI string formatting.
41-41: Config flow macro inclusion
Includingintegrations/config_flow.mdcorrectly integrates the standard config flow instructions.
43-48: Validate configuration block formatting
Theconfiguration_basicsnippet is correctly formatted and consistent with other integrations.
50-53: Configuration options description
Instructions on disabling entities via the UI are clear and concise.
58-60: Troubleshooting section start
Headers and organization follow documentation standards.
71-74: Troubleshooting IP changes
Guidance to use a static IP is appropriate and aligns with best practices.
Proposed change
Added docs for new Libre Hardware Monitor integration.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
New Features
Documentation