ContextQMD
Back to Homepage

PeaNUT

docs/widgets/services/peanut.md

1.12.3846 B
Original Source

Learn more about PeaNUT.

This widget adds support for Network UPS Tools via a third party tool, 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: nameofyourups
  username: username # only needed if set
  password: password # only needed if set