Add known limitations to NUT #38388

tdfountain · 2025-04-04T23:06:54Z

Proposed change

The NUT integration doc lacks a known limitations section. This PR creates a new "Known limitations" section and describes the functionality supported by a NUT server but not supported by this NUT integration. This new "Known limitations" section also further reinforces that this integration does not install the NUT package.

Additionally, added to existing introduction an explanation that this integrations interacts with a NUT server and not directly with a power device.

Type of change

Spelling, grammar or other readability improvements (current branch).
Adjusted missing or incorrect information in the current documentation (current branch).
Added documentation for a new integration I'm adding to Home Assistant (next branch).
- I've opened up a PR to add logos and icons in Brands repository.
Added documentation for a new feature I'm adding to Home Assistant (next branch).
Removed stale or deprecated documentation.

Additional information

Link to parent pull request in the codebase:
Link to parent pull request in the Brands repository:
This PR fixes or closes issue: fixes #

Checklist

This PR uses the correct branch, based on one of the following:
- I made a change to the existing documentation and used the current branch.
- I made a change that is related to an upcoming version of Home Assistant and used the next branch.
The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

Documentation
- Added a "Known limitations" section to the NUT integration guide.
- Detailed current constraints regarding supported NUT variables and commands.
- Clarified that the integration uses a NUT server for device communication.

netlify · 2025-04-04T23:07:11Z

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	`7ab8609`
🔍 Latest deploy log	https://app.netlify.com/sites/home-assistant-docs/deploys/680260674aeeb500083c04b8
😎 Deploy Preview	https://deploy-preview-38388--home-assistant-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

coderabbitai · 2025-04-04T23:10:03Z

📝 Walkthrough

Walkthrough

The update adds a new "Known limitations" section to the NUT integration documentation. The section details that the integration supports only a subset of NUT variables and commands, does not permit setting variables, and excludes commands that require parameters. It also clarifies that the integration communicates with a NUT server (which interacts with power devices) rather than managing devices directly or installing the server within Home Assistant.

Changes

File	Change Summary
source/_integrations/nut.markdown	Added a "Known limitations" section outlining limitations regarding supported NUT variables, commands (including parameter-requiring commands), and integration behaviors.

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)

We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0476f04 and 7ab8609.

📒 Files selected for processing (1)

source/_integrations/nut.markdown (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

source/_integrations/nut.markdown

⏰ 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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

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)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

source/_integrations/nut.markdown (1)

100-116: Clear and Informative "Known limitations" Section

This new section clearly and concisely documents the limitations of the NUT integration, which aligns well with the PR objectives. The bullet list format makes each limitation easy to parse, and the text accurately communicates that only a subset of NUT functionality is supported.

A small stylistic suggestion: for consistency and enhanced clarity, consider wrapping key terms such as variables and commands in backticks (i.e. `variables` and `commands`) if similar formatting is used elsewhere in the documentation.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9a5da07 and 0c3d4bf.

📒 Files selected for processing (1)

source/_integrations/nut.markdown (1 hunks)

source/_integrations/nut.markdown

home-assistant · 2025-04-05T10:22:16Z

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

source/_integrations/nut.markdown (1)

104-123: Addition of Known Limitations Section

The new "Known limitations" section comprehensively outlines what NUT functionality is unsupported (e.g., a subset of "variables" and "commands", lack of support for setting variables and commands requiring parameters) and clarifies that the integration does not install the NUT server. For additional clarity, consider including a reference link to the official NUT documentation for users seeking more detailed information on supported features.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0c3d4bf and 30a9cb6.

📒 Files selected for processing (1)

source/_integrations/nut.markdown (2 hunks)

🔇 Additional comments (1)

source/_integrations/nut.markdown (1)

31-34: Clarify Integration Communication Approach

The added block clearly explains that the integration communicates with a NUT server using the NUT protocol rather than interfacing directly with power devices. This clarification helps set the right context for users regarding data flow and control.

source/_integrations/nut.markdown

c0ffeeca7 · 2025-04-14T06:43:58Z

A merge conflict popped-up. Could you take a look, @tdfountain?

frenck

Seems like something went wrong in your latest merge/rebase. There are now many unrelated commits in this PR. Could you take a look?

Thanks 👍

../Frenck

tdfountain · 2025-04-18T06:52:00Z

Thanks! The rebase issue has been fixed, sorry about that.

source/_integrations/nut.markdown

Emphasize use of NUT server Co-authored-by: J. Nick Koston <nick+github@koston.org>

frenck

Thanks, @tdfountain 👍

../Frenck

tdfountain requested a review from bdraco as a code owner April 4, 2025 23:06

github-project-automation bot added this to Documentation PRs Apr 4, 2025

home-assistant bot added the current This PR goes into the current branch label Apr 4, 2025

github-project-automation bot moved this to Todo in Documentation PRs Apr 4, 2025

coderabbitai bot reviewed Apr 4, 2025

View reviewed changes

frenck requested changes Apr 5, 2025

View reviewed changes

source/_integrations/nut.markdown Outdated Show resolved Hide resolved

source/_integrations/nut.markdown Outdated Show resolved Hide resolved

home-assistant bot marked this pull request as draft April 5, 2025 10:22

github-project-automation bot moved this from Todo to In Progress in Documentation PRs Apr 5, 2025

tdfountain marked this pull request as ready for review April 5, 2025 17:05

home-assistant bot requested a review from frenck April 5, 2025 17:05

coderabbitai bot reviewed Apr 5, 2025

View reviewed changes

c0ffeeca7 reviewed Apr 7, 2025

View reviewed changes

source/_integrations/nut.markdown Outdated Show resolved Hide resolved

frenck requested changes Apr 7, 2025

View reviewed changes

source/_integrations/nut.markdown Outdated Show resolved Hide resolved

home-assistant bot marked this pull request as draft April 7, 2025 07:10

tdfountain marked this pull request as ready for review April 7, 2025 15:22

home-assistant bot requested a review from frenck April 7, 2025 15:22

frenck requested changes Apr 14, 2025

View reviewed changes

home-assistant bot marked this pull request as draft April 14, 2025 09:47

tdfountain force-pushed the add-known-limitations-doc branch from 02c19b6 to 63895fa Compare April 18, 2025 06:37

tdfountain added 4 commits April 18, 2025 01:39

Add known limitations section

10388db

Move content to intro and explain reason

ed8aeda

Clarify get vs set in known limitations

423fc3f

Remove note about not upgrading NUT

2440c8f

tdfountain force-pushed the add-known-limitations-doc branch from 63895fa to 2440c8f Compare April 18, 2025 06:41

tdfountain added 2 commits April 18, 2025 01:42

Fix line wrap

9f0fee8

Fix action to be singular

0476f04

tdfountain marked this pull request as ready for review April 18, 2025 06:52

home-assistant bot requested a review from frenck April 18, 2025 06:52

bdraco reviewed Apr 18, 2025

View reviewed changes

source/_integrations/nut.markdown Show resolved Hide resolved

bdraco reviewed Apr 18, 2025

View reviewed changes

source/_integrations/nut.markdown Outdated Show resolved Hide resolved

Update source/_integrations/nut.markdown

7ab8609

Emphasize use of NUT server Co-authored-by: J. Nick Koston <nick+github@koston.org>

frenck approved these changes Apr 19, 2025

View reviewed changes

frenck merged commit 6f6c5cd into home-assistant:current Apr 19, 2025
7 checks passed

bdraco mentioned this pull request Apr 19, 2025

Add quality scale and set Platinum for NUT home-assistant/core#143269

Open

73 tasks

github-actions bot locked and limited conversation to collaborators Apr 20, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add known limitations to NUT #38388

Add known limitations to NUT #38388

tdfountain commented Apr 4, 2025 •

edited by coderabbitai bot

Loading

netlify bot commented Apr 4, 2025 •

edited

Loading

coderabbitai bot commented Apr 4, 2025 •

edited

Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

home-assistant bot commented Apr 5, 2025

coderabbitai bot left a comment

c0ffeeca7 commented Apr 14, 2025

frenck left a comment

tdfountain commented Apr 18, 2025

frenck left a comment

Add known limitations to NUT #38388

Add known limitations to NUT #38388

Conversation

tdfountain commented Apr 4, 2025 • edited by coderabbitai bot Loading

Proposed change

Type of change

Additional information

Checklist

Summary by CodeRabbit

netlify bot commented Apr 4, 2025 • edited Loading

✅ Deploy Preview for home-assistant-docs ready!

coderabbitai bot commented Apr 4, 2025 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

home-assistant bot commented Apr 5, 2025

coderabbitai bot left a comment

Choose a reason for hiding this comment

c0ffeeca7 commented Apr 14, 2025

frenck left a comment

Choose a reason for hiding this comment

tdfountain commented Apr 18, 2025

frenck left a comment

Choose a reason for hiding this comment

tdfountain commented Apr 4, 2025 •

edited by coderabbitai bot

Loading

netlify bot commented Apr 4, 2025 •

edited

Loading

coderabbitai bot commented Apr 4, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)