Files
homarr/apps/docs/docs/widgets/ups/index.mdx
T

55 lines
2.0 KiB
Plaintext

---
title: "UPS"
description: "Monitor the status of your UPS devices through a NUT server."
hide_title: true
---
import { WidgetInteractionGuide } from "@site/src/components/widgets/interactions";
import { WidgetHeader } from "@site/src/components/widgets/header";
import { AddingWidget } from "@site/src/components/widgets/adding";
import { WidgetConfig } from "@site/src/components/widgets/configuration";
import { WidgetIntegrations } from "@site/src/components/widgets/integrations";
import { upsWidget } from ".";
import { peaNutIntegration } from "@site/docs/integrations/peanut";
<WidgetHeader widget={upsWidget} categories={["UPS"]} />
This widget displays the status of the UPS devices reported by a Network UPS Tools (NUT) server. Each device shows its
status (online, on battery, charging or low battery), battery charge and estimated runtime, output load, and input and
output voltage.
### Layouts
import screenshotFull from "./img/screenshot.png";
import screenshotCompact from "./img/screenshot-compact.png";
import screenshotMini from "./img/screenshot-mini.png";
The widget adapts to the size of the tile, so it stays readable from a full dashboard panel down to a single cell. Multiple UPS devices scroll within the widget at any height.
| Layout | Size | Preview |
| ------- | --------------- | --------------------------------------------------------------------------- |
| Full | 3+ columns wide | <img src={screenshotFull} alt="UPS widget full layout" width={239} /> |
| Compact | ~2 columns | <img src={screenshotCompact} alt="UPS widget compact layout" width={171} /> |
| Mini | 1 column | <img src={screenshotMini} alt="UPS widget mini layout" width={90} /> |
### Supported Integrations
<WidgetIntegrations
items={[
{
integration: peaNutIntegration,
},
]}
/>
<WidgetInteractionGuide />
### Adding the widget
<AddingWidget />
### Configuration
<WidgetConfig configuration={upsWidget.configuration} />