homepage/docs/widgets/services/peanut.md
Martin Bjeldbak Madsen 26480c74a2
docs: Set key to default value for peanut
As noted in the document, the default name is `ups` and unlikely to change in the future
2024-04-14 13:33:50 +10:00

24 lines
817 B
Markdown

---
title: PeaNUT
description: PeaNUT Widget Configuration
---
Learn more about [PeaNUT](https://github.com/Brandawg93/PeaNUT).
This widget adds support for [Network UPS Tools](https://networkupstools.org/) via a third party tool, [PeaNUT](https://github.com/Brandawg93/PeaNUT).
The default ups name is `ups`. To configure more than one ups, you must create multiple peanut services.
Allowed fields: `["battery_charge", "ups_load", "ups_status"]`.
!!! note
This widget requires an additional tool, [PeaNUT](https://github.com/Brandawg93/PeaNUT), as noted. Other projects exist to achieve similar results using a `customapi` widget, for example [NUTCase](https://github.com/ArthurMitchell42/nutcase#using-nutcase-homepage).
```yaml
widget:
type: peanut
url: http://peanut.host.or.ip:port
key: ups
```