Document sensors and diagnostic sensors in NUT #38163
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Caution Review failedThe pull request is closed. 📝 WalkthroughWalkthroughThe changes introduce a new "Supported functionality" section in the NUT integration documentation, detailing the capabilities of the integration by outlining available sensor metrics. This includes general sensors, such as alarms and battery charge, as well as diagnostic sensors like ambient temperature and battery capacity, each with descriptions. The previous "UPS Status - human-readable version" section has been removed, enhancing the document's clarity and organization. Changes
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (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 (4)
source/_integrations/nut.markdown (4)
50-57: New "Supported functionality" Section Introduced
The new section clearly introduces the supported sensors and diagnostic sensors for the NUT integration. The note block succinctly explains that only the available sensors (as reported by the NUT server) are added to Home Assistant.
Consider adding a brief explanation or a link to further details on what “variables” are (e.g., linking to the official NUT documentation) to further assist end users in understanding the scope.
58-81: Enhanced Sensors Documentation
The "Sensors" section now presents a clear description alongside a well-formatted table of available sensor types. The table is informative and covers a broad set of measurements.
- Suggestion: The "Watts" sensor (line 78) has an empty description. It may help users if a short explanation (e.g., "Power consumption" or similar) is added.
- Verification: Also, please verify that the sensor names are sorted alphabetically as indicated by the PR objectives.
83-96: Outlet Sensors Table Consistency
The table for outlet sensors is comprehensive and clearly outlines the sensor details for individual outlets.
- Suggestion: To fully align with the PR objective of alphabetical ordering, please double-check that the outlet sensor rows are arranged alphabetically by name.
97-112: Comprehensive Diagnostic Sensors Section
This section provides detailed information on diagnostic sensors, including guidance on which sensors are enabled by default and how to enable others. The accompanying note about "opaque by mfg" is especially helpful for understanding manufacturer-specific values.
- Suggestion: As with the "Sensors" section, consider verifying and, if necessary, reordering the diagnostic sensors in alphabetical order to maintain consistency with PR objectives.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
source/_integrations/nut.markdown (2)
58-82: Clear and Concise Sensors SectionThe "Sensors" subsection is well structured. It starts with a brief description and then presents a neatly formatted table listing the sensor name, unit, and description. One minor suggestion: consider adding a short description for the "Watts" sensor if a meaningful metric exists.
113-228: Comprehensive Diagnostic Sensors TableThis extensive table lists diagnostic sensors along with their units and descriptions. The alphabetical ordering (with minor grouping based on naming conventions) aids readability. As a nitpick, it might be worth reviewing individual sensor descriptions for completeness and consistency.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/nut.markdown(1 hunks)
🔇 Additional comments (4)
source/_integrations/nut.markdown (4)
50-57: New "Supported functionality" Section AddedThis block cleanly introduces the new section that outlines the capabilities of the NUT integration. The note block immediately provides context on how variables are retrieved from the NUT server. Overall, this addition enhances the documentation clarity.
83-96: Outlet Sensor Details and External ReferenceThe text following the sensors table clearly differentiates sensors provided per outlet and explains their specific utility. Including the link to the official NUT variable names documentation helps users find more detailed information.
97-111: Diagnostic Sensors Description and NoteThe diagnostic sensors section is introduced well. The description explains that these sensors are disabled by default (to reduce storage overhead) and the accompanying note clarifies the "opaque by mfg" terminology effectively.
229-235: Individually Monitored Outlet SensorsThe table for outlet-specific diagnostic sensors is clear and the use of backticks for the placeholder
nameimproves clarity. This small, focused table complements the main diagnostic sensors list very well.
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
source/_integrations/nut.markdown (2)
92-103: Clear Diagnostic Sensors Section with Minor TypoThe "Diagnostic sensors" section is well introduced with an important note that details the default-disabled state of most diagnostic sensors. Please fix the typo on line 98 ("diganostic") to "diagnostic" to maintain consistency.
-Most of this integration's diagnostic sensors are disabled by default -to reduce storage overhead for Home Assistant. The diganostic sensors +Most of this integration's diagnostic sensors are disabled by default +to reduce storage overhead for Home Assistant. The diagnostic sensors
111-225: Comprehensive Diagnostic Sensor List with Minor TyposThis section provides an extensive and detailed list of diagnostic sensors, which is valuable for users needing deep insights. A few minor corrections are suggested for clarity:
Line 116: Correct the spacing error in the phrase "t he thresholds".
- **Ambient temperature status**\*: Ambient temperature status relative to t he thresholds + **Ambient temperature status**\*: Ambient temperature status relative to the thresholdsLine 174: Remove the unnecessary comma for smoother reading.
- **Low battery voltage (V)**: Minimum battery voltage, that triggers FSD status + **Low battery voltage (V)**: Minimum battery voltage that triggers FSD statusAdditionally, please review any similar minor duplications flagged by static analysis (e.g., lines 68, 83–85, 170, and 218) to ensure consistency and clarity throughout the list.
🧰 Tools
🪛 LanguageTool
[grammar] ~115-~115: This phrase is duplicated. You should probably use “Ambient temperature” only once.
Context: ...holds - Ambient temperature (°C)*: Ambient temperature - Ambient temperature status*: Ambient temperature status ...(PHRASE_REPETITION)
[grammar] ~116-~116: Check that the noun ‘thresholds’ after the pronoun ‘he’ is correct. You may need to use a different part of speech, or use ‘the’ instead.
Context: ...mbient temperature status relative to t he thresholds - Apparent power (VA): Current valu...(PRP_VB)
[duplication] ~170-~170: Possible typo: you repeated a word.
Context: ... Interval to wait before restarting the load - Load shutdown timer (secs): Time before th...(ENGLISH_WORD_REPEAT_RULE)
[typographical] ~175-~175: Make sure that the comma (,) is correct. Do not use a comma before a dependent clause that starts with ‘that’.
Context: ...y voltage (V)**: Minimum battery voltage, that triggers FSD status - **Low voltage tra...(COMMA_THAT_NOUN)
[duplication] ~218-~218: Possible typo: you repeated a word.
Context: ...: Interval to wait before rebooting the UPS - UPS shutdown delay (secs): Interval to wa...(ENGLISH_WORD_REPEAT_RULE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/nut.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/nut.markdown
[duplication] ~68-~68: Possible typo: you repeated a word.
Context: ...nt - Input load (%): Load on (ePDU) input - Input voltage (V): Input voltage - **Load (...
(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~83-~83: Possible typo: you repeated a word.
Context: ...et NAME current (A)**: Current of named outlet - Outlet NAME description: Description of name...
(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~84-~84: Possible typo: you repeated a word.
Context: ...AME description**: Description of named outlet - Outlet NAME power (VA): Apparent power of na...
(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~85-~85: Possible typo: you repeated a word.
Context: ...E power (VA)**: Apparent power of named outlet - Outlet NAME real power (W): Real power of na...
(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~115-~115: This phrase is duplicated. You should probably use “Ambient temperature” only once.
Context: ...holds - Ambient temperature (°C)*: Ambient temperature - Ambient temperature status*: Ambient temperature status ...
(PHRASE_REPETITION)
[grammar] ~116-~116: Check that the noun ‘thresholds’ after the pronoun ‘he’ is correct. You may need to use a different part of speech, or use ‘the’ instead.
Context: ...mbient temperature status relative to t he thresholds - Apparent power (VA): Current valu...
(PRP_VB)
[duplication] ~170-~170: Possible typo: you repeated a word.
Context: ... Interval to wait before restarting the load - Load shutdown timer (secs): Time before th...
(ENGLISH_WORD_REPEAT_RULE)
[typographical] ~175-~175: Make sure that the comma (,) is correct. Do not use a comma before a dependent clause that starts with ‘that’.
Context: ...y voltage (V)**: Minimum battery voltage, that triggers FSD status - **Low voltage tra...
(COMMA_THAT_NOUN)
[duplication] ~218-~218: Possible typo: you repeated a word.
Context: ...: Interval to wait before rebooting the UPS - UPS shutdown delay (secs): Interval to wa...
(ENGLISH_WORD_REPEAT_RULE)
🔇 Additional comments (7)
source/_integrations/nut.markdown (7)
50-57: Add "Supported functionality" SectionThe new section clearly outlines the integration’s capabilities with an informative note block. The formatting is consistent with Home Assistant documentation standards and replaces the removed section appropriately.
58-61: Introduce "Sensors" SubsectionThe "Sensors" subsection is introduced clearly with a brief description that sets the context for the following sensor list. The content is succinct and meets the documentation objectives.
62-76: Organized Sensor ListThe sensors are presented in a bullet list that appears to be in alphabetical order, which aligns with the PR objective to organize them by name. The relationship between the virtual "Status" and its corresponding "Status data" sensor is also clearly explained.
🧰 Tools
🪛 LanguageTool
[duplication] ~68-~68: Possible typo: you repeated a word.
Context: ...nt - Input load (%): Load on (ePDU) input - Input voltage (V): Input voltage - **Load (...(ENGLISH_WORD_REPEAT_RULE)
80-87: Outlet Sensor DetailsThe outlet sensors use "Outlet NAME" as a placeholder effectively, indicating that these items are dynamically created based on configuration. This approach is clear and user friendly.
🧰 Tools
🪛 LanguageTool
[duplication] ~83-~83: Possible typo: you repeated a word.
Context: ...et NAME current (A)**: Current of named outlet - Outlet NAME description: Description of name...(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~84-~84: Possible typo: you repeated a word.
Context: ...AME description**: Description of named outlet - Outlet NAME power (VA): Apparent power of na...(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~85-~85: Possible typo: you repeated a word.
Context: ...E power (VA)**: Apparent power of named outlet - Outlet NAME real power (W): Real power of na...(ENGLISH_WORD_REPEAT_RULE)
88-91: Additional Information with Documentation LinkThis note provides a helpful link to official variable names documentation, enhancing user understanding regarding the available sensor values. The reference is clear and well integrated.
105-109: Diagnostic Sensor Value NoteThe note block explaining manufacturer-specific ("opaque by mfg") sensor values is concise and helpful. It clearly informs users about potential variations, which is important for troubleshooting.
226-229: Outlet Diagnostic SensorsThe additional diagnostic sensor for individually monitored outlets is separated into its own section. The use of the "Outlet NAME" placeholder continues to clearly signal dynamically generated sensor names, which maintains consistency with the rest of the documentation.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
source/_integrations/nut.markdown (3)
58-91: Sensors Subsection Enhancement
This subsection provides a comprehensive list of available sensors. A couple of minor improvements to consider:
- For Input load (%) (line 68), the phrase "Load on (ePDU) input" may be refined to avoid any ambiguity for some readers.
- In the outlet sensor entries (lines 83–86), the repeated use of "named outlet" could be streamlined—for example, by rephrasing to "Current measured" and "Outlet description" to reduce redundancy.
🧰 Tools
🪛 LanguageTool
[duplication] ~68-~68: Possible typo: you repeated a word.
Context: ...nt - Input load (%): Load on (ePDU) input - Input voltage (V): Input voltage - **Load (...(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~83-~83: Possible typo: you repeated a word.
Context: ...et NAME current (A)**: Current of named outlet - Outlet NAME description: Description of name...(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~84-~84: Possible typo: you repeated a word.
Context: ...AME description**: Description of named outlet - Outlet NAME power (VA): Apparent power of na...(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~85-~85: Possible typo: you repeated a word.
Context: ...E power (VA)**: Apparent power of named outlet - Outlet NAME real power (W): Real power of na...(ENGLISH_WORD_REPEAT_RULE)
113-116: Ambient Temperature Sensor Descriptions
The descriptions for Ambient temperature (°C) and Ambient temperature status are clear but a bit repetitive. Consider rephrasing them to, for example, "Measured ambient temperature" and "Temperature status relative to thresholds" to tighten the language.🧰 Tools
🪛 LanguageTool
[grammar] ~115-~115: This phrase is duplicated. You should probably use “Ambient temperature” only once.
Context: ...holds - Ambient temperature (°C)*: Ambient temperature - Ambient temperature status*: Ambient temperature status ...(PHRASE_REPETITION)
168-171: Refine Delay Sensor Wording
For sensors such as Load restart delay (secs) (line 169) and UPS reboot delay (secs) (line 217), the descriptive phrasing ("Interval to wait before…") is a bit redundant when paired with the sensor names. A more concise wording (e.g., "Time before restart" or "Reboot wait time") could improve clarity.Also applies to: 217-218
🧰 Tools
🪛 LanguageTool
[duplication] ~169-~169: Possible typo: you repeated a word.
Context: ... Interval to wait before restarting the load - Load shutdown timer (secs): Time before th...(ENGLISH_WORD_REPEAT_RULE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/nut.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/nut.markdown
[duplication] ~68-~68: Possible typo: you repeated a word.
Context: ...nt - Input load (%): Load on (ePDU) input - Input voltage (V): Input voltage - **Load (...
(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~83-~83: Possible typo: you repeated a word.
Context: ...et NAME current (A)**: Current of named outlet - Outlet NAME description: Description of name...
(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~84-~84: Possible typo: you repeated a word.
Context: ...AME description**: Description of named outlet - Outlet NAME power (VA): Apparent power of na...
(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~85-~85: Possible typo: you repeated a word.
Context: ...E power (VA)**: Apparent power of named outlet - Outlet NAME real power (W): Real power of na...
(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~115-~115: This phrase is duplicated. You should probably use “Ambient temperature” only once.
Context: ...holds - Ambient temperature (°C)*: Ambient temperature - Ambient temperature status*: Ambient temperature status ...
(PHRASE_REPETITION)
[duplication] ~169-~169: Possible typo: you repeated a word.
Context: ... Interval to wait before restarting the load - Load shutdown timer (secs): Time before th...
(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~217-~217: Possible typo: you repeated a word.
Context: ...: Interval to wait before rebooting the UPS - UPS shutdown delay (secs): Interval to wa...
(ENGLISH_WORD_REPEAT_RULE)
🔇 Additional comments (4)
source/_integrations/nut.markdown (4)
50-51: New Section Addition: "Supported functionality"
The addition of the "Supported functionality" section clearly groups sensor-related details for the NUT integration, enhancing the overall organization and readability of the documentation.
52-56: Note Block Clarity
The note block explains that the integration only adds sensors available on your device via the NUT protocol. It’s concise and informative.
92-110: Diagnostic Sensors Section Structure
The "Diagnostic sensors" section is well organized. The note blocks clearly state that most diagnostic sensors are disabled by default and explain the manufacturer-specific ("opaque by mfg") values, which is very helpful for users.
290-295: Overall Documentation Consistency
The updated documentation overall adheres well to Home Assistant’s standards. The segmentation into supported devices, functionality, sensor categories, and diagnostic sensors is logical. Please verify that the ordering (alphabetically or by grouping) of sensor entries aligns with both the official NUT documentation and Home Assistant’s guidelines.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
source/_integrations/nut.markdown (4)
67-74: New "Supported functionality" section added.
The new section clearly introduces the available sensors and diagnostic sensors. The note block (lines 69–73) provides useful context on how the NUT protocol is used to retrieve variables. Please verify that the terminology and references align with the Home Assistant documentation style and that any links (if added later) are current.
75-104: "Sensors" section review for clarity and consistency.
The comprehensive list of sensor metrics is well organized. A few points to consider:
- Input load (%) (line 85): The description "Load on (ePDU) input" might be rephrased for enhanced clarity and to clearly differentiate it from Load (%) on line 87. For example, consider something like "Measured load on the ePDU input."
- The dual listing of Status and Status data (lines 91–92) is informative; however, a brief note explaining why both are included (i.e. one being a human-readable translation of the other) could further assist users.
- The use of "NAME" as a placeholder in outlet sensors (lines 100–103) is appropriate provided that other documentation clarifies how users should replace it with the actual outlet name.
🧰 Tools
🪛 LanguageTool
[duplication] ~85-~85: Possible typo: you repeated a word.
Context: ...nt - Input load (%): Load on (ePDU) input - Input voltage (V): Input voltage - **Load (...(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~100-~100: Possible typo: you repeated a word.
Context: ...et NAME current (A)**: Current of named outlet - Outlet NAME description: Description of name...(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~101-~101: Possible typo: you repeated a word.
Context: ...AME description**: Description of named outlet - Outlet NAME power (VA): Apparent power of na...(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~102-~102: Possible typo: you repeated a word.
Context: ...E power (VA)**: Apparent power of named outlet - Outlet NAME real power (W): Real power of na...(ENGLISH_WORD_REPEAT_RULE)
85-85: Review sensor description wording (Input load).
LanguageTool flagged a possible duplication or redundancy in the description for Input load (%) ("Load on (ePDU) input"). Consider rephrasing it (for example, "Measured load on the ePDU input") to ensure clarity and avoid any potential confusion.🧰 Tools
🪛 LanguageTool
[duplication] ~85-~85: Possible typo: you repeated a word.
Context: ...nt - Input load (%): Load on (ePDU) input - Input voltage (V): Input voltage - **Load (...(ENGLISH_WORD_REPEAT_RULE)
100-103: Verify language consistency in outlet sensor descriptions.
Static analysis noted potential duplication in wording for the outlet sensor descriptions (e.g., "Current of named outlet" and "Description of named outlet"). This repetition appears intentional to maintain clarity. Please review and adjust only if a more concise wording is available.🧰 Tools
🪛 LanguageTool
[duplication] ~100-~100: Possible typo: you repeated a word.
Context: ...et NAME current (A)**: Current of named outlet - Outlet NAME description: Description of name...(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~101-~101: Possible typo: you repeated a word.
Context: ...AME description**: Description of named outlet - Outlet NAME power (VA): Apparent power of na...(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~102-~102: Possible typo: you repeated a word.
Context: ...E power (VA)**: Apparent power of named outlet - Outlet NAME real power (W): Real power of na...(ENGLISH_WORD_REPEAT_RULE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/nut.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/nut.markdown
[duplication] ~85-~85: Possible typo: you repeated a word.
Context: ...nt - Input load (%): Load on (ePDU) input - Input voltage (V): Input voltage - **Load (...
(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~100-~100: Possible typo: you repeated a word.
Context: ...et NAME current (A)**: Current of named outlet - Outlet NAME description: Description of name...
(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~101-~101: Possible typo: you repeated a word.
Context: ...AME description**: Description of named outlet - Outlet NAME power (VA): Apparent power of na...
(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~102-~102: Possible typo: you repeated a word.
Context: ...E power (VA)**: Apparent power of named outlet - Outlet NAME real power (W): Real power of na...
(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~132-~132: This phrase is duplicated. You should probably use “Ambient temperature” only once.
Context: ...holds - Ambient temperature (°C)*: Ambient temperature - Ambient temperature status*: Ambient temperature status ...
(PHRASE_REPETITION)
[duplication] ~186-~186: Possible typo: you repeated a word.
Context: ... Interval to wait before restarting the load - Load shutdown timer (secs): Time before th...
(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~234-~234: Possible typo: you repeated a word.
Context: ...: Interval to wait before rebooting the UPS - UPS shutdown delay (secs): Interval to wa...
(ENGLISH_WORD_REPEAT_RULE)
🔇 Additional comments (1)
source/_integrations/nut.markdown (1)
109-127: "Diagnostic sensors" section review.
The diagnostic sensors section is clear and informative. The {% important %} block (lines 113–120) and the subsequent note (lines 122–126) both provide helpful guidance about sensor availability and the "opaque by mfg" terminology. Verify that the provided link to the [enabling or disabling entities] documentation (/common-tasks/general/#enabling-or-disabling-entities) is correct and maintained.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
source/_integrations/nut.markdown (4)
67-74: Enhancement of "Supported functionality" section.
The new section is clear and well-structured. The {% note %} block provides a concise explanation regarding sensor retrieval from the NUT server. For even better context, consider adding an introductory sentence that briefly summarizes the overall capabilities before detailing the sensor lists.
97-104: Clarification on dynamic outlet sensor labels.
The use of "Outlet NAME" effectively indicates a placeholder for dynamically generated sensor names. For improved clarity, consider adding a brief inline note (or a remark in the documentation) specifying that "NAME" should be replaced with the actual outlet identifier.🧰 Tools
🪛 LanguageTool
[duplication] ~100-~100: Possible typo: you repeated a word.
Context: ...et NAME current (A)**: Current of named outlet - Outlet NAME description: Description of name...(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~101-~101: Possible typo: you repeated a word.
Context: ...AME description**: Description of named outlet - Outlet NAME power (VA): Apparent power of na...(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~102-~102: Possible typo: you repeated a word.
Context: ...E power (VA)**: Apparent power of named outlet - Outlet NAME real power (W): Real power of na...(ENGLISH_WORD_REPEAT_RULE)
100-103: Nitpick on outlet sensor descriptions.
For entries like “Outlet NAME current (A): Current of named outlet”, consider streamlining the wording to avoid redundancy (for example, “Current for outlet [NAME]”). This minor change could enhance readability without altering meaning.🧰 Tools
🪛 LanguageTool
[duplication] ~100-~100: Possible typo: you repeated a word.
Context: ...et NAME current (A)**: Current of named outlet - Outlet NAME description: Description of name...(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~101-~101: Possible typo: you repeated a word.
Context: ...AME description**: Description of named outlet - Outlet NAME power (VA): Apparent power of na...(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~102-~102: Possible typo: you repeated a word.
Context: ...E power (VA)**: Apparent power of named outlet - Outlet NAME real power (W): Real power of na...(ENGLISH_WORD_REPEAT_RULE)
131-133: Nitpick on "Ambient temperature" entries.
The entries for "Ambient temperature (°C)" and "Ambient temperature status" are clear; however, the description for the basic temperature sensor is very terse and may seem repetitive alongside its status description. Consider elaborating or rephrasing the first entry to better differentiate between the raw value and its status.🧰 Tools
🪛 LanguageTool
[grammar] ~132-~132: This phrase is duplicated. You should probably use “Ambient temperature” only once.
Context: ...high` - Ambient temperature (°C)*: Ambient temperature - Ambient temperature status*: Ambient temperature status ...(PHRASE_REPETITION)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/nut.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/nut.markdown
[duplication] ~85-~85: Possible typo: you repeated a word.
Context: ...nt - Input load (%): Load on (ePDU) input - Input voltage (V): Input voltage - **Load (...
(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~100-~100: Possible typo: you repeated a word.
Context: ...et NAME current (A)**: Current of named outlet - Outlet NAME description: Description of name...
(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~101-~101: Possible typo: you repeated a word.
Context: ...AME description**: Description of named outlet - Outlet NAME power (VA): Apparent power of na...
(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~102-~102: Possible typo: you repeated a word.
Context: ...E power (VA)**: Apparent power of named outlet - Outlet NAME real power (W): Real power of na...
(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~132-~132: This phrase is duplicated. You should probably use “Ambient temperature” only once.
Context: ...high` - Ambient temperature (°C)*: Ambient temperature - Ambient temperature status*: Ambient temperature status ...
(PHRASE_REPETITION)
[duplication] ~186-~186: Possible typo: you repeated a word.
Context: ... Interval to wait before restarting the load - Load shutdown timer (secs): Time before th...
(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~234-~234: Possible typo: you repeated a word.
Context: ...: Interval to wait before rebooting the UPS - UPS shutdown delay (secs): Interval to wa...
(ENGLISH_WORD_REPEAT_RULE)
⏰ 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/nut.markdown (5)
75-96: "Sensors" section approval.
The breakdown and descriptions in this section are clear and appropriately formatted. The clarification regarding the "Status" sensor is especially useful. Ensure that future updates maintain consistency across similar sensor entries.🧰 Tools
🪛 LanguageTool
[duplication] ~85-~85: Possible typo: you repeated a word.
Context: ...nt - Input load (%): Load on (ePDU) input - Input voltage (V): Input voltage - **Load (...(ENGLISH_WORD_REPEAT_RULE)
105-108: Additional information note is on point.
Linking to the NUT variable names documentation gives users additional context. Just ensure that the linked page remains current with any upstream changes.
109-120: Diagnostic sensors introduction review.
The {% important %} block clearly indicates that diagnostic sensors are disabled by default and explains how to enable them. This meets documentation standards and is valuable for users.
122-126: "Opaque by mfg" note feedback.
The note regarding manufacturer-dependent values is concise and appropriately informs users about potential variability.
233-234:⚠️ Potential issueCritical: Correct the delay description for UPS shutdown.
The description for "UPS shutdown delay (secs)" mistakenly reads “Interval to wait before rebooting the UPS,” which appears to be a copy-paste error. It should specify the delay related to shutting down the UPS. Please update it as suggested below.- - **UPS shutdown delay (secs)**: Interval to wait before rebooting the UPS + - **UPS shutdown delay (secs)**: Interval to wait after issuing a shutdown command to the UPSLikely an incorrect or invalid review comment.
🧰 Tools
🪛 LanguageTool
[duplication] ~234-~234: Possible typo: you repeated a word.
Context: ...: Interval to wait before rebooting the UPS - UPS shutdown delay (secs): Interval to wa...(ENGLISH_WORD_REPEAT_RULE)
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (4)
source/_integrations/nut.markdown (4)
108-140: Comprehensive Sensor List Added
The new sensor list provides detailed and clear descriptions that align well with the PR objectives. Please verify that all sensor names and descriptions are consistent with the naming conventions used elsewhere in the documentation, particularly for dynamic outlet sensors and the special "Status" sensor.🧰 Tools
🪛 LanguageTool
[duplication] ~118-~118: Possible typo: you repeated a word.
Context: ...nt - Input load (%): Load on (ePDU) input - Input voltage (V): Input voltage - **Load (...(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~133-~133: Possible typo: you repeated a word.
Context: ...et NAME current (A)**: Current of named outlet - Outlet NAME description: Description of name...(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~134-~134: Possible typo: you repeated a word.
Context: ...AME description**: Description of named outlet - Outlet NAME power (VA): Apparent power of na...(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~135-~135: Possible typo: you repeated a word.
Context: ...E power (VA)**: Apparent power of named outlet - Outlet NAME real power (W): Real power of na...(ENGLISH_WORD_REPEAT_RULE)
118-136: Review Sensor Description Redundancy
Some of the sensor descriptions (for example, the phrasing in Input load (%) and the outlet sensor items) seem somewhat repetitive. A minor rewording to eliminate redundant expressions can enhance readability without sacrificing clarity.🧰 Tools
🪛 LanguageTool
[duplication] ~118-~118: Possible typo: you repeated a word.
Context: ...nt - Input load (%): Load on (ePDU) input - Input voltage (V): Input voltage - **Load (...(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~133-~133: Possible typo: you repeated a word.
Context: ...et NAME current (A)**: Current of named outlet - Outlet NAME description: Description of name...(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~134-~134: Possible typo: you repeated a word.
Context: ...AME description**: Description of named outlet - Outlet NAME power (VA): Apparent power of na...(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~135-~135: Possible typo: you repeated a word.
Context: ...E power (VA)**: Apparent power of named outlet - Outlet NAME real power (W): Real power of na...(ENGLISH_WORD_REPEAT_RULE)
142-159: Diagnostic Sensors Section is Clear and Informative
The diagnostic sensors section is well structured, using both the important and note blocks to emphasize key details (such as which sensors are disabled by default and the meaning of "opaque by mfg"). One suggestion is to review the wording for the ambient temperature sensors—slightly rephrasing the descriptions for Ambient temperature (°C) and Ambient temperature status might help avoid any perceived redundancy.
268-269: Clarify UPS Delay Sensor Descriptions
The descriptions for UPS reboot delay (secs) ("Interval to wait before rebooting the UPS") and UPS shutdown delay (secs) ("Interval to wait after shutdown with delay command") are quite similar. Consider differentiating them further to clearly indicate their distinct purposes.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/nut.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/nut.markdown
[duplication] ~118-~118: Possible typo: you repeated a word.
Context: ...nt - Input load (%): Load on (ePDU) input - Input voltage (V): Input voltage - **Load (...
(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~133-~133: Possible typo: you repeated a word.
Context: ...et NAME current (A)**: Current of named outlet - Outlet NAME description: Description of name...
(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~134-~134: Possible typo: you repeated a word.
Context: ...AME description**: Description of named outlet - Outlet NAME power (VA): Apparent power of na...
(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~135-~135: Possible typo: you repeated a word.
Context: ...E power (VA)**: Apparent power of named outlet - Outlet NAME real power (W): Real power of na...
(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~165-~165: This phrase is duplicated. You should probably use “Ambient temperature” only once.
Context: ...high` - Ambient temperature (°C)*: Ambient temperature - Ambient temperature status*: Ambient temperature status ...
(PHRASE_REPETITION)
[duplication] ~219-~219: Possible typo: you repeated a word.
Context: ... Interval to wait before restarting the load - Load shutdown timer (secs): Time before th...
(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~267-~267: Possible typo: you repeated a word.
Context: ...: Interval to wait before rebooting the UPS - UPS shutdown delay (secs): Interval to wa...
(ENGLISH_WORD_REPEAT_RULE)
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/nut.markdown
100-100: Multiple headings with the same content
null
(MD024, no-duplicate-heading)
source/_integrations/nut.markdown
Outdated
| ## Supported functionality | ||
|
|
||
| {% note %} | ||
| This NUT integration uses the NUT protocol to retrieve "variables" | ||
| from the NUT server. Only sensors and diagnostic sensors available for | ||
| your device are added to Home Assistant. | ||
| {% endnote %} | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Duplicate Heading Detected: "Supported functionality"
It appears that a "Supported functionality" section already exists earlier in the document (around line 66). Duplicating this heading may confuse readers and trigger markdownlint warnings. Consider merging the two sections or renaming one to ensure clear, distinct sections.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
100-100: Multiple headings with the same content
null
(MD024, no-duplicate-heading)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
source/_integrations/nut.markdown (5)
68-72: Review Note Block for Supported Functionality
The note block clearly explains that the integration uses the NUT protocol to retrieve “variables” and that only the available sensors and diagnostic sensors for the device are added to Home Assistant. Please double-check that this information isn’t redundant with other sections and that its placement avoids any potential confusion with existing documentation.
83-112: Review Sensors Section for Clarity and Consistency
The Sensors section is well structured and uses a clean bullet list. However, several sensor descriptions appear to have slight duplications or repeated phrasing (e.g. around line 93 for Input load (%) and the outlet sensor entries at lines 108–110). Please review these descriptions for clarity and consider rephrasing to avoid any redundancy.🧰 Tools
🪛 LanguageTool
[duplication] ~93-~93: Possible typo: you repeated a word.
Context: ...nt - Input load (%): Load on (ePDU) input - Input voltage (V): Input voltage - **Load (...(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~108-~108: Possible typo: you repeated a word.
Context: ...et NAME current (A)**: Current of named outlet - Outlet NAME description: Description of name...(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~109-~109: Possible typo: you repeated a word.
Context: ...AME description**: Description of named outlet - Outlet NAME power (VA): Apparent power of na...(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~110-~110: Possible typo: you repeated a word.
Context: ...E power (VA)**: Apparent power of named outlet - Outlet NAME real power (W): Real power of na...(ENGLISH_WORD_REPEAT_RULE)
130-135: Review Diagnostic Sensors - Manufacturer Note
The note regarding the “opaque by mfg” values is concise; however, static analysis hints indicate there may be duplicated phrasing (for instance, around the Ambient temperature descriptions in subsequent lines). It would be beneficial to re-read the text for any repetitions and adjust as necessary for maximum clarity.
136-248: Review Detailed Diagnostic Sensors List for Duplicated Phrasing
This list is comprehensive and well organized. That said, static analysis flags several potential duplications or repeated words (e.g., at line ~140 with “Ambient temperature”, at ~194 with “Load restart delay”, and at ~242 with “UPS reboot delay”). Please review these entries to ensure consistent phrasing and remove any unnecessary repetition.🧰 Tools
🪛 LanguageTool
[grammar] ~140-~140: This phrase is duplicated. You should probably use “Ambient temperature” only once.
Context: ...high` - Ambient temperature (°C)*: Ambient temperature - Ambient temperature status*: Ambient temperature status ...(PHRASE_REPETITION)
[duplication] ~194-~194: Possible typo: you repeated a word.
Context: ... Interval to wait before restarting the load - Load shutdown timer (secs): Time before th...(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~242-~242: Possible typo: you repeated a word.
Context: ...: Interval to wait before rebooting the UPS - UPS shutdown delay (secs): Interval to wa...(ENGLISH_WORD_REPEAT_RULE)
250-254: Review Outlet Diagnostic Sensors Section
The subsection regarding diagnostic sensors for individually monitored outlets is formatted consistently with the rest of the document. Verify if any wording overlaps with other similar entries and adjust accordingly to maintain clarity throughout the document.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/nut.markdown(2 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/nut.markdown
[duplication] ~93-~93: Possible typo: you repeated a word.
Context: ...nt - Input load (%): Load on (ePDU) input - Input voltage (V): Input voltage - **Load (...
(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~108-~108: Possible typo: you repeated a word.
Context: ...et NAME current (A)**: Current of named outlet - Outlet NAME description: Description of name...
(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~109-~109: Possible typo: you repeated a word.
Context: ...AME description**: Description of named outlet - Outlet NAME power (VA): Apparent power of na...
(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~110-~110: Possible typo: you repeated a word.
Context: ...E power (VA)**: Apparent power of named outlet - Outlet NAME real power (W): Real power of na...
(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~140-~140: This phrase is duplicated. You should probably use “Ambient temperature” only once.
Context: ...high` - Ambient temperature (°C)*: Ambient temperature - Ambient temperature status*: Ambient temperature status ...
(PHRASE_REPETITION)
[duplication] ~194-~194: Possible typo: you repeated a word.
Context: ... Interval to wait before restarting the load - Load shutdown timer (secs): Time before th...
(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~242-~242: Possible typo: you repeated a word.
Context: ...: Interval to wait before rebooting the UPS - UPS shutdown delay (secs): Interval to wa...
(ENGLISH_WORD_REPEAT_RULE)
🔇 Additional comments (1)
source/_integrations/nut.markdown (1)
117-128: Check Diagnostic Sensors - Important Note Formatting
The “Important” block in the Diagnostic Sensors section is clearly defined and informative, highlighting that most diagnostic sensors are disabled by default. Ensure that the wording and markdown formatting are consistent with the Home Assistant documentation standards.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (7)
source/_integrations/nut.markdown (7)
68-72: Clarify Note Block Details
The note block clearly states that the integration uses the NUT protocol to retrieve sensor variables. To further aid the reader, consider adding a brief mention that sensor availability may vary across different devices and to consult the diagnostic sensors section for additional configuration details.
83-104: Ensure Consistency in Sensor Descriptions
The "Sensors" section provides a solid, itemized list. However, a couple of descriptions (e.g., "Input load (%)" and "Input voltage (V)") use similar phrasing. Please double-check that each description is uniquely clear and, if possible, rephrase repeated patterns for better consistency and readability.🧰 Tools
🪛 LanguageTool
[duplication] ~93-~93: Possible typo: you repeated a word.
Context: ...nt - Input load (%): Load on (ePDU) input - Input voltage (V): Input voltage - **Load (...(ENGLISH_WORD_REPEAT_RULE)
105-112: Outlet Sensor Descriptions
The list of outlet sensors is detailed and organized, which is great. There is, however, some repeated wording such as “named outlet” across the items. You might streamline these descriptions for brevity and clarity—for example, by omitting redundant words where context is clear.🧰 Tools
🪛 LanguageTool
[duplication] ~108-~108: Possible typo: you repeated a word.
Context: ...et NAME current (A)**: Current of named outlet - Outlet NAME description: Description of name...(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~109-~109: Possible typo: you repeated a word.
Context: ...AME description**: Description of named outlet - Outlet NAME power (VA): Apparent power of na...(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~110-~110: Possible typo: you repeated a word.
Context: ...E power (VA)**: Apparent power of named outlet - Outlet NAME real power (W): Real power of na...(ENGLISH_WORD_REPEAT_RULE)
138-141: Review Ambient Sensor Descriptions
Both the "Ambient temperature (°C)" and "Ambient temperature status" entries mention similar terminology. It may be beneficial to rephrase one of these (for example, clarifying one as the actual temperature reading and the other as its status evaluation) to avoid redundancy and to improve clarity.🧰 Tools
🪛 LanguageTool
[grammar] ~140-~140: This phrase is duplicated. You should probably use “Ambient temperature” only once.
Context: ...high` - Ambient temperature (°C)*: Ambient temperature - Ambient temperature status*: Ambient temperature status ...(PHRASE_REPETITION)
142-249: Diagnostic Sensor Descriptions Consistency
The diagnostic sensor list is comprehensive; however, several entries seem to use repetitive phrasings (such as repeated references to "Battery" or "Input"). A review to streamline these descriptions can enhance clarity and reduce redundancy. Considering the static analysis hints, a slight rewording may help ensure each sensor’s description is both succinct and distinct.🧰 Tools
🪛 LanguageTool
[duplication] ~194-~194: Possible typo: you repeated a word.
Context: ... Interval to wait before restarting the load - Load shutdown timer (secs): Time before th...(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~242-~242: Possible typo: you repeated a word.
Context: ...: Interval to wait before rebooting the UPS - UPS shutdown delay (secs): Interval to wa...(ENGLISH_WORD_REPEAT_RULE)
242-242: UPS Reboot Delay Description
The description for UPS reboot delay (secs) appears to have duplicated wording, which might affect clarity. A brief rewording to make it more concise would be beneficial.🧰 Tools
🪛 LanguageTool
[duplication] ~242-~242: Possible typo: you repeated a word.
Context: ...: Interval to wait before rebooting the UPS - UPS shutdown delay (secs): Interval to wa...(ENGLISH_WORD_REPEAT_RULE)
31-35: Overall Documentation Structure
The revised document structure comprehensively covers the NUT integration's capabilities in a clear and organized manner. Please ensure that the new "Supported functionality" section does not duplicate or conflict with other sections (as previously cautioned by reviewers regarding duplicate headings). If any overlap exists, consider merging the relevant information to maintain a single source of truth.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/nut.markdown(2 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/nut.markdown
[duplication] ~93-~93: Possible typo: you repeated a word.
Context: ...nt - Input load (%): Load on (ePDU) input - Input voltage (V): Input voltage - **Load (...
(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~108-~108: Possible typo: you repeated a word.
Context: ...et NAME current (A)**: Current of named outlet - Outlet NAME description: Description of name...
(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~109-~109: Possible typo: you repeated a word.
Context: ...AME description**: Description of named outlet - Outlet NAME power (VA): Apparent power of na...
(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~110-~110: Possible typo: you repeated a word.
Context: ...E power (VA)**: Apparent power of named outlet - Outlet NAME real power (W): Real power of na...
(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~140-~140: This phrase is duplicated. You should probably use “Ambient temperature” only once.
Context: ...high` - Ambient temperature (°C)*: Ambient temperature - Ambient temperature status*: Ambient temperature status ...
(PHRASE_REPETITION)
[duplication] ~194-~194: Possible typo: you repeated a word.
Context: ... Interval to wait before restarting the load - Load shutdown timer (secs): Time before th...
(ENGLISH_WORD_REPEAT_RULE)
[duplication] ~242-~242: Possible typo: you repeated a word.
Context: ...: Interval to wait before rebooting the UPS - UPS shutdown delay (secs): Interval to wa...
(ENGLISH_WORD_REPEAT_RULE)
🔇 Additional comments (1)
source/_integrations/nut.markdown (1)
117-134: Clear Diagnostic Sensors Section
The "Diagnostic sensors" section is well structured with important usage notes and a clear explanation regarding default disablement. The inclusion of a link to the enabling/disabling entities documentation is helpful. Please verify that this link remains up-to-date with the current Home Assistant guidelines.
|
Nice addition to the docs! |
* Document sensors and diagnostic sensors * Fix list of diagnostic sensors enabled by default * Fix capitalization of L1/L2/L3 and N * Change sensors from table to list * Fix special formatting and other lcleanup * Fix coderabbit nitpick suggestions * List available states for ambient humidity/temperature status * Complete manual merge from 'current' into document-sensors * Add states where defined; fix incorrect units on Input Frequency Status * tiny tweak --------- Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
Proposed change
The current instructions for NUT do not generally define the sensors or diagnostic sensors. Add a new "Supported functionality" section and sub-sections for both "Sensors" and "Diagnostic sensors". Create lists of all available sensors including the name, units (if specified) and a brief description. Use the NUT documentation as the brief description as much as possible to avoid confusing users, though those descriptions are not always the most helpful.
Move and rewrite the special "Status" virtual sensor description for easier readability.
Dynamically created sensors per outlet are listed separately since the name is based on the end user's configuration. Provide a link to the official NUT document describing variable names.
For diagnostic sensors, explain that most sensors are disabled by default and provide a link to instructions for enabling a sensor. Use same terminology for consistency with NUT documentation. Include a note regarding "opaque by mfg" used in the NUT documentation.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
Summary by CodeRabbit