walNUT

Devices are listed in hostname:port alphabetical order and then alphabetically by their name.

Not available devices are signaled with a (N/A) [A] at their right. You can choose either to display or not not available devices in the preferences.

If available both device manufacturer and device model will be shown here.

Device status will show: line status [A] (online/on battery), and then, on the second row, every status reported by the device [B] (bypass, trim, ..).

If an alarm is set (ups.status: ALARM and ups.alarm) it’ll be shown here.

If available, [C] battery charge, [D] backup time, [E] device load and [F] temperature will be shown here.
Battery icon [1] will display actual charge through the number of horizontal bars (as the ones of panel icon).

If you want a deep dive in all the variables available for a device you have to select the Display raw data option in the preferences: raw vars will be displayed in a scrollable submenu.

If you want to execute NUT’s instant commands through walNUT you have to set the Display device’s commands option in the preferences.
You can choose to show device’s instant command either in a combo box [A] or as a submenu [B].

If the combo box [A] is chosen, first you have to select the command, and then click on the [1] ‘execute’ button on the right of the command’s description [2].

If the submenu [B] is chosen, when you click on a command, it’ll be executed.

Once a command has been executed, you’ll be notified whether it has been successfully sent to the driver [E] or not [F].

At the bottom of the panel menu there’s a handful of control buttons, some of which will open their own box [A] just before the controls row [B].

The buttons will show:

Clicking on the ‘credentials’ button [A] the credentials box [B] will open. This box is used to store username and password for devices so that you don’t have to be prompted for them every time you execute a command.

If you click on the [1] ‘undo and close’ button any change you made to user/password before clicking on [2] ‘save’ button will be discarded.

In order to find new devices, once you clicked on the [A] ‘find’ button, you have to insert the devices' hostname [1] and port [2] and then click on the [B] ‘start search’ button.

You will be notified either if new devices are found [C] or not [D].

If you want to delete a device, first you have to select it from the device list, and then you have to click on the [A] ‘delete’ button.
A new box [B] will appear asking you if you really want to delete it [1] or not [2].

The credentials dialog will prompt you to insert a valid username or password either if they’ve not been saved through the credentials box or if they proved to be wrong [A].

A guide to translate extensions can be found in Gnome Shell extensions' FAQ.

walNUT's documentation is done in AsciiDoc and then processed either to the html version and to the Mallard version for Yelp.

The help files must be put in the extension’s help subdir, creating a directory named after the desired locale’s language code (e.g. en, it, ..) or, for country-specific locales, language code and country code (e.g. pt_BR, pt_PT).

The html version must be compiled with:

Where help.html is the name the help file must have, manual.txt is the name of your source file and XX is the desired locale’s language code (e.g. it, es, ..).

While the Mallard version needs some further steps: