Document new buttons platform and PDU dynamic outlet buttons in NUT (#38140)

* Document dynamic PDU buttons

* Close important block

* Fix ha_category and ha_platforms to be singular
This commit is contained in:
tdfountain 2025-03-22 16:10:12 -07:00 committed by GitHub
parent 3ce7394fb4
commit 675d19b9d2
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -2,6 +2,7 @@
title: Network UPS Tools (NUT) title: Network UPS Tools (NUT)
description: Instructions on how to set up NUT sensors within Home Assistant. description: Instructions on how to set up NUT sensors within Home Assistant.
ha_category: ha_category:
- Button
- System monitor - System monitor
ha_iot_class: Local Polling ha_iot_class: Local Polling
ha_release: 0.34 ha_release: 0.34
@ -14,6 +15,7 @@ ha_codeowners:
- '@tdfountain' - '@tdfountain'
ha_zeroconf: true ha_zeroconf: true
ha_platforms: ha_platforms:
- button
- diagnostics - diagnostics
- sensor - sensor
ha_integration_type: device ha_integration_type: device
@ -23,6 +25,27 @@ The Network UPS Tools (NUT) integration allows you to monitor and manage a UPS (
{% include integrations/config_flow.md %} {% include integrations/config_flow.md %}
## Supported functionality
### Buttons
{% important %}
The username and password configured for the device must be granted
`instcmds` permissions on the NUT server to use buttons. Buttons will
not be available if user credentials are not specified. See the
[NUT server documentation](https://networkupstools.org/documentation.html)
for configuration information.
{% endimportant %}
This NUT integration will add buttons for NUT server commands
available for your device.
The following buttons are available for each switchable outlet:
| name | Description |
|---------------------------|:------------------------------------------------|
| Power cycle outlet `name` | Power cycle the named outlet |
## Example Resources ## Example Resources
Given the following example output from NUT (your variables may differ): Given the following example output from NUT (your variables may differ):