Skip to content

Add description for installation parameters for APCUPSD #38763

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 28, 2025
Merged

Add description for installation parameters for APCUPSD #38763

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
44e1da8
Add description of installation parameters
yuxincs Apr 27, 2025
1127056
Update apcupsd.markdown
yuxincs Apr 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions source/_integrations/apcupsd.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,21 @@ ha_integration_type: integration
2. Configure apcupsd for network access.

- Open the `apcupsd.conf` file (usually found in `/etc/apcupsd/`) and make sure it’s set to listen for network connections.
- Look for the line: `NISIP 0.0.0.0`.
- This setting allows it to accept connections on all network interfaces.
- If you prefer, you can set this to a specific IP address that Home Assistant can reach.
- Look for the lines: `NISIP 0.0.0.0` and `NISPORT 3551`.
- This setting allows it to accept connections on all network interfaces on port 3551.
- If you prefer, you can set this to a specific IP address and port that Home Assistant can reach.

3. Start the apcupsd service.

{% include integrations/config_flow.md %}

{% configuration_basic %}
Host:
description: "The IP address of the APC UPS Daemon configured above."
Port:
description: "The port of the APC UPS Daemon configured above."
{% endconfiguration_basic %}
Comment on lines +42 to +47
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Align configuration keys with schema and include defaults
YAML keys are case-sensitive—use lowercase to match the integration schema. Also, add default values in the descriptions for clarity.

@@ -42,6 +42,9 @@
 {% configuration_basic %}
-Host:
-  description: "The IP address of the APC UPS Daemon configured above."
-Port:
-  description: "The port of the APC UPS Daemon configured above."
+host:
+  description: "The IP address of the APC UPS Daemon (default: 0.0.0.0)."
+port:
+  description: "The port of the APC UPS Daemon (default: 3551)."
+{% endconfiguration_basic %}

Committable suggestion skipped: line range outside the PR's diff.


{% note %}

If you get `ConnectionRefusedError: Connection refused` errors in the Home Assistant logs, it means that Home Assistant is not able to connect to the daemon. Please check if the `NISIP` is properly configured.
Expand Down