Document new switch platform and PDU dynamic outlet switches in NUT (#38146)

This commit is contained in:
tdfountain 2025-03-22 22:28:21 -07:00 committed by GitHub
parent 675d19b9d2
commit 1da15ee59e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -4,6 +4,7 @@ description: Instructions on how to set up NUT sensors within Home Assistant.
ha_category: ha_category:
- Button - Button
- System monitor - System monitor
- Switch
ha_iot_class: Local Polling ha_iot_class: Local Polling
ha_release: 0.34 ha_release: 0.34
ha_domain: nut ha_domain: nut
@ -18,6 +19,7 @@ ha_platforms:
- button - button
- diagnostics - diagnostics
- sensor - sensor
- switch
ha_integration_type: device ha_integration_type: device
--- ---
@ -27,16 +29,17 @@ The Network UPS Tools (NUT) integration allows you to monitor and manage a UPS (
## Supported functionality ## Supported functionality
### Buttons
{% important %} {% important %}
The username and password configured for the device must be granted The username and password configured for the device must be granted
`instcmds` permissions on the NUT server to use buttons. Buttons will `instcmds` permissions on the NUT server to use buttons and
not be available if user credentials are not specified. See the switches. Buttons and switches will not be available if user
[NUT server documentation](https://networkupstools.org/documentation.html) credentials are not specified. See the [NUT server
for configuration information. documentation](https://networkupstools.org/documentation.html) for
configuration information.
{% endimportant %} {% endimportant %}
### Buttons
This NUT integration will add buttons for NUT server commands This NUT integration will add buttons for NUT server commands
available for your device. available for your device.
@ -46,6 +49,17 @@ The following buttons are available for each switchable outlet:
|---------------------------|:------------------------------------------------| |---------------------------|:------------------------------------------------|
| Power cycle outlet `name` | Power cycle the named outlet | | Power cycle outlet `name` | Power cycle the named outlet |
### Switches
This NUT integration will add switches for NUT server commands
available for your device.
The following switches are available for each switchable outlet:
| name | Description |
|---------------------------|:------------------------------------------------|
| Power outlet `name` | Turn power on/off for 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):