diff --git a/docs/widgets/services/peanut.md b/docs/widgets/services/peanut.md index 433bedbc..fa6cf6b3 100644 --- a/docs/widgets/services/peanut.md +++ b/docs/widgets/services/peanut.md @@ -3,10 +3,16 @@ title: PeaNUT description: PeaNUT Widget Configuration --- +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