Add guide for ups support via nut integration in Synology DSM #39725
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull Request Overview
This PR adds a new UPS support section to the Synology DSM integration docs, showing how to enable UPS on the NAS and connect it via the NUT integration.
- Introduces a UPS support heading and explanatory paragraph.
- Provides a numbered step-by-step guide for enabling UPS and configuring NUT.
- Links to Synology’s UPS KB and Home Assistant’s NUT integration.
Comments suppressed due to low confidence (5)
source/_integrations/synology_dsm.markdown:180
- [nitpick] Begin list items with a capital letter to match style guidelines. Change “activate” to “Activate”.
1. activate **Enable UPS support** in the NAS settings under **Control Panel > Hardware & Power > UPS**
source/_integrations/synology_dsm.markdown:181
- [nitpick] Start this item with a capital letter: change “activate” to “Activate”.
2. activate **Enable network UPS server**
source/_integrations/synology_dsm.markdown:182
- [nitpick] Capitalize the first word of the step (“Click on …”).
3. click on **Permitted Synology NAS Devices** and add the IP address of your HA instance
source/_integrations/synology_dsm.markdown:183
- Use the verb form “Set up” instead of “setup” and update the link to use a leading slash:
[Network UPS Tools (NUT)](/integrations/nut).
4. setup the [Network UPS Tools (NUT)](integrations/nut) integration
source/_integrations/synology_dsm.markdown:188
- Add a blank line above this heading to separate it from the preceding list, ensuring lists are surrounded by blank lines.
## Troubleshooting
📝 WalkthroughWalkthroughA new "UPS support" section was added to the Synology DSM integration documentation. This section explains how to monitor UPS systems connected to a Synology NAS using the Network UPS Tools (NUT) integration in Home Assistant, including detailed setup instructions. No code or existing documentation sections were modified. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Synology NAS
participant Home Assistant
participant NUT Integration
User->>Synology NAS: Enable UPS support and network UPS server
User->>Synology NAS: Permit Home Assistant IP
Home Assistant->>NUT Integration: Configure with NAS IP, default port, no credentials
NUT Integration->>Synology NAS: Connect to UPS server
Synology NAS-->>NUT Integration: Provide UPS status
NUT Integration-->>Home Assistant: Display UPS monitoring data
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (3)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
source/_integrations/synology_dsm.markdown (1)
180-187: Minor style & terminology clean-upsCapitalize list entries, spell out “Home Assistant”, and keep wording consistent with the rest of the doc set:
-1. activate **Enable UPS support** in the NAS settings under **Control Panel > Hardware & Power > UPS** -2. activate **Enable network UPS server** -3. click on **Permitted Synology NAS Devices** and add the IP address of your HA instance -4. setup the [Network UPS Tools (NUT)](integrations/nut) integration +1. Activate **Enable UPS support** in the NAS settings under **Control Panel > Hardware & Power > UPS**. +2. Activate **Enable network UPS server**. +3. Open **Permitted Synology NAS Devices** and add the IP address of your Home Assistant instance. +4. Set up the [Network UPS Tools (NUT)](/integrations/nut) integration:This keeps tone and terminology consistent with the existing sections.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_integrations/synology_dsm.markdown(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`source/_integrations/*`: Integration documentation must use the provided template structure and section order.
source/_integrations/*: Integration documentation must use the provided template structure and section order.
📄 Source: CodeRabbit Inference Engine (.github/copilot-instructions.md)
List of files the instruction was applied to:
source/_integrations/synology_dsm.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
🔇 Additional comments (1)
source/_integrations/synology_dsm.markdown (1)
176-178: To confirm whether we should use a root-relative link and that/integrations/nutactually resolves, let’s:
- Check how other integration pages link to each other (root-relative vs. relative).
- Verify that the NUT integration page exists under
source/_integrations.#!/bin/bash # 1) List how integrations are linked in markdown: echo "---- Root-relative integration links ----" rg -n '\]\(/integrations/' source || true echo "---- Relative integration links ----" rg -n '\]\(integrations/' source || true # 2) Ensure the NUT integration page is present: echo "---- Files matching 'nut' in source/_integrations ----" ls source/_integrations | grep -i '^nut' || true
Proposed change
This adds a short guide on how to add support for UPS systems connected to the NAS via the NUT integration.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit