The GUI
The main page shows a summary of a single UPS device. See below for a break down of the features.
The toolbar icons allow quick movement to the other pages and get extra details about the device. From left to right the functions are:
-
DeviceA pull down to select you server and device from the list in the configuration file -
DownloadThis pull down allows quick viewing or downloading of the JSON, metrics or raw JSON as a text file to allow setup and inspection of the data returned by your UPS. -
HomeReturn to the main page from any sub-page -
LogsDisplay and download the log file or any rotated copies of such - ℹ️ Opens a pop-up section in the main window with details of the server and device. This shows a list of UPS clients, if present.
-
GitHubOpen the NUTCase Wiki on GitHub for help and information -
BookOpen a quick help page with information on usage - ❓ Quick help on the current page
- 🌔 GUI Theme, select light, dark or auto to follow your system theme
The status block shows most of the key information about the UPS. The heart icon pulses on a successful update and turns red on an error occurring. The plug and icon to it's right indicate the state of the incoming line voltage. Hover the mouse over them for details. Over and under voltages are indicated by a yellow plug icon and an icon indicating the condition.
The battery icon indicates normal, charging and discharging states by colour. Red indicates a critical battery level or a battery failure.
Runtime is the reported time that the battery can sustain the output before shut down. The format of the number can be set with the Settings->ui_format_runtime option and the default is "%-Hh %-Mm %Ss"
The sounder can indicate whether it is enabled, disabled and for NUT servers, whether it is muted. For APC servers, if the information is sent, it can also show under which conditions the sounder activates.
Clicking the pull-down chevron at the top right of the status block shows a drop down with raw variable values for some of the key values. This is intended for diagnostics. Click it again to hide this section.
The gauges show a variety of information about the battery, the input and output states. The outer, thicker ring shows the current state of the parameter and the thinner, inner ring indicates the limits or bounds associated with the measurement.
For instance, the input voltage gauge has a green section for the acceptable range of line voltage and the red sections indicate at which point the UPS takes over the supply. This information is sourced from the data supplied by the UPS. If the inner ring is black or missing then your model may not supply this data. Check by following the documented diagnostics on this Wiki and view the JSON data for your device in a web browser to check the data your device sends.
Hovering over any gauge segment will show you the current value or the from-to range for things like input limits.
The input voltage and the battery voltage will also show a grey marker to indicate the nominal voltage if your device provides this information.
The charts show a real-time graph of certain parameters. In this version the data is only stored while you view the page. A future version will log data at all times if there is interest in such a feature.
Hover over a chart point to get the data value.
The output power graph shows percentage capacity of the device. The left scale will indicate true power in Watts either if your device supplies a nominal power figure in it's output data, or you over ride the device power by specifying a power value in the servers section for this device. Check the configuration file for details.